{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.cloudfront#AccessDenied": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "
Access denied.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cloudfront#ActiveTrustedKeyGroups": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "This field is true
if any of the key groups have public keys that CloudFront can use\n\t\t\tto verify the signatures of signed URLs and signed cookies. If not, this field is\n\t\t\tfalse
.
The number of key groups in the list.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#KGKeyPairIdsList", "traits": { "smithy.api#documentation": "A list of key groups, including the identifiers of the public keys in each key group that\n\t\t\tCloudFront can use to verify the signatures of signed URLs and signed cookies.
" } } }, "traits": { "smithy.api#documentation": "A list of key groups, and the public keys in each key group,\n\t\t\tthat CloudFront can use to verify the signatures of signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#ActiveTrustedSigners": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "This field is true
if any of the AWS accounts in the list have active CloudFront\n\t\t\tkey pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies.\n\t\t\tIf not, this field is false
.
The number of AWS accounts in the list.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#SignerList", "traits": { "smithy.api#documentation": "A list of AWS accounts and the identifiers of active CloudFront key pairs in each account that\n\t\t\tCloudFront can use to verify the signatures of signed URLs and signed cookies.
" } } }, "traits": { "smithy.api#documentation": "A list of AWS accounts and the active CloudFront key pairs in each account that CloudFront can use\n\t\t\tto verify the signatures of signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#AliasICPRecordal": { "type": "structure", "members": { "CNAME": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A domain name associated with a distribution.
" } }, "ICPRecordalStatus": { "target": "com.amazonaws.cloudfront#ICPRecordalStatus", "traits": { "smithy.api#documentation": "The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to \n\t\t\tAPPROVED for all CNAMEs (aliases) in regions outside of China.
\n\t\tThe status values returned are the following:
\n\t\t\n APPROVED indicates that the associated CNAME has a valid ICP recordal number.\n\t\t\tMultiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as\n\t\t\tAPPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.
\n\n SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal \n\t\t\t\tnumber.
\n\n PENDING indicates that CloudFront can't determine the ICP recordal status of the \n\t\t\t\tCNAME associated with the distribution because there was an error in trying to determine the status. You can try again\n\t\t\t\tto see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.
\nAWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content \n\t\t\tpublicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP \n\t\t\trecordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure\n\t\t\tit yourself.
\n\t\tFor more information about ICP recordals, see \n\t\t\tSignup, Accounts, and Credentials in Getting Started with AWS services in China.
" } }, "com.amazonaws.cloudfront#AliasICPRecordals": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#AliasICPRecordal", "traits": { "smithy.api#xmlName": "AliasICPRecordal" } } }, "com.amazonaws.cloudfront#AliasList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "CNAME" } } }, "com.amazonaws.cloudfront#Aliases": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of CNAME aliases, if any, that you want to associate with this \n\t\t\tdistribution.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#AliasList", "traits": { "smithy.api#documentation": "A complex type that contains the CNAME aliases, if any, that you want to associate with \n\t\t\tthis distribution.
" } } }, "traits": { "smithy.api#documentation": "A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this distribution.
" } }, "com.amazonaws.cloudfront#AllowedMethods": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of HTTP methods that you want CloudFront to forward to your origin. Valid values \n\t\t\tare 2 (for GET
and HEAD
requests), 3 (for GET
, \n\t\t\t\tHEAD
, and OPTIONS
requests) and 7 (for GET, HEAD, OPTIONS, \n\t\t\t\tPUT, PATCH, POST
, and DELETE
requests).
A complex type that contains the HTTP methods that you want CloudFront to process and forward \n\t\t\tto your origin.
", "smithy.api#required": {} } }, "CachedMethods": { "target": "com.amazonaws.cloudfront#CachedMethods" } }, "traits": { "smithy.api#documentation": "A complex type that controls which HTTP methods CloudFront processes and forwards to your \n\t\t\tAmazon S3 bucket or your custom origin. There are three choices:
\n\t\tCloudFront forwards only GET
and HEAD
requests.
CloudFront forwards only GET
, HEAD
, and OPTIONS
\n\t\t\t\t\trequests.
CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST
, and \n\t\t\t\t\t\tDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or \n\t\t\tto your custom origin so users can't perform operations that you don't want them to. For \n\t\t\texample, you might not want users to have permissions to delete objects from your \n\t\t\torigin.
" } }, "com.amazonaws.cloudfront#AwsAccountNumberList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "AwsAccountNumber" } } }, "com.amazonaws.cloudfront#BatchTooLarge": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Invalidation batch specified is too large.
", "smithy.api#error": "client", "smithy.api#httpError": 413 } }, "com.amazonaws.cloudfront#CNAMEAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The CNAME specified is already defined for CloudFront.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#CacheBehavior": { "type": "structure", "members": { "PathPattern": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The pattern (for example, images/*.jpg
) that specifies which requests to \n\t\t\tapply the behavior to. When CloudFront receives a viewer request, the requested path is compared \n\t\t\twith path patterns in the order in which cache behaviors are listed in the \n\t\t\tdistribution.
You can optionally include a slash (/
) at the beginning of the path \n\t\t\t\tpattern. For example, /images/*.jpg
. CloudFront behavior is the same with or without \n\t\t\t\tthe leading /
.
The path pattern for the default cache behavior is *
and cannot be \n\t\t\tchanged. If the request for an object does not match the path pattern for any cache behaviors, \n\t\t\tCloudFront applies the behavior in the default cache behavior.
For more information, see Path \n\t\t\t\tPattern in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "TargetOriginId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of ID
for the origin that you want CloudFront to route requests to\n\t\t\twhen they match this cache behavior.
We recommend using TrustedKeyGroups
instead of\n\t\t\t\tTrustedSigners
.
A list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed\n\t\t\tcookies.
\n\t\tWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies\n\t\t\tfor all requests that match the cache behavior. The URLs or cookies must be signed with\n\t\t\tthe private key of a CloudFront key pair in the trusted signer’s AWS account. The signed URL\n\t\t\tor cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" } }, "TrustedKeyGroups": { "target": "com.amazonaws.cloudfront#TrustedKeyGroups", "traits": { "smithy.api#documentation": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
\n\t\tWhen a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with a private key whose corresponding public key is in the key group. The signed\n\t\t\tURL or cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" } }, "ViewerProtocolPolicy": { "target": "com.amazonaws.cloudfront#ViewerProtocolPolicy", "traits": { "smithy.api#documentation": "The protocol that viewers can use to access the files in the origin specified by \n\t\t\t\tTargetOriginId
when a request matches the path pattern in \n\t\t\t\tPathPattern
. You can specify the following options:
\n allow-all
: Viewers can use HTTP or HTTPS.
\n redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns \n\t\t\t\t\tan HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The \n\t\t\t\t\tviewer then resubmits the request using the new URL.
\n https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP \n\t\t\t\t\tstatus code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tThe only way to guarantee that viewers retrieve an object that was fetched from the origin\n\t\t\t\tusing HTTPS is never to use any other protocol to fetch the object. If you have\n\t\t\t\trecently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache\n\t\t\t\tbecause cached objects are protocol agnostic. That means that an edge location will\n\t\t\t\treturn an object from the cache regardless of whether the current request protocol\n\t\t\t\tmatches the protocol used previously. For more information, see Managing Cache Expiration in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\n\t\tIndicates whether you want to distribute media files in the Microsoft Smooth Streaming \n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify \n\t\t\t\ttrue
; if not, specify false
. If you specify true
for \n\t\t\t\tSmoothStreaming
, you can still distribute other content using this cache \n\t\t\tbehavior if the content matches the value of PathPattern
.
Whether you want CloudFront to automatically compress certain files for this cache behavior. \n\t\t\tIf so, specify true; if not, specify false. For more information, see Serving Compressed Files in the \n\t\t\t\tAmazon CloudFront Developer Guide.
" } }, "LambdaFunctionAssociations": { "target": "com.amazonaws.cloudfront#LambdaFunctionAssociations", "traits": { "smithy.api#documentation": "A complex type that contains zero or more Lambda function associations for a cache \n\t\t\tbehavior.
" } }, "FunctionAssociations": { "target": "com.amazonaws.cloudfront#FunctionAssociations", "traits": { "smithy.api#documentation": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must\n\t\t\tbe published to the LIVE
stage to associate them with a cache\n\t\t\tbehavior.
The value of ID
for the field-level encryption configuration that you want CloudFront\n\t\t\tto use for encrypting specific fields of data for this cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this\n\t\t\tcache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
" } }, "CachePolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The unique identifier of the cache policy that is attached to this cache behavior. For more\n\t\t\tinformation, see Creating cache policies or Using the managed cache policies in the\n Amazon CloudFront Developer Guide.
\nA CacheBehavior
must include either a\n CachePolicyId
or ForwardedValues
. We recommend that you\n use a CachePolicyId
.
The unique identifier of the origin request policy that is attached to this cache behavior.\n\t\t\tFor more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
" } }, "ForwardedValues": { "target": "com.amazonaws.cloudfront#ForwardedValues", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field. For more information, see Working with policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tIf you want to include values in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tIf you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the\n Amazon CloudFront Developer Guide.
\nA CacheBehavior
must include either a\n CachePolicyId
or ForwardedValues
. We recommend that you\n use a CachePolicyId
.
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
" } }, "MinTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "This field is deprecated. We recommend that you use the MinTTL
field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. For \n\t\t\tmore information, see \n\t\t\t\tManaging How Long Content Stays in an Edge Cache (Expiration) in the \n\t\t\t\tAmazon CloudFront Developer Guide.
\n\t\tYou must specify 0
for MinTTL
if you configure CloudFront to \n\t\t\tforward all headers to your origin (under Headers
, if you specify 1
\n\t\t\tfor Quantity
and *
for Name
).
This field is deprecated. We recommend that you use the DefaultTTL
field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.
The default amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin does not add HTTP headers such as \n\t\t\t\tCache-Control max-age
, Cache-Control s-maxage
, and \n\t\t\t\tExpires
to objects. For more information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
This field is deprecated. We recommend that you use the MaxTTL
field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.
The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin adds HTTP headers such as \n\t\t\t\tCache-Control max-age
, Cache-Control s-maxage
, and \n\t\t\t\tExpires
to objects. For more information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
A complex type that describes how CloudFront processes requests.
\n\t\tYou must create at least as many cache behaviors (including the default cache behavior) as\n\t\t\tyou have origins if you want CloudFront to serve objects from all of the origins. Each cache\n\t\t\tbehavior specifies the one origin from which you want CloudFront to get objects. If you have\n\t\t\ttwo origins and only the default cache behavior, the default cache behavior will cause\n\t\t\tCloudFront to get objects from one of the origins, but the other origin is never used.
\n\t\tFor the current quota (formerly known as limit) on the number of cache behaviors that you\n\t\t\tcan add to a distribution, see Quotas in the Amazon CloudFront Developer Guide.
\n\t\tIf you don’t want to specify any cache behaviors, include only an empty\n\t\t\tCacheBehaviors
element. Don’t include an empty CacheBehavior
\n\t\t\telement because this is invalid.
To delete all cache behaviors in an existing distribution, update the distribution \n\t\t\tconfiguration and include only an empty CacheBehaviors
element.
To add, change, or remove one or more cache behaviors, update the distribution \n\t\t\tconfiguration and specify all of the cache behaviors that you want to include in the updated \n\t\t\tdistribution.
\n\t\tFor more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#CacheBehaviorList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#CacheBehavior", "traits": { "smithy.api#xmlName": "CacheBehavior" } } }, "com.amazonaws.cloudfront#CacheBehaviors": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of cache behaviors for this distribution.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#CacheBehaviorList", "traits": { "smithy.api#documentation": "Optional: A complex type that contains cache behaviors for this distribution. If \n\t\t\t\tQuantity
is 0
, you can omit Items
.
A complex type that contains zero or more CacheBehavior
elements. \n\t\t
The unique identifier for the cache policy.
", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "The date and time when the cache policy was last modified.
", "smithy.api#required": {} } }, "CachePolicyConfig": { "target": "com.amazonaws.cloudfront#CachePolicyConfig", "traits": { "smithy.api#documentation": "The cache policy configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A cache policy.
\n\t\tWhen it’s attached to a cache behavior, the cache policy determines the\n\t\t\tfollowing:
\n\t\tThe values that CloudFront includes in the cache key. These values can include HTTP headers,\n\t\t\t\t\tcookies, and URL query strings. CloudFront uses the cache key to find an object in its\n\t\t\t\t\tcache that it can return to the viewer.
\n\t\t\tThe default, minimum, and maximum time to live (TTL) values that you want objects to stay\n\t\t\t\t\tin the CloudFront cache.
\n\t\t\tThe headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind a valid object in its cache that matches the request’s cache key. If you want to\n\t\t\tsend values to the origin but not include them in the cache key,\n\t\t\tuse OriginRequestPolicy
.
A cache policy with this name already exists. You must provide a unique name. To\n\t\t\tmodify an existing cache policy, use UpdateCachePolicy
.
A comment to describe the cache policy. The comment cannot be longer than 128\n\t\t\tcharacters.
" } }, "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A unique name to identify the cache policy.
", "smithy.api#required": {} } }, "DefaultTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#documentation": "The default amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. CloudFront uses this value as the object’s time to live (TTL) only when the origin\n\t\t\tdoes not send Cache-Control
or Expires
\n\t\t\theaders with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.
The default value for this field is 86400 seconds (one day). If the value of\n\t\t\tMinTTL
is more than 86400 seconds, then the default value for this field is\n\t\t\tthe same as the value of MinTTL
.
The maximum amount of time, in seconds, that objects stay in the CloudFront cache\n\t\t\tbefore CloudFront sends another request to the origin to see if the object has been updated.\n\t\t\tCloudFront uses this value only when the origin sends Cache-Control
or\n\t\t\tExpires
headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.
The default value for this field is 31536000 seconds (one year). If the value of\n\t\t\tMinTTL
or DefaultTTL
is more than 31536000 seconds, then the\n\t\t\tdefault value for this field is the same as the value of DefaultTTL
.
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "ParametersInCacheKeyAndForwardedToOrigin": { "target": "com.amazonaws.cloudfront#ParametersInCacheKeyAndForwardedToOrigin", "traits": { "smithy.api#documentation": "The HTTP headers, cookies, and URL query strings to include in the cache key. The\n\t\t\tvalues included in the cache key are automatically included in requests that CloudFront sends\n\t\t\tto the origin.
" } } }, "traits": { "smithy.api#documentation": "A cache policy configuration.
\n\t\tThis configuration determines the following:
\n\t\tThe values that CloudFront includes in the cache key. These values can include HTTP headers,\n\t\t\t\t\tcookies, and URL query strings. CloudFront uses the cache key to find an object in its\n\t\t\t\t\tcache that it can return to the viewer.
\n\t\t\tThe default, minimum, and maximum time to live (TTL) values that you want objects to stay\n\t\t\t\t\tin the CloudFront cache.
\n\t\t\tThe headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind a valid object in its cache that matches the request’s cache key. If you want to\n\t\t\tsend values to the origin but not include them in the cache key,\n\t\t\tuse OriginRequestPolicy
.
Determines whether any cookies in viewer requests are included in the cache key and\n\t\t\tautomatically included in requests that CloudFront sends to the origin. Valid values\n\t\t\tare:
\n\t\t\n none
– Cookies in viewer requests are not included in the cache key and are\n\t\t\t\t\tnot automatically included in requests that CloudFront sends to the origin. Even when\n\t\t\t\t\tthis field is set to none
, any cookies that are listed in an\n\t\t\t\t\tOriginRequestPolicy
\n are included in origin\n\t\t\t\t\trequests.
\n whitelist
– The cookies in viewer requests that are listed in the\n\t\t\t\t\tCookieNames
type are included in the cache key and automatically\n\t\t\t\t\tincluded in requests that CloudFront sends to the origin.
\n allExcept
– All cookies in viewer requests that are \n not\n listed in the CookieNames
\n\t\t\t\t\ttype are included in the cache key and automatically included in requests that\n\t\t\t\t\tCloudFront sends to the origin.
\n all
– All cookies in viewer requests are included in the cache key and are\n\t\t\t\t\tautomatically included in requests that CloudFront sends to the origin.
An object that determines whether any cookies in viewer requests (and if so, which cookies)\n\t\t\tare included in the cache key and automatically included in requests that CloudFront sends to\n\t\t\tthe origin.
" } }, "com.amazonaws.cloudfront#CachePolicyHeaderBehavior": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "none", "name": "none" }, { "value": "whitelist", "name": "whitelist" } ] } }, "com.amazonaws.cloudfront#CachePolicyHeadersConfig": { "type": "structure", "members": { "HeaderBehavior": { "target": "com.amazonaws.cloudfront#CachePolicyHeaderBehavior", "traits": { "smithy.api#documentation": "Determines whether any HTTP headers are included in the cache key and automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. Valid values are:
\n\t\t\n none
– HTTP headers are not included in the cache key and are not\n\t\t\t\t\tautomatically included in requests that CloudFront sends to the origin. Even when this\n\t\t\t\t\tfield is set to none
, any headers that are listed in an\n\t\t\t\t\tOriginRequestPolicy
\n are included in origin\n\t\t\t\t\trequests.
\n whitelist
– The HTTP headers that are listed in the Headers
type\n\t\t\t\t\tare included in the cache key and are automatically included in requests that\n\t\t\t\t\tCloudFront sends to the origin.
An object that determines whether any HTTP headers (and if so, which headers) are included\n\t\t\tin the cache key and automatically included in requests that CloudFront sends to the\n\t\t\torigin.
" } }, "com.amazonaws.cloudfront#CachePolicyInUse": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Cannot delete the cache policy because it is attached to one or more cache\n\t\t\tbehaviors.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#CachePolicyList": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker
field of a\n\t\t\tsubsequent request to continue listing cache policies where you left off.
The maximum number of cache policies requested.
", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The total number of cache policies returned in the response.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#CachePolicySummaryList", "traits": { "smithy.api#documentation": "Contains the cache policies in the list.
" } } }, "traits": { "smithy.api#documentation": "A list of cache policies.
" } }, "com.amazonaws.cloudfront#CachePolicyQueryStringBehavior": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "none", "name": "none" }, { "value": "whitelist", "name": "whitelist" }, { "value": "allExcept", "name": "allExcept" }, { "value": "all", "name": "all" } ] } }, "com.amazonaws.cloudfront#CachePolicyQueryStringsConfig": { "type": "structure", "members": { "QueryStringBehavior": { "target": "com.amazonaws.cloudfront#CachePolicyQueryStringBehavior", "traits": { "smithy.api#documentation": "Determines whether any URL query strings in viewer requests are included in the cache key\n\t\t\tand automatically included in requests that CloudFront sends to the origin. Valid values\n\t\t\tare:
\n\t\t\n none
– Query strings in viewer requests are not included in the cache key and\n\t\t\t\t\tare not automatically included in requests that CloudFront sends to the origin. Even\n\t\t\t\t\twhen this field is set to none
, any query strings that are listed\n\t\t\t\t\tin an OriginRequestPolicy
\n are included in\n\t\t\t\t\torigin requests.
\n whitelist
– The query strings in viewer requests that are listed in the\n\t\t\t\t\tQueryStringNames
type are included in the cache key and\n\t\t\t\t\tautomatically included in requests that CloudFront sends to the origin.
\n allExcept
– All query strings in viewer requests that are \n not\n listed in the\n\t\t\t\t\tQueryStringNames
type are included in the cache key and\n\t\t\t\t\tautomatically included in requests that CloudFront sends to the origin.
\n all
– All query strings in viewer requests are included in the cache key and\n\t\t\t\t\tare automatically included in requests that CloudFront sends to the origin.
Contains the specific query strings in viewer requests that either \n are\n or \n are\n\t\t\tnot\n included in the cache key and automatically included in\n\t\t\trequests that CloudFront sends to the origin. The behavior depends on whether the\n\t\t\tQueryStringBehavior
field in the CachePolicyQueryStringsConfig
\n\t\t\ttype is set to whitelist
(the listed query strings \n are\n included) or allExcept
(the listed\n\t\t\tquery strings \n are not\n included,\n\t\t\tbut all other query strings are).
An object that determines whether any URL query strings in viewer requests (and if so, which\n\t\t\tquery strings) are included in the cache key and automatically included in requests that\n\t\t\tCloudFront sends to the origin.
" } }, "com.amazonaws.cloudfront#CachePolicySummary": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudfront#CachePolicyType", "traits": { "smithy.api#documentation": "The type of cache policy, either managed
(created by AWS) or\n\t\t\tcustom
(created in this AWS account).
The cache policy.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains a cache policy.
" } }, "com.amazonaws.cloudfront#CachePolicySummaryList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#CachePolicySummary", "traits": { "smithy.api#xmlName": "CachePolicySummary" } } }, "com.amazonaws.cloudfront#CachePolicyType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "managed", "name": "managed" }, { "value": "custom", "name": "custom" } ] } }, "com.amazonaws.cloudfront#CachedMethods": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of HTTP methods for which you want CloudFront to cache responses. Valid values are \n\t\t\t\t2
(for caching responses to GET
and HEAD
requests) \n\t\t\tand 3
(for caching responses to GET
, HEAD
, and \n\t\t\t\tOPTIONS
requests).
A complex type that contains the HTTP methods that you want CloudFront to cache responses \n\t\t\tto.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A complex type that controls whether CloudFront caches the response to requests using the \n\t\t\tspecified HTTP methods. There are two choices:
\n\t\tCloudFront caches responses to GET
and HEAD
requests.
CloudFront caches responses to GET
, HEAD
, and \n\t\t\t\t\t\tOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward \n\t\t\tAccess-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the \n\t\t\tresponses to be cached correctly.
" } }, "com.amazonaws.cloudfront#CannotChangeImmutablePublicKeyFields": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You can't change the value of a public key.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#CertificateSource": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "cloudfront", "name": "cloudfront" }, { "value": "iam", "name": "iam" }, { "value": "acm", "name": "acm" } ] } }, "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentity": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID for the origin access identity, for example, E74FTE3AJFJ256A
. \n\t\t
The Amazon S3 canonical user ID for the origin access identity, used when giving the origin \n\t\t\taccess identity read permission to an object in Amazon S3.
", "smithy.api#required": {} } }, "CloudFrontOriginAccessIdentityConfig": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityConfig", "traits": { "smithy.api#documentation": "The current configuration information for the identity.
" } } }, "traits": { "smithy.api#documentation": "CloudFront origin access identity.
" } }, "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "If the CallerReference
is a value you already sent in a previous request to create an identity but the content \n\t\t\tof the CloudFrontOriginAccessIdentityConfig
is different from the original request, CloudFront returns a \n\t\t\tCloudFrontOriginAccessIdentityAlreadyExists
error.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
\n\t\tIf the value of CallerReference
is new (regardless of the content of the \n\t\t\tCloudFrontOriginAccessIdentityConfig
object), a new origin access identity is \n\t\t\tcreated.
If the CallerReference
is a value already sent in a previous identity \n\t\t\trequest, and the content of the CloudFrontOriginAccessIdentityConfig
is identical \n\t\t\tto the original request (ignoring white space), the response includes the same information \n\t\t\treturned to the original request.
If the CallerReference
is a value you already sent in a previous request \n\t\t\tto create an identity, but the content of the \n\t\t\tCloudFrontOriginAccessIdentityConfig
is different from the original request, \n\t\t\tCloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists
error.
An optional comment to describe the origin access identity. The comment cannot be longer\n\t\t\tthan 128 characters.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Origin access identity configuration. Send a GET
request to the \n\t\t\t\t\t/CloudFront API version/CloudFront/identity ID/config
resource. \n\t\t
The Origin Access Identity specified is already in use.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityList": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of origin \n\t\t\taccess identities. The results include identities in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker
to the value of the \n\t\t\t\tNextMarker
from the current page's response (which is also the ID of the last \n\t\t\tidentity on that page).
If IsTruncated
is true
, this element is present and contains \n\t\t\tthe value you can use for the Marker
request parameter to continue listing your \n\t\t\torigin access identities where they left off.
The maximum number of origin access identities you want in the response body. \n\t\t
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "A flag that indicates whether more origin access identities remain to be listed. If \n\t\t\tyour results were truncated, you can make a follow-up pagination request using the \n\t\t\t\tMarker
request parameter to retrieve more items in the list.
The number of CloudFront origin access identities that were created by the current AWS \n\t\t\taccount.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentitySummaryList", "traits": { "smithy.api#documentation": "A complex type that contains one CloudFrontOriginAccessIdentitySummary
\n\t\t\telement for each origin access identity that was created by the current AWS \n\t\t\taccount.
Lists the origin access identities for CloudFront.Send a GET
request to the \n\t\t\t\t\t/CloudFront API version/origin-access-identity/cloudfront
\n\t\t\tresource. The response includes a CloudFrontOriginAccessIdentityList
element with \n\t\t\tzero or more CloudFrontOriginAccessIdentitySummary
child elements. By default, \n\t\t\tyour entire list of origin access identities is returned in one single page. If the list is \n\t\t\tlong, you can paginate it using the MaxItems
and Marker
\n\t\t\tparameters.
The ID for the origin access identity. For example: \n\t\t\tE74FTE3AJFJ256A
.
The Amazon S3 canonical user ID for the origin access identity, which you use when giving \n\t\t\tthe origin access identity read permission to an object in Amazon S3.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The comment for this origin access identity, as originally specified when \n\t\t\tcreated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Summary of the information about a CloudFront origin access identity.
" } }, "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentitySummaryList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentitySummary", "traits": { "smithy.api#xmlName": "CloudFrontOriginAccessIdentitySummary" } } }, "com.amazonaws.cloudfront#Cloudfront2020_05_31": { "type": "service", "version": "2020-05-31", "operations": [ { "target": "com.amazonaws.cloudfront#CreateCachePolicy" }, { "target": "com.amazonaws.cloudfront#CreateCloudFrontOriginAccessIdentity" }, { "target": "com.amazonaws.cloudfront#CreateDistribution" }, { "target": "com.amazonaws.cloudfront#CreateDistributionWithTags" }, { "target": "com.amazonaws.cloudfront#CreateFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#CreateFieldLevelEncryptionProfile" }, { "target": "com.amazonaws.cloudfront#CreateFunction" }, { "target": "com.amazonaws.cloudfront#CreateInvalidation" }, { "target": "com.amazonaws.cloudfront#CreateKeyGroup" }, { "target": "com.amazonaws.cloudfront#CreateMonitoringSubscription" }, { "target": "com.amazonaws.cloudfront#CreateOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#CreatePublicKey" }, { "target": "com.amazonaws.cloudfront#CreateRealtimeLogConfig" }, { "target": "com.amazonaws.cloudfront#CreateStreamingDistribution" }, { "target": "com.amazonaws.cloudfront#CreateStreamingDistributionWithTags" }, { "target": "com.amazonaws.cloudfront#DeleteCachePolicy" }, { "target": "com.amazonaws.cloudfront#DeleteCloudFrontOriginAccessIdentity" }, { "target": "com.amazonaws.cloudfront#DeleteDistribution" }, { "target": "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionProfile" }, { "target": "com.amazonaws.cloudfront#DeleteFunction" }, { "target": "com.amazonaws.cloudfront#DeleteKeyGroup" }, { "target": "com.amazonaws.cloudfront#DeleteMonitoringSubscription" }, { "target": "com.amazonaws.cloudfront#DeleteOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#DeletePublicKey" }, { "target": "com.amazonaws.cloudfront#DeleteRealtimeLogConfig" }, { "target": "com.amazonaws.cloudfront#DeleteStreamingDistribution" }, { "target": "com.amazonaws.cloudfront#DescribeFunction" }, { "target": "com.amazonaws.cloudfront#GetCachePolicy" }, { "target": "com.amazonaws.cloudfront#GetCachePolicyConfig" }, { "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentity" }, { "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfig" }, { "target": "com.amazonaws.cloudfront#GetDistribution" }, { "target": "com.amazonaws.cloudfront#GetDistributionConfig" }, { "target": "com.amazonaws.cloudfront#GetFieldLevelEncryption" }, { "target": "com.amazonaws.cloudfront#GetFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#GetFieldLevelEncryptionProfile" }, { "target": "com.amazonaws.cloudfront#GetFieldLevelEncryptionProfileConfig" }, { "target": "com.amazonaws.cloudfront#GetFunction" }, { "target": "com.amazonaws.cloudfront#GetInvalidation" }, { "target": "com.amazonaws.cloudfront#GetKeyGroup" }, { "target": "com.amazonaws.cloudfront#GetKeyGroupConfig" }, { "target": "com.amazonaws.cloudfront#GetMonitoringSubscription" }, { "target": "com.amazonaws.cloudfront#GetOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#GetOriginRequestPolicyConfig" }, { "target": "com.amazonaws.cloudfront#GetPublicKey" }, { "target": "com.amazonaws.cloudfront#GetPublicKeyConfig" }, { "target": "com.amazonaws.cloudfront#GetRealtimeLogConfig" }, { "target": "com.amazonaws.cloudfront#GetStreamingDistribution" }, { "target": "com.amazonaws.cloudfront#GetStreamingDistributionConfig" }, { "target": "com.amazonaws.cloudfront#ListCachePolicies" }, { "target": "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentities" }, { "target": "com.amazonaws.cloudfront#ListDistributions" }, { "target": "com.amazonaws.cloudfront#ListDistributionsByCachePolicyId" }, { "target": "com.amazonaws.cloudfront#ListDistributionsByKeyGroup" }, { "target": "com.amazonaws.cloudfront#ListDistributionsByOriginRequestPolicyId" }, { "target": "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfig" }, { "target": "com.amazonaws.cloudfront#ListDistributionsByWebACLId" }, { "target": "com.amazonaws.cloudfront#ListFieldLevelEncryptionConfigs" }, { "target": "com.amazonaws.cloudfront#ListFieldLevelEncryptionProfiles" }, { "target": "com.amazonaws.cloudfront#ListFunctions" }, { "target": "com.amazonaws.cloudfront#ListInvalidations" }, { "target": "com.amazonaws.cloudfront#ListKeyGroups" }, { "target": "com.amazonaws.cloudfront#ListOriginRequestPolicies" }, { "target": "com.amazonaws.cloudfront#ListPublicKeys" }, { "target": "com.amazonaws.cloudfront#ListRealtimeLogConfigs" }, { "target": "com.amazonaws.cloudfront#ListStreamingDistributions" }, { "target": "com.amazonaws.cloudfront#ListTagsForResource" }, { "target": "com.amazonaws.cloudfront#PublishFunction" }, { "target": "com.amazonaws.cloudfront#TagResource" }, { "target": "com.amazonaws.cloudfront#TestFunction" }, { "target": "com.amazonaws.cloudfront#UntagResource" }, { "target": "com.amazonaws.cloudfront#UpdateCachePolicy" }, { "target": "com.amazonaws.cloudfront#UpdateCloudFrontOriginAccessIdentity" }, { "target": "com.amazonaws.cloudfront#UpdateDistribution" }, { "target": "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionProfile" }, { "target": "com.amazonaws.cloudfront#UpdateFunction" }, { "target": "com.amazonaws.cloudfront#UpdateKeyGroup" }, { "target": "com.amazonaws.cloudfront#UpdateOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#UpdatePublicKey" }, { "target": "com.amazonaws.cloudfront#UpdateRealtimeLogConfig" }, { "target": "com.amazonaws.cloudfront#UpdateStreamingDistribution" } ], "traits": { "aws.api#service": { "sdkId": "CloudFront", "arnNamespace": "cloudfront", "cloudFormationName": "CloudFront", "cloudTrailEventSource": "cloudfront.amazonaws.com", "endpointPrefix": "cloudfront" }, "aws.auth#sigv4": { "name": "cloudfront" }, "aws.protocols#restXml": {}, "smithy.api#documentation": "This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about \n\t\t\tCloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.
", "smithy.api#title": "Amazon CloudFront", "smithy.api#xmlNamespace": { "uri": "http://cloudfront.amazonaws.com/doc/2020-05-31/" } } }, "com.amazonaws.cloudfront#CommentType": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.cloudfront#ContentTypeProfile": { "type": "structure", "members": { "Format": { "target": "com.amazonaws.cloudfront#Format", "traits": { "smithy.api#documentation": "The format for a field-level encryption content type-profile mapping.
", "smithy.api#required": {} } }, "ProfileId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The profile ID for a field-level encryption content type-profile mapping.
" } }, "ContentType": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The content type for a field-level encryption content type-profile mapping.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A field-level encryption content type profile.
" } }, "com.amazonaws.cloudfront#ContentTypeProfileConfig": { "type": "structure", "members": { "ForwardWhenContentTypeIsUnknown": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "The setting in a field-level encryption content type-profile mapping that specifies what to do\n\t\t\twhen an unknown content type is provided for the profile. If true, content is\n\t\t\tforwarded without being encrypted when the content type is unknown. If false (the\n\t\t\tdefault), an error is returned when the content type is unknown.
", "smithy.api#required": {} } }, "ContentTypeProfiles": { "target": "com.amazonaws.cloudfront#ContentTypeProfiles", "traits": { "smithy.api#documentation": "The configuration for a field-level encryption content type-profile.
" } } }, "traits": { "smithy.api#documentation": "The configuration for a field-level encryption content type-profile mapping.
" } }, "com.amazonaws.cloudfront#ContentTypeProfileList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#ContentTypeProfile", "traits": { "smithy.api#xmlName": "ContentTypeProfile" } } }, "com.amazonaws.cloudfront#ContentTypeProfiles": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of field-level encryption content type-profile mappings.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#ContentTypeProfileList", "traits": { "smithy.api#documentation": "Items in a field-level encryption content type-profile mapping.
" } } }, "traits": { "smithy.api#documentation": "Field-level encryption content type-profile.
" } }, "com.amazonaws.cloudfront#CookieNameList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "Name" } } }, "com.amazonaws.cloudfront#CookieNames": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of cookie names in the Items
list.
A list of cookie names.
" } } }, "traits": { "smithy.api#documentation": "Contains a list of cookie names.
" } }, "com.amazonaws.cloudfront#CookiePreference": { "type": "structure", "members": { "Forward": { "target": "com.amazonaws.cloudfront#ItemSelection", "traits": { "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\n\t\tIf you want to include cookies in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.
\n\t\tIf you want to send cookies to the origin but not include them in the cache key, use origin\n\t\t\trequest policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tSpecifies which cookies to forward to the origin for this cache behavior: all, none, or \n\t\t\tthe list of cookies specified in the WhitelistedNames
complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an \n\t\t\tAmazon S3 origin, specify none for the Forward
element.
This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\n\t\tIf you want to include cookies in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.
\n\t\tIf you want to send cookies to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tRequired if you specify whitelist
for the value of Forward
. \n\t\t\tA complex type that specifies how many different cookies you want CloudFront to forward to the \n\t\t\torigin for this cache behavior and, if you want to forward selected cookies, the names of \n\t\t\tthose cookies.
If you specify all
or none
for the value of Forward
, omit \n\t\t\t\tWhitelistedNames
. If you change the value of Forward
from \n\t\t\twhitelist
to all
or none
and you don't delete the WhitelistedNames
\n\t\t\telement and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each \n\t\t\tcache behavior, see \n\t\t\t\tCloudFront Limits in the AWS General Reference.
" } } }, "traits": { "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\n\t\tIf you want to include cookies in the cache key, use CookiesConfig
in a\n\t\t\tcache policy. See CachePolicy
.
If you want to send cookies to the origin but not include them in the cache key, use\n\t\t\tCookiesConfig
in an origin request policy. See\n\t\t\tOriginRequestPolicy
.
A complex type that specifies whether you want CloudFront to forward cookies to the origin \n\t\t\tand, if so, which ones. For more information about forwarding cookies to the origin, see \n\t\t\tCaching Content \n\t\t\t\tBased on Cookies in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#CreateCachePolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateCachePolicyRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateCachePolicyResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#CachePolicyAlreadyExists" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#TooManyCachePolicies" }, { "target": "com.amazonaws.cloudfront#TooManyCookiesInCachePolicy" }, { "target": "com.amazonaws.cloudfront#TooManyHeadersInCachePolicy" }, { "target": "com.amazonaws.cloudfront#TooManyQueryStringsInCachePolicy" } ], "traits": { "smithy.api#documentation": "Creates a cache policy.
\n\t\tAfter you create a cache policy, you can attach it to one or more cache behaviors. When it’s\n\t\t\tattached to a cache behavior, the cache policy determines the following:
\n\t\tThe values that CloudFront includes in the cache key. These values can\n\t\t\t\t\tinclude HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to\n\t\t\t\t\tfind an object in its cache that it can return to the viewer.
\n\t\t\tThe default, minimum, and maximum time to live (TTL) values that you want objects to stay\n\t\t\t\t\tin the CloudFront cache.
\n\t\t\tThe headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind an object in its cache that matches the request’s cache key. If you want to send\n\t\t\tvalues to the origin but not include them in the cache key, use\n\t\t\tOriginRequestPolicy
.
For more information about cache policies, see Controlling the cache key in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/cache-policy", "code": 201 } } }, "com.amazonaws.cloudfront#CreateCachePolicyRequest": { "type": "structure", "members": { "CachePolicyConfig": { "target": "com.amazonaws.cloudfront#CachePolicyConfig", "traits": { "smithy.api#documentation": "A cache policy configuration.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "CachePolicyConfig" } } } }, "com.amazonaws.cloudfront#CreateCachePolicyResult": { "type": "structure", "members": { "CachePolicy": { "target": "com.amazonaws.cloudfront#CachePolicy", "traits": { "smithy.api#documentation": "A cache policy.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The fully qualified URI of the cache policy just created.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the cache policy.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#CreateCloudFrontOriginAccessIdentity": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateCloudFrontOriginAccessIdentityRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateCloudFrontOriginAccessIdentityResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityAlreadyExists" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#MissingBody" }, { "target": "com.amazonaws.cloudfront#TooManyCloudFrontOriginAccessIdentities" } ], "traits": { "smithy.api#documentation": "Creates a new origin access identity. If you're using Amazon S3 for your origin, you can \n\t\t\tuse an origin access identity to require users to access your content using a CloudFront URL instead \n\t\t\tof the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the \n\t\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/origin-access-identity/cloudfront", "code": 201 } } }, "com.amazonaws.cloudfront#CreateCloudFrontOriginAccessIdentityRequest": { "type": "structure", "members": { "CloudFrontOriginAccessIdentityConfig": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityConfig", "traits": { "smithy.api#documentation": "The current configuration information for the identity.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "CloudFrontOriginAccessIdentityConfig" } } }, "traits": { "smithy.api#documentation": "The request to create a new origin access identity (OAI). An origin access identity is a \n\t\t\tspecial CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or \n\t\t\tjust some of your Amazon S3 content. For more information, see \n\t\t\tRestricting Access to Amazon S3 Content by Using an Origin Access Identity in the \n\t\t\tAmazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#CreateCloudFrontOriginAccessIdentityResult": { "type": "structure", "members": { "CloudFrontOriginAccessIdentity": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentity", "traits": { "smithy.api#documentation": "The origin access identity's information.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The fully qualified URI of the new origin access identity just created.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the origin access identity created.
", "smithy.api#httpHeader": "ETag" } } }, "traits": { "smithy.api#documentation": "The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#CreateDistribution": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateDistributionRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateDistributionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" }, { "target": "com.amazonaws.cloudfront#DistributionAlreadyExists" }, { "target": "com.amazonaws.cloudfront#IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidDefaultRootObject" }, { "target": "com.amazonaws.cloudfront#InvalidErrorCode" }, { "target": "com.amazonaws.cloudfront#InvalidForwardCookies" }, { "target": "com.amazonaws.cloudfront#InvalidFunctionAssociation" }, { "target": "com.amazonaws.cloudfront#InvalidGeoRestrictionParameter" }, { "target": "com.amazonaws.cloudfront#InvalidHeadersForS3Origin" }, { "target": "com.amazonaws.cloudfront#InvalidLambdaFunctionAssociation" }, { "target": "com.amazonaws.cloudfront#InvalidLocationCode" }, { "target": "com.amazonaws.cloudfront#InvalidMinimumProtocolVersion" }, { "target": "com.amazonaws.cloudfront#InvalidOrigin" }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, { "target": "com.amazonaws.cloudfront#InvalidOriginKeepaliveTimeout" }, { "target": "com.amazonaws.cloudfront#InvalidOriginReadTimeout" }, { "target": "com.amazonaws.cloudfront#InvalidProtocolSettings" }, { "target": "com.amazonaws.cloudfront#InvalidQueryStringParameters" }, { "target": "com.amazonaws.cloudfront#InvalidRelativePath" }, { "target": "com.amazonaws.cloudfront#InvalidRequiredProtocol" }, { "target": "com.amazonaws.cloudfront#InvalidResponseCode" }, { "target": "com.amazonaws.cloudfront#InvalidTTLOrder" }, { "target": "com.amazonaws.cloudfront#InvalidViewerCertificate" }, { "target": "com.amazonaws.cloudfront#InvalidWebACLId" }, { "target": "com.amazonaws.cloudfront#MissingBody" }, { "target": "com.amazonaws.cloudfront#NoSuchCachePolicy" }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#NoSuchOrigin" }, { "target": "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig" }, { "target": "com.amazonaws.cloudfront#RealtimeLogConfigOwnerMismatch" }, { "target": "com.amazonaws.cloudfront#TooManyCacheBehaviors" }, { "target": "com.amazonaws.cloudfront#TooManyCertificates" }, { "target": "com.amazonaws.cloudfront#TooManyCookieNamesInWhiteList" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionCNAMEs" }, { "target": "com.amazonaws.cloudfront#TooManyDistributions" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToCachePolicy" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToKeyGroup" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsWithFunctionAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsWithLambdaAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsWithSingleFunctionARN" }, { "target": "com.amazonaws.cloudfront#TooManyFunctionAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyHeadersInForwardedValues" }, { "target": "com.amazonaws.cloudfront#TooManyKeyGroupsAssociatedToDistribution" }, { "target": "com.amazonaws.cloudfront#TooManyLambdaFunctionAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyOriginCustomHeaders" }, { "target": "com.amazonaws.cloudfront#TooManyOriginGroupsPerDistribution" }, { "target": "com.amazonaws.cloudfront#TooManyOrigins" }, { "target": "com.amazonaws.cloudfront#TooManyQueryStringParameters" }, { "target": "com.amazonaws.cloudfront#TooManyTrustedSigners" }, { "target": "com.amazonaws.cloudfront#TrustedKeyGroupDoesNotExist" }, { "target": "com.amazonaws.cloudfront#TrustedSignerDoesNotExist" } ], "traits": { "smithy.api#documentation": "Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you \n\t\t\twant content to be delivered from, and the details about how to track and manage content delivery. Send a POST
request to the \n\t\t\t/CloudFront API version/distribution
/distribution ID
resource.
When you update a distribution, there are more required fields than when you create a distribution.\n\t\t\tWhen you update your distribution by using \n\t\t\tUpdateDistribution,\n\t\t\tfollow the steps included\n\t\t\tin the documentation to get the current configuration\n\t\t\tand then make your updates. This helps to make sure that you include all of the required fields. To view a summary,\n\t\t\tsee Required \n\t\t\t\tFields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
\nThe distribution's configuration information.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "DistributionConfig" } } }, "traits": { "smithy.api#documentation": "The request to create a new distribution.
" } }, "com.amazonaws.cloudfront#CreateDistributionResult": { "type": "structure", "members": { "Distribution": { "target": "com.amazonaws.cloudfront#Distribution", "traits": { "smithy.api#documentation": "The distribution's information.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The fully qualified URI of the new distribution resource just created.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the distribution created.
", "smithy.api#httpHeader": "ETag" } } }, "traits": { "smithy.api#documentation": "The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#CreateDistributionWithTags": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateDistributionWithTagsRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateDistributionWithTagsResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" }, { "target": "com.amazonaws.cloudfront#DistributionAlreadyExists" }, { "target": "com.amazonaws.cloudfront#IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidDefaultRootObject" }, { "target": "com.amazonaws.cloudfront#InvalidErrorCode" }, { "target": "com.amazonaws.cloudfront#InvalidForwardCookies" }, { "target": "com.amazonaws.cloudfront#InvalidFunctionAssociation" }, { "target": "com.amazonaws.cloudfront#InvalidGeoRestrictionParameter" }, { "target": "com.amazonaws.cloudfront#InvalidHeadersForS3Origin" }, { "target": "com.amazonaws.cloudfront#InvalidLambdaFunctionAssociation" }, { "target": "com.amazonaws.cloudfront#InvalidLocationCode" }, { "target": "com.amazonaws.cloudfront#InvalidMinimumProtocolVersion" }, { "target": "com.amazonaws.cloudfront#InvalidOrigin" }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, { "target": "com.amazonaws.cloudfront#InvalidOriginKeepaliveTimeout" }, { "target": "com.amazonaws.cloudfront#InvalidOriginReadTimeout" }, { "target": "com.amazonaws.cloudfront#InvalidProtocolSettings" }, { "target": "com.amazonaws.cloudfront#InvalidQueryStringParameters" }, { "target": "com.amazonaws.cloudfront#InvalidRelativePath" }, { "target": "com.amazonaws.cloudfront#InvalidRequiredProtocol" }, { "target": "com.amazonaws.cloudfront#InvalidResponseCode" }, { "target": "com.amazonaws.cloudfront#InvalidTagging" }, { "target": "com.amazonaws.cloudfront#InvalidTTLOrder" }, { "target": "com.amazonaws.cloudfront#InvalidViewerCertificate" }, { "target": "com.amazonaws.cloudfront#InvalidWebACLId" }, { "target": "com.amazonaws.cloudfront#MissingBody" }, { "target": "com.amazonaws.cloudfront#NoSuchCachePolicy" }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#NoSuchOrigin" }, { "target": "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig" }, { "target": "com.amazonaws.cloudfront#RealtimeLogConfigOwnerMismatch" }, { "target": "com.amazonaws.cloudfront#TooManyCacheBehaviors" }, { "target": "com.amazonaws.cloudfront#TooManyCertificates" }, { "target": "com.amazonaws.cloudfront#TooManyCookieNamesInWhiteList" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionCNAMEs" }, { "target": "com.amazonaws.cloudfront#TooManyDistributions" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToCachePolicy" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToKeyGroup" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsWithFunctionAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsWithLambdaAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsWithSingleFunctionARN" }, { "target": "com.amazonaws.cloudfront#TooManyFunctionAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyHeadersInForwardedValues" }, { "target": "com.amazonaws.cloudfront#TooManyKeyGroupsAssociatedToDistribution" }, { "target": "com.amazonaws.cloudfront#TooManyLambdaFunctionAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyOriginCustomHeaders" }, { "target": "com.amazonaws.cloudfront#TooManyOriginGroupsPerDistribution" }, { "target": "com.amazonaws.cloudfront#TooManyOrigins" }, { "target": "com.amazonaws.cloudfront#TooManyQueryStringParameters" }, { "target": "com.amazonaws.cloudfront#TooManyTrustedSigners" }, { "target": "com.amazonaws.cloudfront#TrustedKeyGroupDoesNotExist" }, { "target": "com.amazonaws.cloudfront#TrustedSignerDoesNotExist" } ], "traits": { "smithy.api#documentation": "Create a new distribution with tags.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distribution?WithTags", "code": 201 } } }, "com.amazonaws.cloudfront#CreateDistributionWithTagsRequest": { "type": "structure", "members": { "DistributionConfigWithTags": { "target": "com.amazonaws.cloudfront#DistributionConfigWithTags", "traits": { "smithy.api#documentation": "The distribution's configuration information.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "DistributionConfigWithTags" } } }, "traits": { "smithy.api#documentation": "The request to create a new distribution with tags.
" } }, "com.amazonaws.cloudfront#CreateDistributionWithTagsResult": { "type": "structure", "members": { "Distribution": { "target": "com.amazonaws.cloudfront#Distribution", "traits": { "smithy.api#documentation": "The distribution's information.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The fully qualified URI of the new distribution resource just created.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the distribution created.
", "smithy.api#httpHeader": "ETag" } } }, "traits": { "smithy.api#documentation": "The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#CreateFieldLevelEncryptionConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateFieldLevelEncryptionConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateFieldLevelEncryptionConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfigAlreadyExists" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionProfile" }, { "target": "com.amazonaws.cloudfront#QueryArgProfileEmpty" }, { "target": "com.amazonaws.cloudfront#TooManyFieldLevelEncryptionConfigs" }, { "target": "com.amazonaws.cloudfront#TooManyFieldLevelEncryptionContentTypeProfiles" }, { "target": "com.amazonaws.cloudfront#TooManyFieldLevelEncryptionQueryArgProfiles" } ], "traits": { "smithy.api#documentation": "Create a new field-level encryption configuration.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/field-level-encryption", "code": 201 } } }, "com.amazonaws.cloudfront#CreateFieldLevelEncryptionConfigRequest": { "type": "structure", "members": { "FieldLevelEncryptionConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfig", "traits": { "smithy.api#documentation": "The request to create a new field-level encryption configuration.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "FieldLevelEncryptionConfig" } } } }, "com.amazonaws.cloudfront#CreateFieldLevelEncryptionConfigResult": { "type": "structure", "members": { "FieldLevelEncryption": { "target": "com.amazonaws.cloudfront#FieldLevelEncryption", "traits": { "smithy.api#documentation": "Returned when you create a new field-level encryption configuration.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The fully qualified URI of the new configuration resource just created.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL
.
Create a field-level encryption profile.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/field-level-encryption-profile", "code": 201 } } }, "com.amazonaws.cloudfront#CreateFieldLevelEncryptionProfileRequest": { "type": "structure", "members": { "FieldLevelEncryptionProfileConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileConfig", "traits": { "smithy.api#documentation": "The request to create a field-level encryption profile.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "FieldLevelEncryptionProfileConfig" } } } }, "com.amazonaws.cloudfront#CreateFieldLevelEncryptionProfileResult": { "type": "structure", "members": { "FieldLevelEncryptionProfile": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfile", "traits": { "smithy.api#documentation": "Returned when you create a new field-level encryption profile.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The fully qualified URI of the new profile resource just created.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL
.
Creates a CloudFront function.
\n\t\tTo create a function, you provide the function code and some configuration information\n\t\t\tabout the function. The response contains an Amazon Resource Name (ARN) that uniquely\n\t\t\tidentifies the function.
\n\t\tWhen you create a function, it’s in the DEVELOPMENT
stage. In this stage, you\n\t\t\tcan test the function with TestFunction
, and update it with\n\t\t\tUpdateFunction
.
When you’re ready to use your function with a CloudFront distribution, use\n\t\t\tPublishFunction
to copy the function from the DEVELOPMENT
\n\t\t\tstage to LIVE
. When it’s live, you can attach the function to a\n\t\t\tdistribution’s cache behavior, using the function’s ARN.
A name to identify the function.
", "smithy.api#required": {} } }, "FunctionConfig": { "target": "com.amazonaws.cloudfront#FunctionConfig", "traits": { "smithy.api#documentation": "Configuration information about the function, including an optional comment and the\n\t\t\tfunction’s runtime.
", "smithy.api#required": {} } }, "FunctionCode": { "target": "com.amazonaws.cloudfront#FunctionBlob", "traits": { "smithy.api#documentation": "The function code. For more information about writing a CloudFront function, see Writing function\n\t\t\tcode for CloudFront Functions in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#CreateFunctionResult": { "type": "structure", "members": { "FunctionSummary": { "target": "com.amazonaws.cloudfront#FunctionSummary", "traits": { "smithy.api#documentation": "Contains configuration information and metadata about a CloudFront function.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The URL of the CloudFront function. Use the URL to manage the function with the CloudFront\n\t\t\tAPI.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The version identifier for the current version of the CloudFront function.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#CreateInvalidation": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateInvalidationRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateInvalidationResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#BatchTooLarge" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#MissingBody" }, { "target": "com.amazonaws.cloudfront#NoSuchDistribution" }, { "target": "com.amazonaws.cloudfront#TooManyInvalidationsInProgress" } ], "traits": { "smithy.api#documentation": "Create a new invalidation.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distribution/{DistributionId}/invalidation", "code": 201 } } }, "com.amazonaws.cloudfront#CreateInvalidationRequest": { "type": "structure", "members": { "DistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The distribution's id.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "InvalidationBatch": { "target": "com.amazonaws.cloudfront#InvalidationBatch", "traits": { "smithy.api#documentation": "The batch information for the invalidation.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "InvalidationBatch" } } }, "traits": { "smithy.api#documentation": "The request to create an invalidation.
" } }, "com.amazonaws.cloudfront#CreateInvalidationResult": { "type": "structure", "members": { "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The fully qualified URI of the distribution and invalidation batch request, including \n\t\t\tthe Invalidation ID
.
The invalidation's information.
", "smithy.api#httpPayload": {} } } }, "traits": { "smithy.api#documentation": "The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#CreateKeyGroup": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateKeyGroupRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateKeyGroupResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#KeyGroupAlreadyExists" }, { "target": "com.amazonaws.cloudfront#TooManyKeyGroups" }, { "target": "com.amazonaws.cloudfront#TooManyPublicKeysInKeyGroup" } ], "traits": { "smithy.api#documentation": "Creates a key group that you can use with CloudFront signed URLs and signed cookies.
\n\t\tTo create a key group, you must specify at least one public key for the key group. After you\n\t\t\tcreate a key group, you can reference it from one or more cache behaviors. When you\n\t\t\treference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies\n\t\t\tfor all requests that match the cache behavior. The URLs or cookies must be signed with\n\t\t\ta private key whose corresponding public key is in the key group. The signed URL or\n\t\t\tcookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/key-group", "code": 201 } } }, "com.amazonaws.cloudfront#CreateKeyGroupRequest": { "type": "structure", "members": { "KeyGroupConfig": { "target": "com.amazonaws.cloudfront#KeyGroupConfig", "traits": { "smithy.api#documentation": "A key group configuration.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "KeyGroupConfig" } } } }, "com.amazonaws.cloudfront#CreateKeyGroupResult": { "type": "structure", "members": { "KeyGroup": { "target": "com.amazonaws.cloudfront#KeyGroup", "traits": { "smithy.api#documentation": "The key group that was just created.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The URL of the key group.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for this version of the key group.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#CreateMonitoringSubscription": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateMonitoringSubscriptionRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateMonitoringSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchDistribution" }, { "target": "com.amazonaws.cloudfront#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Enables additional CloudWatch metrics for the specified CloudFront distribution. The\n\t\t\tadditional metrics incur an additional cost.
\n\t\tFor more information, see Viewing additional CloudFront distribution metrics in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", "code": 200 } } }, "com.amazonaws.cloudfront#CreateMonitoringSubscriptionRequest": { "type": "structure", "members": { "DistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID of the distribution that you are enabling metrics for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MonitoringSubscription": { "target": "com.amazonaws.cloudfront#MonitoringSubscription", "traits": { "smithy.api#documentation": "A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "MonitoringSubscription" } } } }, "com.amazonaws.cloudfront#CreateMonitoringSubscriptionResult": { "type": "structure", "members": { "MonitoringSubscription": { "target": "com.amazonaws.cloudfront#MonitoringSubscription", "traits": { "smithy.api#documentation": "A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#CreateOriginRequestPolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateOriginRequestPolicyRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateOriginRequestPolicyResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#OriginRequestPolicyAlreadyExists" }, { "target": "com.amazonaws.cloudfront#TooManyCookiesInOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#TooManyHeadersInOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#TooManyOriginRequestPolicies" }, { "target": "com.amazonaws.cloudfront#TooManyQueryStringsInOriginRequestPolicy" } ], "traits": { "smithy.api#documentation": "Creates an origin request policy.
\n\t\tAfter you create an origin request policy, you can attach it to one or more cache behaviors.\n\t\t\tWhen it’s attached to a cache behavior, the origin request policy determines the values\n\t\t\tthat CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends\n\t\t\tto the origin includes the following:
\n\t\tThe request body and the URL path (without the domain name) from the viewer\n\t\t\t\t\trequest.
\n\t\t\tThe headers that CloudFront automatically includes in every origin request, including\n\t\t\t\t\tHost
, User-Agent
, and X-Amz-Cf-Id
.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or\n\t\t\t\t\tthe origin request policy. These can include items from the viewer request and,\n\t\t\t\t\tin the case of headers, additional ones that are added by CloudFront.
\n\t\t\tCloudFront sends a request when it can’t find a valid object in its cache that matches the\n\t\t\trequest. If you want to send values to the origin and also include them in the cache\n\t\t\tkey, use CachePolicy
.
For more information about origin request policies, see Controlling origin requests in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/origin-request-policy", "code": 201 } } }, "com.amazonaws.cloudfront#CreateOriginRequestPolicyRequest": { "type": "structure", "members": { "OriginRequestPolicyConfig": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyConfig", "traits": { "smithy.api#documentation": "An origin request policy configuration.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "OriginRequestPolicyConfig" } } } }, "com.amazonaws.cloudfront#CreateOriginRequestPolicyResult": { "type": "structure", "members": { "OriginRequestPolicy": { "target": "com.amazonaws.cloudfront#OriginRequestPolicy", "traits": { "smithy.api#documentation": "An origin request policy.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The fully qualified URI of the origin request policy just created.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the origin request policy.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#CreatePublicKey": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreatePublicKeyRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreatePublicKeyResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#PublicKeyAlreadyExists" }, { "target": "com.amazonaws.cloudfront#TooManyPublicKeys" } ], "traits": { "smithy.api#documentation": "Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/public-key", "code": 201 } } }, "com.amazonaws.cloudfront#CreatePublicKeyRequest": { "type": "structure", "members": { "PublicKeyConfig": { "target": "com.amazonaws.cloudfront#PublicKeyConfig", "traits": { "smithy.api#documentation": "A CloudFront public key configuration.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "PublicKeyConfig" } } } }, "com.amazonaws.cloudfront#CreatePublicKeyResult": { "type": "structure", "members": { "PublicKey": { "target": "com.amazonaws.cloudfront#PublicKey", "traits": { "smithy.api#documentation": "The public key.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The URL of the public key.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for this version of the public key.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#CreateRealtimeLogConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateRealtimeLogConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateRealtimeLogConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#RealtimeLogConfigAlreadyExists" }, { "target": "com.amazonaws.cloudfront#TooManyRealtimeLogConfigs" } ], "traits": { "smithy.api#documentation": "Creates a real-time log configuration.
\n\t\tAfter you create a real-time log configuration, you can attach it to one or more cache\n\t\t\tbehaviors to send real-time log data to the specified Amazon Kinesis data stream.
\n\t\tFor more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/realtime-log-config", "code": 201 } } }, "com.amazonaws.cloudfront#CreateRealtimeLogConfigRequest": { "type": "structure", "members": { "EndPoints": { "target": "com.amazonaws.cloudfront#EndPointList", "traits": { "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data.
", "smithy.api#required": {} } }, "Fields": { "target": "com.amazonaws.cloudfront#FieldList", "traits": { "smithy.api#documentation": "A list of fields to include in each real-time log record.
\n\t\tFor more information about fields, see Real-time log configuration fields in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A unique name to identify this real-time log configuration.
", "smithy.api#required": {} } }, "SamplingRate": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#documentation": "The sampling rate for this real-time log configuration. The sampling rate determines the\n\t\t\tpercentage of viewer requests that are represented in the real-time log data. You must\n\t\t\tprovide an integer between 1 and 100, inclusive.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#CreateRealtimeLogConfigResult": { "type": "structure", "members": { "RealtimeLogConfig": { "target": "com.amazonaws.cloudfront#RealtimeLogConfig", "traits": { "smithy.api#documentation": "A real-time log configuration.
" } } } }, "com.amazonaws.cloudfront#CreateStreamingDistribution": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateStreamingDistributionRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateStreamingDistributionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidOrigin" }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, { "target": "com.amazonaws.cloudfront#MissingBody" }, { "target": "com.amazonaws.cloudfront#StreamingDistributionAlreadyExists" }, { "target": "com.amazonaws.cloudfront#TooManyStreamingDistributionCNAMEs" }, { "target": "com.amazonaws.cloudfront#TooManyStreamingDistributions" }, { "target": "com.amazonaws.cloudfront#TooManyTrustedSigners" }, { "target": "com.amazonaws.cloudfront#TrustedSignerDoesNotExist" } ], "traits": { "smithy.api#documentation": "This API is deprecated.\n Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020.\n For more information, read the announcement on the Amazon CloudFront discussion forum.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/streaming-distribution", "code": 201 } } }, "com.amazonaws.cloudfront#CreateStreamingDistributionRequest": { "type": "structure", "members": { "StreamingDistributionConfig": { "target": "com.amazonaws.cloudfront#StreamingDistributionConfig", "traits": { "smithy.api#documentation": "The streaming distribution's configuration information.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "StreamingDistributionConfig" } } }, "traits": { "smithy.api#documentation": "The request to create a new streaming distribution.
" } }, "com.amazonaws.cloudfront#CreateStreamingDistributionResult": { "type": "structure", "members": { "StreamingDistribution": { "target": "com.amazonaws.cloudfront#StreamingDistribution", "traits": { "smithy.api#documentation": "The streaming distribution's information.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The fully qualified URI of the new streaming distribution resource just created.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the streaming distribution created.
", "smithy.api#httpHeader": "ETag" } } }, "traits": { "smithy.api#documentation": "The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#CreateStreamingDistributionWithTags": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#CreateStreamingDistributionWithTagsRequest" }, "output": { "target": "com.amazonaws.cloudfront#CreateStreamingDistributionWithTagsResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidOrigin" }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, { "target": "com.amazonaws.cloudfront#InvalidTagging" }, { "target": "com.amazonaws.cloudfront#MissingBody" }, { "target": "com.amazonaws.cloudfront#StreamingDistributionAlreadyExists" }, { "target": "com.amazonaws.cloudfront#TooManyStreamingDistributionCNAMEs" }, { "target": "com.amazonaws.cloudfront#TooManyStreamingDistributions" }, { "target": "com.amazonaws.cloudfront#TooManyTrustedSigners" }, { "target": "com.amazonaws.cloudfront#TrustedSignerDoesNotExist" } ], "traits": { "smithy.api#documentation": "This API is deprecated.\n Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020.\n For more information, read the announcement on the Amazon CloudFront discussion forum.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/streaming-distribution?WithTags", "code": 201 } } }, "com.amazonaws.cloudfront#CreateStreamingDistributionWithTagsRequest": { "type": "structure", "members": { "StreamingDistributionConfigWithTags": { "target": "com.amazonaws.cloudfront#StreamingDistributionConfigWithTags", "traits": { "smithy.api#documentation": "The streaming distribution's configuration information.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "StreamingDistributionConfigWithTags" } } }, "traits": { "smithy.api#documentation": "The request to create a new streaming distribution with tags.
" } }, "com.amazonaws.cloudfront#CreateStreamingDistributionWithTagsResult": { "type": "structure", "members": { "StreamingDistribution": { "target": "com.amazonaws.cloudfront#StreamingDistribution", "traits": { "smithy.api#documentation": "The streaming distribution's information.
", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The fully qualified URI of the new streaming distribution resource just created.
", "smithy.api#httpHeader": "Location" } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the distribution created.
", "smithy.api#httpHeader": "ETag" } } }, "traits": { "smithy.api#documentation": "The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#CustomErrorResponse": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The HTTP status code for which you want to specify a custom error page and/or a caching \n\t\t\tduration.
", "smithy.api#required": {} } }, "ResponsePagePath": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The path to the custom error page that you want CloudFront to return to a viewer when your \n\t\t\torigin returns the HTTP status code specified by ErrorCode
, for example, \n\t\t\t\t/4xx-errors/403-forbidden.html
. If you want to store your objects and your \n\t\t\tcustom error pages in different locations, your distribution must include a cache behavior for \n\t\t\twhich the following is true:
The value of PathPattern
matches the path to your custom error \n\t\t\t\t\tmessages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 \n\t\t\t\t\tbucket in a directory named /4xx-errors
. Your distribution must include a \n\t\t\t\t\tcache behavior for which the path pattern routes requests for your custom error pages to \n\t\t\t\t\tthat location, for example, /4xx-errors/*
.
The value of TargetOriginId
specifies the value of the ID
\n\t\t\t\t\telement for the origin that contains your custom error pages.
If you specify a value for ResponsePagePath
, you must also specify a value\n\t\t\tfor ResponseCode
.
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom \n\t\t\terror pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the \n\t\t\tfiles that you want to return to viewers because the origin server is unavailable.
" } }, "ResponseCode": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The HTTP status code that you want CloudFront to return to the viewer along with the custom \n\t\t\terror page. There are a variety of reasons that you might want CloudFront to return a status code \n\t\t\tdifferent from the status code that your origin returned to CloudFront, for example:
\n\t\tSome Internet devices (some firewalls and corporate proxies, for example) intercept \n\t\t\t\t\tHTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you \n\t\t\t\t\tsubstitute 200
, the response typically won't be intercepted.
If you don't care about distinguishing among different client errors or server \n\t\t\t\t\terrors, you can specify 400
or 500
as the \n\t\t\t\t\t\tResponseCode
for all 4xx or 5xx errors.
You might want to return a 200
status code (OK) and static website so \n\t\t\t\t\tyour customers don't know that your website is down.
If you specify a value for ResponseCode
, you must also specify a value for\n\t\t\tResponsePagePath
.
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status \n\t\t\tcode specified in ErrorCode
. When this time period has elapsed, CloudFront queries your \n\t\t\torigin to see whether the problem that caused the error has been resolved and the requested \n\t\t\tobject is now available.
For more information, see Customizing \n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.
" } } }, "traits": { "smithy.api#documentation": "A complex type that controls:
\n\t\tWhether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error \n\t\t\t\t\tmessages before returning the response to the viewer.
\n\t\t\tHow long CloudFront caches HTTP status codes in the 4xx and 5xx range.
\n\t\t\tFor more information about custom error pages, see Customizing Error Responses in the \n\t\t\t\tAmazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#CustomErrorResponseList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#CustomErrorResponse", "traits": { "smithy.api#xmlName": "CustomErrorResponse" } } }, "com.amazonaws.cloudfront#CustomErrorResponses": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of HTTP status codes for which you want to specify a custom error page \n\t\t\tand/or a caching duration. If Quantity
is 0
, you can omit \n\t\t\t\tItems
.
A complex type that contains a CustomErrorResponse
element for each HTTP \n\t\t\tstatus code for which you want to specify a custom error page and/or a caching duration. \n\t\t
A complex type that controls:
\n\t\tWhether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error \n\t\t\t\t\tmessages before returning the response to the viewer.
\n\t\t\tHow long CloudFront caches HTTP status codes in the 4xx and 5xx range.
\n\t\t\tFor more information about custom error pages, see Customizing Error Responses in the \n\t\t\t\tAmazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#CustomHeaders": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of custom headers, if any, for this distribution.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#OriginCustomHeadersList", "traits": { "smithy.api#documentation": "\n Optional: A list that contains one \n\t\t\t\tOriginCustomHeader
element for each custom header that you want CloudFront to forward \n\t\t\tto the origin. If Quantity is 0
, omit Items
.
A complex type that contains the list of Custom Headers for each origin.
" } }, "com.amazonaws.cloudfront#CustomOriginConfig": { "type": "structure", "members": { "HTTPPort": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin\n\t\t\tlistens on.
", "smithy.api#required": {} } }, "HTTPSPort": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the\n\t\t\torigin listens on.
", "smithy.api#required": {} } }, "OriginProtocolPolicy": { "target": "com.amazonaws.cloudfront#OriginProtocolPolicy", "traits": { "smithy.api#documentation": "Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values\n\t\t\tare:
\n\t\t\n http-only
– CloudFront always uses HTTP to connect to the\n\t\t\t\t\torigin.
\n match-viewer
– CloudFront connects to the origin using the same\n\t\t\t\t\tprotocol that the viewer used to connect to CloudFront.
\n https-only
– CloudFront always uses HTTPS to connect to the\n\t\t\t\t\torigin.
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over\n\t\t\tHTTPS. Valid values include SSLv3
, TLSv1
,\n\t\t\tTLSv1.1
, and TLSv1.2
.
For more information, see Minimum Origin SSL Protocol in the\n\t\t\tAmazon CloudFront Developer Guide.
" } }, "OriginReadTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also\n\t\t\tknown as the origin response timeout. The minimum timeout is 1\n\t\t\tsecond, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is\n\t\t\t30 seconds.
\n\t\tFor more information, see Origin Response Timeout in the\n\t\t\tAmazon CloudFront Developer Guide.
" } }, "OriginKeepaliveTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum\n\t\t\ttimeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify\n\t\t\totherwise) is 5 seconds.
\n\t\tFor more information, see Origin Keep-alive Timeout in the\n\t\t\tAmazon CloudFront Developer Guide.
" } } }, "traits": { "smithy.api#documentation": "A custom origin. A custom origin is any origin that is not an Amazon S3\n\t\t\tbucket, with one exception. An Amazon S3 bucket that is configured with\n\t\t\tstatic website hosting \n is a custom origin.
" } }, "com.amazonaws.cloudfront#DefaultCacheBehavior": { "type": "structure", "members": { "TargetOriginId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of ID
for the origin that you want CloudFront to route requests to when\n\t\t\tthey use the default cache behavior.
We recommend using TrustedKeyGroups
instead of\n\t\t\t\tTrustedSigners
.
A list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed\n\t\t\tcookies.
\n\t\tWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies\n\t\t\tfor all requests that match the cache behavior. The URLs or cookies must be signed with\n\t\t\tthe private key of a CloudFront key pair in a trusted signer’s AWS account. The signed URL or\n\t\t\tcookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" } }, "TrustedKeyGroups": { "target": "com.amazonaws.cloudfront#TrustedKeyGroups", "traits": { "smithy.api#documentation": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
\n\t\tWhen a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with a private key whose corresponding public key is in the key group. The signed\n\t\t\tURL or cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" } }, "ViewerProtocolPolicy": { "target": "com.amazonaws.cloudfront#ViewerProtocolPolicy", "traits": { "smithy.api#documentation": "The protocol that viewers can use to access the files in the origin specified by \n\t\t\t\tTargetOriginId
when a request matches the path pattern in \n\t\t\t\tPathPattern
. You can specify the following options:
\n allow-all
: Viewers can use HTTP or HTTPS.
\n redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns \n\t\t\t\t\tan HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The \n\t\t\t\t\tviewer then resubmits the request using the new URL.
\n https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP \n\t\t\t\t\tstatus code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.
\n\t\tThe only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects’ cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\tManaging Cache\n\t\t\t\tExpiration in the \n\t\t\t\t\tAmazon CloudFront Developer Guide.
\n\t\tIndicates whether you want to distribute media files in the Microsoft Smooth Streaming \n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify \n\t\t\t\ttrue
; if not, specify false
. If you specify true
for \n\t\t\t\tSmoothStreaming
, you can still distribute other content using this cache \n\t\t\tbehavior if the content matches the value of PathPattern
.
Whether you want CloudFront to automatically compress certain files for this cache behavior. \n\t\t\tIf so, specify true
; if not, specify false
. For more information, \n\t\t\tsee Serving Compressed Files in \n\t\t\tthe Amazon CloudFront Developer Guide.
A complex type that contains zero or more Lambda function associations for a cache \n\t\t\tbehavior.
" } }, "FunctionAssociations": { "target": "com.amazonaws.cloudfront#FunctionAssociations", "traits": { "smithy.api#documentation": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must\n\t\t\tbe published to the LIVE
stage to associate them with a cache\n\t\t\tbehavior.
The value of ID
for the field-level encryption configuration that you want CloudFront\n\t\t\tto use for encrypting specific fields of data for the default cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this\n\t\t\tcache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
" } }, "CachePolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The unique identifier of the cache policy that is attached to the default cache behavior.\n\t\t\tFor more information, see Creating cache policies or Using the managed cache policies in the\n Amazon CloudFront Developer Guide.
\nA DefaultCacheBehavior
must include either a\n CachePolicyId
or ForwardedValues
. We recommend that you\n use a CachePolicyId
.
The unique identifier of the origin request policy that is attached to the default cache\n\t\t\tbehavior. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
" } }, "ForwardedValues": { "target": "com.amazonaws.cloudfront#ForwardedValues", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin request\n\t\t\tpolicy instead of this field. For more information, see Working with policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tIf you want to include values in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tIf you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the\n Amazon CloudFront Developer Guide.
\nA DefaultCacheBehavior
must include either a\n CachePolicyId
or ForwardedValues
. We recommend that you\n use a CachePolicyId
.
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
" } }, "MinTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "This field is deprecated. We recommend that you use the MinTTL
field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. For \n\t\t\tmore information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
\n\t\tYou must specify 0
for MinTTL
if you configure CloudFront to \n\t\t\tforward all headers to your origin (under Headers
, if you specify 1
\n\t\t\tfor Quantity
and *
for Name
).
This field is deprecated. We recommend that you use the DefaultTTL
field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.
The default amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin does not add HTTP headers such as \n\t\t\t\tCache-Control max-age
, Cache-Control s-maxage
, and \n\t\t\t\tExpires
to objects. For more information, see Managing How Long Content Stays \n\t\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
This field is deprecated. We recommend that you use the MaxTTL
field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.
The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin adds HTTP headers such as \n\t\t\tCache-Control max-age
, Cache-Control s-maxage
, and \n\t\t\tExpires
to objects. For more information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
A complex type that describes the default cache behavior if you don’t specify a\n\t\t\tCacheBehavior
element or if request URLs don’t match any of the values of\n\t\t\tPathPattern
in CacheBehavior
elements. You must create exactly\n\t\t\tone default cache behavior.
Deletes a cache policy.
\n\t\tYou cannot delete a cache policy if it’s attached to a cache behavior. First update your\n\t\t\tdistributions to remove the cache policy from all cache behaviors, then delete the cache\n\t\t\tpolicy.
\n\t\tTo delete a cache policy, you must provide the policy’s identifier and version. To get these\n\t\t\tvalues, you can use ListCachePolicies
or\n\t\t\tGetCachePolicy
.
The unique identifier for the cache policy that you are deleting. To get the\n\t\t\tidentifier, you can use ListCachePolicies
.
The version of the cache policy that you are deleting. The version is the cache\n\t\t\tpolicy’s ETag
value, which you can get using\n\t\t\tListCachePolicies
, GetCachePolicy
, or\n\t\t\tGetCachePolicyConfig
.
Delete an origin access identity.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}", "code": 204 } } }, "com.amazonaws.cloudfront#DeleteCloudFrontOriginAccessIdentityRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The origin access identity's ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header you received from a previous GET
\n\t\t\tor PUT
request. For example: E2QWRUHAPOMQZL
.
Deletes a origin access identity.
" } }, "com.amazonaws.cloudfront#DeleteDistribution": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#DeleteDistributionRequest" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#DistributionNotDisabled" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#NoSuchDistribution" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" } ], "traits": { "smithy.api#documentation": "Delete a distribution.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/distribution/{Id}", "code": 204 } } }, "com.amazonaws.cloudfront#DeleteDistributionRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The distribution ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when you disabled the \n\t\t\tdistribution. For example: E2QWRUHAPOMQZL
.
This action deletes a web distribution. To delete a web distribution using the CloudFront \n\t\t\tAPI, perform the following steps.
\n\t\t\n\t\t\t To delete a web distribution using the CloudFront API: \n\t\t
\n\t\tDisable the web distribution
\n\t\t\tSubmit a GET Distribution Config
request to get the current \n\t\t\t\t\tconfiguration and the Etag
header for the distribution.
Update the XML document that was returned in the response to your GET \n\t\t\t\t\t\tDistribution Config
request to change the value of Enabled
to \n\t\t\t\t\t\tfalse
.
Submit a PUT Distribution Config
request to update the configuration \n\t\t\t\t\tfor your distribution. In the request body, include the XML document that you updated in \n\t\t\t\t\tStep 3. Set the value of the HTTP If-Match
header to the value of the \n\t\t\t\t\t\tETag
header that CloudFront returned when you submitted the GET \n\t\t\t\t\t\tDistribution Config
request in Step 2.
Review the response to the PUT Distribution Config
request to confirm \n\t\t\t\t\tthat the distribution was successfully disabled.
Submit a GET Distribution
request to confirm that your changes have \n\t\t\t\t\tpropagated. When propagation is complete, the value of Status
is \n\t\t\t\t\t\tDeployed
.
Submit a DELETE Distribution
request. Set the value of the HTTP \n\t\t\t\t\t\tIf-Match
header to the value of the ETag
header that CloudFront \n\t\t\t\t\treturned when you submitted the GET Distribution Config
request in Step \n\t\t\t\t\t6.
Review the response to your DELETE Distribution
request to confirm \n\t\t\t\t\tthat the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the \n\t\t\t\tAmazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionConfigRequest" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfigInUse" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" } ], "traits": { "smithy.api#documentation": "Remove a field-level encryption configuration.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/field-level-encryption/{Id}", "code": 204 } } }, "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionConfigRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID of the configuration you want to delete from CloudFront.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when retrieving the \n\t\t\tconfiguration identity to delete. For example: E2QWRUHAPOMQZL
.
Remove a field-level encryption profile.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/field-level-encryption-profile/{Id}", "code": 204 } } }, "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionProfileRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Request the ID of the profile you want to delete from CloudFront.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when retrieving the \n\t\t\tprofile to delete. For example: E2QWRUHAPOMQZL
.
Deletes a CloudFront function.
\n\t\tYou cannot delete a function if it’s associated with a cache behavior. First, update your\n\t\t\tdistributions to remove the function association from all cache behaviors, then delete\n\t\t\tthe function.
\n\t\tTo delete a function, you must provide the function’s name and version\n\t\t\t(ETag
value). To get these values, you can use ListFunctions
\n\t\t\tand DescribeFunction
.
The name of the function that you are deleting.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version (ETag
value) of the function that you are deleting, which\n\t\t\tyou can get using DescribeFunction
.
Deletes a key group.
\n\t\tYou cannot delete a key group that is referenced in a cache behavior. First update\n\t\t\tyour distributions to remove the key group from all cache behaviors, then delete the key\n\t\t\tgroup.
\n\t\tTo delete a key group, you must provide the key group’s identifier and version. To get\n\t\t\tthese values, use ListKeyGroups
followed by GetKeyGroup
or\n\t\t\tGetKeyGroupConfig
.
The identifier of the key group that you are deleting. To get the identifier, use\n\t\t\tListKeyGroups
.
The version of the key group that you are deleting. The version is the key group’s\n\t\t\tETag
value. To get the ETag
, use GetKeyGroup
or\n\t\t\tGetKeyGroupConfig
.
Disables additional CloudWatch metrics for the specified CloudFront distribution.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", "code": 200 } } }, "com.amazonaws.cloudfront#DeleteMonitoringSubscriptionRequest": { "type": "structure", "members": { "DistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID of the distribution that you are disabling metrics for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#DeleteMonitoringSubscriptionResult": { "type": "structure", "members": {} }, "com.amazonaws.cloudfront#DeleteOriginRequestPolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#DeleteOriginRequestPolicyRequest" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#IllegalDelete" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#OriginRequestPolicyInUse" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" } ], "traits": { "smithy.api#documentation": "Deletes an origin request policy.
\n\t\tYou cannot delete an origin request policy if it’s attached to any cache behaviors. First\n\t\t\tupdate your distributions to remove the origin request policy from all cache behaviors,\n\t\t\tthen delete the origin request policy.
\n\t\tTo delete an origin request policy, you must provide the policy’s identifier and version. To\n\t\t\tget the identifier, you can use ListOriginRequestPolicies
or\n\t\t\tGetOriginRequestPolicy
.
The unique identifier for the origin request policy that you are deleting. To get the\n\t\t\tidentifier, you can use ListOriginRequestPolicies
.
The version of the origin request policy that you are deleting. The version is the origin\n\t\t\trequest policy’s ETag
value, which you can get using\n\t\t\tListOriginRequestPolicies
, GetOriginRequestPolicy
, or\n\t\t\tGetOriginRequestPolicyConfig
.
Remove a public key you previously added to CloudFront.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/public-key/{Id}", "code": 204 } } }, "com.amazonaws.cloudfront#DeletePublicKeyRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID of the public key you want to remove from CloudFront.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when retrieving the \n\t\t\tpublic key identity to delete. For example: E2QWRUHAPOMQZL
.
Deletes a real-time log configuration.
\n\t\tYou cannot delete a real-time log configuration if it’s attached to a cache behavior.\n\t\t\tFirst update your distributions to remove the real-time log configuration from all cache\n\t\t\tbehaviors, then delete the real-time log configuration.
\n\t\tTo delete a real-time log configuration, you can provide the configuration’s name or its\n\t\t\tAmazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront\n\t\t\tuses the name to identify the real-time log configuration to delete.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/delete-realtime-log-config", "code": 204 } } }, "com.amazonaws.cloudfront#DeleteRealtimeLogConfigRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The name of the real-time log configuration to delete.
" } }, "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the real-time log configuration to delete.
" } } } }, "com.amazonaws.cloudfront#DeleteStreamingDistribution": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#DeleteStreamingDistributionRequest" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#NoSuchStreamingDistribution" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" }, { "target": "com.amazonaws.cloudfront#StreamingDistributionNotDisabled" } ], "traits": { "smithy.api#documentation": "Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, \n\t\t\tperform the following steps.
\n \n\t\t\n To delete an RTMP distribution using the CloudFront \n\t\t\tAPI:
\n\t\tDisable the RTMP distribution.
\n\t\t\tSubmit a GET Streaming Distribution Config
request to get the current \n\t\t\t\t\tconfiguration and the Etag
header for the distribution.
Update the XML document that was returned in the response to your GET \n\t\t\t\t\t\tStreaming Distribution Config
request to change the value of Enabled
\n\t\t\t\t\tto false
.
Submit a PUT Streaming Distribution Config
request to update the \n\t\t\t\t\tconfiguration for your distribution. In the request body, include the XML document that \n\t\t\t\t\tyou updated in Step 3. Then set the value of the HTTP If-Match
header to the \n\t\t\t\t\tvalue of the ETag
header that CloudFront returned when you submitted the GET \n\t\t\t\t\t\tStreaming Distribution Config
request in Step 2.
Review the response to the PUT Streaming Distribution Config
request \n\t\t\t\t\tto confirm that the distribution was successfully disabled.
Submit a GET Streaming Distribution Config
request to confirm that \n\t\t\t\t\tyour changes have propagated. When propagation is complete, the value of \n\t\t\t\t\t\tStatus
is Deployed
.
Submit a DELETE Streaming Distribution
request. Set the value of the \n\t\t\t\t\tHTTP If-Match
header to the value of the ETag
header that CloudFront \n\t\t\t\t\treturned when you submitted the GET Streaming Distribution Config
request in \n\t\t\t\t\tStep 2.
Review the response to your DELETE Streaming Distribution
request to \n\t\t\t\t\tconfirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the \n\t\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/streaming-distribution/{Id}", "code": 204 } } }, "com.amazonaws.cloudfront#DeleteStreamingDistributionRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The distribution ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when you disabled the \n\t\t\tstreaming distribution. For example: E2QWRUHAPOMQZL
.
The request to delete a streaming distribution.
" } }, "com.amazonaws.cloudfront#DescribeFunction": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#DescribeFunctionRequest" }, "output": { "target": "com.amazonaws.cloudfront#DescribeFunctionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#NoSuchFunctionExists" } ], "traits": { "smithy.api#documentation": "Gets configuration information and metadata about a CloudFront function, but not the function’s\n\t\t\tcode. To get a function’s code, use GetFunction
.
To get configuration information and metadata about a function, you must provide the\n\t\t\tfunction’s name and stage. To get these values, you can use\n\t\t\tListFunctions
.
The name of the function that you are getting information about.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Stage": { "target": "com.amazonaws.cloudfront#FunctionStage", "traits": { "smithy.api#documentation": "The function’s stage, either DEVELOPMENT
or LIVE
.
Contains configuration information and metadata about a CloudFront function.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The version identifier for the current version of the CloudFront function.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#Distribution": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for the distribution. For example: EDFDVBD632BHDS5
. \n\t\t
The ARN (Amazon Resource Name) for the distribution. For example: \n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5
, where \n\t\t\t\t123456789012
is your AWS account ID.
This response element indicates the current status of the distribution. When the status \n\t\t\tis Deployed
, the distribution's information is fully propagated to all CloudFront edge \n\t\t\tlocations.
The date and time the distribution was last modified.
", "smithy.api#required": {} } }, "InProgressInvalidationBatches": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of invalidation batches currently in progress.
", "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net
.
We recommend using TrustedKeyGroups
instead of\n\t\t\t\tTrustedSigners
.
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in\n\t\t\tthis distribution to serve private content using trusted signers. This field contains a\n\t\t\tlist of AWS account IDs and the active CloudFront key pairs in each account that CloudFront can use\n\t\t\tto verify the signatures of signed URLs or signed cookies.
" } }, "ActiveTrustedKeyGroups": { "target": "com.amazonaws.cloudfront#ActiveTrustedKeyGroups", "traits": { "smithy.api#documentation": "CloudFront automatically adds this field to the response if you’ve configured a cache\n\t\t\tbehavior in this distribution to serve private content using key groups. This field\n\t\t\tcontains a list of key groups and the public keys in each key group that CloudFront can use to\n\t\t\tverify the signatures of signed URLs or signed cookies.
" } }, "DistributionConfig": { "target": "com.amazonaws.cloudfront#DistributionConfig", "traits": { "smithy.api#documentation": "The current configuration information for the distribution. Send a GET
\n\t\t\trequest to the /CloudFront API version/distribution ID/config
\n\t\t\tresource.
AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content \n\t\t\tpublicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP \n\t\t\trecordal status for CNAMEs associated with distributions.
\n\t\tFor more information about ICP recordals, see \n\t\t\tSignup, Accounts, and Credentials in Getting Started with AWS services in China.
" } } }, "traits": { "smithy.api#documentation": "A distribution tells CloudFront where you want content to be delivered from, and the details about how to \n\t\t\ttrack and manage content delivery.
" } }, "com.amazonaws.cloudfront#DistributionAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The caller reference you attempted to create the distribution with is associated with another distribution.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#DistributionConfig": { "type": "structure", "members": { "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A unique value (for example, a date-time stamp) that ensures that the request can't be \n\t\t\treplayed.
\n\t\tIf the value of CallerReference
is new (regardless of the content of the \n\t\t\t\tDistributionConfig
object), CloudFront creates a new distribution.
If CallerReference
is a value that you already sent in a previous request to \n\t\t\tcreate a distribution, CloudFront returns a DistributionAlreadyExists
error.
A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this distribution.
" } }, "DefaultRootObject": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The object that you want CloudFront to request from your origin (for example, \n\t\t\t\tindex.html
) when a viewer requests the root URL for your distribution \n\t\t\t\t(http://www.example.com
) instead of an object in your distribution \n\t\t\t\t(http://www.example.com/product-description.html
). Specifying a default root \n\t\t\tobject avoids exposing the contents of your distribution.
Specify only the object name, for example, index.html
. Don't add a \n\t\t\t\t/
before the object name.
If you don't want to specify a default root object when you create a distribution, \n\t\t\tinclude an empty DefaultRootObject
element.
To delete the default root object from an existing distribution, update the \n\t\t\tdistribution configuration and include an empty DefaultRootObject
\n\t\t\telement.
To replace the default root object, update the distribution configuration and specify \n\t\t\tthe new object.
\n\t\tFor more information about the default root object, see Creating a Default Root Object in the \n\t\t\t\tAmazon CloudFront Developer Guide.
" } }, "Origins": { "target": "com.amazonaws.cloudfront#Origins", "traits": { "smithy.api#documentation": "A complex type that contains information about origins for this distribution. \n\t\t
", "smithy.api#required": {} } }, "OriginGroups": { "target": "com.amazonaws.cloudfront#OriginGroups", "traits": { "smithy.api#documentation": "A complex type that contains information about origin groups for this \n\t\t\tdistribution.
" } }, "DefaultCacheBehavior": { "target": "com.amazonaws.cloudfront#DefaultCacheBehavior", "traits": { "smithy.api#documentation": "A complex type that describes the default cache behavior if you don't specify a \n\t\t\t\tCacheBehavior
element or if files don't match any of the values of \n\t\t\t\tPathPattern
in CacheBehavior
elements. You must create exactly one \n\t\t\tdefault cache behavior.
A complex type that contains zero or more CacheBehavior
elements. \n\t\t
A complex type that controls the following:
\n\t\tWhether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error \n\t\t\t\t\tmessages before returning the response to the viewer.
\n\t\t\tHow long CloudFront caches HTTP status codes in the 4xx and 5xx range.
\n\t\t\tFor more information about custom error pages, see Customizing Error Responses in the \n\t\t\t\tAmazon CloudFront Developer Guide.
" } }, "Comment": { "target": "com.amazonaws.cloudfront#CommentType", "traits": { "smithy.api#documentation": "An optional comment to describe the distribution. The comment cannot be longer than 128\n\t\t\tcharacters.
", "smithy.api#required": {} } }, "Logging": { "target": "com.amazonaws.cloudfront#LoggingConfig", "traits": { "smithy.api#documentation": "A complex type that controls whether access logs are written for the \n\t\t\tdistribution.
\n\t\tFor more information about logging, see Access \n\t\t\t\tLogs in the Amazon CloudFront Developer Guide.
" } }, "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { "smithy.api#documentation": "The price class that corresponds with the maximum price that you want to pay for CloudFront \n\t\t\tservice. If you specify PriceClass_All
, CloudFront responds to requests for your \n\t\t\tobjects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All
, CloudFront serves your \n\t\t\tobjects from the CloudFront edge location that has the lowest latency among the edge locations in \n\t\t\tyour price class. Viewers who are in or near regions that are excluded from your specified \n\t\t\tprice class may encounter slower performance.
For more information about price classes, see Choosing the Price Class\n\t\t\tfor a CloudFront Distribution in the Amazon CloudFront Developer Guide. For\n\t\t\tinformation about CloudFront pricing, including how price classes (such as Price Class 100)\n\t\t\tmap to CloudFront regions, see Amazon CloudFront\n\t\t\tPricing.
" } }, "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "From this field, you can enable or disable the selected distribution.
", "smithy.api#required": {} } }, "ViewerCertificate": { "target": "com.amazonaws.cloudfront#ViewerCertificate", "traits": { "smithy.api#documentation": "A complex type that determines the distribution’s SSL/TLS configuration for\n\t\t\tcommunicating with viewers.
" } }, "Restrictions": { "target": "com.amazonaws.cloudfront#Restrictions", "traits": { "smithy.api#documentation": "A complex type that identifies ways in which you want to restrict distribution of your \n\t\t\tcontent.
" } }, "WebACLId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A unique identifier that specifies the AWS WAF web ACL, if any, to associate\n\t\t\twith this distribution. To specify a web ACL created using the latest version of AWS\n\t\t\tWAF, use the ACL ARN, for example\n\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
.\n\t\t\tTo specify a web ACL created using AWS WAF Classic, use the ACL ID, for example\n\t\t\t473e64fd-f30b-4765-81a0-62ad96dd167a
.
AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS \n\t\t\trequests that are forwarded to CloudFront, and lets you control access to your content. Based on \n\t\t\tconditions that you specify, such as the IP addresses that requests originate from or the \n\t\t\tvalues of query strings, CloudFront responds to requests either with the requested content or with \n\t\t\tan HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page \n\t\t\twhen a request is blocked. For more information about AWS WAF, see the AWS WAF \n\t\t\t\tDeveloper Guide.
" } }, "HttpVersion": { "target": "com.amazonaws.cloudfront#HttpVersion", "traits": { "smithy.api#documentation": "(Optional) Specify the maximum HTTP version that you want viewers to use to communicate \n\t\t\twith CloudFront. The default value for new web distributions is http2. Viewers that don't support \n\t\t\tHTTP/2 automatically use an earlier HTTP version.
\n\t\tFor viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must \n\t\t\tsupport Server Name Identification (SNI).
\n\t\tIn general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. \n\t\t\tYou can improve performance by optimizing for HTTP/2. For more information, do an Internet \n\t\t\tsearch for \"http/2 optimization.\"
" } }, "IsIPV6Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your \n\t\t\tdistribution, specify true
. If you specify false
, CloudFront responds to \n\t\t\tIPv6 DNS requests with the DNS response code NOERROR
and with no IP addresses. \n\t\t\tThis allows viewers to submit a second request, for an IPv4 address for your distribution.
In general, you should enable IPv6 if you have users on IPv6 networks who want to \n\t\t\taccess your content. However, if you're using signed URLs or signed cookies to restrict access \n\t\t\tto your content, and if you're using a custom policy that includes the IpAddress
\n\t\t\tparameter to restrict the IP addresses that can access your content, don't enable IPv6. If \n\t\t\tyou want to restrict access to some content by IP address and not restrict access to other \n\t\t\tcontent (or restrict access but not by IP address), you can create two distributions. For more \n\t\t\tinformation, see \n\t\t\tCreating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer \n\t\t\t\tGuide.
If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront \n\t\t\tdistribution, you need to create a second alias resource record set when both of the following \n\t\t\tare true:
\n\t\tYou enable IPv6 for the distribution
\n\t\t\tYou're using alternate domain names in the URLs for your objects
\n\t\t\tFor more information, see Routing Traffic \n\t\t\t\tto an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 \n\t\t\t\tDeveloper Guide.
\n\t\tIf you created a CNAME resource record set, either with Amazon Route 53 or with another DNS \n\t\t\tservice, you don't need to make any changes. A CNAME record will route traffic to your \n\t\t\tdistribution regardless of the IP address format of the viewer request.
" } } }, "traits": { "smithy.api#documentation": "A distribution configuration.
" } }, "com.amazonaws.cloudfront#DistributionConfigWithTags": { "type": "structure", "members": { "DistributionConfig": { "target": "com.amazonaws.cloudfront#DistributionConfig", "traits": { "smithy.api#documentation": "A distribution configuration.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.cloudfront#Tags", "traits": { "smithy.api#documentation": "A complex type that contains zero or more Tag
elements.
A distribution Configuration and a list of tags to be associated with the \n\t\t\tdistribution.
" } }, "com.amazonaws.cloudfront#DistributionIdList": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value provided in the Marker
request field.
Contains the value that you should use in the Marker
field of a\n\t\t\tsubsequent request to continue listing distribution IDs where you left off.
The maximum number of distribution IDs requested.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "A flag that indicates whether more distribution IDs remain to be listed. If your\n\t\t\tresults were truncated, you can make a subsequent request using the Marker
\n\t\t\trequest field to retrieve more distribution IDs in the list.
The total number of distribution IDs returned in the response.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#DistributionIdListSummary", "traits": { "smithy.api#documentation": "Contains the distribution IDs in the list.
" } } }, "traits": { "smithy.api#documentation": "A list of distribution IDs.
" } }, "com.amazonaws.cloudfront#DistributionIdListSummary": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "DistributionId" } } }, "com.amazonaws.cloudfront#DistributionList": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value you provided for the Marker
request parameter.
If IsTruncated
is true
, this element is present and contains \n\t\t\tthe value you can use for the Marker
request parameter to continue listing your \n\t\t\tdistributions where they left off.
The value you provided for the MaxItems
request parameter.
A flag that indicates whether more distributions remain to be listed. If your results \n\t\t\twere truncated, you can make a follow-up pagination request using the Marker
\n\t\t\trequest parameter to retrieve more distributions in the list.
The number of distributions that were created by the current AWS account.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#DistributionSummaryList", "traits": { "smithy.api#documentation": "A complex type that contains one DistributionSummary
element for each \n\t\t\tdistribution that was created by the current AWS account.
A distribution list.
" } }, "com.amazonaws.cloudfront#DistributionNotDisabled": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified CloudFront distribution is not disabled. You must disable \n\t\t\tthe distribution before you can delete it.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#DistributionSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for the distribution. For example: \n\t\t\tEDFDVBD632BHDS5
.
The ARN (Amazon Resource Name) for the distribution. For example: \n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5
, where \n\t\t\t\t123456789012
is your AWS account ID.
The current status of the distribution. When the status is Deployed
, the \n\t\t\tdistribution's information is propagated to all CloudFront edge locations.
The date and time the distribution was last modified.
", "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net
.
A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this distribution.
", "smithy.api#required": {} } }, "Origins": { "target": "com.amazonaws.cloudfront#Origins", "traits": { "smithy.api#documentation": "A complex type that contains information about origins for this distribution.
", "smithy.api#required": {} } }, "OriginGroups": { "target": "com.amazonaws.cloudfront#OriginGroups", "traits": { "smithy.api#documentation": "A complex type that contains information about origin groups for this \n\t\t\tdistribution.
" } }, "DefaultCacheBehavior": { "target": "com.amazonaws.cloudfront#DefaultCacheBehavior", "traits": { "smithy.api#documentation": "A complex type that describes the default cache behavior if you don't specify a \n\t\t\t\tCacheBehavior
element or if files don't match any of the values of \n\t\t\t\tPathPattern
in CacheBehavior
elements. You must create exactly one \n\t\t\tdefault cache behavior.
A complex type that contains zero or more CacheBehavior
\n\t\t\telements.
A complex type that contains zero or more CustomErrorResponses
\n\t\t\telements.
The comment originally specified when this distribution was created.
", "smithy.api#required": {} } }, "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { "smithy.api#documentation": "A complex type that contains information about price class for this streaming \n\t\t\tdistribution.
", "smithy.api#required": {} } }, "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "Whether the distribution is enabled to accept user requests for content.
", "smithy.api#required": {} } }, "ViewerCertificate": { "target": "com.amazonaws.cloudfront#ViewerCertificate", "traits": { "smithy.api#documentation": "A complex type that determines the distribution’s SSL/TLS configuration for\n\t\t\tcommunicating with viewers.
", "smithy.api#required": {} } }, "Restrictions": { "target": "com.amazonaws.cloudfront#Restrictions", "traits": { "smithy.api#documentation": "A complex type that identifies ways in which you want to restrict distribution of your \n\t\t\tcontent.
", "smithy.api#required": {} } }, "WebACLId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The Web ACL Id (if any) associated with the distribution.
", "smithy.api#required": {} } }, "HttpVersion": { "target": "com.amazonaws.cloudfront#HttpVersion", "traits": { "smithy.api#documentation": " Specify the maximum HTTP version that you want viewers to use to communicate with \n\t\t\tCloudFront. The default value for new web distributions is http2
. Viewers that don't \n\t\t\tsupport HTTP/2
will automatically use an earlier version.
Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your \n\t\t\tdistribution.
", "smithy.api#required": {} } }, "AliasICPRecordals": { "target": "com.amazonaws.cloudfront#AliasICPRecordals", "traits": { "smithy.api#documentation": "AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content \n\t\t\tpublicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP \n\t\t\trecordal status for CNAMEs associated with distributions.
\n\t\tFor more information about ICP recordals, see \n\t\t\tSignup, Accounts, and Credentials in Getting Started with AWS services in China.
" } } }, "traits": { "smithy.api#documentation": "A summary of the information about a CloudFront distribution.
" } }, "com.amazonaws.cloudfront#DistributionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#DistributionSummary", "traits": { "smithy.api#xmlName": "DistributionSummary" } } }, "com.amazonaws.cloudfront#EncryptionEntities": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "Number of field pattern items in a field-level encryption content type-profile mapping.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#EncryptionEntityList", "traits": { "smithy.api#documentation": "An array of field patterns in a field-level encryption content type-profile mapping.
" } } }, "traits": { "smithy.api#documentation": "Complex data type for field-level encryption profiles that includes all of the encryption entities.
" } }, "com.amazonaws.cloudfront#EncryptionEntity": { "type": "structure", "members": { "PublicKeyId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match\n\t\t\tthe patterns.
", "smithy.api#required": {} } }, "ProviderId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The provider associated with the public key being used for encryption. This value must also be provided with the private key\n\t\tfor applications to be able to decrypt data.
", "smithy.api#required": {} } }, "FieldPatterns": { "target": "com.amazonaws.cloudfront#FieldPatterns", "traits": { "smithy.api#documentation": "Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the \n\t\t\tfull field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have\n\t\t\tboth ABC* and AB*. Note that field patterns are case-sensitive.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
" } }, "com.amazonaws.cloudfront#EncryptionEntityList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#EncryptionEntity", "traits": { "smithy.api#xmlName": "EncryptionEntity" } } }, "com.amazonaws.cloudfront#EndPoint": { "type": "structure", "members": { "StreamType": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The type of data stream where you are sending real-time log data. The only valid value is\n\t\t\tKinesis
.
Contains information about the Amazon Kinesis data stream where you are sending\n\t\t\treal-time log data.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data in a real-time log configuration.
" } }, "com.amazonaws.cloudfront#EndPointList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#EndPoint" } }, "com.amazonaws.cloudfront#EventType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "viewer-request", "name": "viewer_request" }, { "value": "viewer-response", "name": "viewer_response" }, { "value": "origin-request", "name": "origin_request" }, { "value": "origin-response", "name": "origin_response" } ] } }, "com.amazonaws.cloudfront#FieldLevelEncryption": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain\n\t\tselected data fields to be encrypted by specific public keys.
", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "The last time the field-level encryption configuration was changed.
", "smithy.api#required": {} } }, "FieldLevelEncryptionConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfig", "traits": { "smithy.api#documentation": "A complex data type that includes the profile configurations specified for field-level encryption.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A complex data type that includes the profile configurations and other options specified for field-level encryption.
" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionConfig": { "type": "structure", "members": { "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A unique number that ensures the request can't be replayed.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "An optional comment about the configuration. The comment cannot be longer than 128\n\t\t\tcharacters.
" } }, "QueryArgProfileConfig": { "target": "com.amazonaws.cloudfront#QueryArgProfileConfig", "traits": { "smithy.api#documentation": "A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a \n\t\t\tquery argument in a request.
" } }, "ContentTypeProfileConfig": { "target": "com.amazonaws.cloudfront#ContentTypeProfileConfig", "traits": { "smithy.api#documentation": "A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default \n\t\t\tin a request if a query argument doesn't specify a profile to use.
" } } }, "traits": { "smithy.api#documentation": "A complex data type that includes the profile configurations specified for field-level encryption.
" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionConfigAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified configuration for field-level encryption already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#FieldLevelEncryptionConfigInUse": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified configuration for field-level encryption is in use.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#FieldLevelEncryptionList": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker
request parameter to continue\n\t\t\tlisting your configurations where you left off.
The maximum number of elements you want in the response body.
", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of field-level encryption items.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionSummaryList", "traits": { "smithy.api#documentation": "An array of field-level encryption items.
" } } }, "traits": { "smithy.api#documentation": "List of field-level encrpytion configurations.
" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionProfile": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain\n\t\t\tselected data fields to be encrypted by specific public keys.
", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "The last time the field-level encryption profile was updated.
", "smithy.api#required": {} } }, "FieldLevelEncryptionProfileConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileConfig", "traits": { "smithy.api#documentation": "A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A complex data type for field-level encryption profiles.
" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionProfileAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified profile for field-level encryption already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#FieldLevelEncryptionProfileConfig": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Profile name for the field-level encryption profile.
", "smithy.api#required": {} } }, "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A unique number that ensures that the request can't be replayed.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "An optional comment for the field-level encryption profile. The comment cannot be longer\n\t\t\tthan 128 characters.
" } }, "EncryptionEntities": { "target": "com.amazonaws.cloudfront#EncryptionEntities", "traits": { "smithy.api#documentation": "A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and\n\t\t\tfield patterns for specifying which fields to encrypt with this key.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A complex data type of profiles for the field-level encryption.
" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionProfileInUse": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified profile for field-level encryption is in use.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#FieldLevelEncryptionProfileList": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker
request parameter to continue\n\t\t\tlisting your profiles where you left off.
The maximum number of field-level encryption profiles you want in the response body.
", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of field-level encryption profiles.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileSummaryList", "traits": { "smithy.api#documentation": "The field-level encryption profile items.
" } } }, "traits": { "smithy.api#documentation": "List of field-level encryption profiles.
" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionProfileSizeExceeded": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum size of a profile for field-level encryption was exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#FieldLevelEncryptionProfileSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "ID for the field-level encryption profile summary.
", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "The time when the the field-level encryption profile summary was last updated.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Name for the field-level encryption profile summary.
", "smithy.api#required": {} } }, "EncryptionEntities": { "target": "com.amazonaws.cloudfront#EncryptionEntities", "traits": { "smithy.api#documentation": "A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and\n\t\t\tfield patterns for specifying which fields to encrypt with this key.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "An optional comment for the field-level encryption profile summary. The comment cannot be\n\t\t\tlonger than 128 characters.
" } } }, "traits": { "smithy.api#documentation": "The field-level encryption profile summary.
" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionProfileSummaryList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileSummary", "traits": { "smithy.api#xmlName": "FieldLevelEncryptionProfileSummary" } } }, "com.amazonaws.cloudfront#FieldLevelEncryptionSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The unique ID of a field-level encryption item.
", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "The last time that the summary of field-level encryption items was modified.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "An optional comment about the field-level encryption item. The comment cannot be longer than\n\t\t\t128 characters.
" } }, "QueryArgProfileConfig": { "target": "com.amazonaws.cloudfront#QueryArgProfileConfig", "traits": { "smithy.api#documentation": "\n\t\t\tA summary of a query argument-profile mapping.\n\t\t
" } }, "ContentTypeProfileConfig": { "target": "com.amazonaws.cloudfront#ContentTypeProfileConfig", "traits": { "smithy.api#documentation": "\n\t\t\tA summary of a content type-profile mapping.\n\t\t
" } } }, "traits": { "smithy.api#documentation": "A summary of a field-level encryption item.
" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionSummary", "traits": { "smithy.api#xmlName": "FieldLevelEncryptionSummary" } } }, "com.amazonaws.cloudfront#FieldList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "Field" } } }, "com.amazonaws.cloudfront#FieldPatternList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "FieldPattern" } } }, "com.amazonaws.cloudfront#FieldPatterns": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of field-level encryption field patterns.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#FieldPatternList", "traits": { "smithy.api#documentation": "An array of the field-level encryption field patterns.
" } } }, "traits": { "smithy.api#documentation": "A complex data type that includes the field patterns to match for field-level encryption.
" } }, "com.amazonaws.cloudfront#Format": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "URLEncoded", "name": "URLEncoded" } ] } }, "com.amazonaws.cloudfront#ForwardedValues": { "type": "structure", "members": { "QueryString": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\n\t\tIf you want to include query strings in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.
\n\t\tIf you want to send query strings to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tIndicates whether you want CloudFront to forward query strings to the origin that is \n\t\t\tassociated with this cache behavior and cache based on the query string parameters. CloudFront \n\t\t\tbehavior depends on the value of QueryString
and on the values that you specify \n\t\t\tfor QueryStringCacheKeys
, if any:
If you specify true for QueryString
and you don't specify any values for \n\t\t\t\tQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin \n\t\t\tand caches based on all query string parameters. Depending on how many query string parameters \n\t\t\tand values you have, this can adversely affect performance because CloudFront must forward more \n\t\t\trequests to the origin.
If you specify true for QueryString
and you specify one or more values for \n\t\t\t\tQueryStringCacheKeys
, CloudFront forwards all query string parameters to the origin, \n\t\t\tbut it only caches based on the query string parameters that you specify.
If you specify false for QueryString
, CloudFront doesn't forward any query \n\t\t\tstring parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the \n\t\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "Cookies": { "target": "com.amazonaws.cloudfront#CookiePreference", "traits": { "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\n\t\tIf you want to include cookies in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.
\n\t\tIf you want to send cookies to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tA complex type that specifies whether you want CloudFront to forward cookies to the origin\n\t\t\tand, if so, which ones. For more information about forwarding cookies to the origin, see\n\t\t\tHow CloudFront Forwards, Caches, and Logs Cookies in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "Headers": { "target": "com.amazonaws.cloudfront#Headers", "traits": { "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\n\t\tIf you want to include headers in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.
\n\t\tIf you want to send headers to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tA complex type that specifies the Headers
, if any, that you want CloudFront to forward to the \n\t\t\torigin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches \n\t\t\tseparate versions of a specified object that is based on the header values in viewer requests.
For more information, see \n\t\t\tCaching Content Based on Request Headers in the Amazon CloudFront Developer Guide.
" } }, "QueryStringCacheKeys": { "target": "com.amazonaws.cloudfront#QueryStringCacheKeys", "traits": { "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\n\t\tIf you want to include query strings in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.
\n\t\tIf you want to send query strings to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tA complex type that contains information about the query string parameters that you \n\t\t\twant CloudFront to use for caching for this cache behavior.
" } } }, "traits": { "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\n\t\tIf you want to include values in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.
\n\t\tIf you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\n\t\tA complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
" } }, "com.amazonaws.cloudfront#FunctionARN": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 108 }, "smithy.api#pattern": "arn:aws:cloudfront::[0-9]{12}:function\\/[a-zA-Z0-9-_]{1,64}$" } }, "com.amazonaws.cloudfront#FunctionAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "A function with the same name already exists in this AWS account. To create a\n\t\t\tfunction, you must provide a unique name. To update an existing function, use\n\t\t\tUpdateFunction
.
The Amazon Resource Name (ARN) of the function.
", "smithy.api#required": {} } }, "EventType": { "target": "com.amazonaws.cloudfront#EventType", "traits": { "smithy.api#documentation": "The event type of the function, either viewer-request
or\n\t\t\tviewer-response
. You cannot use origin-facing event types\n\t\t\t(origin-request
and origin-response
) with a CloudFront\n\t\t\tfunction.
A CloudFront function that is associated with a cache behavior in a CloudFront\n\t\t\tdistribution.
" } }, "com.amazonaws.cloudfront#FunctionAssociationList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#FunctionAssociation", "traits": { "smithy.api#xmlName": "FunctionAssociation" } } }, "com.amazonaws.cloudfront#FunctionAssociations": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of CloudFront functions in the list.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#FunctionAssociationList", "traits": { "smithy.api#documentation": "The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. CloudFront\n\t\t\tfunctions must be published to the LIVE
stage to associate them with a\n\t\t\tcache behavior.
A list of CloudFront functions that are associated with a cache behavior in a CloudFront distribution.\n\t\t\tCloudFront functions must be published to the LIVE
stage to associate them with a\n\t\t\tcache behavior.
A comment to describe the function.
", "smithy.api#required": {} } }, "Runtime": { "target": "com.amazonaws.cloudfront#FunctionRuntime", "traits": { "smithy.api#documentation": "The function’s runtime environment. The only valid value is\n\t\t\tcloudfront-js-1.0
.
Contains configuration information about a CloudFront function.
" } }, "com.amazonaws.cloudfront#FunctionEventObject": { "type": "blob", "traits": { "smithy.api#length": { "min": 0, "max": 40960 }, "smithy.api#sensitive": {} } }, "com.amazonaws.cloudfront#FunctionExecutionLogList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string" } }, "com.amazonaws.cloudfront#FunctionInUse": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Cannot delete the function because it’s attached to one or more cache\n\t\t\tbehaviors.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#FunctionList": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker
field of a\n\t\t\tsubsequent request to continue listing functions where you left off.
The maximum number of functions requested.
", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of functions returned in the response.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#FunctionSummaryList", "traits": { "smithy.api#documentation": "Contains the functions in the list.
" } } }, "traits": { "smithy.api#documentation": "A list of CloudFront functions.
" } }, "com.amazonaws.cloudfront#FunctionMetadata": { "type": "structure", "members": { "FunctionARN": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the\n\t\t\tfunction.
", "smithy.api#required": {} } }, "Stage": { "target": "com.amazonaws.cloudfront#FunctionStage", "traits": { "smithy.api#documentation": "The stage that the function is in, either DEVELOPMENT
or\n\t\t\tLIVE
.
When a function is in the DEVELOPMENT
stage, you can test the function with\n\t\t\t\tTestFunction
, and update it with UpdateFunction
.
When a function is in the LIVE
stage, you can attach the function to a\n\t\t\tdistribution’s cache behavior, using the function’s ARN.
The date and time when the function was created.
" } }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "The date and time when the function was most recently updated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains metadata about a CloudFront function.
" } }, "com.amazonaws.cloudfront#FunctionName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9-_]{1,64}$" } }, "com.amazonaws.cloudfront#FunctionRuntime": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "cloudfront-js-1.0", "name": "cloudfront_js_1_0" } ] } }, "com.amazonaws.cloudfront#FunctionSizeLimitExceeded": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The function is too large. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 413 } }, "com.amazonaws.cloudfront#FunctionStage": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DEVELOPMENT", "name": "DEVELOPMENT" }, { "value": "LIVE", "name": "LIVE" } ] } }, "com.amazonaws.cloudfront#FunctionSummary": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudfront#FunctionName", "traits": { "smithy.api#documentation": "The name of the CloudFront function.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The status of the CloudFront function.
" } }, "FunctionConfig": { "target": "com.amazonaws.cloudfront#FunctionConfig", "traits": { "smithy.api#documentation": "Contains configuration information about a CloudFront function.
", "smithy.api#required": {} } }, "FunctionMetadata": { "target": "com.amazonaws.cloudfront#FunctionMetadata", "traits": { "smithy.api#documentation": "Contains metadata about a CloudFront function.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains configuration information and metadata about a CloudFront function.
" } }, "com.amazonaws.cloudfront#FunctionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#FunctionSummary", "traits": { "smithy.api#xmlName": "FunctionSummary" } } }, "com.amazonaws.cloudfront#GeoRestriction": { "type": "structure", "members": { "RestrictionType": { "target": "com.amazonaws.cloudfront#GeoRestrictionType", "traits": { "smithy.api#documentation": "The method that you want to use to restrict distribution of your content by \n\t\t\tcountry:
\n\t\t\n none
: No geo restriction is enabled, meaning access to content is not \n\t\t\t\t\trestricted by client geo location.
\n blacklist
: The Location
elements specify the countries in \n\t\t\t\t\twhich you don't want CloudFront to distribute your content.
\n whitelist
: The Location
elements specify the countries in \n\t\t\t\t\twhich you want CloudFront to distribute your content.
When geo restriction is enabled
, this is the number of countries in your \n\t\t\t\twhitelist
or blacklist
. Otherwise, when it is not enabled, \n\t\t\t\tQuantity
is 0
, and you can omit Items
.
A complex type that contains a Location
element for each country in which \n\t\t\tyou want CloudFront either to distribute your content (whitelist
) or not distribute \n\t\t\tyour content (blacklist
).
The Location
element is a two-letter, uppercase country code for a country \n\t\t\tthat you want to include in your blacklist
or whitelist
. Include one \n\t\t\t\tLocation
element for each country.
CloudFront and MaxMind
both use ISO 3166
country codes. For the \n\t\t\tcurrent list of countries and the corresponding codes, see ISO 3166-1-alpha-2
\n\t\t\tcode on the International Organization for Standardization website. You \n\t\t\tcan also refer to the country list on the CloudFront console, which includes both country names and \n\t\t\tcodes.
A complex type that controls the countries in which your content is distributed. CloudFront \n\t\t\tdetermines the location of your users using MaxMind
GeoIP databases.
Gets a cache policy, including the following metadata:
\n\t\tThe policy’s identifier.
\n\t\t\tThe date and time when the policy was last modified.
\n\t\t\tTo get a cache policy, you must provide the policy’s identifier. If the cache policy is\n\t\t\tattached to a distribution’s cache behavior, you can get the policy’s identifier using\n\t\t\tListDistributions
or GetDistribution
. If the cache policy is\n\t\t\tnot attached to a cache behavior, you can get the identifier using\n\t\t\tListCachePolicies
.
Gets a cache policy configuration.
\n\t\tTo get a cache policy configuration, you must provide the policy’s identifier. If the cache\n\t\t\tpolicy is attached to a distribution’s cache behavior, you can get the policy’s\n\t\t\tidentifier using ListDistributions
or GetDistribution
. If the\n\t\t\tcache policy is not attached to a cache behavior, you can get the identifier using\n\t\t\tListCachePolicies
.
The unique identifier for the cache policy. If the cache policy is attached to a\n\t\t\tdistribution’s cache behavior, you can get the policy’s identifier using\n\t\t\tListDistributions
or GetDistribution
. If the cache policy is\n\t\t\tnot attached to a cache behavior, you can get the identifier using\n\t\t\tListCachePolicies
.
The cache policy configuration.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the cache policy.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#GetCachePolicyRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The unique identifier for the cache policy. If the cache policy is attached to a\n\t\t\tdistribution’s cache behavior, you can get the policy’s identifier using\n\t\t\tListDistributions
or GetDistribution
. If the cache policy is\n\t\t\tnot attached to a cache behavior, you can get the identifier using\n\t\t\tListCachePolicies
.
The cache policy.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the cache policy.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentity": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchCloudFrontOriginAccessIdentity" } ], "traits": { "smithy.api#documentation": "Get the information about an origin access identity.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}", "code": 200 } } }, "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchCloudFrontOriginAccessIdentity" } ], "traits": { "smithy.api#documentation": "Get the configuration information about an origin access identity.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}/config", "code": 200 } } }, "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identity's ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The origin access identity's configuration information. For more information, see \n\t\t\tCloudFrontOriginAccessIdentityConfig.
" } }, "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigResult": { "type": "structure", "members": { "CloudFrontOriginAccessIdentityConfig": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityConfig", "traits": { "smithy.api#documentation": "The origin access identity's configuration information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL
.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identity's ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request to get an origin access identity's information.
" } }, "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityResult": { "type": "structure", "members": { "CloudFrontOriginAccessIdentity": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentity", "traits": { "smithy.api#documentation": "The origin access identity's information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the origin access identity's information. For example: \n\t\t\t\tE2QWRUHAPOMQZL
.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#GetDistribution": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetDistributionRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetDistributionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchDistribution" } ], "traits": { "smithy.api#documentation": "Get the information about a distribution.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distribution/{Id}", "code": 200 }, "smithy.waiters#waitable": { "DistributionDeployed": { "documentation": "Wait until a distribution is deployed.", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "Distribution.Status", "expected": "Deployed", "comparator": "stringEquals" } } } ], "minDelay": 60 } } } }, "com.amazonaws.cloudfront#GetDistributionConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetDistributionConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetDistributionConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchDistribution" } ], "traits": { "smithy.api#documentation": "Get the configuration information about a distribution.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distribution/{Id}/config", "code": 200 } } }, "com.amazonaws.cloudfront#GetDistributionConfigRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request to get a distribution configuration.
" } }, "com.amazonaws.cloudfront#GetDistributionConfigResult": { "type": "structure", "members": { "DistributionConfig": { "target": "com.amazonaws.cloudfront#DistributionConfig", "traits": { "smithy.api#documentation": "The distribution's configuration information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL
.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#GetDistributionRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request to get a distribution's information.
" } }, "com.amazonaws.cloudfront#GetDistributionResult": { "type": "structure", "members": { "Distribution": { "target": "com.amazonaws.cloudfront#Distribution", "traits": { "smithy.api#documentation": "The distribution's information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the distribution's information. For example: \n\t\t\t\tE2QWRUHAPOMQZL
.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#GetFieldLevelEncryption": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetFieldLevelEncryptionRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetFieldLevelEncryptionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig" } ], "traits": { "smithy.api#documentation": "Get the field-level encryption configuration information.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/field-level-encryption/{Id}", "code": 200 } } }, "com.amazonaws.cloudfront#GetFieldLevelEncryptionConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetFieldLevelEncryptionConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetFieldLevelEncryptionConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig" } ], "traits": { "smithy.api#documentation": "Get the field-level encryption configuration information.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/field-level-encryption/{Id}/config", "code": 200 } } }, "com.amazonaws.cloudfront#GetFieldLevelEncryptionConfigRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Request the ID for the field-level encryption configuration information.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#GetFieldLevelEncryptionConfigResult": { "type": "structure", "members": { "FieldLevelEncryptionConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfig", "traits": { "smithy.api#documentation": "Return the field-level encryption configuration information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL
.
Get the field-level encryption profile information.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/field-level-encryption-profile/{Id}", "code": 200 } } }, "com.amazonaws.cloudfront#GetFieldLevelEncryptionProfileConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetFieldLevelEncryptionProfileConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetFieldLevelEncryptionProfileConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionProfile" } ], "traits": { "smithy.api#documentation": "Get the field-level encryption profile configuration information.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/field-level-encryption-profile/{Id}/config", "code": 200 } } }, "com.amazonaws.cloudfront#GetFieldLevelEncryptionProfileConfigRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Get the ID for the field-level encryption profile configuration information.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#GetFieldLevelEncryptionProfileConfigResult": { "type": "structure", "members": { "FieldLevelEncryptionProfileConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileConfig", "traits": { "smithy.api#documentation": "Return the field-level encryption profile configuration information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL
.
Get the ID for the field-level encryption profile information.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#GetFieldLevelEncryptionProfileResult": { "type": "structure", "members": { "FieldLevelEncryptionProfile": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfile", "traits": { "smithy.api#documentation": "Return the field-level encryption profile information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL
.
Request the ID for the field-level encryption configuration information.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#GetFieldLevelEncryptionResult": { "type": "structure", "members": { "FieldLevelEncryption": { "target": "com.amazonaws.cloudfront#FieldLevelEncryption", "traits": { "smithy.api#documentation": "Return the field-level encryption configuration information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL
.
Gets the code of a CloudFront function. To get configuration information and metadata about\n\t\t\ta function, use DescribeFunction
.
To get a function’s code, you must provide the function’s name and stage. To get these\n\t\t\tvalues, you can use ListFunctions
.
The name of the function whose code you are getting.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Stage": { "target": "com.amazonaws.cloudfront#FunctionStage", "traits": { "smithy.api#documentation": "The function’s stage, either DEVELOPMENT
or LIVE
.
The function code of a CloudFront function.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The version identifier for the current version of the CloudFront function.
", "smithy.api#httpHeader": "ETag" } }, "ContentType": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The content type (media type) of the response.
", "smithy.api#httpHeader": "Content-Type" } } } }, "com.amazonaws.cloudfront#GetInvalidation": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetInvalidationRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetInvalidationResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchDistribution" }, { "target": "com.amazonaws.cloudfront#NoSuchInvalidation" } ], "traits": { "smithy.api#documentation": "Get the information about an invalidation.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distribution/{DistributionId}/invalidation/{Id}", "code": 200 }, "smithy.waiters#waitable": { "InvalidationCompleted": { "documentation": "Wait until an invalidation has completed.", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "Invalidation.Status", "expected": "Completed", "comparator": "stringEquals" } } } ], "minDelay": 20 } } } }, "com.amazonaws.cloudfront#GetInvalidationRequest": { "type": "structure", "members": { "DistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The distribution's ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for the invalidation request, for example, \n\t\t\tIDFDVBD632BHDS5
.
The request to get an invalidation's information.
" } }, "com.amazonaws.cloudfront#GetInvalidationResult": { "type": "structure", "members": { "Invalidation": { "target": "com.amazonaws.cloudfront#Invalidation", "traits": { "smithy.api#documentation": "The invalidation's information. For more information, see Invalidation Complex Type.
", "smithy.api#httpPayload": {} } } }, "traits": { "smithy.api#documentation": "The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#GetKeyGroup": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetKeyGroupRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetKeyGroupResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#NoSuchResource" } ], "traits": { "smithy.api#documentation": "Gets a key group, including the date and time when the key group was last modified.
\n\t\tTo get a key group, you must provide the key group’s identifier. If the key group is\n\t\t\treferenced in a distribution’s cache behavior, you can get the key group’s identifier\n\t\t\tusing ListDistributions
or GetDistribution
. If the key group\n\t\t\tis not referenced in a cache behavior, you can get the identifier using\n\t\t\tListKeyGroups
.
Gets a key group configuration.
\n\t\tTo get a key group configuration, you must provide the key group’s identifier. If the\n\t\t\tkey group is referenced in a distribution’s cache behavior, you can get the key group’s\n\t\t\tidentifier using ListDistributions
or GetDistribution
. If the\n\t\t\tkey group is not referenced in a cache behavior, you can get the identifier using\n\t\t\tListKeyGroups
.
The identifier of the key group whose configuration you are getting. To get the\n\t\t\tidentifier, use ListKeyGroups
.
The key group configuration.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for this version of the key group.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#GetKeyGroupRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier of the key group that you are getting. To get the identifier, use\n\t\t\tListKeyGroups
.
The key group.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for this version of the key group.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#GetMonitoringSubscription": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetMonitoringSubscriptionRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetMonitoringSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchDistribution" }, { "target": "com.amazonaws.cloudfront#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Gets information about whether additional CloudWatch metrics are enabled for the specified\n\t\t\tCloudFront distribution.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", "code": 200 } } }, "com.amazonaws.cloudfront#GetMonitoringSubscriptionRequest": { "type": "structure", "members": { "DistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID of the distribution that you are getting metrics information for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#GetMonitoringSubscriptionResult": { "type": "structure", "members": { "MonitoringSubscription": { "target": "com.amazonaws.cloudfront#MonitoringSubscription", "traits": { "smithy.api#documentation": "A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#GetOriginRequestPolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetOriginRequestPolicyRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetOriginRequestPolicyResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy" } ], "traits": { "smithy.api#documentation": "Gets an origin request policy, including the following metadata:
\n\t\tThe policy’s identifier.
\n\t\t\tThe date and time when the policy was last modified.
\n\t\t\tTo get an origin request policy, you must provide the policy’s identifier. If the origin\n\t\t\trequest policy is attached to a distribution’s cache behavior, you can get the policy’s\n\t\t\tidentifier using ListDistributions
or GetDistribution
. If the\n\t\t\torigin request policy is not attached to a cache behavior, you can get the identifier\n\t\t\tusing ListOriginRequestPolicies
.
Gets an origin request policy configuration.
\n\t\tTo get an origin request policy configuration, you must provide the policy’s identifier. If\n\t\t\tthe origin request policy is attached to a distribution’s cache behavior, you can get\n\t\t\tthe policy’s identifier using ListDistributions
or\n\t\t\tGetDistribution
. If the origin request policy is not attached to a cache\n\t\t\tbehavior, you can get the identifier using\n\t\t\tListOriginRequestPolicies
.
The unique identifier for the origin request policy. If the origin request policy is\n\t\t\tattached to a distribution’s cache behavior, you can get the policy’s identifier using\n\t\t\tListDistributions
or GetDistribution
. If the origin request\n\t\t\tpolicy is not attached to a cache behavior, you can get the identifier using\n\t\t\tListOriginRequestPolicies
.
The origin request policy configuration.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the origin request policy.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#GetOriginRequestPolicyRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The unique identifier for the origin request policy. If the origin request policy is\n\t\t\tattached to a distribution’s cache behavior, you can get the policy’s identifier using\n\t\t\tListDistributions
or GetDistribution
. If the origin request\n\t\t\tpolicy is not attached to a cache behavior, you can get the identifier using\n\t\t\tListOriginRequestPolicies
.
The origin request policy.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the origin request policy.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#GetPublicKey": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetPublicKeyRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetPublicKeyResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchPublicKey" } ], "traits": { "smithy.api#documentation": "Gets a public key.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/public-key/{Id}", "code": 200 } } }, "com.amazonaws.cloudfront#GetPublicKeyConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetPublicKeyConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetPublicKeyConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchPublicKey" } ], "traits": { "smithy.api#documentation": "Gets a public key configuration.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/public-key/{Id}/config", "code": 200 } } }, "com.amazonaws.cloudfront#GetPublicKeyConfigRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier of the public key whose configuration you are getting.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#GetPublicKeyConfigResult": { "type": "structure", "members": { "PublicKeyConfig": { "target": "com.amazonaws.cloudfront#PublicKeyConfig", "traits": { "smithy.api#documentation": "A public key configuration.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for this version of the public key configuration.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#GetPublicKeyRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier of the public key you are getting.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#GetPublicKeyResult": { "type": "structure", "members": { "PublicKey": { "target": "com.amazonaws.cloudfront#PublicKey", "traits": { "smithy.api#documentation": "The public key.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for this version of the public key.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#GetRealtimeLogConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetRealtimeLogConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetRealtimeLogConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig" } ], "traits": { "smithy.api#documentation": "Gets a real-time log configuration.
\n\t\tTo get a real-time log configuration, you can provide the configuration’s name or its Amazon\n\t\t\tResource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the\n\t\t\tname to identify the real-time log configuration to get.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/get-realtime-log-config", "code": 200 } } }, "com.amazonaws.cloudfront#GetRealtimeLogConfigRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The name of the real-time log configuration to get.
" } }, "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the real-time log configuration to get.
" } } } }, "com.amazonaws.cloudfront#GetRealtimeLogConfigResult": { "type": "structure", "members": { "RealtimeLogConfig": { "target": "com.amazonaws.cloudfront#RealtimeLogConfig", "traits": { "smithy.api#documentation": "A real-time log configuration.
" } } } }, "com.amazonaws.cloudfront#GetStreamingDistribution": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetStreamingDistributionRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetStreamingDistributionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchStreamingDistribution" } ], "traits": { "smithy.api#documentation": "Gets information about a specified RTMP distribution, including the distribution configuration.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/streaming-distribution/{Id}", "code": 200 }, "smithy.waiters#waitable": { "StreamingDistributionDeployed": { "documentation": "Wait until a streaming distribution is deployed.", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "StreamingDistribution.Status", "expected": "Deployed", "comparator": "stringEquals" } } } ], "minDelay": 60 } } } }, "com.amazonaws.cloudfront#GetStreamingDistributionConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#GetStreamingDistributionConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#GetStreamingDistributionConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#NoSuchStreamingDistribution" } ], "traits": { "smithy.api#documentation": "Get the configuration information about a streaming distribution.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/streaming-distribution/{Id}/config", "code": 200 } } }, "com.amazonaws.cloudfront#GetStreamingDistributionConfigRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The streaming distribution's ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "To request to get a streaming distribution configuration.
" } }, "com.amazonaws.cloudfront#GetStreamingDistributionConfigResult": { "type": "structure", "members": { "StreamingDistributionConfig": { "target": "com.amazonaws.cloudfront#StreamingDistributionConfig", "traits": { "smithy.api#documentation": "The streaming distribution's configuration information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the configuration. For example: E2QWRUHAPOMQZL
. \n\t\t
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#GetStreamingDistributionRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The streaming distribution's ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request to get a streaming distribution's information.
" } }, "com.amazonaws.cloudfront#GetStreamingDistributionResult": { "type": "structure", "members": { "StreamingDistribution": { "target": "com.amazonaws.cloudfront#StreamingDistribution", "traits": { "smithy.api#documentation": "The streaming distribution's information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the streaming distribution's information. For example: \n\t\t\t\tE2QWRUHAPOMQZL
.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#HeaderList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "Name" } } }, "com.amazonaws.cloudfront#Headers": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of header names in the Items
list.
A list of HTTP header names.
" } } }, "traits": { "smithy.api#documentation": "Contains a list of HTTP header names.
" } }, "com.amazonaws.cloudfront#HttpVersion": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "http1.1", "name": "http1_1" }, { "value": "http2", "name": "http2" } ] } }, "com.amazonaws.cloudfront#ICPRecordalStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "APPROVED", "name": "APPROVED" }, { "value": "SUSPENDED", "name": "SUSPENDED" }, { "value": "PENDING", "name": "PENDING" } ] } }, "com.amazonaws.cloudfront#IllegalDelete": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You cannot delete a managed policy.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified configuration for field-level encryption can't be associated with the specified cache behavior.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#IllegalUpdate": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The update contains modifications that are not allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InconsistentQuantities": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The value of Quantity
and the size of Items
don't match.
An argument is invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidDefaultRootObject": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The default root object file name is too big or contains an invalid character.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidErrorCode": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "An invalid error code was specified.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidForwardCookies": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Your request contains forward cookies option which doesn't match with the expectation for the whitelisted
\n\t\t\tlist of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.
A CloudFront function association is invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidGeoRestrictionParameter": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified geo restriction parameter is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidHeadersForS3Origin": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The headers specified are not valid for an Amazon S3 origin.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidIfMatchVersion": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The If-Match
version is missing or not valid.
The specified Lambda function association is invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidLocationCode": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The location code specified is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidMinimumProtocolVersion": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The minimum protocol version specified is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidOrigin": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidOriginAccessIdentity": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The origin access identity is not valid or doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidOriginKeepaliveTimeout": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The keep alive timeout specified for the origin is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidOriginReadTimeout": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The read timeout specified for the origin is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidProtocolSettings": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support \n\t\t\tServer Name Indication (SNI).
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidQueryStringParameters": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The query string parameters specified are not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidRelativePath": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidRequiredProtocol": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the \n\t\t\tRequiredProtocols
element from your distribution configuration.
A response code is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidTTLOrder": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The TTL order specified is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidTagging": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The tagging specified is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidViewerCertificate": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "A viewer certificate specified is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#InvalidWebACLId": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "A web ACL ID specified is not valid. To specify a web ACL created using the latest\n\t\t\tversion of AWS WAF, use the ACL ARN, for example\n\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
.\n\t\t\tTo specify a web ACL created using AWS WAF Classic, use the ACL ID, for example\n\t\t\t473e64fd-f30b-4765-81a0-62ad96dd167a
.
The identifier for the invalidation request. For example: \n\t\t\tIDFDVBD632BHDS5
.
The status of the invalidation request. When the invalidation batch is finished, the \n\t\t\tstatus is Completed
.
The date and time the invalidation request was first made.
", "smithy.api#required": {} } }, "InvalidationBatch": { "target": "com.amazonaws.cloudfront#InvalidationBatch", "traits": { "smithy.api#documentation": "The current invalidation information for the batch request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An invalidation.
" } }, "com.amazonaws.cloudfront#InvalidationBatch": { "type": "structure", "members": { "Paths": { "target": "com.amazonaws.cloudfront#Paths", "traits": { "smithy.api#documentation": "A complex type that contains information about the objects that you want to invalidate. \n\t\t\tFor more information, see Specifying the Objects \n\t\t\t\tto Invalidate in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A value that you specify to uniquely identify an invalidation request. CloudFront uses the \n\t\t\tvalue to prevent you from accidentally resubmitting an identical request. Whenever you create \n\t\t\ta new invalidation request, you must specify a new value for CallerReference
and \n\t\t\tchange other values in the request as applicable. One way to ensure that the value of \n\t\t\t\tCallerReference
is unique is to use a timestamp
, for example, \n\t\t\t\t20120301090000
.
If you make a second invalidation request with the same value for \n\t\t\t\tCallerReference
, and if the rest of the request is the same, CloudFront doesn't \n\t\t\tcreate a new invalidation request. Instead, CloudFront returns information about the invalidation \n\t\t\trequest that you previously created with the same CallerReference
.
If CallerReference
is a value you already sent in a previous invalidation \n\t\t\tbatch request but the content of any Path
is different from the original request, \n\t\t\tCloudFront returns an InvalidationBatchAlreadyExists
error.
An invalidation batch.
" } }, "com.amazonaws.cloudfront#InvalidationList": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value that you provided for the Marker
request parameter.
If IsTruncated
is true
, this element is present and contains \n\t\t\tthe value that you can use for the Marker
request parameter to continue listing \n\t\t\tyour invalidation batches where they left off.
The value that you provided for the MaxItems
request parameter.
A flag that indicates whether more invalidation batch requests remain to be listed. If \n\t\t\tyour results were truncated, you can make a follow-up pagination request using the \n\t\t\t\tMarker
request parameter to retrieve more invalidation batches in the \n\t\t\tlist.
The number of invalidation batches that were created by the current AWS account. \n\t\t
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#InvalidationSummaryList", "traits": { "smithy.api#documentation": "A complex type that contains one InvalidationSummary
element for each \n\t\t\tinvalidation batch created by the current AWS account.
The InvalidationList
complex type describes the list of invalidation \n\t\t\tobjects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in \n\t\t\tthe Amazon CloudFront Developer Guide.
The unique ID for an invalidation request.
", "smithy.api#required": {} } }, "CreateTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "The time that an invalidation request was created.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The status of an invalidation request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A summary of an invalidation request.
" } }, "com.amazonaws.cloudfront#InvalidationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#InvalidationSummary", "traits": { "smithy.api#xmlName": "InvalidationSummary" } } }, "com.amazonaws.cloudfront#ItemSelection": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "none", "name": "none" }, { "value": "whitelist", "name": "whitelist" }, { "value": "all", "name": "all" } ] } }, "com.amazonaws.cloudfront#KGKeyPairIds": { "type": "structure", "members": { "KeyGroupId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier of the key group that contains the public keys.
" } }, "KeyPairIds": { "target": "com.amazonaws.cloudfront#KeyPairIds" } }, "traits": { "smithy.api#documentation": "A list of identifiers for the public keys that CloudFront can use to verify the\n\t\t\tsignatures of signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#KGKeyPairIdsList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#KGKeyPairIds", "traits": { "smithy.api#xmlName": "KeyGroup" } } }, "com.amazonaws.cloudfront#KeyGroup": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for the key group.
", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "The date and time when the key group was last modified.
", "smithy.api#required": {} } }, "KeyGroupConfig": { "target": "com.amazonaws.cloudfront#KeyGroupConfig", "traits": { "smithy.api#documentation": "The key group configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A key group.
\n\t\tA key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#KeyGroupAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "A key group with this name already exists. You must provide a unique name. To modify an\n\t\t\texisting key group, use UpdateKeyGroup
.
A name to identify the key group.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#PublicKeyIdList", "traits": { "smithy.api#documentation": "A list of the identifiers of the public keys in the key group.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A comment to describe the key group. The comment cannot be longer than 128\n\t\t\tcharacters.
" } } }, "traits": { "smithy.api#documentation": "A key group configuration.
\n\t\tA key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#KeyGroupList": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "If there are more items in the list than are in this response, this element is present. It\n\t\t\tcontains the value that you should use in the Marker
field of a subsequent\n\t\t\trequest to continue listing key groups.
The maximum number of key groups requested.
", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of key groups returned in the response.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#KeyGroupSummaryList", "traits": { "smithy.api#documentation": "A list of key groups.
" } } }, "traits": { "smithy.api#documentation": "A list of key groups.
" } }, "com.amazonaws.cloudfront#KeyGroupSummary": { "type": "structure", "members": { "KeyGroup": { "target": "com.amazonaws.cloudfront#KeyGroup", "traits": { "smithy.api#documentation": "A key group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about a key group.
" } }, "com.amazonaws.cloudfront#KeyGroupSummaryList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#KeyGroupSummary", "traits": { "smithy.api#xmlName": "KeyGroupSummary" } } }, "com.amazonaws.cloudfront#KeyPairIdList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "KeyPairId" } } }, "com.amazonaws.cloudfront#KeyPairIds": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of key pair identifiers in the list.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#KeyPairIdList", "traits": { "smithy.api#documentation": "A list of CloudFront key pair identifiers.
" } } }, "traits": { "smithy.api#documentation": "A list of CloudFront key pair identifiers.
" } }, "com.amazonaws.cloudfront#KinesisStreamConfig": { "type": "structure", "members": { "RoleARN": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that\n\t\t\tCloudFront can use to send real-time log data to your Kinesis data stream.
\n\t\tFor more information the IAM role, see Real-time log configuration IAM role in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time\n\t\t\tlog data.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending\n\t\t\treal-time log data.
" } }, "com.amazonaws.cloudfront#LambdaFunctionARN": { "type": "string" }, "com.amazonaws.cloudfront#LambdaFunctionAssociation": { "type": "structure", "members": { "LambdaFunctionARN": { "target": "com.amazonaws.cloudfront#LambdaFunctionARN", "traits": { "smithy.api#documentation": "The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias \n\t\t\tor $LATEST.
", "smithy.api#required": {} } }, "EventType": { "target": "com.amazonaws.cloudfront#EventType", "traits": { "smithy.api#documentation": "Specifies the event type that triggers a Lambda function invocation. You can specify the following values:
\n\t\t\n viewer-request
: The function executes when CloudFront receives a request from a viewer \n\t\t\t\tand before it checks to see whether the requested object is in the edge cache.
\n origin-request
: The function executes only when CloudFront sends a request to your\n\t\t\t\t\torigin. When the requested object is in the edge cache, the function doesn't\n\t\t\t\t\texecute.
\n origin-response
: The function executes after CloudFront receives a response from the origin and \n\t\t\t\tbefore it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.
\n viewer-response
: The function executes before CloudFront returns the requested object to the viewer. \n\t\t\t\tThe function executes regardless of whether the object was already in the edge cache.
If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.
\n\t\t\tA flag that allows a Lambda function to have read access to the body content. For more information, \n\t\t\tsee Accessing the Request Body by Choosing the \n\t\t\t\tInclude Body Option in the Amazon CloudFront Developer Guide.
" } } }, "traits": { "smithy.api#documentation": "A complex type that contains a Lambda function association.
" } }, "com.amazonaws.cloudfront#LambdaFunctionAssociationList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#LambdaFunctionAssociation", "traits": { "smithy.api#xmlName": "LambdaFunctionAssociation" } } }, "com.amazonaws.cloudfront#LambdaFunctionAssociations": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of Lambda function associations for this cache behavior.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#LambdaFunctionAssociationList", "traits": { "smithy.api#documentation": "\n Optional: A complex type that contains LambdaFunctionAssociation
items \n\t\t\tfor this cache behavior. If Quantity
is 0
, you can omit Items
.
A complex type that specifies a list of Lambda functions associations for a cache \n\t\t\tbehavior.
\n \n\t\tIf you want to invoke one or more Lambda functions triggered by requests that match the \n\t\t\t\tPathPattern
of the cache behavior, specify the applicable values for \n\t\t\t\tQuantity
and Items
. Note that there can be up to 4 \n\t\t\t\tLambdaFunctionAssociation
items in this list (one for each possible value of \n\t\t\t\tEventType
) and each EventType
can be associated with the Lambda \n\t\t\tfunction only once.
If you don't want to invoke any Lambda functions for the requests that match \n\t\t\t\tPathPattern
, specify 0
for Quantity
and omit \n\t\t\t\tItems
.
Gets a list of cache policies.
\n\t\tYou can optionally apply a filter to return only the managed policies created by AWS, or\n\t\t\tonly the custom policies created in your AWS account.
\n\t\tYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker
value from the current\n\t\t\tresponse as the Marker
value in the subsequent request.
A filter to return only the specified kinds of cache policies. Valid values\n\t\t\tare:
\n\t\t\n managed
– Returns only the managed policies created by AWS.
\n custom
– Returns only the custom policies created in your AWS\n\t\t\t\t\taccount.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tcache policies. The response includes cache policies in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker
from the current page’s response.
The maximum number of cache policies that you want in the response.
", "smithy.api#httpQuery": "MaxItems" } } } }, "com.amazonaws.cloudfront#ListCachePoliciesResult": { "type": "structure", "members": { "CachePolicyList": { "target": "com.amazonaws.cloudfront#CachePolicyList", "traits": { "smithy.api#documentation": "A list of cache policies.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentities": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" } ], "traits": { "smithy.api#documentation": "Lists origin access identities.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/origin-access-identity/cloudfront", "code": 200 }, "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "CloudFrontOriginAccessIdentityList.NextMarker", "items": "CloudFrontOriginAccessIdentityList.Items", "pageSize": "MaxItems" } } }, "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesRequest": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of origin \n\t\t\taccess identities. The results include identities in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker
to the value of the \n\t\t\t\tNextMarker
from the current page's response (which is also the ID of the last \n\t\t\tidentity on that page).
The maximum number of origin access identities you want in the response body. \n\t\t
", "smithy.api#httpQuery": "MaxItems" } } }, "traits": { "smithy.api#documentation": "The request to list origin access identities.
" } }, "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesResult": { "type": "structure", "members": { "CloudFrontOriginAccessIdentityList": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityList", "traits": { "smithy.api#documentation": "The CloudFrontOriginAccessIdentityList
type.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#ListDistributions": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListDistributionsRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListDistributionsResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" } ], "traits": { "smithy.api#documentation": "List CloudFront distributions.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distribution", "code": 200 }, "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "DistributionList.NextMarker", "items": "DistributionList.Items", "pageSize": "MaxItems" } } }, "com.amazonaws.cloudfront#ListDistributionsByCachePolicyId": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListDistributionsByCachePolicyIdRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListDistributionsByCachePolicyIdResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#NoSuchCachePolicy" } ], "traits": { "smithy.api#documentation": "Gets a list of distribution IDs for distributions that have a cache behavior that’s\n\t\t\tassociated with the specified cache policy.
\n\t\tYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker
value from the current\n\t\t\tresponse as the Marker
value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker
from the current page’s response.
The maximum number of distribution IDs that you want in the response.
", "smithy.api#httpQuery": "MaxItems" } }, "CachePolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID of the cache policy whose associated distribution IDs you want to list.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#ListDistributionsByCachePolicyIdResult": { "type": "structure", "members": { "DistributionIdList": { "target": "com.amazonaws.cloudfront#DistributionIdList", "traits": { "smithy.api#documentation": "A list of distribution IDs.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListDistributionsByKeyGroup": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListDistributionsByKeyGroupRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListDistributionsByKeyGroupResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#NoSuchResource" } ], "traits": { "smithy.api#documentation": "Gets a list of distribution IDs for distributions that have a cache behavior that references\n\t\t\tthe specified key group.
\n\t\tYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker
value from the current\n\t\t\tresponse as the Marker
value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker
from the current page’s response.
The maximum number of distribution IDs that you want in the response.
", "smithy.api#httpQuery": "MaxItems" } }, "KeyGroupId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID of the key group whose associated distribution IDs you are listing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#ListDistributionsByKeyGroupResult": { "type": "structure", "members": { "DistributionIdList": { "target": "com.amazonaws.cloudfront#DistributionIdList", "traits": { "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListDistributionsByOriginRequestPolicyId": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListDistributionsByOriginRequestPolicyIdRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListDistributionsByOriginRequestPolicyIdResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy" } ], "traits": { "smithy.api#documentation": "Gets a list of distribution IDs for distributions that have a cache behavior that’s\n\t\t\tassociated with the specified origin request policy.
\n\t\tYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker
value from the current\n\t\t\tresponse as the Marker
value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker
from the current page’s response.
The maximum number of distribution IDs that you want in the response.
", "smithy.api#httpQuery": "MaxItems" } }, "OriginRequestPolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID of the origin request policy whose associated distribution IDs you want to\n\t\t\tlist.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#ListDistributionsByOriginRequestPolicyIdResult": { "type": "structure", "members": { "DistributionIdList": { "target": "com.amazonaws.cloudfront#DistributionIdList", "traits": { "smithy.api#documentation": "A list of distribution IDs.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" } ], "traits": { "smithy.api#documentation": "Gets a list of distributions that have a cache behavior that’s associated with the specified\n\t\t\treal-time log configuration.
\n\t\tYou can specify the real-time log configuration by its name or its Amazon Resource Name\n\t\t\t(ARN). You must provide at least one. If you provide both, CloudFront uses the name to\n\t\t\tidentify the real-time log configuration to list distributions for.
\n\t\tYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker
value from the current\n\t\t\tresponse as the Marker
value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistributions. The response includes distributions in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker
from the current page’s response.
The maximum number of distributions that you want in the response.
" } }, "RealtimeLogConfigName": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The name of the real-time log configuration whose associated distributions you want to\n\t\t\tlist.
" } }, "RealtimeLogConfigArn": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the real-time log configuration whose associated\n\t\t\tdistributions you want to list.
" } } } }, "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfigResult": { "type": "structure", "members": { "DistributionList": { "target": "com.amazonaws.cloudfront#DistributionList", "traits": { "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListDistributionsByWebACLId": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListDistributionsByWebACLIdRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListDistributionsByWebACLIdResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidWebACLId" } ], "traits": { "smithy.api#documentation": "List the distributions that are associated with a specified AWS WAF web ACL.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distributionsByWebACLId/{WebACLId}", "code": 200 } } }, "com.amazonaws.cloudfront#ListDistributionsByWebACLIdRequest": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Use Marker
and MaxItems
to control pagination of results. If \n\t\t\tyou have more than MaxItems
distributions that satisfy the request, the response \n\t\t\tincludes a NextMarker
element. To get the next page of results, submit another \n\t\t\trequest. For the value of Marker
, specify the value of NextMarker
\n\t\t\tfrom the last response. (For the first request, omit Marker
.)
The maximum number of distributions that you want CloudFront to return in the response body. \n\t\t\tThe maximum and default values are both 100.
", "smithy.api#httpQuery": "MaxItems" } }, "WebACLId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID of the AWS WAF web ACL that you want to list the associated distributions. \n\t\t\tIf you specify \"null\" for the ID, the request returns a list of the distributions that aren't \n\t\t\tassociated with a web ACL.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request to list distributions that are associated with a specified AWS WAF web \n\t\t\tACL.
" } }, "com.amazonaws.cloudfront#ListDistributionsByWebACLIdResult": { "type": "structure", "members": { "DistributionList": { "target": "com.amazonaws.cloudfront#DistributionList", "traits": { "smithy.api#documentation": "The DistributionList
type.
The response to a request to list the distributions that are associated with a \n\t\t\tspecified AWS WAF web ACL.
" } }, "com.amazonaws.cloudfront#ListDistributionsRequest": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of \n\t\t\tdistributions. The results include distributions in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker
to the value of the \n\t\t\t\tNextMarker
from the current page's response (which is also the ID of the last \n\t\t\tdistribution on that page).
The maximum number of distributions you want in the response body.
", "smithy.api#httpQuery": "MaxItems" } } }, "traits": { "smithy.api#documentation": "The request to list your distributions.
" } }, "com.amazonaws.cloudfront#ListDistributionsResult": { "type": "structure", "members": { "DistributionList": { "target": "com.amazonaws.cloudfront#DistributionList", "traits": { "smithy.api#documentation": "The DistributionList
type.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#ListFieldLevelEncryptionConfigs": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListFieldLevelEncryptionConfigsRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListFieldLevelEncryptionConfigsResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" } ], "traits": { "smithy.api#documentation": "List all field-level encryption configurations that have been created in CloudFront for this account.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/field-level-encryption", "code": 200 } } }, "com.amazonaws.cloudfront#ListFieldLevelEncryptionConfigsRequest": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that \n\t\t\toccur after the marker. To get the next page of results, set the Marker
to the value of the \n\t\t\tNextMarker
from the current page's response (which is also the ID of the last configuration on that page).
The maximum number of field-level encryption configurations you want in the response body.
", "smithy.api#httpQuery": "MaxItems" } } } }, "com.amazonaws.cloudfront#ListFieldLevelEncryptionConfigsResult": { "type": "structure", "members": { "FieldLevelEncryptionList": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionList", "traits": { "smithy.api#documentation": "Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListFieldLevelEncryptionProfiles": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListFieldLevelEncryptionProfilesRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListFieldLevelEncryptionProfilesResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" } ], "traits": { "smithy.api#documentation": "Request a list of field-level encryption profiles that have been created in CloudFront for this account.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/field-level-encryption-profile", "code": 200 } } }, "com.amazonaws.cloudfront#ListFieldLevelEncryptionProfilesRequest": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that \n\t\t\toccur after the marker. To get the next page of results, set the Marker
to the value of the \n\t\t\tNextMarker
from the current page's response (which is also the ID of the last profile on that page).
The maximum number of field-level encryption profiles you want in the response body.
", "smithy.api#httpQuery": "MaxItems" } } } }, "com.amazonaws.cloudfront#ListFieldLevelEncryptionProfilesResult": { "type": "structure", "members": { "FieldLevelEncryptionProfileList": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileList", "traits": { "smithy.api#documentation": "Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListFunctions": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListFunctionsRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListFunctionsResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" } ], "traits": { "smithy.api#documentation": "Gets a list of all CloudFront functions in your AWS account.
\n\t\tYou can optionally apply a filter to return only the functions that are in the\n\t\t\tspecified stage, either DEVELOPMENT
or LIVE
.
You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker
value from the current\n\t\t\tresponse as the Marker
value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tfunctions. The response includes functions in the list that occur after the marker. To\n\t\t\tget the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker
from the current page’s response.
The maximum number of functions that you want in the response.
", "smithy.api#httpQuery": "MaxItems" } }, "Stage": { "target": "com.amazonaws.cloudfront#FunctionStage", "traits": { "smithy.api#documentation": "An optional filter to return only the functions that are in the specified stage,\n\t\t\teither DEVELOPMENT
or LIVE
.
A list of CloudFront functions.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListInvalidations": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListInvalidationsRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListInvalidationsResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#NoSuchDistribution" } ], "traits": { "smithy.api#documentation": "Lists invalidation batches.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distribution/{DistributionId}/invalidation", "code": 200 }, "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "InvalidationList.NextMarker", "items": "InvalidationList.Items", "pageSize": "MaxItems" } } }, "com.amazonaws.cloudfront#ListInvalidationsRequest": { "type": "structure", "members": { "DistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The distribution's ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Use this parameter when paginating results to indicate where to begin in your list of \n\t\t\tinvalidation batches. Because the results are returned in decreasing order from most recent to \n\t\t\toldest, the most recent results are on the first page, the second page will contain earlier \n\t\t\tresults, and so on. To get the next page of results, set Marker
to the value of \n\t\t\tthe NextMarker
from the current page's response. This value is the same as the ID \n\t\t\tof the last invalidation batch on that page.
The maximum number of invalidation batches that you want in the response \n\t\t\tbody.
", "smithy.api#httpQuery": "MaxItems" } } }, "traits": { "smithy.api#documentation": "The request to list invalidations.
" } }, "com.amazonaws.cloudfront#ListInvalidationsResult": { "type": "structure", "members": { "InvalidationList": { "target": "com.amazonaws.cloudfront#InvalidationList", "traits": { "smithy.api#documentation": "Information about invalidation batches.
", "smithy.api#httpPayload": {} } } }, "traits": { "smithy.api#documentation": "The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#ListKeyGroups": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListKeyGroupsRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListKeyGroupsResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" } ], "traits": { "smithy.api#documentation": "Gets a list of key groups.
\n\t\tYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker
value from the current\n\t\t\tresponse as the Marker
value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of key\n\t\t\tgroups. The response includes key groups in the list that occur after the marker. To get\n\t\t\tthe next page of the list, set this field’s value to the value of\n\t\t\tNextMarker
from the current page’s response.
The maximum number of key groups that you want in the response.
", "smithy.api#httpQuery": "MaxItems" } } } }, "com.amazonaws.cloudfront#ListKeyGroupsResult": { "type": "structure", "members": { "KeyGroupList": { "target": "com.amazonaws.cloudfront#KeyGroupList", "traits": { "smithy.api#documentation": "A list of key groups.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListOriginRequestPolicies": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListOriginRequestPoliciesRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListOriginRequestPoliciesResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy" } ], "traits": { "smithy.api#documentation": "Gets a list of origin request policies.
\n\t\tYou can optionally apply a filter to return only the managed policies created by AWS, or\n\t\t\tonly the custom policies created in your AWS account.
\n\t\tYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker
value from the current\n\t\t\tresponse as the Marker
value in the subsequent request.
A filter to return only the specified kinds of origin request policies. Valid values\n\t\t\tare:
\n\t\t\n managed
– Returns only the managed policies created by AWS.
\n custom
– Returns only the custom policies created in your AWS\n\t\t\t\t\taccount.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\torigin request policies. The response includes origin request policies in the list that\n\t\t\toccur after the marker. To get the next page of the list, set this field’s value to the\n\t\t\tvalue of NextMarker
from the current page’s response.
The maximum number of origin request policies that you want in the response.
", "smithy.api#httpQuery": "MaxItems" } } } }, "com.amazonaws.cloudfront#ListOriginRequestPoliciesResult": { "type": "structure", "members": { "OriginRequestPolicyList": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyList", "traits": { "smithy.api#documentation": "A list of origin request policies.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListPublicKeys": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListPublicKeysRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListPublicKeysResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" } ], "traits": { "smithy.api#documentation": "List all public keys that have been added to CloudFront for this account.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/public-key", "code": 200 } } }, "com.amazonaws.cloudfront#ListPublicKeysRequest": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that \n\t\t\toccur after the marker. To get the next page of results, set the Marker
to the value of the \n\t\t\tNextMarker
from the current page's response (which is also the ID of the last public key on that page).
The maximum number of public keys you want in the response body.
", "smithy.api#httpQuery": "MaxItems" } } } }, "com.amazonaws.cloudfront#ListPublicKeysResult": { "type": "structure", "members": { "PublicKeyList": { "target": "com.amazonaws.cloudfront#PublicKeyList", "traits": { "smithy.api#documentation": "Returns a list of all public keys that have been added to CloudFront for this account.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListRealtimeLogConfigs": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListRealtimeLogConfigsRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListRealtimeLogConfigsResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig" } ], "traits": { "smithy.api#documentation": "Gets a list of real-time log configurations.
\n\t\tYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker
value from the current\n\t\t\tresponse as the Marker
value in the subsequent request.
The maximum number of real-time log configurations that you want in the response.
", "smithy.api#httpQuery": "MaxItems" } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Use this field when paginating results to indicate where to begin in your list of real-time\n\t\t\tlog configurations. The response includes real-time log configurations in the list that\n\t\t\toccur after the marker. To get the next page of the list, set this field’s value to the\n\t\t\tvalue of NextMarker
from the current page’s response.
A list of real-time log configurations.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#ListStreamingDistributions": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListStreamingDistributionsRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListStreamingDistributionsResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" } ], "traits": { "smithy.api#documentation": "List streaming distributions.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/streaming-distribution", "code": 200 }, "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "StreamingDistributionList.NextMarker", "items": "StreamingDistributionList.Items", "pageSize": "MaxItems" } } }, "com.amazonaws.cloudfront#ListStreamingDistributionsRequest": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value that you provided for the Marker
request parameter.
The value that you provided for the MaxItems
request parameter.
The request to list your streaming distributions.
" } }, "com.amazonaws.cloudfront#ListStreamingDistributionsResult": { "type": "structure", "members": { "StreamingDistributionList": { "target": "com.amazonaws.cloudfront#StreamingDistributionList", "traits": { "smithy.api#documentation": "The StreamingDistributionList
type.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.cloudfront#ListTagsForResourceResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidTagging" }, { "target": "com.amazonaws.cloudfront#NoSuchResource" } ], "traits": { "smithy.api#documentation": "List tags for a CloudFront resource.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/tagging", "code": 200 } } }, "com.amazonaws.cloudfront#ListTagsForResourceRequest": { "type": "structure", "members": { "Resource": { "target": "com.amazonaws.cloudfront#ResourceARN", "traits": { "smithy.api#documentation": "An ARN of a CloudFront resource.
", "smithy.api#httpQuery": "Resource", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request to list tags for a CloudFront resource.
" } }, "com.amazonaws.cloudfront#ListTagsForResourceResult": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.cloudfront#Tags", "traits": { "smithy.api#documentation": " A complex type that contains zero or more Tag
elements.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#LocationList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "Location" } } }, "com.amazonaws.cloudfront#LoggingConfig": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't \n\t\t\twant to enable logging when you create a distribution or if you want to disable logging for an \n\t\t\texisting distribution, specify false
for Enabled
, and specify empty \n\t\t\t\tBucket
and Prefix
elements. If you specify false
for \n\t\t\t\tEnabled
but you specify values for Bucket
, prefix
, \n\t\t\tand IncludeCookies
, the values are automatically deleted.
Specifies whether you want CloudFront to include cookies in access logs, specify \n\t\t\t\ttrue
for IncludeCookies
. If you choose to include cookies in logs, \n\t\t\tCloudFront logs all cookies regardless of how you configure the cache behaviors for this \n\t\t\tdistribution. If you don't want to include cookies when you create a distribution or if you \n\t\t\twant to disable include cookies for an existing distribution, specify false
for \n\t\t\t\tIncludeCookies
.
The Amazon S3 bucket to store the access logs in, for example, \n\t\t\t\tmyawslogbucket.s3.amazonaws.com
.
An optional string that you want CloudFront to prefix to the access log \n\t\t\t\tfilenames
for this distribution, for example, myprefix/
. If you \n\t\t\twant to enable logging, but you don't want to specify a prefix, you still must include an \n\t\t\tempty Prefix
element in the Logging
element.
A complex type that controls whether access logs are written for the \n\t\t\tdistribution.
" } }, "com.amazonaws.cloudfront#Method": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "GET", "name": "GET" }, { "value": "HEAD", "name": "HEAD" }, { "value": "POST", "name": "POST" }, { "value": "PUT", "name": "PUT" }, { "value": "PATCH", "name": "PATCH" }, { "value": "OPTIONS", "name": "OPTIONS" }, { "value": "DELETE", "name": "DELETE" } ] } }, "com.amazonaws.cloudfront#MethodsList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#Method", "traits": { "smithy.api#xmlName": "Method" } } }, "com.amazonaws.cloudfront#MinimumProtocolVersion": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SSLv3", "name": "SSLv3" }, { "value": "TLSv1", "name": "TLSv1" }, { "value": "TLSv1_2016", "name": "TLSv1_2016" }, { "value": "TLSv1.1_2016", "name": "TLSv1_1_2016" }, { "value": "TLSv1.2_2018", "name": "TLSv1_2_2018" }, { "value": "TLSv1.2_2019", "name": "TLSv1_2_2019" } ] } }, "com.amazonaws.cloudfront#MissingBody": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "This operation requires a body. Ensure that the body is present and the Content-Type
header is set.
A subscription configuration for additional CloudWatch metrics.
" } } }, "traits": { "smithy.api#documentation": "A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.
" } }, "com.amazonaws.cloudfront#NoSuchCachePolicy": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The cache policy does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#NoSuchCloudFrontOriginAccessIdentity": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified origin access identity does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#NoSuchDistribution": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified distribution does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified configuration for field-level encryption doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionProfile": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified profile for field-level encryption doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#NoSuchFunctionExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The function does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#NoSuchInvalidation": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified invalidation does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#NoSuchOrigin": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "No origin exists with the specified Origin Id
.
The origin request policy does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#NoSuchPublicKey": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified public key doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The real-time log configuration does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#NoSuchResource": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "A resource that was specified is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#NoSuchStreamingDistribution": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified streaming distribution does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudfront#Origin": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A unique identifier for the origin. This value must be unique within the\n\t\t\tdistribution.
\nUse this value to specify the TargetOriginId
in a\n CacheBehavior
or DefaultCacheBehavior
.
The domain name for the origin.
\n\t\tFor more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "OriginPath": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "An optional path that CloudFront appends to the origin domain name when CloudFront requests content from\n\t\t\tthe origin.
\n\t\tFor more information, see Origin Path in the\n\t\t\tAmazon CloudFront Developer Guide.
" } }, "CustomHeaders": { "target": "com.amazonaws.cloudfront#CustomHeaders", "traits": { "smithy.api#documentation": "A list of HTTP header names and values that CloudFront adds to the requests that it sends to\n the origin.
\n\t\tFor more information, see Adding Custom Headers to Origin Requests in the\n\t\t\tAmazon CloudFront Developer Guide.
" } }, "S3OriginConfig": { "target": "com.amazonaws.cloudfront#S3OriginConfig", "traits": { "smithy.api#documentation": "Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static\n\t\t\twebsite hosting. To specify any other type of origin, including an Amazon S3 bucket that is\n\t\t\tconfigured with static website hosting, use the CustomOriginConfig
type\n\t\t\tinstead.
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the\n\t\t\tAmazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket\n\t\t\tis not configured with static website hosting, use the S3OriginConfig
type\n\t\t\tinstead.
The number of times that CloudFront attempts to connect to the origin. The minimum number\n is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
\nFor a custom origin (including an Amazon S3 bucket that’s configured with static\n website hosting), this value also specifies the number of times that CloudFront attempts to\n get a response from the origin, in the case of an Origin Response Timeout.
\nFor more information, see Origin Connection Attempts in the\n\t\t\tAmazon CloudFront Developer Guide.
" } }, "ConnectionTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of seconds that CloudFront waits when trying to establish a connection to the origin.\n\t\t\tThe minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you\n\t\t\tdon’t specify otherwise) is 10 seconds.
\n\t\tFor more information, see Origin Connection Timeout in the\n\t\t\tAmazon CloudFront Developer Guide.
" } }, "OriginShield": { "target": "com.amazonaws.cloudfront#OriginShield", "traits": { "smithy.api#documentation": "CloudFront Origin Shield. Using Origin Shield can help reduce the load on your\n origin.
\n\t\tFor more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
" } } }, "traits": { "smithy.api#documentation": "An origin.
\n\t\tAn origin is the location where content is stored, and from which CloudFront gets content to\n\t\t\tserve to viewers. To specify an origin:
\n\t\tUse S3OriginConfig
to specify an Amazon S3 bucket that is not\n\t\t\t\t\tconfigured with static website hosting.
Use CustomOriginConfig
to specify all other kinds of origins,\n\t\t\t\t\tincluding:
An Amazon S3 bucket that is configured with static website hosting
\n\t\t\t\t\tAn Elastic Load Balancing load balancer
\n\t\t\t\t\tAn AWS Elemental MediaPackage endpoint
\n\t\t\t\t\tAn AWS Elemental MediaStore container
\n\t\t\t\t\tAny other HTTP server, running on an Amazon EC2 instance or any other\n\t\t\t\t\t\t\tkind of host
\n\t\t\t\t\tFor the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the Amazon CloudFront Developer Guide\n\t\t\t(quotas were formerly referred to as limits).
" } }, "com.amazonaws.cloudfront#OriginCustomHeader": { "type": "structure", "members": { "HeaderName": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The name of a header that you want CloudFront to send to your origin. For more information, see\n\t\t\tAdding Custom\n\t\t\tHeaders to Origin Requests in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "HeaderValue": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value for the header that you specified in the HeaderName
\n\t\t\tfield.
A complex type that contains HeaderName
and HeaderValue
\n\t\t\telements, if any, for this distribution.
The origin group's ID.
", "smithy.api#required": {} } }, "FailoverCriteria": { "target": "com.amazonaws.cloudfront#OriginGroupFailoverCriteria", "traits": { "smithy.api#documentation": "A complex type that contains information about the failover criteria for an origin group.
", "smithy.api#required": {} } }, "Members": { "target": "com.amazonaws.cloudfront#OriginGroupMembers", "traits": { "smithy.api#documentation": "A complex type that contains information about the origins in an origin group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify.\n\t\tYou create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specifiy \n\t\tthe origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin\n\t\tunder the failover conditions that you've chosen.
" } }, "com.amazonaws.cloudfront#OriginGroupFailoverCriteria": { "type": "structure", "members": { "StatusCodes": { "target": "com.amazonaws.cloudfront#StatusCodes", "traits": { "smithy.api#documentation": "The status codes that, when returned from the primary origin, will trigger CloudFront to failover \n\t\tto the second origin.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A complex data type that includes information about the failover criteria for an origin group, including\n\t\tthe status codes for which CloudFront will failover from the primary origin to the second origin.
" } }, "com.amazonaws.cloudfront#OriginGroupList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#OriginGroup", "traits": { "smithy.api#xmlName": "OriginGroup" } }, "traits": { "smithy.api#documentation": "List of origin groups for a distribution.
" } }, "com.amazonaws.cloudfront#OriginGroupMember": { "type": "structure", "members": { "OriginId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID for an origin in an origin group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An origin in an origin group.
" } }, "com.amazonaws.cloudfront#OriginGroupMemberList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#OriginGroupMember", "traits": { "smithy.api#xmlName": "OriginGroupMember" } }, "traits": { "smithy.api#documentation": "List of origins in an origin group.
", "smithy.api#length": { "min": 2, "max": 2 } } }, "com.amazonaws.cloudfront#OriginGroupMembers": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of origins in an origin group.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#OriginGroupMemberList", "traits": { "smithy.api#documentation": "Items (origins) in an origin group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A complex data type for the origins included in an origin group.
" } }, "com.amazonaws.cloudfront#OriginGroups": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of origin groups.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#OriginGroupList", "traits": { "smithy.api#documentation": "The items (origin groups) in a distribution.
" } } }, "traits": { "smithy.api#documentation": "A complex data type for the origin groups specified for a distribution.
" } }, "com.amazonaws.cloudfront#OriginList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#Origin", "traits": { "smithy.api#xmlName": "Origin" } }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.cloudfront#OriginProtocolPolicy": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "http-only", "name": "http_only" }, { "value": "match-viewer", "name": "match_viewer" }, { "value": "https-only", "name": "https_only" } ] } }, "com.amazonaws.cloudfront#OriginRequestPolicy": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The unique identifier for the origin request policy.
", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "The date and time when the origin request policy was last modified.
", "smithy.api#required": {} } }, "OriginRequestPolicyConfig": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyConfig", "traits": { "smithy.api#documentation": "The origin request policy configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An origin request policy.
\n\t\tWhen it’s attached to a cache behavior, the origin request policy determines the values that\n\t\t\tCloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to\n\t\t\tthe origin includes the following:
\n\t\tThe request body and the URL path (without the domain name) from the viewer\n\t\t\t\t\trequest.
\n\t\t\tThe headers that CloudFront automatically includes in every origin request, including\n\t\t\t\t\tHost
, User-Agent
, and X-Amz-Cf-Id
.
All HTTP headers, cookies, and URL query strings that are specified in the\n\t\t\t\t\tcache policy or the origin request policy. These can include items from the\n\t\t\t\t\tviewer request and, in the case of headers, additional ones that are added by\n\t\t\t\t\tCloudFront.
\n\t\t\tCloudFront sends a request when it can’t find an object in its cache that matches the request. If\n\t\t\tyou want to send values to the origin and also include them in the cache key, use\n\t\t\tCachePolicy
.
An origin request policy with this name already exists. You must provide a unique\n\t\t\tname. To modify an existing origin request policy, use\n\t\t\tUpdateOriginRequestPolicy
.
A comment to describe the origin request policy. The comment cannot be longer than 128\n\t\t\tcharacters.
" } }, "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A unique name to identify the origin request policy.
", "smithy.api#required": {} } }, "HeadersConfig": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyHeadersConfig", "traits": { "smithy.api#documentation": "The HTTP headers to include in origin requests. These can include headers from viewer\n\t\t\trequests and additional headers added by CloudFront.
", "smithy.api#required": {} } }, "CookiesConfig": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyCookiesConfig", "traits": { "smithy.api#documentation": "The cookies from viewer requests to include in origin requests.
", "smithy.api#required": {} } }, "QueryStringsConfig": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyQueryStringsConfig", "traits": { "smithy.api#documentation": "The URL query strings from viewer requests to include in origin requests.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An origin request policy configuration.
\n\t\tThis configuration determines the values that CloudFront includes in requests that it sends to the\n\t\t\torigin. Each request that CloudFront sends to the origin includes the following:
\n\t\tThe request body and the URL path (without the domain name) from the viewer\n\t\t\t\t\trequest.
\n\t\t\tThe headers that CloudFront automatically includes in every origin request, including\n\t\t\t\t\tHost
, User-Agent
, and X-Amz-Cf-Id
.
All HTTP headers, cookies, and URL query strings that are specified in the\n\t\t\t\t\tcache policy or the origin request policy. These can include items from the\n\t\t\t\t\tviewer request and, in the case of headers, additional ones that are added by\n\t\t\t\t\tCloudFront.
\n\t\t\tCloudFront sends a request when it can’t find an object in its cache that matches the request. If\n\t\t\tyou want to send values to the origin and also include them in the cache key, use\n\t\t\tCachePolicy
.
Determines whether cookies in viewer requests are included in requests that CloudFront sends to\n\t\t\tthe origin. Valid values are:
\n\t\t\n none
– Cookies in viewer requests are not included in requests that CloudFront\n\t\t\t\t\tsends to the origin. Even when this field is set to none
, any\n\t\t\t\t\tcookies that are listed in a CachePolicy
\n are\n\t\t\t\t\tincluded in origin requests.
\n whitelist
– The cookies in viewer requests that are listed in the\n\t\t\t\t\tCookieNames
type are included in requests that CloudFront sends to the\n\t\t\t\t\torigin.
\n all
– All cookies in viewer requests are included in requests that CloudFront sends\n\t\t\t\t\tto the origin.
An object that determines whether any cookies in viewer requests (and if so, which cookies)\n\t\t\tare included in requests that CloudFront sends to the origin.
" } }, "com.amazonaws.cloudfront#OriginRequestPolicyHeaderBehavior": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "none", "name": "none" }, { "value": "whitelist", "name": "whitelist" }, { "value": "allViewer", "name": "allViewer" }, { "value": "allViewerAndWhitelistCloudFront", "name": "allViewerAndWhitelistCloudFront" } ] } }, "com.amazonaws.cloudfront#OriginRequestPolicyHeadersConfig": { "type": "structure", "members": { "HeaderBehavior": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyHeaderBehavior", "traits": { "smithy.api#documentation": "Determines whether any HTTP headers are included in requests that CloudFront sends to the origin.\n\t\t\tValid values are:
\n\t\t\n none
– HTTP headers are not included in requests that CloudFront sends to the\n\t\t\t\t\torigin. Even when this field is set to none
, any headers that are\n\t\t\t\t\tlisted in a CachePolicy
\n are included in origin\n\t\t\t\t\trequests.
\n whitelist
– The HTTP headers that are listed in the Headers
type\n\t\t\t\t\tare included in requests that CloudFront sends to the origin.
\n allViewer
– All HTTP headers in viewer requests are included in requests that\n\t\t\t\t\tCloudFront sends to the origin.
\n allViewerAndWhitelistCloudFront
– All HTTP headers in viewer requests and the\n\t\t\t\t\tadditional CloudFront headers that are listed in the Headers
type are\n\t\t\t\t\tincluded in requests that CloudFront sends to the origin. The additional headers are\n\t\t\t\t\tadded by CloudFront.
An object that determines whether any HTTP headers (and if so, which headers) are included\n\t\t\tin requests that CloudFront sends to the origin.
" } }, "com.amazonaws.cloudfront#OriginRequestPolicyInUse": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Cannot delete the origin request policy because it is attached to one or more cache\n\t\t\tbehaviors.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#OriginRequestPolicyList": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker
field of a\n\t\t\tsubsequent request to continue listing origin request policies where you left\n\t\t\toff.
The maximum number of origin request policies requested.
", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The total number of origin request policies returned in the response.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#OriginRequestPolicySummaryList", "traits": { "smithy.api#documentation": "Contains the origin request policies in the list.
" } } }, "traits": { "smithy.api#documentation": "A list of origin request policies.
" } }, "com.amazonaws.cloudfront#OriginRequestPolicyQueryStringBehavior": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "none", "name": "none" }, { "value": "whitelist", "name": "whitelist" }, { "value": "all", "name": "all" } ] } }, "com.amazonaws.cloudfront#OriginRequestPolicyQueryStringsConfig": { "type": "structure", "members": { "QueryStringBehavior": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyQueryStringBehavior", "traits": { "smithy.api#documentation": "Determines whether any URL query strings in viewer requests are included in requests that\n\t\t\tCloudFront sends to the origin. Valid values are:
\n\t\t\n none
– Query strings in viewer requests are not included in requests that\n\t\t\t\t\tCloudFront sends to the origin. Even when this field is set to none
, any\n\t\t\t\t\tquery strings that are listed in a CachePolicy
\n\t\t\t\t\t are included in origin requests.
\n whitelist
– The query strings in viewer requests that are listed in the\n\t\t\t\t\tQueryStringNames
type are included in requests that CloudFront sends to\n\t\t\t\t\tthe origin.
\n all
– All query strings in viewer requests are included in requests that CloudFront\n\t\t\t\t\tsends to the origin.
Contains a list of the query strings in viewer requests that are included in requests that\n\t\t\tCloudFront sends to the origin.
" } } }, "traits": { "smithy.api#documentation": "An object that determines whether any URL query strings in viewer requests (and if so, which\n\t\t\tquery strings) are included in requests that CloudFront sends to the origin.
" } }, "com.amazonaws.cloudfront#OriginRequestPolicySummary": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyType", "traits": { "smithy.api#documentation": "The type of origin request policy, either managed
(created by AWS) or\n\t\t\tcustom
(created in this AWS account).
The origin request policy.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains an origin request policy.
" } }, "com.amazonaws.cloudfront#OriginRequestPolicySummaryList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#OriginRequestPolicySummary", "traits": { "smithy.api#xmlName": "OriginRequestPolicySummary" } } }, "com.amazonaws.cloudfront#OriginRequestPolicyType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "managed", "name": "managed" }, { "value": "custom", "name": "custom" } ] } }, "com.amazonaws.cloudfront#OriginShield": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "A flag that specifies whether Origin Shield is enabled.
\n\t\tWhen it’s enabled, CloudFront routes all requests through Origin Shield, which can\n help protect your origin. When it’s disabled, CloudFront might send requests directly to\n your origin from multiple edge locations or regional edge caches.
", "smithy.api#required": {} } }, "OriginShieldRegion": { "target": "com.amazonaws.cloudfront#OriginShieldRegion", "traits": { "smithy.api#documentation": "The AWS Region for Origin Shield.
\n\t\tSpecify the AWS Region that has the lowest latency to your origin.\n To specify a region, use the region code, not the region name.\n For example, specify the US East (Ohio) region as us-east-2
.
When you enable CloudFront Origin Shield, you must specify the AWS Region for Origin\n Shield. For the list of AWS Regions that you can specify, and for help choosing the best\n Region for your origin, see Choosing the AWS Region for Origin Shield in the\n\t\t\tAmazon CloudFront Developer Guide.
" } } }, "traits": { "smithy.api#documentation": "CloudFront Origin Shield.
\n\t\tUsing Origin Shield can help reduce the load on your origin. For more\n information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#OriginShieldRegion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "[a-z]{2}-[a-z]+-\\d" } }, "com.amazonaws.cloudfront#OriginSslProtocols": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an \n\t\t\tHTTPS connection with this origin.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#SslProtocolsList", "traits": { "smithy.api#documentation": "A list that contains allowed SSL/TLS protocols for this distribution.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A complex type that contains information about the SSL/TLS protocols that CloudFront can use \n\t\t\twhen establishing an HTTPS connection with your origin.
" } }, "com.amazonaws.cloudfront#Origins": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of origins for this distribution.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#OriginList", "traits": { "smithy.api#documentation": "A list of origins.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about the origins for this distribution.
" } }, "com.amazonaws.cloudfront#ParametersInCacheKeyAndForwardedToOrigin": { "type": "structure", "members": { "EnableAcceptEncodingGzip": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "A flag that can affect whether the Accept-Encoding
HTTP header is\n\t\t\tincluded in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli
field. If one or\n\t\t\tboth of these fields is true
\n and the viewer request\n\t\t\tincludes the Accept-Encoding
header, then CloudFront does the following:
Normalizes the value of the viewer’s Accept-Encoding
\n\t\t\t\t\theader
Includes the normalized header in the cache key
\n\t\t\tIncludes the normalized header in the request to the origin, if a request is necessary
\n\t\t\tFor more information, see Compression support in the\n Amazon CloudFront Developer Guide.
\n\t\tIf you set this value to true
, and this cache behavior also has an origin\n\t\t\trequest policy attached, do not include the Accept-Encoding
header in the\n\t\t\torigin request policy. CloudFront always includes the Accept-Encoding
header in\n\t\t\torigin requests when the value of this field is true
, so including this\n\t\t\theader in an origin request policy has no effect.
If both of these fields are false
, then CloudFront treats the\n\t\t\tAccept-Encoding
header the same as any other HTTP header in the viewer\n\t\t\trequest. By default, it’s not included in the cache key and it’s not included in origin\n\t\t\trequests. In this case, you can manually add Accept-Encoding
to the headers\n\t\t\twhitelist like any other HTTP header.
A flag that can affect whether the Accept-Encoding
HTTP header is\n\t\t\tincluded in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip
field. If one or\n\t\t\tboth of these fields is true
\n and the viewer request\n\t\t\tincludes the Accept-Encoding
header, then CloudFront does the following:
Normalizes the value of the viewer’s Accept-Encoding
\n\t\t\t\t\theader
Includes the normalized header in the cache key
\n\t\t\tIncludes the normalized header in the request to the origin, if a request is necessary
\n\t\t\tFor more information, see Compression support in the\n Amazon CloudFront Developer Guide.
\nIf you set this value to true
, and this cache behavior also has an origin\n\t\t\trequest policy attached, do not include the Accept-Encoding
header in the\n\t\t\torigin request policy. CloudFront always includes the Accept-Encoding
header in\n\t\t\torigin requests when the value of this field is true
, so including this\n\t\t\theader in an origin request policy has no effect.
If both of these fields are false
, then CloudFront treats the\n\t\t\tAccept-Encoding
header the same as any other HTTP header in the viewer\n\t\t\trequest. By default, it’s not included in the cache key and it’s not included in origin\n\t\t\trequests. In this case, you can manually add Accept-Encoding
to the headers\n\t\t\twhitelist like any other HTTP header.
An object that determines whether any HTTP headers (and if so, which headers) are\n\t\t\tincluded in the cache key and automatically included in requests that CloudFront sends to the\n\t\t\torigin.
", "smithy.api#required": {} } }, "CookiesConfig": { "target": "com.amazonaws.cloudfront#CachePolicyCookiesConfig", "traits": { "smithy.api#documentation": "An object that determines whether any cookies in viewer requests (and if so, which cookies)\n\t\t\tare included in the cache key and automatically included in requests that CloudFront sends to\n\t\t\tthe origin.
", "smithy.api#required": {} } }, "QueryStringsConfig": { "target": "com.amazonaws.cloudfront#CachePolicyQueryStringsConfig", "traits": { "smithy.api#documentation": "An object that determines whether any URL query strings in viewer requests (and if so, which\n\t\t\tquery strings) are included in the cache key and automatically included in requests that\n\t\t\tCloudFront sends to the origin.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This object determines the values that CloudFront includes in the cache key. These values can\n\t\t\tinclude HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an\n\t\t\tobject in its cache that it can return to the viewer.
\n\t\tThe headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind an object in its cache that matches the request’s cache key. If you want to send\n\t\t\tvalues to the origin but not include them in the cache key, use\n\t\t\tOriginRequestPolicy
.
The number of invalidation paths specified for the objects that you want to invalidate.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#PathList", "traits": { "smithy.api#documentation": "A complex type that contains a list of the paths that you want to invalidate.
" } } }, "traits": { "smithy.api#documentation": "A complex type that contains information about the objects that you want to invalidate. \n\t\t\tFor more information, see Specifying the Objects \n\t\t\t\tto Invalidate in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#PreconditionFailed": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The precondition in one or more of the request fields evaluated to\n\t\t\tfalse
.
The identifier of the public key.
", "smithy.api#required": {} } }, "CreatedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "The date and time when the public key was uploaded.
", "smithy.api#required": {} } }, "PublicKeyConfig": { "target": "com.amazonaws.cloudfront#PublicKeyConfig", "traits": { "smithy.api#documentation": "Configuration information about a public key that you can use with signed URLs and signed cookies, or with field-level encryption.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A public key that you can use with signed URLs and signed cookies, or with field-level encryption.
" } }, "com.amazonaws.cloudfront#PublicKeyAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified public key already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#PublicKeyConfig": { "type": "structure", "members": { "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A string included in the request to help make sure that the request can’t be\n\t\t\treplayed.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A name to help identify the public key.
", "smithy.api#required": {} } }, "EncodedKey": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The public key that you can use with signed URLs and signed cookies, or with field-level encryption.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A comment to describe the public key. The comment cannot be longer than 128\n\t\t\tcharacters.
" } } }, "traits": { "smithy.api#documentation": "Configuration information about a public key that you can use with signed URLs and signed cookies, or with field-level encryption.
" } }, "com.amazonaws.cloudfront#PublicKeyIdList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "PublicKey" } } }, "com.amazonaws.cloudfront#PublicKeyInUse": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified public key is in use.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#PublicKeyList": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker
request parameter to continue\n\t\t\tlisting your public keys where you left off.
The maximum number of public keys you want in the response.
", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of public keys in the list.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#PublicKeySummaryList", "traits": { "smithy.api#documentation": "A list of public keys.
" } } }, "traits": { "smithy.api#documentation": "A list of public keys that you can use with signed URLs and signed cookies, or with field-level encryption.
" } }, "com.amazonaws.cloudfront#PublicKeySummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier of the public key.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A name to help identify the public key.
", "smithy.api#required": {} } }, "CreatedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "The date and time when the public key was uploaded.
", "smithy.api#required": {} } }, "EncodedKey": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The public key.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A comment to describe the public key. The comment cannot be longer than 128\n\t\t\tcharacters.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a public key.
" } }, "com.amazonaws.cloudfront#PublicKeySummaryList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#PublicKeySummary", "traits": { "smithy.api#xmlName": "PublicKeySummary" } } }, "com.amazonaws.cloudfront#PublishFunction": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#PublishFunctionRequest" }, "output": { "target": "com.amazonaws.cloudfront#PublishFunctionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#NoSuchFunctionExists" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" } ], "traits": { "smithy.api#documentation": "Publishes a CloudFront function by copying the function code from the DEVELOPMENT
\n\t\t\tstage to LIVE
. This automatically updates all cache behaviors that are\n\t\t\tusing this function to use the newly published copy in the LIVE
\n\t\t\tstage.
When a function is published to the LIVE
stage, you can attach the function to\n\t\t\ta distribution’s cache behavior, using the function’s Amazon Resource Name (ARN).
To publish a function, you must provide the function’s name and version (ETag
\n\t\t\tvalue). To get these values, you can use ListFunctions
and\n\t\t\tDescribeFunction
.
The name of the function that you are publishing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version (ETag
value) of the function that you are publishing, which\n\t\t\tyou can get using DescribeFunction
.
Contains configuration information and metadata about a CloudFront function.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#QueryArgProfile": { "type": "structure", "members": { "QueryArg": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Query argument for field-level encryption query argument-profile mapping.
", "smithy.api#required": {} } }, "ProfileId": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "ID of profile to use for field-level encryption query argument-profile mapping
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Query argument-profile mapping for field-level encryption.
" } }, "com.amazonaws.cloudfront#QueryArgProfileConfig": { "type": "structure", "members": { "ForwardWhenQueryArgProfileIsUnknown": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument,\n\t\t\tfle-profile, is unknown.
", "smithy.api#required": {} } }, "QueryArgProfiles": { "target": "com.amazonaws.cloudfront#QueryArgProfiles", "traits": { "smithy.api#documentation": "Profiles specified for query argument-profile mapping for field-level encryption.
" } } }, "traits": { "smithy.api#documentation": "Configuration for query argument-profile mapping for field-level encryption.
" } }, "com.amazonaws.cloudfront#QueryArgProfileEmpty": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "No profile specified for the field-level encryption query argument.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#QueryArgProfileList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#QueryArgProfile", "traits": { "smithy.api#xmlName": "QueryArgProfile" } } }, "com.amazonaws.cloudfront#QueryArgProfiles": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "Number of profiles for query argument-profile mapping for field-level encryption.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#QueryArgProfileList", "traits": { "smithy.api#documentation": "Number of items for query argument-profile mapping for field-level encryption.
" } } }, "traits": { "smithy.api#documentation": "Query argument-profile mapping for field-level encryption.
" } }, "com.amazonaws.cloudfront#QueryStringCacheKeys": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of whitelisted
query string parameters for a cache \n\t\t\tbehavior.
A list that contains the query string parameters that you want CloudFront to use \n\t\t\tas a basis for caching for a cache behavior. If Quantity
is 0, you can omit \n\t\t\tItems
.
This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\n\t\tIf you want to include query strings in the cache key, use\n\t\t\tQueryStringsConfig
in a cache policy. See\n\t\t\tCachePolicy
.
If you want to send query strings to the origin but not include them in the cache key,\n\t\t\tuse QueryStringsConfig
in an origin request policy. See\n\t\t\tOriginRequestPolicy
.
A complex type that contains information about the query string parameters that you want\n\t\t\tCloudFront to use for caching for a cache behavior.\n\t\t
" } }, "com.amazonaws.cloudfront#QueryStringCacheKeysList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "Name" } } }, "com.amazonaws.cloudfront#QueryStringNames": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of query string names in the Items
list.
A list of query string names.
" } } }, "traits": { "smithy.api#documentation": "Contains a list of query string names.
" } }, "com.amazonaws.cloudfront#QueryStringNamesList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "Name" } } }, "com.amazonaws.cloudfront#RealtimeLogConfig": { "type": "structure", "members": { "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of this real-time log configuration.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The unique name of this real-time log configuration.
", "smithy.api#required": {} } }, "SamplingRate": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#documentation": "The sampling rate for this real-time log configuration. The sampling rate determines the\n\t\t\tpercentage of viewer requests that are represented in the real-time log data. The\n\t\t\tsampling rate is an integer between 1 and 100, inclusive.
", "smithy.api#required": {} } }, "EndPoints": { "target": "com.amazonaws.cloudfront#EndPointList", "traits": { "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data for this real-time log configuration.
", "smithy.api#required": {} } }, "Fields": { "target": "com.amazonaws.cloudfront#FieldList", "traits": { "smithy.api#documentation": "A list of fields that are included in each real-time log record. In an API response, the\n\t\t\tfields are provided in the same order in which they are sent to the Amazon Kinesis data\n\t\t\tstream.
\n\t\tFor more information about fields, see Real-time log configuration fields in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A real-time log configuration.
" } }, "com.amazonaws.cloudfront#RealtimeLogConfigAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "A real-time log configuration with this name already exists. You must provide a unique name.\n\t\t\tTo modify an existing real-time log configuration, use\n\t\t\tUpdateRealtimeLogConfig
.
Cannot delete the real-time log configuration because it is attached to one or more cache\n\t\t\tbehaviors.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#RealtimeLogConfigList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#RealtimeLogConfig" } }, "com.amazonaws.cloudfront#RealtimeLogConfigOwnerMismatch": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified real-time log configuration belongs to a different AWS account.
", "smithy.api#error": "client", "smithy.api#httpError": 401 } }, "com.amazonaws.cloudfront#RealtimeLogConfigs": { "type": "structure", "members": { "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The maximum number of real-time log configurations requested.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#RealtimeLogConfigList", "traits": { "smithy.api#documentation": "Contains the list of real-time log configurations.
" } }, "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more real-time log configurations than are contained\n\t\t\tin this list.
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "This parameter indicates where this list of real-time log configurations begins. This list\n\t\t\tincludes real-time log configurations that occur after the marker.
", "smithy.api#required": {} } }, "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "If there are more items in the list than are in this response, this element is present. It\n\t\t\tcontains the value that you should use in the Marker
field of a subsequent\n\t\t\trequest to continue listing real-time log configurations where you left off.
A list of real-time log configurations.
" } }, "com.amazonaws.cloudfront#RealtimeMetricsSubscriptionConfig": { "type": "structure", "members": { "RealtimeMetricsSubscriptionStatus": { "target": "com.amazonaws.cloudfront#RealtimeMetricsSubscriptionStatus", "traits": { "smithy.api#documentation": "A flag that indicates whether additional CloudWatch metrics are enabled for a given\n\t\t\tCloudFront distribution.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A subscription configuration for additional CloudWatch metrics.
" } }, "com.amazonaws.cloudfront#RealtimeMetricsSubscriptionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Enabled", "name": "Enabled" }, { "value": "Disabled", "name": "Disabled" } ] } }, "com.amazonaws.cloudfront#ResourceARN": { "type": "string", "traits": { "smithy.api#pattern": "arn:aws(-cn)?:cloudfront::[0-9]+:.*" } }, "com.amazonaws.cloudfront#ResourceInUse": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Cannot delete this resource because it is in use.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#Restrictions": { "type": "structure", "members": { "GeoRestriction": { "target": "com.amazonaws.cloudfront#GeoRestriction", "traits": { "smithy.api#documentation": "A complex type that controls the countries in which your content is distributed. CloudFront \n\t\t\tdetermines the location of your users using MaxMind
GeoIP databases.
A complex type that identifies ways in which you want to restrict distribution of your \n\t\t\tcontent.
" } }, "com.amazonaws.cloudfront#S3Origin": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The DNS name of the Amazon S3 origin.
", "smithy.api#required": {} } }, "OriginAccessIdentity": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The CloudFront origin access identity to associate with the distribution. Use an origin \n\t\t\taccess identity to configure the distribution so that end users can only access objects in an \n\t\t\tAmazon S3 bucket through CloudFront.
\n\t\tIf you want end users to be able to access objects using either the CloudFront URL or the \n\t\t\tAmazon S3 URL, specify an empty OriginAccessIdentity
element.
To delete the origin access identity from an existing distribution, update the \n\t\t\tdistribution configuration and include an empty OriginAccessIdentity
\n\t\t\telement.
To replace the origin access identity, update the distribution configuration and \n\t\t\tspecify the new origin access identity.
\n\t\tFor more information, see Using an Origin Access \n\t\t\t\tIdentity to Restrict Access to Your Amazon S3 Content in the \n\t\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A complex type that contains information about the Amazon S3 bucket from which you want \n\t\t\tCloudFront to get your media files for distribution.
" } }, "com.amazonaws.cloudfront#S3OriginConfig": { "type": "structure", "members": { "OriginAccessIdentity": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The CloudFront origin access identity to associate with the origin. Use an origin access \n\t\t\tidentity to configure the origin so that viewers can only access objects \n\t\t\tin an Amazon S3 bucket through CloudFront. The format of the value is:
\n\t\torigin-access-identity/cloudfront/ID-of-origin-access-identity\n
\n\t\twhere \n ID-of-origin-access-identity\n
is the value that \n\t\t\tCloudFront returned in the ID
element when you created the origin access \n\t\t\tidentity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 \n\t\t\tURL, specify an empty OriginAccessIdentity
element.
To delete the origin access identity from an existing distribution, update the \n\t\t\tdistribution configuration and include an empty OriginAccessIdentity
\n\t\t\telement.
To replace the origin access identity, update the distribution configuration and \n\t\t\tspecify the new origin access identity.
\n\t\tFor more information about the origin access identity, see Serving Private Content through CloudFront in the \n\t\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A complex type that contains information about the Amazon S3 origin. If the origin is a\n\t\t\tcustom origin or an S3 bucket that is configured as a website endpoint, use the\n CustomOriginConfig
element instead.
An AWS account number that contains active CloudFront key pairs that CloudFront can use to verify the\n\t\t\tsignatures of signed URLs and signed cookies. If the AWS account that owns the key pairs\n\t\t\tis the same account that owns the CloudFront distribution, the value of this field is\n\t\t\tself
.
A list of CloudFront key pair identifiers.
" } } }, "traits": { "smithy.api#documentation": "A list of AWS accounts and the active CloudFront key pairs in each account that CloudFront can use to\n\t\t\tverify the signatures of signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#SignerList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#Signer", "traits": { "smithy.api#xmlName": "Signer" } } }, "com.amazonaws.cloudfront#SslProtocol": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SSLv3", "name": "SSLv3" }, { "value": "TLSv1", "name": "TLSv1" }, { "value": "TLSv1.1", "name": "TLSv1_1" }, { "value": "TLSv1.2", "name": "TLSv1_2" } ] } }, "com.amazonaws.cloudfront#SslProtocolsList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#SslProtocol", "traits": { "smithy.api#xmlName": "SslProtocol" } } }, "com.amazonaws.cloudfront#StatusCodeList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#xmlName": "StatusCode" } }, "traits": { "smithy.api#documentation": "List of status codes for origin failover.
", "smithy.api#length": { "min": 1 } } }, "com.amazonaws.cloudfront#StatusCodes": { "type": "structure", "members": { "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "The number of status codes.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#StatusCodeList", "traits": { "smithy.api#documentation": "The items (status codes) for an origin group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A complex data type for the status codes that you specify that, when returned by a primary origin, trigger\n\t\tCloudFront to failover to a second origin.
" } }, "com.amazonaws.cloudfront#StreamingDistribution": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for the RTMP distribution. For example: \n\t\t\tEGTXBD79EXAMPLE
.
The ARN (Amazon Resource Name) for the distribution. For example: \n\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5
, where \n\t\t\t123456789012
is your AWS account ID.
The current status of the RTMP distribution. When the status is Deployed
, \n\t\t\tthe distribution's information is propagated to all CloudFront edge locations.
The date and time that the distribution was last modified.
" } }, "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net
.
A complex type that lists the AWS accounts, if any, that you included in the \n\t\t\t\tTrustedSigners
complex type for this distribution. These are the accounts that \n\t\t\tyou want to allow to create signed URLs for private content.
The Signer
complex type lists the AWS account number of the trusted \n\t\t\tsigner or self
if the signer is the AWS account that created the distribution. \n\t\t\tThe Signer
element also includes the IDs of any active CloudFront key pairs that are \n\t\t\tassociated with the trusted signer's AWS account. If no KeyPairId
element \n\t\t\tappears for a Signer
, that signer can't create signed URLs.
For more information, see Serving Private \n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "StreamingDistributionConfig": { "target": "com.amazonaws.cloudfront#StreamingDistributionConfig", "traits": { "smithy.api#documentation": "The current configuration information for the RTMP distribution.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A streaming distribution tells CloudFront where you want RTMP content to be delivered from, and the details about how to \n\t\t\ttrack and manage content delivery.
" } }, "com.amazonaws.cloudfront#StreamingDistributionAlreadyExists": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The caller reference you attempted to create the streaming distribution with \n\t\t\tis associated with another distribution
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#StreamingDistributionConfig": { "type": "structure", "members": { "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "A unique value (for example, a date-time stamp) that ensures that the request can't be \n\t\t\treplayed.
\n\t\tIf the value of CallerReference
is new (regardless of the content of the \n\t\t\tStreamingDistributionConfig
object), CloudFront creates a new distribution.
If CallerReference
is a value that you already sent in a previous request to \n\t\t\tcreate a distribution, CloudFront returns a DistributionAlreadyExists
error.
A complex type that contains information about the Amazon S3 bucket from which you want \n\t\t\tCloudFront to get your media files for distribution.
", "smithy.api#required": {} } }, "Aliases": { "target": "com.amazonaws.cloudfront#Aliases", "traits": { "smithy.api#documentation": "A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this streaming distribution.
" } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "Any comments you want to include about the streaming distribution.
", "smithy.api#required": {} } }, "Logging": { "target": "com.amazonaws.cloudfront#StreamingLoggingConfig", "traits": { "smithy.api#documentation": "A complex type that controls whether access logs are written for the streaming \n\t\t\tdistribution.
" } }, "TrustedSigners": { "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { "smithy.api#documentation": "A complex type that specifies any AWS accounts that you want to permit to create signed \n\t\t\tURLs for private content. If you want the distribution to use signed URLs, include this \n\t\t\telement; if you want the distribution to use public URLs, remove this element. For more \n\t\t\tinformation, see Serving Private Content through \n\t\t\t\tCloudFront in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { "smithy.api#documentation": "A complex type that contains information about price class for this streaming \n\t\t\tdistribution.
" } }, "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "Whether the streaming distribution is enabled to accept user requests for \n\t\t\tcontent.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The RTMP distribution's configuration information.
" } }, "com.amazonaws.cloudfront#StreamingDistributionConfigWithTags": { "type": "structure", "members": { "StreamingDistributionConfig": { "target": "com.amazonaws.cloudfront#StreamingDistributionConfig", "traits": { "smithy.api#documentation": "A streaming distribution Configuration.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.cloudfront#Tags", "traits": { "smithy.api#documentation": "A complex type that contains zero or more Tag
elements.
A streaming distribution Configuration and a list of tags to be associated with the \n\t\t\tstreaming distribution.
" } }, "com.amazonaws.cloudfront#StreamingDistributionList": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value you provided for the Marker
request parameter.
If IsTruncated
is true
, this element is present and contains \n\t\t\tthe value you can use for the Marker
request parameter to continue listing your \n\t\t\tRTMP distributions where they left off.
The value you provided for the MaxItems
request parameter.
A flag that indicates whether more streaming distributions remain to be listed. If your \n\t\t\tresults were truncated, you can make a follow-up pagination request using the \n\t\t\t\tMarker
request parameter to retrieve more distributions in the list.
The number of streaming distributions that were created by the current AWS account. \n\t\t
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#StreamingDistributionSummaryList", "traits": { "smithy.api#documentation": "A complex type that contains one StreamingDistributionSummary
element for \n\t\t\teach distribution that was created by the current AWS account.
A streaming distribution list.
" } }, "com.amazonaws.cloudfront#StreamingDistributionNotDisabled": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified CloudFront distribution is not disabled. You must disable \n\t\t\tthe distribution before you can delete it.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.cloudfront#StreamingDistributionSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for the distribution, for example, EDFDVBD632BHDS5
.
The ARN (Amazon Resource Name) for the streaming distribution. For example: \n\t\t\t\tarn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5
, where \n\t\t\t\t123456789012
is your AWS account ID.
Indicates the current status of the distribution. When the status is \n\t\t\tDeployed
, the distribution's information is fully propagated throughout the \n\t\t\tAmazon CloudFront system.
The date and time the distribution was last modified.
", "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net
.
A complex type that contains information about the Amazon S3 bucket from which you want \n\t\t\tCloudFront to get your media files for distribution.
", "smithy.api#required": {} } }, "Aliases": { "target": "com.amazonaws.cloudfront#Aliases", "traits": { "smithy.api#documentation": "A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this streaming distribution.
", "smithy.api#required": {} } }, "TrustedSigners": { "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { "smithy.api#documentation": "A complex type that specifies the AWS accounts, if any, that you want to allow to \n\t\t\tcreate signed URLs for private content. If you want to require signed URLs in requests for \n\t\t\tobjects in the target origin that match the PathPattern
for this cache behavior, \n\t\t\tspecify true
for Enabled
, and specify the applicable values for \n\t\t\t\tQuantity
and Items
.If you don't want to require signed URLs in \n\t\t\trequests for objects that match PathPattern
, specify false
for \n\t\t\t\tEnabled
and 0
for Quantity
. Omit Items
. \n\t\t\tTo add, change, or remove one or more trusted signers, change Enabled
to \n\t\t\t\ttrue
(if it's currently false
), change Quantity
as \n\t\t\tapplicable, and specify all of the trusted signers that you want to include in the updated \n\t\t\tdistribution.
For more information, see Serving Private \n\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The comment originally specified when this distribution was created.
", "smithy.api#required": {} } }, "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { "smithy.api#documentation": "A complex type that contains information about price class for this streaming \n\t\t\tdistribution.
", "smithy.api#required": {} } }, "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "Whether the distribution is enabled to accept end user requests for content.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A summary of the information for a CloudFront streaming distribution.
" } }, "com.amazonaws.cloudfront#StreamingDistributionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#StreamingDistributionSummary", "traits": { "smithy.api#xmlName": "StreamingDistributionSummary" } } }, "com.amazonaws.cloudfront#StreamingLoggingConfig": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't \n\t\t\twant to enable logging when you create a streaming distribution or if you want to disable \n\t\t\tlogging for an existing streaming distribution, specify false
for \n\t\t\t\tEnabled
, and specify empty Bucket
and Prefix
\n\t\t\telements. If you specify false
for Enabled
but you specify values \n\t\t\tfor Bucket
and Prefix
, the values are automatically deleted. \n\t\t
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com
.
An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, \n\t\t\tmyprefix/
. If you want to enable logging, but you don't want to specify a prefix, you still must include \n\t\t\tan empty Prefix
element in the Logging
element.
A complex type that controls whether access logs are written for this streaming distribution.
" } }, "com.amazonaws.cloudfront#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.cloudfront#TagKey", "traits": { "smithy.api#documentation": " A string that contains Tag
key.
The string length should be between 1 and 128 characters. Valid characters include \n\t\t\t\ta-z
, A-Z
, 0-9
, space, and the special characters \n\t\t\t\t_ - . : / = + @
.
A string that contains an optional Tag
value.
The string length should be between 0 and 256 characters. Valid characters include \n\t\t\t\ta-z
, A-Z
, 0-9
, space, and the special characters \n\t\t\t\t_ - . : / = + @
.
A complex type that contains Tag
key and Tag
value.
A string that contains Tag
key.
The string length should be between 1 and 128 characters. Valid characters include \n\t\t\t\ta-z
, A-Z
, 0-9
, space, and the special characters \n\t\t\t\t_ - . : / = + @
.
A complex type that contains Tag
key elements.
A complex type that contains zero or more Tag
elements.
Add tags to a CloudFront resource.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/tagging?Operation=Tag", "code": 204 } } }, "com.amazonaws.cloudfront#TagResourceRequest": { "type": "structure", "members": { "Resource": { "target": "com.amazonaws.cloudfront#ResourceARN", "traits": { "smithy.api#documentation": "An ARN of a CloudFront resource.
", "smithy.api#httpQuery": "Resource", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.cloudfront#Tags", "traits": { "smithy.api#documentation": " A complex type that contains zero or more Tag
elements.
The request to add tags to a CloudFront resource.
" } }, "com.amazonaws.cloudfront#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.cloudfront#Tags": { "type": "structure", "members": { "Items": { "target": "com.amazonaws.cloudfront#TagList", "traits": { "smithy.api#documentation": " A complex type that contains Tag
elements.
A complex type that contains zero or more Tag
elements.
Tests a CloudFront function.
\n\t\tTo test a function, you provide an event object that represents an HTTP\n\t\t\trequest or response that your CloudFront distribution could receive in production. CloudFront runs\n\t\t\tthe function, passing it the event object that you provided, and returns the function’s\n\t\t\tresult (the modified event object) in the response. The response also contains function\n\t\t\tlogs and error messages, if any exist. For more information about testing functions, see\n\t\t\tTesting functions in the Amazon CloudFront Developer Guide.
\n\t\tTo test a function, you provide the function’s name and version (ETag
value)\n\t\t\talong with the event object. To get the function’s name and version, you can use\n\t\t\tListFunctions
and DescribeFunction
.
The CloudFront function failed.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.cloudfront#TestFunctionRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The name of the function that you are testing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version (ETag
value) of the function that you are testing, which\n\t\t\tyou can get using DescribeFunction
.
The stage of the function that you are testing, either DEVELOPMENT
or\n\t\t\tLIVE
.
The event object to test the function with. For more information about the structure of the\n\t\t\tevent object, see Testing functions in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#TestFunctionResult": { "type": "structure", "members": { "TestResult": { "target": "com.amazonaws.cloudfront#TestResult", "traits": { "smithy.api#documentation": "An object that represents the result of running the function with the provided event\n\t\t\tobject.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.cloudfront#TestResult": { "type": "structure", "members": { "FunctionSummary": { "target": "com.amazonaws.cloudfront#FunctionSummary", "traits": { "smithy.api#documentation": "Contains configuration information and metadata about the CloudFront function that was\n\t\t\ttested.
" } }, "ComputeUtilization": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The amount of time that the function took to run as a percentage of the maximum\n\t\t\tallowed time. For example, a compute utilization of 35 means that the function completed\n\t\t\tin 35% of the maximum allowed time.
" } }, "FunctionExecutionLogs": { "target": "com.amazonaws.cloudfront#FunctionExecutionLogList", "traits": { "smithy.api#documentation": "Contains the log lines that the function wrote (if any) when running the test.
" } }, "FunctionErrorMessage": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "If the result of testing the function was an error, this field contains the error\n\t\t\tmessage.
" } }, "FunctionOutput": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The event object returned by the function. For more information about the structure of the\n\t\t\tevent object, see Event object\n\t\t\tstructure in the Amazon CloudFront Developer Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains the result of testing a CloudFront function with TestFunction
.
You cannot create more cache behaviors for the distribution.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyCachePolicies": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You have reached the maximum number of cache policies for this AWS account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyCertificates": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You cannot create anymore custom SSL/TLS certificates.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyCloudFrontOriginAccessIdentities": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of origin access identities allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyCookieNamesInWhiteList": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Your request contains more cookie names in the whitelist than are allowed per cache behavior.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyCookiesInCachePolicy": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The number of cookies in the cache policy exceeds the maximum. For more information,\n\t\t\tsee Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyCookiesInOriginRequestPolicy": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The number of cookies in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyDistributionCNAMEs": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Your request contains more CNAMEs than are allowed per distribution.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyDistributions": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of distributions allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToCachePolicy": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum number of distributions have been associated with the specified cache\n\t\t\tpolicy. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToFieldLevelEncryptionConfig": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum number of distributions have been associated with the specified configuration for field-level encryption.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToKeyGroup": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The number of distributions that reference this key group is more than the maximum\n\t\t\tallowed. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginRequestPolicy": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum number of distributions have been associated with the specified origin\n\t\t\trequest policy. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyDistributionsWithFunctionAssociations": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You have reached the maximum number of distributions that are associated with a CloudFront\n\t\t\tfunction. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyDistributionsWithLambdaAssociations": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Processing your request would cause the maximum number of distributions with Lambda function associations per owner \n\t\t\tto be exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyDistributionsWithSingleFunctionARN": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum number of distributions have been associated with the specified Lambda\n\t\t\tfunction.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyFieldLevelEncryptionConfigs": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum number of configurations for field-level encryption have been created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyFieldLevelEncryptionContentTypeProfiles": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum number of content type profiles for field-level encryption have been created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyFieldLevelEncryptionEncryptionEntities": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum number of encryption entities for field-level encryption have been created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyFieldLevelEncryptionFieldPatterns": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum number of field patterns for field-level encryption have been created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyFieldLevelEncryptionProfiles": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum number of profiles for field-level encryption have been created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyFieldLevelEncryptionQueryArgProfiles": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum number of query arg profiles for field-level encryption have been created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyFunctionAssociations": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You have reached the maximum number of CloudFront function associations for this\n\t\t\tdistribution. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyFunctions": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You have reached the maximum number of CloudFront functions for this AWS account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyHeadersInCachePolicy": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The number of headers in the cache policy exceeds the maximum. For more information,\n\t\t\tsee Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyHeadersInForwardedValues": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Your request contains too many headers in forwarded values.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyHeadersInOriginRequestPolicy": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The number of headers in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyInvalidationsInProgress": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyKeyGroups": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You have reached the maximum number of key groups for this AWS account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyKeyGroupsAssociatedToDistribution": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The number of key groups referenced by this distribution is more than the maximum\n\t\t\tallowed. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyLambdaFunctionAssociations": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Your request contains more Lambda function associations than are allowed per distribution.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyOriginCustomHeaders": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Your request contains too many origin custom headers.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyOriginGroupsPerDistribution": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of origin groups allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyOriginRequestPolicies": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You have reached the maximum number of origin request policies for this AWS account.\n\t\t\tFor more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyOrigins": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You cannot create more origins for the distribution.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyPublicKeys": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The maximum number of public keys for field-level encryption have been created. To create a new public key, delete one of the existing keys.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyPublicKeysInKeyGroup": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The number of public keys in this key group is more than the maximum allowed. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyQueryStringParameters": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Your request contains too many query string parameters.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyQueryStringsInCachePolicy": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The number of query strings in the cache policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyQueryStringsInOriginRequestPolicy": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The number of query strings in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyRealtimeLogConfigs": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "You have reached the maximum number of real-time log configurations for this AWS account.\n\t\t\tFor more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyStreamingDistributionCNAMEs": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Your request contains more CNAMEs than are allowed per distribution.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyStreamingDistributions": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of streaming distributions allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TooManyTrustedSigners": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "Your request contains more trusted signers than are allowed per distribution.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TrustedKeyGroupDoesNotExist": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "The specified key group does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TrustedKeyGroupIdList": { "type": "list", "member": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#xmlName": "KeyGroup" } } }, "com.amazonaws.cloudfront#TrustedKeyGroups": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "This field is true
if any of the key groups in the list have public keys that\n\t\t\tCloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this\n\t\t\tfield is false
.
The number of key groups in the list.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#TrustedKeyGroupIdList", "traits": { "smithy.api#documentation": "A list of key groups identifiers.
" } } }, "traits": { "smithy.api#documentation": "A list of key groups whose public keys CloudFront can use to verify the signatures of signed\n\t\t\tURLs and signed cookies.
" } }, "com.amazonaws.cloudfront#TrustedSignerDoesNotExist": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "One or more of your trusted signers don't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#TrustedSigners": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "This field is true
if any of the AWS accounts have public keys that CloudFront can\n\t\t\tuse to verify the signatures of signed URLs and signed cookies. If not, this field is\n\t\t\tfalse
.
The number of AWS accounts in the list.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#AwsAccountNumberList", "traits": { "smithy.api#documentation": "A list of AWS account identifiers.
" } } }, "traits": { "smithy.api#documentation": "A list of AWS accounts whose public keys CloudFront can use to verify the signatures of signed\n\t\t\tURLs and signed cookies.
" } }, "com.amazonaws.cloudfront#UnsupportedOperation": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudfront#string" } }, "traits": { "smithy.api#documentation": "This operation is not supported in this region.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudfront#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#UntagResourceRequest" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidTagging" }, { "target": "com.amazonaws.cloudfront#NoSuchResource" } ], "traits": { "smithy.api#documentation": "Remove tags from a CloudFront resource.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/tagging?Operation=Untag", "code": 204 } } }, "com.amazonaws.cloudfront#UntagResourceRequest": { "type": "structure", "members": { "Resource": { "target": "com.amazonaws.cloudfront#ResourceARN", "traits": { "smithy.api#documentation": "An ARN of a CloudFront resource.
", "smithy.api#httpQuery": "Resource", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.cloudfront#TagKeys", "traits": { "smithy.api#documentation": " A complex type that contains zero or more Tag
key elements.
The request to remove tags from a CloudFront resource.
" } }, "com.amazonaws.cloudfront#UpdateCachePolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#UpdateCachePolicyRequest" }, "output": { "target": "com.amazonaws.cloudfront#UpdateCachePolicyResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#CachePolicyAlreadyExists" }, { "target": "com.amazonaws.cloudfront#IllegalUpdate" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#NoSuchCachePolicy" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" }, { "target": "com.amazonaws.cloudfront#TooManyCookiesInCachePolicy" }, { "target": "com.amazonaws.cloudfront#TooManyHeadersInCachePolicy" }, { "target": "com.amazonaws.cloudfront#TooManyQueryStringsInCachePolicy" } ], "traits": { "smithy.api#documentation": "Updates a cache policy configuration.
\n\t\tWhen you update a cache policy configuration, all the fields are updated with the\n\t\t\tvalues provided in the request. You cannot update some fields independent of others. To\n\t\t\tupdate a cache policy configuration:
\n\t\tUse GetCachePolicyConfig
to get the current configuration.
Locally modify the fields in the cache policy configuration that you want to\n\t\t\t\t\tupdate.
\n\t\t\tCall UpdateCachePolicy
by providing the entire cache policy\n\t\t\t\t\tconfiguration, including the fields that you modified and those that you\n\t\t\t\t\tdidn’t.
The unique identifier for the cache policy that you are updating. The identifier is returned\n\t\t\tin a cache behavior’s CachePolicyId
field in the response to\n\t\t\tGetDistributionConfig
.
The version of the cache policy that you are updating. The version is returned in the cache\n\t\t\tpolicy’s ETag
field in the response to\n\t\t\tGetCachePolicyConfig
.
A cache policy configuration.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "CachePolicyConfig" } } } }, "com.amazonaws.cloudfront#UpdateCachePolicyResult": { "type": "structure", "members": { "CachePolicy": { "target": "com.amazonaws.cloudfront#CachePolicy", "traits": { "smithy.api#documentation": "A cache policy.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the cache policy.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#UpdateCloudFrontOriginAccessIdentity": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#UpdateCloudFrontOriginAccessIdentityRequest" }, "output": { "target": "com.amazonaws.cloudfront#UpdateCloudFrontOriginAccessIdentityResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#IllegalUpdate" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#MissingBody" }, { "target": "com.amazonaws.cloudfront#NoSuchCloudFrontOriginAccessIdentity" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" } ], "traits": { "smithy.api#documentation": "Update an origin access identity.
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}/config", "code": 200 } } }, "com.amazonaws.cloudfront#UpdateCloudFrontOriginAccessIdentityRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identity's id.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when retrieving the \n\t\t\tidentity's configuration. For example: E2QWRUHAPOMQZL
.
The identity's configuration information.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "CloudFrontOriginAccessIdentityConfig" } } }, "traits": { "smithy.api#documentation": "The request to update an origin access identity.
" } }, "com.amazonaws.cloudfront#UpdateCloudFrontOriginAccessIdentityResult": { "type": "structure", "members": { "CloudFrontOriginAccessIdentity": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentity", "traits": { "smithy.api#documentation": "The origin access identity's information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL
.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#UpdateDistribution": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#UpdateDistributionRequest" }, "output": { "target": "com.amazonaws.cloudfront#UpdateDistributionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" }, { "target": "com.amazonaws.cloudfront#IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior" }, { "target": "com.amazonaws.cloudfront#IllegalUpdate" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidDefaultRootObject" }, { "target": "com.amazonaws.cloudfront#InvalidErrorCode" }, { "target": "com.amazonaws.cloudfront#InvalidForwardCookies" }, { "target": "com.amazonaws.cloudfront#InvalidFunctionAssociation" }, { "target": "com.amazonaws.cloudfront#InvalidGeoRestrictionParameter" }, { "target": "com.amazonaws.cloudfront#InvalidHeadersForS3Origin" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#InvalidLambdaFunctionAssociation" }, { "target": "com.amazonaws.cloudfront#InvalidLocationCode" }, { "target": "com.amazonaws.cloudfront#InvalidMinimumProtocolVersion" }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, { "target": "com.amazonaws.cloudfront#InvalidOriginKeepaliveTimeout" }, { "target": "com.amazonaws.cloudfront#InvalidOriginReadTimeout" }, { "target": "com.amazonaws.cloudfront#InvalidQueryStringParameters" }, { "target": "com.amazonaws.cloudfront#InvalidRelativePath" }, { "target": "com.amazonaws.cloudfront#InvalidRequiredProtocol" }, { "target": "com.amazonaws.cloudfront#InvalidResponseCode" }, { "target": "com.amazonaws.cloudfront#InvalidTTLOrder" }, { "target": "com.amazonaws.cloudfront#InvalidViewerCertificate" }, { "target": "com.amazonaws.cloudfront#InvalidWebACLId" }, { "target": "com.amazonaws.cloudfront#MissingBody" }, { "target": "com.amazonaws.cloudfront#NoSuchCachePolicy" }, { "target": "com.amazonaws.cloudfront#NoSuchDistribution" }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#NoSuchOrigin" }, { "target": "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" }, { "target": "com.amazonaws.cloudfront#RealtimeLogConfigOwnerMismatch" }, { "target": "com.amazonaws.cloudfront#TooManyCacheBehaviors" }, { "target": "com.amazonaws.cloudfront#TooManyCertificates" }, { "target": "com.amazonaws.cloudfront#TooManyCookieNamesInWhiteList" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionCNAMEs" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToCachePolicy" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToKeyGroup" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsWithFunctionAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsWithLambdaAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsWithSingleFunctionARN" }, { "target": "com.amazonaws.cloudfront#TooManyFunctionAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyHeadersInForwardedValues" }, { "target": "com.amazonaws.cloudfront#TooManyKeyGroupsAssociatedToDistribution" }, { "target": "com.amazonaws.cloudfront#TooManyLambdaFunctionAssociations" }, { "target": "com.amazonaws.cloudfront#TooManyOriginCustomHeaders" }, { "target": "com.amazonaws.cloudfront#TooManyOriginGroupsPerDistribution" }, { "target": "com.amazonaws.cloudfront#TooManyOrigins" }, { "target": "com.amazonaws.cloudfront#TooManyQueryStringParameters" }, { "target": "com.amazonaws.cloudfront#TooManyTrustedSigners" }, { "target": "com.amazonaws.cloudfront#TrustedKeyGroupDoesNotExist" }, { "target": "com.amazonaws.cloudfront#TrustedSignerDoesNotExist" } ], "traits": { "smithy.api#documentation": "Updates the configuration for a web distribution.
\n\t\tWhen you update a distribution, there are more required fields than when you create a distribution.\n\t\t\tWhen you update your distribution by using this API action, follow the steps here to get the current configuration\n\t\t\tand then make your updates, to make sure that you include all of the required fields. To view a summary,\n\t\t\tsee Required \n\t\t\t\tFields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
\nThe update process includes getting the current distribution configuration, updating the XML document that is \n\t\t\treturned to make your changes, and then submitting an UpdateDistribution
request to make the updates.
For information about updating a distribution using the CloudFront console instead, see \n\t\t\tCreating a \n\t\t\t\tDistribution in the Amazon CloudFront Developer Guide.
\n\t\t \n\t\t\n To update a web distribution using the CloudFront API\n
\n\t\tSubmit a \n\t\t\t\tGetDistributionConfig\n\t\t\t\trequest to get the current configuration and an Etag
header \n\t\t\t\tfor the distribution.
If you update the distribution again, you must get a new Etag
header.
Update the XML document that was returned in the response to your GetDistributionConfig
request to include \n\t\t\t\tyour changes.
When you edit the XML file, be aware of the following:
\n\t\t\t\t\tYou must strip out the ETag parameter that is returned.
\nAdditional fields are required when you update a distribution. There may be fields included in the \n\t\t\t\t\t\t\tXML file for features that you haven't configured for your distribution. This is expected and required to\n\t\t\t\t\t\t\tsuccessfully update the distribution.
\nYou can't change the value of CallerReference
. If you try to change this value, CloudFront returns an \n\t\t\t\t\t\t\tIllegalUpdate
error.
The new configuration replaces the existing configuration; the values that you specify in an \n\t\t\t\t\t\t\tUpdateDistribution
request are not merged into your existing configuration. When you add, delete, or \n\t\t\t\t\t\t\treplace values in an element that allows multiple values (for example, CNAME
), you must specify all of the \n\t\t\t\t\t\t\tvalues that you want to appear in the updated distribution. In addition, \n\t\t\t\t\t\t\tyou must update the corresponding Quantity
element.
Submit an UpdateDistribution
request to update the configuration for your distribution:
In the request body, include the XML document that you updated in Step 2. The request body must include an \n\t\t\t\t\t\tXML document with a DistributionConfig
element.
Set the value of the HTTP If-Match
header to the value of the ETag
header that CloudFront returned \n\t\t\t\t\t\twhen you submitted the GetDistributionConfig
request in Step 1.
Review the response to the UpdateDistribution
request to confirm that the configuration was \n\t\t\t\tsuccessfully updated.
Optional: Submit a \n\t\t\t\tGetDistribution\n\t\t\t\trequest to confirm that your changes have propagated. \n\t\t\t\tWhen propagation is complete, the value of Status
is Deployed
.
The distribution's id.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when retrieving the \n\t\t\tdistribution's configuration. For example: E2QWRUHAPOMQZL
.
The distribution's configuration information.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "DistributionConfig" } } }, "traits": { "smithy.api#documentation": "The request to update a distribution.
" } }, "com.amazonaws.cloudfront#UpdateDistributionResult": { "type": "structure", "members": { "Distribution": { "target": "com.amazonaws.cloudfront#Distribution", "traits": { "smithy.api#documentation": "The distribution's information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL
.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#IllegalUpdate" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig" }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionProfile" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" }, { "target": "com.amazonaws.cloudfront#QueryArgProfileEmpty" }, { "target": "com.amazonaws.cloudfront#TooManyFieldLevelEncryptionContentTypeProfiles" }, { "target": "com.amazonaws.cloudfront#TooManyFieldLevelEncryptionQueryArgProfiles" } ], "traits": { "smithy.api#documentation": "Update a field-level encryption configuration.
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/field-level-encryption/{Id}/config", "code": 200 } } }, "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfigRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID of the configuration you want to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when retrieving the configuration identity to update. \n\t\t\tFor example: E2QWRUHAPOMQZL
.
Request to update a field-level encryption configuration.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "FieldLevelEncryptionConfig" } } } }, "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfigResult": { "type": "structure", "members": { "FieldLevelEncryption": { "target": "com.amazonaws.cloudfront#FieldLevelEncryption", "traits": { "smithy.api#documentation": "Return the results of updating the configuration.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when updating the configuration. \n\t\t\tFor example: E2QWRUHAPOMQZL
.
Update a field-level encryption profile.
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/field-level-encryption-profile/{Id}/config", "code": 200 } } }, "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionProfileRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The ID of the field-level encryption profile request.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when retrieving the profile identity to update. \n\t\t\tFor example: E2QWRUHAPOMQZL
.
Request to update a field-level encryption profile.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "FieldLevelEncryptionProfileConfig" } } } }, "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionProfileResult": { "type": "structure", "members": { "FieldLevelEncryptionProfile": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfile", "traits": { "smithy.api#documentation": "Return the results of updating the profile.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The result of the field-level encryption profile request.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#UpdateFunction": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#UpdateFunctionRequest" }, "output": { "target": "com.amazonaws.cloudfront#UpdateFunctionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#FunctionSizeLimitExceeded" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#NoSuchFunctionExists" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" } ], "traits": { "smithy.api#documentation": "Updates a CloudFront function.
\n\t\tYou can update a function’s code or the comment that describes the function. You\n\t\t\tcannot update a function’s name.
\n\t\tTo update a function, you provide the function’s name and version (ETag
value)\n\t\t\talong with the updated function code. To get the name and version, you can use\n\t\t\tListFunctions
and DescribeFunction
.
The name of the function that you are updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version (ETag
value) of the function that you are updating, which\n\t\t\tyou can get using DescribeFunction
.
Configuration information about the function.
", "smithy.api#required": {} } }, "FunctionCode": { "target": "com.amazonaws.cloudfront#FunctionBlob", "traits": { "smithy.api#documentation": "The function code. For more information about writing a CloudFront function, see Writing function\n\t\t\tcode for CloudFront Functions in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudfront#UpdateFunctionResult": { "type": "structure", "members": { "FunctionSummary": { "target": "com.amazonaws.cloudfront#FunctionSummary", "traits": { "smithy.api#documentation": "Contains configuration information and metadata about a CloudFront function.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The version identifier for the current version of the CloudFront function.
", "smithy.api#httpHeader": "ETtag" } } } }, "com.amazonaws.cloudfront#UpdateKeyGroup": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#UpdateKeyGroupRequest" }, "output": { "target": "com.amazonaws.cloudfront#UpdateKeyGroupResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#KeyGroupAlreadyExists" }, { "target": "com.amazonaws.cloudfront#NoSuchResource" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" }, { "target": "com.amazonaws.cloudfront#TooManyPublicKeysInKeyGroup" } ], "traits": { "smithy.api#documentation": "Updates a key group.
\n\t\tWhen you update a key group, all the fields are updated with the values provided in\n\t\t\tthe request. You cannot update some fields independent of others. To update a key\n\t\t\tgroup:
\n\t\tGet the current key group with GetKeyGroup
or\n\t\t\t\t\tGetKeyGroupConfig
.
Locally modify the fields in the key group that you want to update. For\n\t\t\t\t\texample, add or remove public key IDs.
\n\t\t\tCall UpdateKeyGroup
with the entire key group object, including\n\t\t\t\t\tthe fields that you modified and those that you didn’t.
The identifier of the key group that you are updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The version of the key group that you are updating. The version is the key group’s\n\t\t\tETag
value.
The key group configuration.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "KeyGroupConfig" } } } }, "com.amazonaws.cloudfront#UpdateKeyGroupResult": { "type": "structure", "members": { "KeyGroup": { "target": "com.amazonaws.cloudfront#KeyGroup", "traits": { "smithy.api#documentation": "The key group that was just updated.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier for this version of the key group.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#UpdateOriginRequestPolicy": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#UpdateOriginRequestPolicyRequest" }, "output": { "target": "com.amazonaws.cloudfront#UpdateOriginRequestPolicyResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#IllegalUpdate" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#OriginRequestPolicyAlreadyExists" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" }, { "target": "com.amazonaws.cloudfront#TooManyCookiesInOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#TooManyHeadersInOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#TooManyQueryStringsInOriginRequestPolicy" } ], "traits": { "smithy.api#documentation": "Updates an origin request policy configuration.
\n\t\tWhen you update an origin request policy configuration, all the fields are updated\n\t\t\twith the values provided in the request. You cannot update some fields independent of\n\t\t\tothers. To update an origin request policy configuration:
\n\t\tUse GetOriginRequestPolicyConfig
to get the current configuration.
Locally modify the fields in the origin request policy configuration that you\n\t\t\t\t\twant to update.
\n\t\t\tCall UpdateOriginRequestPolicy
by providing the entire origin\n\t\t\t\t\trequest policy configuration, including the fields that you modified and those\n\t\t\t\t\tthat you didn’t.
The unique identifier for the origin request policy that you are updating. The identifier is\n\t\t\treturned in a cache behavior’s OriginRequestPolicyId
field in the response\n\t\t\tto GetDistributionConfig
.
The version of the origin request policy that you are updating. The version is returned in\n\t\t\tthe origin request policy’s ETag
field in the response to\n\t\t\tGetOriginRequestPolicyConfig
.
An origin request policy configuration.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "OriginRequestPolicyConfig" } } } }, "com.amazonaws.cloudfront#UpdateOriginRequestPolicyResult": { "type": "structure", "members": { "OriginRequestPolicy": { "target": "com.amazonaws.cloudfront#OriginRequestPolicy", "traits": { "smithy.api#documentation": "An origin request policy.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the origin request policy.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#UpdatePublicKey": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#UpdatePublicKeyRequest" }, "output": { "target": "com.amazonaws.cloudfront#UpdatePublicKeyResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#CannotChangeImmutablePublicKeyFields" }, { "target": "com.amazonaws.cloudfront#IllegalUpdate" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#NoSuchPublicKey" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" } ], "traits": { "smithy.api#documentation": "Update public key information. Note that the only value you can change is the comment.
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/public-key/{Id}/config", "code": 200 } } }, "com.amazonaws.cloudfront#UpdatePublicKeyRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier of the public key that you are updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when retrieving the public key to update. \n\t\t\tFor example: E2QWRUHAPOMQZL
.
A public key configuration.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "PublicKeyConfig" } } } }, "com.amazonaws.cloudfront#UpdatePublicKeyResult": { "type": "structure", "members": { "PublicKey": { "target": "com.amazonaws.cloudfront#PublicKey", "traits": { "smithy.api#documentation": "The public key.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The identifier of the current version of the public key.
", "smithy.api#httpHeader": "ETag" } } } }, "com.amazonaws.cloudfront#UpdateRealtimeLogConfig": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#UpdateRealtimeLogConfigRequest" }, "output": { "target": "com.amazonaws.cloudfront#UpdateRealtimeLogConfigResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig" } ], "traits": { "smithy.api#documentation": "Updates a real-time log configuration.
\n\t\tWhen you update a real-time log configuration, all the parameters are updated with the\n\t\t\tvalues provided in the request. You cannot update some parameters independent of others.\n\t\t\tTo update a real-time log configuration:
\n\t\tCall GetRealtimeLogConfig
to get the current real-time log\n\t\t\t\t\tconfiguration.
Locally modify the parameters in the real-time log configuration that you want\n\t\t\t\t\tto update.
\n\t\t\tCall this API (UpdateRealtimeLogConfig
) by providing the entire\n\t\t\t\t\treal-time log configuration, including the parameters that you modified and\n\t\t\t\t\tthose that you didn’t.
You cannot update a real-time log configuration’s Name
or\n\t\t\tARN
.
Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data.
" } }, "Fields": { "target": "com.amazonaws.cloudfront#FieldList", "traits": { "smithy.api#documentation": "A list of fields to include in each real-time log record.
\n\t\tFor more information about fields, see Real-time log configuration fields in the\n\t\t\tAmazon CloudFront Developer Guide.
" } }, "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The name for this real-time log configuration.
" } }, "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for this real-time log configuration.
" } }, "SamplingRate": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#documentation": "The sampling rate for this real-time log configuration. The sampling rate determines the\n\t\t\tpercentage of viewer requests that are represented in the real-time log data. You must\n\t\t\tprovide an integer between 1 and 100, inclusive.
" } } } }, "com.amazonaws.cloudfront#UpdateRealtimeLogConfigResult": { "type": "structure", "members": { "RealtimeLogConfig": { "target": "com.amazonaws.cloudfront#RealtimeLogConfig", "traits": { "smithy.api#documentation": "A real-time log configuration.
" } } } }, "com.amazonaws.cloudfront#UpdateStreamingDistribution": { "type": "operation", "input": { "target": "com.amazonaws.cloudfront#UpdateStreamingDistributionRequest" }, "output": { "target": "com.amazonaws.cloudfront#UpdateStreamingDistributionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" }, { "target": "com.amazonaws.cloudfront#IllegalUpdate" }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" }, { "target": "com.amazonaws.cloudfront#MissingBody" }, { "target": "com.amazonaws.cloudfront#NoSuchStreamingDistribution" }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" }, { "target": "com.amazonaws.cloudfront#TooManyStreamingDistributionCNAMEs" }, { "target": "com.amazonaws.cloudfront#TooManyTrustedSigners" }, { "target": "com.amazonaws.cloudfront#TrustedSignerDoesNotExist" } ], "traits": { "smithy.api#documentation": "Update a streaming distribution.
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/streaming-distribution/{Id}/config", "code": 200 } } }, "com.amazonaws.cloudfront#UpdateStreamingDistributionRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The streaming distribution's id.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The value of the ETag
header that you received when retrieving the \n\t\t\tstreaming distribution's configuration. For example: E2QWRUHAPOMQZL
.
The streaming distribution's configuration information.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "StreamingDistributionConfig" } } }, "traits": { "smithy.api#documentation": "The request to update a streaming distribution.
" } }, "com.amazonaws.cloudfront#UpdateStreamingDistributionResult": { "type": "structure", "members": { "StreamingDistribution": { "target": "com.amazonaws.cloudfront#StreamingDistribution", "traits": { "smithy.api#documentation": "The streaming distribution's information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL
.
The returned result of the corresponding request.
" } }, "com.amazonaws.cloudfront#ViewerCertificate": { "type": "structure", "members": { "CloudFrontDefaultCertificate": { "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net
, set this field to true
.
If the distribution uses Aliases
(alternate domain names or CNAMEs), set\n\t\t\tthis field to false
and specify values for the following fields:
\n ACMCertificateArn
or IAMCertificateId
(specify a value for one,\n\t\t\t\t\tnot both)
\n MinimumProtocolVersion
\n
\n SSLSupportMethod
\n \n
If the distribution uses Aliases
(alternate domain names or CNAMEs) and\n\t\t\tthe SSL/TLS certificate is stored in AWS\n\t\t\tIdentity and Access Management (AWS IAM), provide the ID of the IAM\n\t\t\tcertificate.
If you specify an IAM certificate ID, you must also specify values for\n\t\t\tMinimumProtocolVersion
and SSLSupportMethod
. \n
If the distribution uses Aliases
(alternate domain names or CNAMEs) and\n\t\t\tthe SSL/TLS certificate is stored in AWS Certificate Manager (ACM), provide the Amazon Resource\n\t\t\tName (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US\n\t\t\tEast (N. Virginia) Region (us-east-1
).
If you specify an ACM certificate ARN, you must also specify values for\n\t\t\tMinimumProtocolVersion
and SSLSupportMethod
.\n
If the distribution uses Aliases
(alternate domain names or CNAMEs), specify\n\t\t\twhich viewers the distribution accepts HTTPS connections from.
\n sni-only
– The distribution accepts HTTPS connections from only viewers that\n\t\t\t\t\tsupport server\n\t\t\t\t\tname indication (SNI). This is recommended. Most browsers and clients support SNI.
\n vip
– The distribution accepts HTTPS connections from all viewers including\n\t\t\t\t\tthose that don’t support SNI. This is not recommended, and results in additional\n\t\t\t\t\tmonthly charges from CloudFront.
\n static-ip
- Do not specify this value unless your distribution\n\t\t\t\t\thas been enabled for this feature by the CloudFront team. If you have a use case\n\t\t\t\t\tthat requires static IP addresses for a distribution, contact CloudFront through\n\t\t\t\t\tthe AWS Support Center.
If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net
, don’t set a value for this field.
If the distribution uses Aliases
(alternate domain names or CNAMEs),\n\t\t\tspecify the security policy that you want CloudFront to use for HTTPS connections with\n\t\t\tviewers. The security policy determines two settings:
The minimum SSL/TLS protocol that CloudFront can use to communicate with\n\t\t\t\t\tviewers.
\n\t\t\tThe ciphers that CloudFront can use to encrypt the content that it returns to\n\t\t\t\t\tviewers.
\n\t\t\tFor more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and\n\t\t\tCloudFront in the Amazon CloudFront Developer Guide.
\n\t\tOn the CloudFront console, this setting is called Security\n\t\t\t\tPolicy.
\n\t\tWhen you’re using SNI only (you set SSLSupportMethod
to sni-only
),\n\t\t\tyou must specify TLSv1
or higher.\n
If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net
(you set\n\t\t\tCloudFrontDefaultCertificate
to true
), CloudFront automatically sets\n\t\t\tthe security policy to TLSv1
regardless of the value that you set\n\t\t\there.
This field is deprecated. Use one of the following fields instead:
\n\t\t\n ACMCertificateArn
\n \n
\n IAMCertificateId
\n \n
\n CloudFrontDefaultCertificate
\n
This field is deprecated. Use one of the following fields instead:
\n\t\t\n ACMCertificateArn
\n \n
\n IAMCertificateId
\n \n
\n CloudFrontDefaultCertificate
\n
A complex type that determines the distribution’s SSL/TLS configuration for communicating\n\t\t\twith viewers.
\n\t\tIf the distribution doesn’t use Aliases
(also known as alternate domain\n\t\t\tnames or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net
—set CloudFrontDefaultCertificate
\n\t\t\tto true
and leave all other fields empty.
If the distribution uses Aliases
(alternate domain names or CNAMEs), use\n\t\t\tthe fields in this type to specify the following settings:
Which viewers the distribution accepts HTTPS connections from: only viewers that support\n\t\t\t\t\tserver name\n\t\t\t\t\tindication (SNI) (recommended), or all viewers including those that\n\t\t\t\t\tdon’t support SNI.
\n\t\t\t\tTo accept HTTPS connections from only viewers that support SNI, set\n\t\t\t\t\t\t\tSSLSupportMethod
to sni-only
. This is\n\t\t\t\t\t\t\trecommended. Most browsers and clients support\n SNI.\n \n
To accept HTTPS connections from all viewers, including those that don’t support SNI,\n\t\t\t\t\t\t\tset SSLSupportMethod
to vip
. This is not\n\t\t\t\t\t\t\trecommended, and results in additional monthly charges from\n\t\t\t\t\t\t\tCloudFront.\n
The minimum SSL/TLS protocol version that the distribution can use to\n\t\t\t\t\tcommunicate with viewers. To specify a minimum version, choose a value for\n\t\t\t\t\tMinimumProtocolVersion
. For more information, see Security Policy in the\n\t\t\t\t\tAmazon CloudFront Developer Guide.
The location of the SSL/TLS certificate, AWS\n\t\t\t\t\tCertificate Manager (ACM) (recommended) or AWS Identity and Access Management (AWS IAM). You specify the location\n\t\t\t\t\tby setting a value in one of the following fields (not both):
\n\t\t\t\t\n ACMCertificateArn
\n \n
\n IAMCertificateId
\n \n
All distributions support HTTPS connections from viewers. To require viewers to use\n\t\t\tHTTPS only, or to redirect them from HTTP to HTTPS, use\n\t\t\tViewerProtocolPolicy
in the CacheBehavior
or\n\t\t\tDefaultCacheBehavior
. To specify how CloudFront should use SSL/TLS to\n\t\t\tcommunicate with your custom origin, use CustomOriginConfig
.
For more information, see Using\n\t\t\tHTTPS with CloudFront and \n\t\t\tUsing Alternate Domain Names and HTTPS in the\n\t\t\tAmazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#ViewerProtocolPolicy": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "allow-all", "name": "allow_all" }, { "value": "https-only", "name": "https_only" }, { "value": "redirect-to-https", "name": "redirect_to_https" } ] } }, "com.amazonaws.cloudfront#boolean": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.cloudfront#integer": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.cloudfront#long": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.cloudfront#string": { "type": "string" }, "com.amazonaws.cloudfront#timestamp": { "type": "timestamp" } } }