Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).
The maximum number of distributions you want in the response body.
", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your distributions.
" }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type.
The returned result of the corresponding request.
", "payload":"DistributionList" }, "ListFieldLevelEncryptionConfigsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker 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.
", "location":"querystring", "locationName":"MaxItems" } } }, "ListFieldLevelEncryptionConfigsResult":{ "type":"structure", "members":{ "FieldLevelEncryptionList":{ "shape":"FieldLevelEncryptionList", "documentation":"Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.
" } }, "payload":"FieldLevelEncryptionList" }, "ListFieldLevelEncryptionProfilesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker 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.
", "location":"querystring", "locationName":"MaxItems" } } }, "ListFieldLevelEncryptionProfilesResult":{ "type":"structure", "members":{ "FieldLevelEncryptionProfileList":{ "shape":"FieldLevelEncryptionProfileList", "documentation":"Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.
" } }, "payload":"FieldLevelEncryptionProfileList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's ID.
", "location":"uri", "locationName":"DistributionId" }, "Marker":{ "shape":"string", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.
The maximum number of invalidation batches that you want in the response body.
", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list invalidations.
" }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches.
" } }, "documentation":"The returned result of the corresponding request.
", "payload":"InvalidationList" }, "ListPublicKeysRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "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 occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker 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.
", "location":"querystring", "locationName":"MaxItems" } } }, "ListPublicKeysResult":{ "type":"structure", "members":{ "PublicKeyList":{ "shape":"PublicKeyList", "documentation":"Returns a list of all public keys that have been added to CloudFront for this account.
" } }, "payload":"PublicKeyList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "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.
" }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type.
The returned result of the corresponding request.
", "payload":"StreamingDistributionList" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["Resource"], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"An ARN of a CloudFront resource.
", "location":"querystring", "locationName":"Resource" } }, "documentation":"The request to list tags for a CloudFront resource.
" }, "ListTagsForResourceResult":{ "type":"structure", "required":["Tags"], "members":{ "Tags":{ "shape":"Tags", "documentation":" A complex type that contains zero or more Tag elements.
The returned result of the corresponding request.
", "payload":"Tags" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.
Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.
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 distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A complex type that controls whether access logs are written for the distribution.
" }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.
The specified origin access identity does not exist.
", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified distribution does not exist.
", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchFieldLevelEncryptionConfig":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified configuration for field-level encryption doesn't exist.
", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchFieldLevelEncryptionProfile":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified profile for field-level encryption doesn't exist.
", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified invalidation does not exist.
", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"No origin exists with the specified Origin Id.
The specified public key doesn't exist.
", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchResource":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified streaming distribution does not exist.
", "error":{"httpStatusCode":404}, "exception":true }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution.
When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.
Constraints for Amazon S3 origins:
If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.
The bucket name must be between 3 and 63 characters long (inclusive).
The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.
The bucket name must not contain adjacent periods.
Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.
Constraints for custom origins:
DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.
The name cannot exceed 128 characters.
An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name.
For example, suppose you've specified the following values for your distribution:
DomainName: An Amazon S3 bucket named myawsbucket.
OriginPath: /production
CNAME: example.com
When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.
When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.
A complex type that contains names and values for the custom headers that you want.
" }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.
A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.
A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.
For the current limit on the number of origins that you can create for a distribution, see Amazon CloudFront Limits in the AWS General Reference.
" }, "OriginCustomHeader":{ "type":"structure", "required":[ "HeaderName", "HeaderValue" ], "members":{ "HeaderName":{ "shape":"string", "documentation":"The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.
" }, "HeaderValue":{ "shape":"string", "documentation":"The value for the header that you specified in the HeaderName field.
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
" }, "Items":{ "shape":"SslProtocolsList", "documentation":"A list that contains allowed SSL/TLS protocols for this distribution.
" } }, "documentation":"A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.
" }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution.
" }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution.
" } }, "documentation":"A complex type that contains information about origins for this distribution.
" }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate.
" }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the paths that you want to invalidate.
" } }, "documentation":"A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.
" }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The precondition given in one or more of the request-header fields evaluated to false.
A unique ID assigned to a public key you've added to CloudFront.
" }, "CreatedTime":{ "shape":"timestamp", "documentation":"A time you added a public key to CloudFront.
" }, "PublicKeyConfig":{ "shape":"PublicKeyConfig", "documentation":"A complex data type for a public key you add to CloudFront to use with features like field-level encryption.
" } }, "documentation":"A complex data type of public keys you add to CloudFront to use with features like field-level encryption.
" }, "PublicKeyAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified public key already exists.
", "error":{"httpStatusCode":409}, "exception":true }, "PublicKeyConfig":{ "type":"structure", "required":[ "CallerReference", "Name", "EncodedKey" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed.
" }, "Name":{ "shape":"string", "documentation":"The name for a public key you add to CloudFront to use with features like field-level encryption.
" }, "EncodedKey":{ "shape":"string", "documentation":"The encoded public key that you want to add to CloudFront to use with features like field-level encryption.
" }, "Comment":{ "shape":"string", "documentation":"An optional comment about a public key.
" } }, "documentation":"Information about a public key you add to CloudFront to use with features like field-level encryption.
" }, "PublicKeyInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified public key is in use.
", "error":{"httpStatusCode":409}, "exception":true }, "PublicKeyList":{ "type":"structure", "required":[ "MaxItems", "Quantity" ], "members":{ "NextMarker":{ "shape":"string", "documentation":"If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your public keys where you left off.
The maximum number of public keys you want in the response body.
" }, "Quantity":{ "shape":"integer", "documentation":"The number of public keys you added to CloudFront to use with features like field-level encryption.
" }, "Items":{ "shape":"PublicKeySummaryList", "documentation":"An array of information about a public key you add to CloudFront to use with features like field-level encryption.
" } }, "documentation":"A list of public keys you've added to CloudFront to use with features like field-level encryption.
" }, "PublicKeySummary":{ "type":"structure", "required":[ "Id", "Name", "CreatedTime", "EncodedKey" ], "members":{ "Id":{ "shape":"string", "documentation":"ID for public key information summary.
" }, "Name":{ "shape":"string", "documentation":"Name for public key information summary.
" }, "CreatedTime":{ "shape":"timestamp", "documentation":"Creation time for public key information summary.
" }, "EncodedKey":{ "shape":"string", "documentation":"Encoded key for public key information summary.
" }, "Comment":{ "shape":"string", "documentation":"Comment for public key information summary.
" } }, "documentation":"Public key information summary.
" }, "PublicKeySummaryList":{ "type":"list", "member":{ "shape":"PublicKeySummary", "locationName":"PublicKeySummary" } }, "QueryArgProfile":{ "type":"structure", "required":[ "QueryArg", "ProfileId" ], "members":{ "QueryArg":{ "shape":"string", "documentation":"Query argument for field-level encryption query argument-profile mapping.
" }, "ProfileId":{ "shape":"string", "documentation":"ID of profile to use for field-level encryption query argument-profile mapping
" } }, "documentation":"Query argument-profile mapping for field-level encryption.
" }, "QueryArgProfileConfig":{ "type":"structure", "required":["ForwardWhenQueryArgProfileIsUnknown"], "members":{ "ForwardWhenQueryArgProfileIsUnknown":{ "shape":"boolean", "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, fle-profile, is unknown.
" }, "QueryArgProfiles":{ "shape":"QueryArgProfiles", "documentation":"Profiles specified for query argument-profile mapping for field-level encryption.
" } }, "documentation":"Configuration for query argument-profile mapping for field-level encryption.
" }, "QueryArgProfileEmpty":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"No profile specified for the field-level encryption query argument.
", "error":{"httpStatusCode":400}, "exception":true }, "QueryArgProfileList":{ "type":"list", "member":{ "shape":"QueryArgProfile", "locationName":"QueryArgProfile" } }, "QueryArgProfiles":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"Number of profiles for query argument-profile mapping for field-level encryption.
" }, "Items":{ "shape":"QueryArgProfileList", "documentation":"Number of items for query argument-profile mapping for field-level encryption.
" } }, "documentation":"Query argument-profile mapping for field-level encryption.
" }, "QueryStringCacheKeys":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted query string parameters for this cache behavior.
(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items.
A complex type that identifies ways in which you want to restrict distribution of your content.
" }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the Amazon S3 origin.
" }, "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.
If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon Amazon CloudFront Developer Guide.
" } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
" }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
" } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.
An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:
self, which is the AWS account used to create the distribution.
An AWS account number.
A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.
A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.
The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.
The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.
The date and time that the distribution was last modified.
" }, "DomainName":{ "shape":"string", "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 TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.
The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
" }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the RTMP distribution.
" } }, "documentation":"A streaming distribution.
" }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures that the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
" }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
" }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution.
" }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution.
" }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
" }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution.
" }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept user requests for content.
" } }, "documentation":"The RTMP distribution's configuration information.
" }, "StreamingDistributionConfigWithTags":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Tags" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"A streaming distribution Configuration.
" }, "Tags":{ "shape":"Tags", "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 streaming distribution.
" }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter.
If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP 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 results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.
The number of streaming distributions that were created by the current AWS account.
" }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.
A streaming distribution list.
" }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution, for example, EDFDVBD632BHDS5.
The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.
Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.
The date and time the distribution was last modified.
" }, "DomainName":{ "shape":"string", "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 CloudFront to get your media files for distribution.
" }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
" }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
The comment originally specified when this distribution was created.
" }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content.
" } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution.
" }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.
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, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A complex type that controls whether access logs are written for this streaming distribution.
" }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":" A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
A string that contains an optional Tag value.
The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
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 a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
A complex type that contains Tag key elements.
A complex type that contains zero or more Tag elements.
An ARN of a CloudFront resource.
", "location":"querystring", "locationName":"Resource" }, "Tags":{ "shape":"Tags", "documentation":" A complex type that contains zero or more Tag elements.
The request to add tags to a CloudFront resource.
", "payload":"Tags" }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"structure", "members":{ "Items":{ "shape":"TagList", "documentation":" A complex type that contains Tag elements.
A complex type that contains zero or more Tag elements.
You cannot create more cache behaviors for the distribution.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore custom SSL/TLS certificates.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more CNAMEs than are allowed per distribution.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionsAssociatedToFieldLevelEncryptionConfig":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The maximum number of distributions have been associated with the specified configuration for field-level encryption.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionsWithLambdaAssociations":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyFieldLevelEncryptionConfigs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The maximum number of configurations for field-level encryption have been created.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyFieldLevelEncryptionContentTypeProfiles":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The maximum number of content type profiles for field-level encryption have been created.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyFieldLevelEncryptionEncryptionEntities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The maximum number of encryption entities for field-level encryption have been created.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyFieldLevelEncryptionFieldPatterns":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The maximum number of field patterns for field-level encryption have been created.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyFieldLevelEncryptionProfiles":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The maximum number of profiles for field-level encryption have been created.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyFieldLevelEncryptionQueryArgProfiles":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The maximum number of query arg profiles for field-level encryption have been created.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyLambdaFunctionAssociations":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more Lambda function associations than are allowed per distribution.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyOriginCustomHeaders":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create more origins for the distribution.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyPublicKeys":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "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.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyQueryStringParameters":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more trusted signers than are allowed per distribution.
", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"One or more of your trusted signers don't exist.
", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.
The number of trusted signers for this cache behavior.
" }, "Items":{ "shape":"AwsAccountNumberList", "documentation":" Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.
If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.
If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.
To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
For more information about updating the distribution configuration, see DistributionConfig .
" }, "UntagResourceRequest":{ "type":"structure", "required":[ "Resource", "TagKeys" ], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"An ARN of a CloudFront resource.
", "location":"querystring", "locationName":"Resource" }, "TagKeys":{ "shape":"TagKeys", "documentation":" A complex type that contains zero or more Tag key elements.
The request to remove tags from a CloudFront resource.
", "payload":"TagKeys" }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.
", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} }, "Id":{ "shape":"string", "documentation":"The identity's id.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.
The request to update an origin access identity.
", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.
The returned result of the corresponding request.
", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.
", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} }, "Id":{ "shape":"string", "documentation":"The distribution's id.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.
The request to update a distribution.
", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.
The returned result of the corresponding request.
", "payload":"Distribution" }, "UpdateFieldLevelEncryptionConfigRequest":{ "type":"structure", "required":[ "FieldLevelEncryptionConfig", "Id" ], "members":{ "FieldLevelEncryptionConfig":{ "shape":"FieldLevelEncryptionConfig", "documentation":"Request to update a field-level encryption configuration.
", "locationName":"FieldLevelEncryptionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} }, "Id":{ "shape":"string", "documentation":"The ID of the configuration you want to update.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL.
Return the results of updating the configuration.
" }, "ETag":{ "shape":"string", "documentation":"The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL.
Request to update a field-level encryption profile.
", "locationName":"FieldLevelEncryptionProfileConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} }, "Id":{ "shape":"string", "documentation":"The ID of the field-level encryption profile request.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL.
Return the results of updating the profile.
" }, "ETag":{ "shape":"string", "documentation":"The result of the field-level encryption profile request.
", "location":"header", "locationName":"ETag" } }, "payload":"FieldLevelEncryptionProfile" }, "UpdatePublicKeyRequest":{ "type":"structure", "required":[ "PublicKeyConfig", "Id" ], "members":{ "PublicKeyConfig":{ "shape":"PublicKeyConfig", "documentation":"Request to update public key information.
", "locationName":"PublicKeyConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} }, "Id":{ "shape":"string", "documentation":"ID of the public key to be updated.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL.
Return the results of updating the public key.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the update public key result. For example: E2QWRUHAPOMQZL.
The streaming distribution's configuration information.
", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} }, "Id":{ "shape":"string", "documentation":"The streaming distribution's id.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.
The request to update a streaming distribution.
", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.
The returned result of the corresponding request.
", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.
For information about how and when to use IAMCertificateId, see ViewerCertificate.
For information about how and when to use ACMCertificateArn, see ViewerCertificate.
If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:
vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.
sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:
Use the vip option (dedicated IP addresses) instead of sni-only.
Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.
If you can control which browser your users use, upgrade the browser to one that supports SNI.
Use HTTP instead of HTTPS.
Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.
For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.
" }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:
The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers
The cipher that CloudFront uses to encrypt the content that it returns to viewers
On the CloudFront console, this setting is called Security policy.
We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.
When both of the following are true, you must specify TLSv1 or later for the security policy:
You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId
You're using SNI: you specified sni-only for SSLSupportMethod
If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.
For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.
" }, "Certificate":{ "shape":"string", "documentation":"This field has been deprecated. Use one of the following fields instead:
This field has been deprecated. Use one of the following fields instead:
A complex type that specifies the following:
Whether you want viewers to use HTTP or HTTPS to request your objects.
If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.
If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.
You must specify only one of the following values:
Don't specify false for CloudFrontDefaultCertificate.
If you want viewers to use HTTP instead of HTTPS to request your objects: Specify the following value:
<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>
In addition, specify allow-all for ViewerProtocolPolicy for all of your cache behaviors.
If you want viewers to use HTTPS to request your objects: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:
If you're using an alternate domain name, such as example.com: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:
<ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.
<IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.
If you specify ACMCertificateArn or IAMCertificateId, you must also specify a value for SSLSupportMethod.
If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (https://example.com/logo.jpg). If you use the domain name that is associated with your CloudFront distribution (such as https://d111111abcdef8.cloudfront.net/logo.jpg) and the viewer supports SNI, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for SSLSupportMethod:
vip: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.
sni-only: CloudFront drops the connection with the browser without returning the object.
If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net : Specify the following value:
<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>
If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:
<ViewerProtocolPolicy>https-only<ViewerProtocolPolicy>
<ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy>
You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:
<OriginProtocolPolicy>https-only<OriginProtocolPolicy>
<OriginProtocolPolicy>match-viewer<OriginProtocolPolicy>
For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.
" }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, "documentation":"This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.
" }