Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.
For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
" }, "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/origin-access-identity/cloudfront", "responseCode":201 }, "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, {"shape":"MissingBody"}, {"shape":"TooManyCloudFrontOriginAccessIdentities"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
" }, "CreateDistribution":{ "name":"CreateDistribution2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/distribution", "responseCode":201 }, "input":{"shape":"CreateDistributionRequest"}, "output":{"shape":"CreateDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyOriginGroupsPerDistribution"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"}, {"shape":"TooManyDistributionsWithLambdaAssociations"}, {"shape":"TooManyDistributionsWithSingleFunctionARN"}, {"shape":"TooManyLambdaFunctionAssociations"}, {"shape":"InvalidLambdaFunctionAssociation"}, {"shape":"InvalidOriginReadTimeout"}, {"shape":"InvalidOriginKeepaliveTimeout"}, {"shape":"NoSuchFieldLevelEncryptionConfig"}, {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"}, {"shape":"NoSuchCachePolicy"}, {"shape":"TooManyDistributionsAssociatedToCachePolicy"}, {"shape":"NoSuchOriginRequestPolicy"}, {"shape":"TooManyDistributionsAssociatedToOriginRequestPolicy"}, {"shape":"TooManyDistributionsAssociatedToKeyGroup"}, {"shape":"TooManyKeyGroupsAssociatedToDistribution"}, {"shape":"TrustedKeyGroupDoesNotExist"} ], "documentation":"Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
Create a new distribution with tags.
" }, "CreateFieldLevelEncryptionConfig":{ "name":"CreateFieldLevelEncryptionConfig2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/field-level-encryption", "responseCode":201 }, "input":{"shape":"CreateFieldLevelEncryptionConfigRequest"}, "output":{"shape":"CreateFieldLevelEncryptionConfigResult"}, "errors":[ {"shape":"InconsistentQuantities"}, {"shape":"InvalidArgument"}, {"shape":"NoSuchFieldLevelEncryptionProfile"}, {"shape":"FieldLevelEncryptionConfigAlreadyExists"}, {"shape":"TooManyFieldLevelEncryptionConfigs"}, {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, {"shape":"QueryArgProfileEmpty"} ], "documentation":"Create a new field-level encryption configuration.
" }, "CreateFieldLevelEncryptionProfile":{ "name":"CreateFieldLevelEncryptionProfile2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/field-level-encryption-profile", "responseCode":201 }, "input":{"shape":"CreateFieldLevelEncryptionProfileRequest"}, "output":{"shape":"CreateFieldLevelEncryptionProfileResult"}, "errors":[ {"shape":"InconsistentQuantities"}, {"shape":"InvalidArgument"}, {"shape":"NoSuchPublicKey"}, {"shape":"FieldLevelEncryptionProfileAlreadyExists"}, {"shape":"FieldLevelEncryptionProfileSizeExceeded"}, {"shape":"TooManyFieldLevelEncryptionProfiles"}, {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, {"shape":"TooManyFieldLevelEncryptionFieldPatterns"} ], "documentation":"Create a field-level encryption profile.
" }, "CreateInvalidation":{ "name":"CreateInvalidation2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{"shape":"CreateInvalidationRequest"}, "output":{"shape":"CreateInvalidationResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"MissingBody"}, {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"BatchTooLarge"}, {"shape":"TooManyInvalidationsInProgress"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new invalidation.
" }, "CreateKeyGroup":{ "name":"CreateKeyGroup2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/key-group", "responseCode":201 }, "input":{"shape":"CreateKeyGroupRequest"}, "output":{"shape":"CreateKeyGroupResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"KeyGroupAlreadyExists"}, {"shape":"TooManyKeyGroups"}, {"shape":"TooManyPublicKeysInKeyGroup"} ], "documentation":"Creates a key group that you can use with CloudFront signed URLs and signed cookies.
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" }, "CreateMonitoringSubscription":{ "name":"CreateMonitoringSubscription2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/distributions/{DistributionId}/monitoring-subscription" }, "input":{"shape":"CreateMonitoringSubscriptionRequest"}, "output":{"shape":"CreateMonitoringSubscriptionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"NoSuchDistribution"} ], "documentation":"Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
" }, "CreateOriginRequestPolicy":{ "name":"CreateOriginRequestPolicy2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/origin-request-policy", "responseCode":201 }, "input":{"shape":"CreateOriginRequestPolicyRequest"}, "output":{"shape":"CreateOriginRequestPolicyResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InconsistentQuantities"}, {"shape":"InvalidArgument"}, {"shape":"OriginRequestPolicyAlreadyExists"}, {"shape":"TooManyOriginRequestPolicies"}, {"shape":"TooManyHeadersInOriginRequestPolicy"}, {"shape":"TooManyCookiesInOriginRequestPolicy"}, {"shape":"TooManyQueryStringsInOriginRequestPolicy"} ], "documentation":"Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can’t find a valid object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.
For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.
" }, "CreatePublicKey":{ "name":"CreatePublicKey2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/public-key", "responseCode":201 }, "input":{"shape":"CreatePublicKeyRequest"}, "output":{"shape":"CreatePublicKeyResult"}, "errors":[ {"shape":"PublicKeyAlreadyExists"}, {"shape":"InvalidArgument"}, {"shape":"TooManyPublicKeys"} ], "documentation":"Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
" }, "CreateRealtimeLogConfig":{ "name":"CreateRealtimeLogConfig2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/realtime-log-config", "responseCode":201 }, "input":{ "shape":"CreateRealtimeLogConfigRequest", "locationName":"CreateRealtimeLogConfigRequest", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} }, "output":{"shape":"CreateRealtimeLogConfigResult"}, "errors":[ {"shape":"RealtimeLogConfigAlreadyExists"}, {"shape":"TooManyRealtimeLogConfigs"}, {"shape":"InvalidArgument"}, {"shape":"AccessDenied"} ], "documentation":"Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
" }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/streaming-distribution", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionRequest"}, "output":{"shape":"CreateStreamingDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
" }, "CreateStreamingDistributionWithTags":{ "name":"CreateStreamingDistributionWithTags2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/streaming-distribution?WithTags", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"}, {"shape":"InvalidTagging"} ], "documentation":"This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
" }, "DeleteCachePolicy":{ "name":"DeleteCachePolicy2020_05_31", "http":{ "method":"DELETE", "requestUri":"/2020-05-31/cache-policy/{Id}", "responseCode":204 }, "input":{"shape":"DeleteCachePolicyRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCachePolicy"}, {"shape":"PreconditionFailed"}, {"shape":"IllegalDelete"}, {"shape":"CachePolicyInUse"} ], "documentation":"Deletes a cache policy.
You cannot delete a cache policy if it’s attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy’s identifier and version. To get these values, you can use ListCachePolicies or GetCachePolicy.
Delete an origin access identity.
" }, "DeleteDistribution":{ "name":"DeleteDistribution2020_05_31", "http":{ "method":"DELETE", "requestUri":"/2020-05-31/distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"DistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a distribution.
" }, "DeleteFieldLevelEncryptionConfig":{ "name":"DeleteFieldLevelEncryptionConfig2020_05_31", "http":{ "method":"DELETE", "requestUri":"/2020-05-31/field-level-encryption/{Id}", "responseCode":204 }, "input":{"shape":"DeleteFieldLevelEncryptionConfigRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchFieldLevelEncryptionConfig"}, {"shape":"PreconditionFailed"}, {"shape":"FieldLevelEncryptionConfigInUse"} ], "documentation":"Remove a field-level encryption configuration.
" }, "DeleteFieldLevelEncryptionProfile":{ "name":"DeleteFieldLevelEncryptionProfile2020_05_31", "http":{ "method":"DELETE", "requestUri":"/2020-05-31/field-level-encryption-profile/{Id}", "responseCode":204 }, "input":{"shape":"DeleteFieldLevelEncryptionProfileRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchFieldLevelEncryptionProfile"}, {"shape":"PreconditionFailed"}, {"shape":"FieldLevelEncryptionProfileInUse"} ], "documentation":"Remove a field-level encryption profile.
" }, "DeleteKeyGroup":{ "name":"DeleteKeyGroup2020_05_31", "http":{ "method":"DELETE", "requestUri":"/2020-05-31/key-group/{Id}", "responseCode":204 }, "input":{"shape":"DeleteKeyGroupRequest"}, "errors":[ {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchResource"}, {"shape":"PreconditionFailed"}, {"shape":"ResourceInUse"} ], "documentation":"Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.
To delete a key group, you must provide the key group’s identifier and version. To get these values, use ListKeyGroups followed by GetKeyGroup or GetKeyGroupConfig.
Disables additional CloudWatch metrics for the specified CloudFront distribution.
" }, "DeleteOriginRequestPolicy":{ "name":"DeleteOriginRequestPolicy2020_05_31", "http":{ "method":"DELETE", "requestUri":"/2020-05-31/origin-request-policy/{Id}", "responseCode":204 }, "input":{"shape":"DeleteOriginRequestPolicyRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchOriginRequestPolicy"}, {"shape":"PreconditionFailed"}, {"shape":"IllegalDelete"}, {"shape":"OriginRequestPolicyInUse"} ], "documentation":"Deletes an origin request policy.
You cannot delete an origin request policy if it’s attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.
To delete an origin request policy, you must provide the policy’s identifier and version. To get the identifier, you can use ListOriginRequestPolicies or GetOriginRequestPolicy.
Remove a public key you previously added to CloudFront.
" }, "DeleteRealtimeLogConfig":{ "name":"DeleteRealtimeLogConfig2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/delete-realtime-log-config/", "responseCode":204 }, "input":{ "shape":"DeleteRealtimeLogConfigRequest", "locationName":"DeleteRealtimeLogConfigRequest", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} }, "errors":[ {"shape":"NoSuchRealtimeLogConfig"}, {"shape":"RealtimeLogConfigInUse"}, {"shape":"InvalidArgument"}, {"shape":"AccessDenied"} ], "documentation":"Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it’s attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
" }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2020_05_31", "http":{ "method":"DELETE", "requestUri":"/2020-05-31/streaming-distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteStreamingDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"StreamingDistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API:
Disable the RTMP distribution.
Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.
Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.
Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.
Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.
Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.
Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.
Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
" }, "GetCachePolicy":{ "name":"GetCachePolicy2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/cache-policy/{Id}" }, "input":{"shape":"GetCachePolicyRequest"}, "output":{"shape":"GetCachePolicyResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"NoSuchCachePolicy"} ], "documentation":"Gets a cache policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy’s identifier. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.
Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy’s identifier. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.
Get the information about an origin access identity.
" }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about an origin access identity.
" }, "GetDistribution":{ "name":"GetDistribution2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/distribution/{Id}" }, "input":{"shape":"GetDistributionRequest"}, "output":{"shape":"GetDistributionResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a distribution.
" }, "GetDistributionConfig":{ "name":"GetDistributionConfig2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/distribution/{Id}/config" }, "input":{"shape":"GetDistributionConfigRequest"}, "output":{"shape":"GetDistributionConfigResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a distribution.
" }, "GetFieldLevelEncryption":{ "name":"GetFieldLevelEncryption2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/field-level-encryption/{Id}" }, "input":{"shape":"GetFieldLevelEncryptionRequest"}, "output":{"shape":"GetFieldLevelEncryptionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"NoSuchFieldLevelEncryptionConfig"} ], "documentation":"Get the field-level encryption configuration information.
" }, "GetFieldLevelEncryptionConfig":{ "name":"GetFieldLevelEncryptionConfig2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/field-level-encryption/{Id}/config" }, "input":{"shape":"GetFieldLevelEncryptionConfigRequest"}, "output":{"shape":"GetFieldLevelEncryptionConfigResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"NoSuchFieldLevelEncryptionConfig"} ], "documentation":"Get the field-level encryption configuration information.
" }, "GetFieldLevelEncryptionProfile":{ "name":"GetFieldLevelEncryptionProfile2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/field-level-encryption-profile/{Id}" }, "input":{"shape":"GetFieldLevelEncryptionProfileRequest"}, "output":{"shape":"GetFieldLevelEncryptionProfileResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"NoSuchFieldLevelEncryptionProfile"} ], "documentation":"Get the field-level encryption profile information.
" }, "GetFieldLevelEncryptionProfileConfig":{ "name":"GetFieldLevelEncryptionProfileConfig2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/field-level-encryption-profile/{Id}/config" }, "input":{"shape":"GetFieldLevelEncryptionProfileConfigRequest"}, "output":{"shape":"GetFieldLevelEncryptionProfileConfigResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"NoSuchFieldLevelEncryptionProfile"} ], "documentation":"Get the field-level encryption profile configuration information.
" }, "GetInvalidation":{ "name":"GetInvalidation2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/distribution/{DistributionId}/invalidation/{Id}" }, "input":{"shape":"GetInvalidationRequest"}, "output":{"shape":"GetInvalidationResult"}, "errors":[ {"shape":"NoSuchInvalidation"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an invalidation.
" }, "GetKeyGroup":{ "name":"GetKeyGroup2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/key-group/{Id}" }, "input":{"shape":"GetKeyGroupRequest"}, "output":{"shape":"GetKeyGroupResult"}, "errors":[ {"shape":"NoSuchResource"} ], "documentation":"Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group’s identifier. If the key group is referenced in a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups.
Gets a key group configuration.
To get a key group configuration, you must provide the key group’s identifier. If the key group is referenced in a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups.
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
" }, "GetOriginRequestPolicy":{ "name":"GetOriginRequestPolicy2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/origin-request-policy/{Id}" }, "input":{"shape":"GetOriginRequestPolicyRequest"}, "output":{"shape":"GetOriginRequestPolicyResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"NoSuchOriginRequestPolicy"} ], "documentation":"Gets an origin request policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
To get an origin request policy, you must provide the policy’s identifier. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy’s identifier. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
Gets a public key.
" }, "GetPublicKeyConfig":{ "name":"GetPublicKeyConfig2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/public-key/{Id}/config" }, "input":{"shape":"GetPublicKeyConfigRequest"}, "output":{"shape":"GetPublicKeyConfigResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"NoSuchPublicKey"} ], "documentation":"Gets a public key configuration.
" }, "GetRealtimeLogConfig":{ "name":"GetRealtimeLogConfig2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/get-realtime-log-config/" }, "input":{ "shape":"GetRealtimeLogConfigRequest", "locationName":"GetRealtimeLogConfigRequest", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} }, "output":{"shape":"GetRealtimeLogConfigResult"}, "errors":[ {"shape":"NoSuchRealtimeLogConfig"}, {"shape":"InvalidArgument"}, {"shape":"AccessDenied"} ], "documentation":"Gets a real-time log configuration.
To get a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.
" }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/streaming-distribution/{Id}" }, "input":{"shape":"GetStreamingDistributionRequest"}, "output":{"shape":"GetStreamingDistributionResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Gets information about a specified RTMP distribution, including the distribution configuration.
" }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/streaming-distribution/{Id}/config" }, "input":{"shape":"GetStreamingDistributionConfigRequest"}, "output":{"shape":"GetStreamingDistributionConfigResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a streaming distribution.
" }, "ListCachePolicies":{ "name":"ListCachePolicies2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/cache-policy" }, "input":{"shape":"ListCachePoliciesRequest"}, "output":{"shape":"ListCachePoliciesResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"NoSuchCachePolicy"}, {"shape":"InvalidArgument"} ], "documentation":"Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by AWS, or only the custom policies created in your AWS account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Lists origin access identities.
" }, "ListDistributions":{ "name":"ListDistributions2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/distribution" }, "input":{"shape":"ListDistributionsRequest"}, "output":{"shape":"ListDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List CloudFront distributions.
" }, "ListDistributionsByCachePolicyId":{ "name":"ListDistributionsByCachePolicyId2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/distributionsByCachePolicyId/{CachePolicyId}" }, "input":{"shape":"ListDistributionsByCachePolicyIdRequest"}, "output":{"shape":"ListDistributionsByCachePolicyIdResult"}, "errors":[ {"shape":"NoSuchCachePolicy"}, {"shape":"InvalidArgument"}, {"shape":"AccessDenied"} ], "documentation":"Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
List the distributions that are associated with a specified AWS WAF web ACL.
" }, "ListFieldLevelEncryptionConfigs":{ "name":"ListFieldLevelEncryptionConfigs2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/field-level-encryption" }, "input":{"shape":"ListFieldLevelEncryptionConfigsRequest"}, "output":{"shape":"ListFieldLevelEncryptionConfigsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List all field-level encryption configurations that have been created in CloudFront for this account.
" }, "ListFieldLevelEncryptionProfiles":{ "name":"ListFieldLevelEncryptionProfiles2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/field-level-encryption-profile" }, "input":{"shape":"ListFieldLevelEncryptionProfilesRequest"}, "output":{"shape":"ListFieldLevelEncryptionProfilesResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"Request a list of field-level encryption profiles that have been created in CloudFront for this account.
" }, "ListInvalidations":{ "name":"ListInvalidations2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/distribution/{DistributionId}/invalidation" }, "input":{"shape":"ListInvalidationsRequest"}, "output":{"shape":"ListInvalidationsResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Lists invalidation batches.
" }, "ListKeyGroups":{ "name":"ListKeyGroups2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/key-group" }, "input":{"shape":"ListKeyGroupsRequest"}, "output":{"shape":"ListKeyGroupsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by AWS, or only the custom policies created in your AWS account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
List all public keys that have been added to CloudFront for this account.
" }, "ListRealtimeLogConfigs":{ "name":"ListRealtimeLogConfigs2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/realtime-log-config" }, "input":{"shape":"ListRealtimeLogConfigsRequest"}, "output":{"shape":"ListRealtimeLogConfigsResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"AccessDenied"}, {"shape":"NoSuchRealtimeLogConfig"} ], "documentation":"Gets a list of real-time log configurations.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
List streaming distributions.
" }, "ListTagsForResource":{ "name":"ListTagsForResource2020_05_31", "http":{ "method":"GET", "requestUri":"/2020-05-31/tagging" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"List tags for a CloudFront resource.
" }, "TagResource":{ "name":"TagResource2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/tagging?Operation=Tag", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"Add tags to a CloudFront resource.
" }, "UntagResource":{ "name":"UntagResource2020_05_31", "http":{ "method":"POST", "requestUri":"/2020-05-31/tagging?Operation=Untag", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"Remove tags from a CloudFront resource.
" }, "UpdateCachePolicy":{ "name":"UpdateCachePolicy2020_05_31", "http":{ "method":"PUT", "requestUri":"/2020-05-31/cache-policy/{Id}" }, "input":{"shape":"UpdateCachePolicyRequest"}, "output":{"shape":"UpdateCachePolicyResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"IllegalUpdate"}, {"shape":"InconsistentQuantities"}, {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCachePolicy"}, {"shape":"PreconditionFailed"}, {"shape":"CachePolicyAlreadyExists"}, {"shape":"TooManyHeadersInCachePolicy"}, {"shape":"TooManyCookiesInCachePolicy"}, {"shape":"TooManyQueryStringsInCachePolicy"} ], "documentation":"Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
Use GetCachePolicyConfig to get the current configuration.
Locally modify the fields in the cache policy configuration that you want to update.
Call UpdateCachePolicy by providing the entire cache policy configuration, including the fields that you modified and those that you didn’t.
Update an origin access identity.
" }, "UpdateDistribution":{ "name":"UpdateDistribution2020_05_31", "http":{ "method":"PUT", "requestUri":"/2020-05-31/distribution/{Id}/config" }, "input":{"shape":"UpdateDistributionRequest"}, "output":{"shape":"UpdateDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyOriginGroupsPerDistribution"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"}, {"shape":"TooManyDistributionsWithLambdaAssociations"}, {"shape":"TooManyDistributionsWithSingleFunctionARN"}, {"shape":"TooManyLambdaFunctionAssociations"}, {"shape":"InvalidLambdaFunctionAssociation"}, {"shape":"InvalidOriginReadTimeout"}, {"shape":"InvalidOriginKeepaliveTimeout"}, {"shape":"NoSuchFieldLevelEncryptionConfig"}, {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"}, {"shape":"NoSuchCachePolicy"}, {"shape":"TooManyDistributionsAssociatedToCachePolicy"}, {"shape":"NoSuchOriginRequestPolicy"}, {"shape":"TooManyDistributionsAssociatedToOriginRequestPolicy"}, {"shape":"TooManyDistributionsAssociatedToKeyGroup"}, {"shape":"TooManyKeyGroupsAssociatedToDistribution"}, {"shape":"TrustedKeyGroupDoesNotExist"} ], "documentation":"Updates the configuration for a web distribution.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
The update process includes getting the current distribution configuration, updating the XML document that is returned 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 Creating a Distribution in the Amazon CloudFront Developer Guide.
To update a web distribution using the CloudFront API
Submit a GetDistributionConfig request to get the current configuration and an Etag header for 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 your changes.
When you edit the XML file, be aware of the following:
You must strip out the ETag parameter that is returned.
Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.
You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error.
The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you 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 XML document with a DistributionConfig element.
Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1.
Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated.
Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.
Update a field-level encryption configuration.
" }, "UpdateFieldLevelEncryptionProfile":{ "name":"UpdateFieldLevelEncryptionProfile2020_05_31", "http":{ "method":"PUT", "requestUri":"/2020-05-31/field-level-encryption-profile/{Id}/config" }, "input":{"shape":"UpdateFieldLevelEncryptionProfileRequest"}, "output":{"shape":"UpdateFieldLevelEncryptionProfileResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"FieldLevelEncryptionProfileAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InconsistentQuantities"}, {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchPublicKey"}, {"shape":"NoSuchFieldLevelEncryptionProfile"}, {"shape":"PreconditionFailed"}, {"shape":"FieldLevelEncryptionProfileSizeExceeded"}, {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, {"shape":"TooManyFieldLevelEncryptionFieldPatterns"} ], "documentation":"Update a field-level encryption profile.
" }, "UpdateKeyGroup":{ "name":"UpdateKeyGroup2020_05_31", "http":{ "method":"PUT", "requestUri":"/2020-05-31/key-group/{Id}" }, "input":{"shape":"UpdateKeyGroupRequest"}, "output":{"shape":"UpdateKeyGroupResult"}, "errors":[ {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchResource"}, {"shape":"PreconditionFailed"}, {"shape":"KeyGroupAlreadyExists"}, {"shape":"InvalidArgument"}, {"shape":"TooManyPublicKeysInKeyGroup"} ], "documentation":"Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
Get the current key group with GetKeyGroup or GetKeyGroupConfig.
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
Call UpdateKeyGroup with the entire key group object, including the fields that you modified and those that you didn’t.
Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
Use GetOriginRequestPolicyConfig to get the current configuration.
Locally modify the fields in the origin request policy configuration that you want to update.
Call UpdateOriginRequestPolicy by providing the entire origin request policy configuration, including the fields that you modified and those that you didn’t.
Update public key information. Note that the only value you can change is the comment.
" }, "UpdateRealtimeLogConfig":{ "name":"UpdateRealtimeLogConfig2020_05_31", "http":{ "method":"PUT", "requestUri":"/2020-05-31/realtime-log-config/" }, "input":{ "shape":"UpdateRealtimeLogConfigRequest", "locationName":"UpdateRealtimeLogConfigRequest", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} }, "output":{"shape":"UpdateRealtimeLogConfigResult"}, "errors":[ {"shape":"NoSuchRealtimeLogConfig"}, {"shape":"InvalidArgument"}, {"shape":"AccessDenied"} ], "documentation":"Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
Call GetRealtimeLogConfig to get the current real-time log configuration.
Locally modify the parameters in the real-time log configuration that you want to update.
Call this API (UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn’t.
You cannot update a real-time log configuration’s Name or ARN.
Update a streaming distribution.
" } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Access denied.
", "error":{"httpStatusCode":403}, "exception":true }, "ActiveTrustedKeyGroups":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"This field is true if any of the key groups have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
The number of key groups in the list.
" }, "Items":{ "shape":"KGKeyPairIdsList", "documentation":"A list of key groups, including the identifiers of the public keys in each key group that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" } }, "documentation":"A list of key groups, and the public keys in each key group, that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"This field is true if any of the AWS accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
The number of AWS accounts in the list.
" }, "Items":{ "shape":"SignerList", "documentation":"A list of AWS accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" } }, "documentation":"A list of AWS accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" }, "AliasICPRecordal":{ "type":"structure", "members":{ "CNAME":{ "shape":"string", "documentation":"A domain name associated with a distribution.
" }, "ICPRecordalStatus":{ "shape":"ICPRecordalStatus", "documentation":"The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.
The status values returned are the following:
APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.
SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.
PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.
AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure it yourself.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China.
" }, "AliasICPRecordals":{ "type":"list", "member":{ "shape":"AliasICPRecordal", "locationName":"AliasICPRecordal" } }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAME aliases, if any, that you want to associate with this distribution.
" }, "Items":{ "shape":"AliasList", "documentation":"A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
" } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
" }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
" }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
CloudFront forwards only GET and HEAD requests.
CloudFront forwards only GET, HEAD, and OPTIONS requests.
CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
" }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Invalidation batch specified is too large.
", "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The CNAME specified is already defined for CloudFront.
", "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ViewerProtocolPolicy" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.
The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide.
" }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s AWS account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" }, "TrustedKeyGroups":{ "shape":"TrustedKeyGroups", "documentation":"A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:
allow-all: Viewers can use HTTP or HTTPS.
redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.
https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status 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.
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
" }, "LambdaFunctionAssociations":{ "shape":"LambdaFunctionAssociations", "documentation":"A complex type that contains zero or more Lambda function associations for a cache behavior.
" }, "FieldLevelEncryptionId":{ "shape":"string", "documentation":"The value of ID for the field-level encryption configuration that you want CloudFront to 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 cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
" }, "CachePolicyId":{ "shape":"string", "documentation":"The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
" }, "OriginRequestPolicyId":{ "shape":"string", "documentation":"The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
" }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
", "deprecated":true }, "MinTTL":{ "shape":"long", "documentation":"This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in 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 policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
A complex type that describes how CloudFront processes requests.
You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.
For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see Quotas in the Amazon CloudFront Developer Guide.
If you don’t want to specify any cache behaviors, include only an empty CacheBehaviors element. Don’t include an empty CacheBehavior element because this is invalid.
To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.
To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.
For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
" }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution.
" }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.
A complex type that contains zero or more CacheBehavior elements.
The unique identifier for the cache policy.
" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time when the cache policy was last modified.
" }, "CachePolicyConfig":{ "shape":"CachePolicyConfig", "documentation":"The cache policy configuration.
" } }, "documentation":"A cache policy.
When it’s attached to a cache behavior, the cache policy determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find a valid object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.
A cache policy with this name already exists. You must provide a unique name. To modify an existing cache policy, use UpdateCachePolicy.
A comment to describe the cache policy.
" }, "Name":{ "shape":"string", "documentation":"A unique name to identify the cache policy.
" }, "DefaultTTL":{ "shape":"long", "documentation":"The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL.
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default 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 cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
" }, "ParametersInCacheKeyAndForwardedToOrigin":{ "shape":"ParametersInCacheKeyAndForwardedToOrigin", "documentation":"The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.
" } }, "documentation":"A cache policy configuration.
This configuration determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find a valid object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.
Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in an OriginRequestPolicy are included in origin requests.
whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
allExcept – All cookies in viewer requests that are not listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
" }, "CachePolicyHeaderBehavior":{ "type":"string", "enum":[ "none", "whitelist" ] }, "CachePolicyHeadersConfig":{ "type":"structure", "required":["HeaderBehavior"], "members":{ "HeaderBehavior":{ "shape":"CachePolicyHeaderBehavior", "documentation":"Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.
whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
" }, "CachePolicyInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Cannot delete the cache policy because it is attached to one or more cache behaviors.
", "error":{"httpStatusCode":409}, "exception":true }, "CachePolicyList":{ "type":"structure", "required":[ "MaxItems", "Quantity" ], "members":{ "NextMarker":{ "shape":"string", "documentation":"If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing cache policies where you left off.
The maximum number of cache policies requested.
" }, "Quantity":{ "shape":"integer", "documentation":"The total number of cache policies returned in the response.
" }, "Items":{ "shape":"CachePolicySummaryList", "documentation":"Contains the cache policies in the list.
" } }, "documentation":"A list of cache policies.
" }, "CachePolicyQueryStringBehavior":{ "type":"string", "enum":[ "none", "whitelist", "allExcept", "all" ] }, "CachePolicyQueryStringsConfig":{ "type":"structure", "required":["QueryStringBehavior"], "members":{ "QueryStringBehavior":{ "shape":"CachePolicyQueryStringBehavior", "documentation":"Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in an OriginRequestPolicy are included in origin requests.
whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
allExcept – All query strings in viewer requests that are not listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
Contains the specific query strings in viewer requests that either are or are not included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).
An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
" }, "CachePolicySummary":{ "type":"structure", "required":[ "Type", "CachePolicy" ], "members":{ "Type":{ "shape":"CachePolicyType", "documentation":"The type of cache policy, either managed (created by AWS) or custom (created in this AWS account).
The cache policy.
" } }, "documentation":"Contains a cache policy.
" }, "CachePolicySummaryList":{ "type":"list", "member":{ "shape":"CachePolicySummary", "locationName":"CachePolicySummary" } }, "CachePolicyType":{ "type":"string", "enum":[ "managed", "custom" ] }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
" } }, "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
CloudFront caches responses to GET and HEAD requests.
CloudFront caches responses to GET, HEAD, and OPTIONS requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
" }, "CannotChangeImmutablePublicKeyFields":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You can't change the value of a public key.
", "error":{"httpStatusCode":400}, "exception":true }, "CertificateSource":{ "type":"string", "enum":[ "cloudfront", "iam", "acm" ] }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity, for example, E74FTE3AJFJ256A.
The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.
" }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity.
" } }, "documentation":"CloudFront origin access identity.
" }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.
If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig 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 you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.
Any comments you want to include about the origin access identity.
" } }, "documentation":"Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.
The Origin Access Identity specified is already in use.
", "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities 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 identity on that page).
If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.
The maximum number of origin access identities you want in the response body.
" }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities 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 items in the list.
The number of CloudFront origin access identities that were created by the current AWS account.
" }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.
Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.
The ID for the origin access identity. For example: E74FTE3AJFJ256A.
The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.
" }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created.
" } }, "documentation":"Summary of the information about a CloudFront origin access identity.
" }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CommentType":{ "type":"string", "sensitive":true }, "ContentTypeProfile":{ "type":"structure", "required":[ "Format", "ContentType" ], "members":{ "Format":{ "shape":"Format", "documentation":"The format for a field-level encryption content type-profile mapping.
" }, "ProfileId":{ "shape":"string", "documentation":"The profile ID for a field-level encryption content type-profile mapping.
" }, "ContentType":{ "shape":"string", "documentation":"The content type for a field-level encryption content type-profile mapping.
" } }, "documentation":"A field-level encryption content type profile.
" }, "ContentTypeProfileConfig":{ "type":"structure", "required":["ForwardWhenContentTypeIsUnknown"], "members":{ "ForwardWhenContentTypeIsUnknown":{ "shape":"boolean", "documentation":"The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
" }, "ContentTypeProfiles":{ "shape":"ContentTypeProfiles", "documentation":"The configuration for a field-level encryption content type-profile.
" } }, "documentation":"The configuration for a field-level encryption content type-profile mapping.
" }, "ContentTypeProfileList":{ "type":"list", "member":{ "shape":"ContentTypeProfile", "locationName":"ContentTypeProfile" } }, "ContentTypeProfiles":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of field-level encryption content type-profile mappings.
" }, "Items":{ "shape":"ContentTypeProfileList", "documentation":"Items in a field-level encryption content type-profile mapping.
" } }, "documentation":"Field-level encryption content type-profile.
" }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cookie names in the Items list.
A list of cookie names.
" } }, "documentation":"Contains a list of cookie names.
" }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Required if you specify whitelist for the value of Forward. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the AWS General Reference.
" } }, "documentation":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use CookiesConfig in a cache policy. See CachePolicy.
If you want to send cookies to the origin but not include them in the cache key, use CookiesConfig in an origin request policy. See OriginRequestPolicy.
A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see Caching Content Based on Cookies in the Amazon CloudFront Developer Guide.
" }, "CreateCachePolicyRequest":{ "type":"structure", "required":["CachePolicyConfig"], "members":{ "CachePolicyConfig":{ "shape":"CachePolicyConfig", "documentation":"A cache policy configuration.
", "locationName":"CachePolicyConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "payload":"CachePolicyConfig" }, "CreateCachePolicyResult":{ "type":"structure", "members":{ "CachePolicy":{ "shape":"CachePolicy", "documentation":"A cache policy.
" }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the cache policy just created.
", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the cache policy.
", "location":"header", "locationName":"ETag" } }, "payload":"CachePolicy" }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity.
", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "documentation":"The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide.
", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information.
" }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new origin access identity just created.
", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity created.
", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.
", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.
", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "documentation":"The request to create a new distribution.
", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information.
" }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new distribution resource just created.
", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.
", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.
", "payload":"Distribution" }, "CreateDistributionWithTagsRequest":{ "type":"structure", "required":["DistributionConfigWithTags"], "members":{ "DistributionConfigWithTags":{ "shape":"DistributionConfigWithTags", "documentation":"The distribution's configuration information.
", "locationName":"DistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "documentation":"The request to create a new distribution with tags.
", "payload":"DistributionConfigWithTags" }, "CreateDistributionWithTagsResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information.
" }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new distribution resource just created.
", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.
", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.
", "payload":"Distribution" }, "CreateFieldLevelEncryptionConfigRequest":{ "type":"structure", "required":["FieldLevelEncryptionConfig"], "members":{ "FieldLevelEncryptionConfig":{ "shape":"FieldLevelEncryptionConfig", "documentation":"The request to create a new field-level encryption configuration.
", "locationName":"FieldLevelEncryptionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "payload":"FieldLevelEncryptionConfig" }, "CreateFieldLevelEncryptionConfigResult":{ "type":"structure", "members":{ "FieldLevelEncryption":{ "shape":"FieldLevelEncryption", "documentation":"Returned when you create a new field-level encryption configuration.
" }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new configuration resource just created.
", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
The request to create a field-level encryption profile.
", "locationName":"FieldLevelEncryptionProfileConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "payload":"FieldLevelEncryptionProfileConfig" }, "CreateFieldLevelEncryptionProfileResult":{ "type":"structure", "members":{ "FieldLevelEncryptionProfile":{ "shape":"FieldLevelEncryptionProfile", "documentation":"Returned when you create a new field-level encryption profile.
" }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new profile resource just created.
", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.
The distribution's id.
", "location":"uri", "locationName":"DistributionId" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.
", "locationName":"InvalidationBatch", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "documentation":"The request to create an invalidation.
", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.
The invalidation's information.
" } }, "documentation":"The returned result of the corresponding request.
", "payload":"Invalidation" }, "CreateKeyGroupRequest":{ "type":"structure", "required":["KeyGroupConfig"], "members":{ "KeyGroupConfig":{ "shape":"KeyGroupConfig", "documentation":"A key group configuration.
", "locationName":"KeyGroupConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "payload":"KeyGroupConfig" }, "CreateKeyGroupResult":{ "type":"structure", "members":{ "KeyGroup":{ "shape":"KeyGroup", "documentation":"The key group that was just created.
" }, "Location":{ "shape":"string", "documentation":"The URL of the key group.
", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The identifier for this version of the key group.
", "location":"header", "locationName":"ETag" } }, "payload":"KeyGroup" }, "CreateMonitoringSubscriptionRequest":{ "type":"structure", "required":[ "MonitoringSubscription", "DistributionId" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The ID of the distribution that you are enabling metrics for.
", "location":"uri", "locationName":"DistributionId" }, "MonitoringSubscription":{ "shape":"MonitoringSubscription", "documentation":"A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
", "locationName":"MonitoringSubscription", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "payload":"MonitoringSubscription" }, "CreateMonitoringSubscriptionResult":{ "type":"structure", "members":{ "MonitoringSubscription":{ "shape":"MonitoringSubscription", "documentation":"A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
" } }, "payload":"MonitoringSubscription" }, "CreateOriginRequestPolicyRequest":{ "type":"structure", "required":["OriginRequestPolicyConfig"], "members":{ "OriginRequestPolicyConfig":{ "shape":"OriginRequestPolicyConfig", "documentation":"An origin request policy configuration.
", "locationName":"OriginRequestPolicyConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "payload":"OriginRequestPolicyConfig" }, "CreateOriginRequestPolicyResult":{ "type":"structure", "members":{ "OriginRequestPolicy":{ "shape":"OriginRequestPolicy", "documentation":"An origin request policy.
" }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the origin request policy just created.
", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin request policy.
", "location":"header", "locationName":"ETag" } }, "payload":"OriginRequestPolicy" }, "CreatePublicKeyRequest":{ "type":"structure", "required":["PublicKeyConfig"], "members":{ "PublicKeyConfig":{ "shape":"PublicKeyConfig", "documentation":"A CloudFront public key configuration.
", "locationName":"PublicKeyConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "payload":"PublicKeyConfig" }, "CreatePublicKeyResult":{ "type":"structure", "members":{ "PublicKey":{ "shape":"PublicKey", "documentation":"The public key.
" }, "Location":{ "shape":"string", "documentation":"The URL of the public key.
", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The identifier for this version of the public key.
", "location":"header", "locationName":"ETag" } }, "payload":"PublicKey" }, "CreateRealtimeLogConfigRequest":{ "type":"structure", "required":[ "EndPoints", "Fields", "Name", "SamplingRate" ], "members":{ "EndPoints":{ "shape":"EndPointList", "documentation":"Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
" }, "Fields":{ "shape":"FieldList", "documentation":"A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
" }, "Name":{ "shape":"string", "documentation":"A unique name to identify this real-time log configuration.
" }, "SamplingRate":{ "shape":"long", "documentation":"The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.
" } } }, "CreateRealtimeLogConfigResult":{ "type":"structure", "members":{ "RealtimeLogConfig":{ "shape":"RealtimeLogConfig", "documentation":"A real-time log configuration.
" } } }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.
", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "documentation":"The request to create a new streaming distribution.
", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information.
" }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new streaming distribution resource just created.
", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution created.
", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.
", "payload":"StreamingDistribution" }, "CreateStreamingDistributionWithTagsRequest":{ "type":"structure", "required":["StreamingDistributionConfigWithTags"], "members":{ "StreamingDistributionConfigWithTags":{ "shape":"StreamingDistributionConfigWithTags", "documentation":"The streaming distribution's configuration information.
", "locationName":"StreamingDistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} } }, "documentation":"The request to create a new streaming distribution with tags.
", "payload":"StreamingDistributionConfigWithTags" }, "CreateStreamingDistributionWithTagsResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information.
" }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new streaming distribution resource just created.
", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.
", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.
", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The HTTP status code for which you want to specify a custom error page and/or a caching duration.
" }, "ResponsePagePath":{ "shape":"string", "documentation":"The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.
The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.
If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode.
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
" }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.
If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.
You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.
If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath.
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
" } }, "documentation":"A complex type that controls:
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
" }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
A complex type that controls:
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
" }, "CustomHeaders":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom headers, if any, for this distribution.
" }, "Items":{ "shape":"OriginCustomHeadersList", "documentation":" Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.
A complex type that contains the list of Custom Headers for each origin.
" }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
" }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
" }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only – CloudFront always uses HTTP to connect to the origin.
match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.
https-only – CloudFront always uses HTTPS to connect to the origin.
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2.
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
" }, "OriginReadTimeout":{ "shape":"integer", "documentation":"Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
" }, "OriginKeepaliveTimeout":{ "shape":"integer", "documentation":"Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
" } }, "documentation":"A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting is a custom origin.
" }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ViewerProtocolPolicy" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s AWS account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" }, "TrustedKeyGroups":{ "shape":"TrustedKeyGroups", "documentation":"A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:
allow-all: Viewers can use HTTP or HTTPS.
redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.
https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status 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.
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
A complex type that contains zero or more Lambda function associations for a cache behavior.
" }, "FieldLevelEncryptionId":{ "shape":"string", "documentation":"The value of ID for the field-level encryption configuration that you want CloudFront to 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 cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
" }, "CachePolicyId":{ "shape":"string", "documentation":"The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
" }, "OriginRequestPolicyId":{ "shape":"string", "documentation":"The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
" }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
", "deprecated":true }, "MinTTL":{ "shape":"long", "documentation":"This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in 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 policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in 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 CacheBehavior element or if request URLs don’t match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.
The unique identifier for the cache policy that you are deleting. To get the identifier, you can use ListCachePolicies.
The version of the cache policy that you are deleting. The version is the cache policy’s ETag value, which you can get using ListCachePolicies, GetCachePolicy, or GetCachePolicyConfig.
The origin access identity's ID.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.
Deletes a origin access identity.
" }, "DeleteDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution ID.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.
This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.
To delete a web distribution using the CloudFront API:
Disable the web distribution
Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.
Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.
Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.
Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.
Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.
Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.
Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
" }, "DeleteFieldLevelEncryptionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The ID of the configuration you want to delete from CloudFront.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL.
Request the ID of the profile you want to delete from CloudFront.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL.
The identifier of the key group that you are deleting. To get the identifier, use ListKeyGroups.
The version of the key group that you are deleting. The version is the key group’s ETag value. To get the ETag, use GetKeyGroup or GetKeyGroupConfig.
The ID of the distribution that you are disabling metrics for.
", "location":"uri", "locationName":"DistributionId" } } }, "DeleteMonitoringSubscriptionResult":{ "type":"structure", "members":{ } }, "DeleteOriginRequestPolicyRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use ListOriginRequestPolicies.
The version of the origin request policy that you are deleting. The version is the origin request policy’s ETag value, which you can get using ListOriginRequestPolicies, GetOriginRequestPolicy, or GetOriginRequestPolicyConfig.
The ID of the public key you want to remove from CloudFront.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL.
The name of the real-time log configuration to delete.
" }, "ARN":{ "shape":"string", "documentation":"The Amazon Resource Name (ARN) of the real-time log configuration to delete.
" } } }, "DeleteStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution ID.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.
The request to delete a streaming distribution.
" }, "Distribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5.
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.
This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.
The date and time the distribution was last modified.
" }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress.
" }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.
We recommend using TrustedKeyGroups instead of TrustedSigners.
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of AWS account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
" }, "ActiveTrustedKeyGroups":{ "shape":"ActiveTrustedKeyGroups", "documentation":"CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.
" }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.
AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China.
" } }, "documentation":"A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
" }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.
", "error":{"httpStatusCode":409}, "exception":true }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
" }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.
Specify only the object name, for example, index.html. Don't add a / before the object name.
If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.
To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.
To replace the default root object, update the distribution configuration and specify the new object.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.
" }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution.
" }, "OriginGroups":{ "shape":"OriginGroups", "documentation":"A complex type that contains information about origin groups for this distribution.
" }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.
A complex type that contains zero or more CacheBehavior elements.
A complex type that controls the following:
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
" }, "Comment":{ "shape":"CommentType", "documentation":"Any comments you want to include about the distribution.
If you don't want to specify a comment, include an empty Comment element.
To delete an existing comment, update the distribution configuration and include an empty Comment element.
To add or change a comment, update the distribution configuration and specify the new comment.
" }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.
" }, "PriceClass":{ "shape":"PriceClass", "documentation":"The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.
" }, "Enabled":{ "shape":"boolean", "documentation":"From this field, you can enable or disable the selected distribution.
" }, "ViewerCertificate":{ "shape":"ViewerCertificate", "documentation":"A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
" }, "Restrictions":{ "shape":"Restrictions", "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content.
" }, "WebACLId":{ "shape":"string", "documentation":"A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.
AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.
" }, "HttpVersion":{ "shape":"HttpVersion", "documentation":"(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).
In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\"
" }, "IsIPV6Enabled":{ "shape":"boolean", "documentation":"If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This 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 access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.
If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
You enable IPv6 for the distribution
You're using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.
If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
" } }, "documentation":"A distribution configuration.
" }, "DistributionConfigWithTags":{ "type":"structure", "required":[ "DistributionConfig", "Tags" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"A distribution configuration.
" }, "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements.
A distribution Configuration and a list of tags to be associated with the distribution.
" }, "DistributionIdList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value provided in the Marker request field.
Contains the value that you should use in the Marker field of a subsequent request to continue listing distribution IDs where you left off.
The maximum number of distribution IDs requested.
" }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you can make a subsequent request using the Marker request field to retrieve more distribution IDs in the list.
The total number of distribution IDs returned in the response.
" }, "Items":{ "shape":"DistributionIdListSummary", "documentation":"Contains the distribution IDs in the list.
" } }, "documentation":"A list of distribution IDs.
" }, "DistributionIdListSummary":{ "type":"list", "member":{ "shape":"string", "locationName":"DistributionId" } }, "DistributionList":{ "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 distributions 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 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 distributions that were created by the current AWS account.
" }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.
A distribution list.
" }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.
", "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions", "WebACLId", "HttpVersion", "IsIPV6Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5.
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.
The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.
The date and time the distribution was last modified.
" }, "DomainName":{ "shape":"string", "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, for this distribution.
" }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution.
" }, "OriginGroups":{ "shape":"OriginGroups", "documentation":"A complex type that contains information about origin groups for this distribution.
" }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.
A complex type that contains zero or more CacheBehavior elements.
A complex type that contains zero or more CustomErrorResponses elements.
The comment originally specified when this distribution was created.
" }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution.
" }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept user requests for content.
" }, "ViewerCertificate":{ "shape":"ViewerCertificate", "documentation":"A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
" }, "Restrictions":{ "shape":"Restrictions", "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content.
" }, "WebACLId":{ "shape":"string", "documentation":"The Web ACL Id (if any) associated with the distribution.
" }, "HttpVersion":{ "shape":"HttpVersion", "documentation":" Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.
Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
" }, "AliasICPRecordals":{ "shape":"AliasICPRecordals", "documentation":"AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China.
" } }, "documentation":"A summary of the information about a CloudFront distribution.
" }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "EncryptionEntities":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"Number of field pattern items in a field-level encryption content type-profile mapping.
" }, "Items":{ "shape":"EncryptionEntityList", "documentation":"An array of field patterns in a field-level encryption content type-profile mapping.
" } }, "documentation":"Complex data type for field-level encryption profiles that includes all of the encryption entities.
" }, "EncryptionEntity":{ "type":"structure", "required":[ "PublicKeyId", "ProviderId", "FieldPatterns" ], "members":{ "PublicKeyId":{ "shape":"string", "documentation":"The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.
" }, "ProviderId":{ "shape":"string", "documentation":"The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.
" }, "FieldPatterns":{ "shape":"FieldPatterns", "documentation":"Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
" } }, "documentation":"Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
" }, "EncryptionEntityList":{ "type":"list", "member":{ "shape":"EncryptionEntity", "locationName":"EncryptionEntity" } }, "EndPoint":{ "type":"structure", "required":["StreamType"], "members":{ "StreamType":{ "shape":"string", "documentation":"The type of data stream where you are sending real-time log data. The only valid value is Kinesis.
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
" } }, "documentation":"Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
" }, "EndPointList":{ "type":"list", "member":{"shape":"EndPoint"} }, "EventType":{ "type":"string", "enum":[ "viewer-request", "viewer-response", "origin-request", "origin-response" ] }, "FieldLevelEncryption":{ "type":"structure", "required":[ "Id", "LastModifiedTime", "FieldLevelEncryptionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The last time the field-level encryption configuration was changed.
" }, "FieldLevelEncryptionConfig":{ "shape":"FieldLevelEncryptionConfig", "documentation":"A complex data type that includes the profile configurations specified for field-level encryption.
" } }, "documentation":"A complex data type that includes the profile configurations and other options specified for field-level encryption.
" }, "FieldLevelEncryptionConfig":{ "type":"structure", "required":["CallerReference"], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed.
" }, "Comment":{ "shape":"string", "documentation":"An optional comment about the configuration.
" }, "QueryArgProfileConfig":{ "shape":"QueryArgProfileConfig", "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 query argument in a request.
" }, "ContentTypeProfileConfig":{ "shape":"ContentTypeProfileConfig", "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 in a request if a query argument doesn't specify a profile to use.
" } }, "documentation":"A complex data type that includes the profile configurations specified for field-level encryption.
" }, "FieldLevelEncryptionConfigAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified configuration for field-level encryption already exists.
", "error":{"httpStatusCode":409}, "exception":true }, "FieldLevelEncryptionConfigInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified configuration for field-level encryption is in use.
", "error":{"httpStatusCode":409}, "exception":true }, "FieldLevelEncryptionList":{ "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 configurations where you left off.
The maximum number of elements you want in the response body.
" }, "Quantity":{ "shape":"integer", "documentation":"The number of field-level encryption items.
" }, "Items":{ "shape":"FieldLevelEncryptionSummaryList", "documentation":"An array of field-level encryption items.
" } }, "documentation":"List of field-level encrpytion configurations.
" }, "FieldLevelEncryptionProfile":{ "type":"structure", "required":[ "Id", "LastModifiedTime", "FieldLevelEncryptionProfileConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The last time the field-level encryption profile was updated.
" }, "FieldLevelEncryptionProfileConfig":{ "shape":"FieldLevelEncryptionProfileConfig", "documentation":"A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.
" } }, "documentation":"A complex data type for field-level encryption profiles.
" }, "FieldLevelEncryptionProfileAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified profile for field-level encryption already exists.
", "error":{"httpStatusCode":409}, "exception":true }, "FieldLevelEncryptionProfileConfig":{ "type":"structure", "required":[ "Name", "CallerReference", "EncryptionEntities" ], "members":{ "Name":{ "shape":"string", "documentation":"Profile name for the field-level encryption profile.
" }, "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures that the request can't be replayed.
" }, "Comment":{ "shape":"string", "documentation":"An optional comment for the field-level encryption profile.
" }, "EncryptionEntities":{ "shape":"EncryptionEntities", "documentation":"A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
" } }, "documentation":"A complex data type of profiles for the field-level encryption.
" }, "FieldLevelEncryptionProfileInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified profile for field-level encryption is in use.
", "error":{"httpStatusCode":409}, "exception":true }, "FieldLevelEncryptionProfileList":{ "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 profiles where you left off.
The maximum number of field-level encryption profiles you want in the response body.
" }, "Quantity":{ "shape":"integer", "documentation":"The number of field-level encryption profiles.
" }, "Items":{ "shape":"FieldLevelEncryptionProfileSummaryList", "documentation":"The field-level encryption profile items.
" } }, "documentation":"List of field-level encryption profiles.
" }, "FieldLevelEncryptionProfileSizeExceeded":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The maximum size of a profile for field-level encryption was exceeded.
", "error":{"httpStatusCode":400}, "exception":true }, "FieldLevelEncryptionProfileSummary":{ "type":"structure", "required":[ "Id", "LastModifiedTime", "Name", "EncryptionEntities" ], "members":{ "Id":{ "shape":"string", "documentation":"ID for the field-level encryption profile summary.
" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The time when the the field-level encryption profile summary was last updated.
" }, "Name":{ "shape":"string", "documentation":"Name for the field-level encryption profile summary.
" }, "EncryptionEntities":{ "shape":"EncryptionEntities", "documentation":"A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
" }, "Comment":{ "shape":"string", "documentation":"An optional comment for the field-level encryption profile summary.
" } }, "documentation":"The field-level encryption profile summary.
" }, "FieldLevelEncryptionProfileSummaryList":{ "type":"list", "member":{ "shape":"FieldLevelEncryptionProfileSummary", "locationName":"FieldLevelEncryptionProfileSummary" } }, "FieldLevelEncryptionSummary":{ "type":"structure", "required":[ "Id", "LastModifiedTime" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID of a field-level encryption item.
" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The last time that the summary of field-level encryption items was modified.
" }, "Comment":{ "shape":"string", "documentation":"An optional comment about the field-level encryption item.
" }, "QueryArgProfileConfig":{ "shape":"QueryArgProfileConfig", "documentation":"A summary of a query argument-profile mapping.
" }, "ContentTypeProfileConfig":{ "shape":"ContentTypeProfileConfig", "documentation":"A summary of a content type-profile mapping.
" } }, "documentation":"A summary of a field-level encryption item.
" }, "FieldLevelEncryptionSummaryList":{ "type":"list", "member":{ "shape":"FieldLevelEncryptionSummary", "locationName":"FieldLevelEncryptionSummary" } }, "FieldList":{ "type":"list", "member":{ "shape":"string", "locationName":"Field" } }, "FieldPatternList":{ "type":"list", "member":{ "shape":"string", "locationName":"FieldPattern" } }, "FieldPatterns":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of field-level encryption field patterns.
" }, "Items":{ "shape":"FieldPatternList", "documentation":"An array of the field-level encryption field patterns.
" } }, "documentation":"A complex data type that includes the field patterns to match for field-level encryption.
" }, "Format":{ "type":"string", "enum":["URLEncoded"] }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString, CloudFront doesn't forward any query string 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 Amazon CloudFront Developer Guide.
" }, "Cookies":{ "shape":"CookiePreference", "documentation":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.
" }, "Headers":{ "shape":"Headers", "documentation":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies the Headers, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.
" }, "QueryStringCacheKeys":{ "shape":"QueryStringCacheKeys", "documentation":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
" } }, "documentation":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
" }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country:
none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.
blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.
whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.
When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.
A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).
The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.
CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
The unique identifier for the cache policy. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.
The cache policy configuration.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the cache policy.
", "location":"header", "locationName":"ETag" } }, "payload":"CachePolicyConfig" }, "GetCachePolicyRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The unique identifier for the cache policy. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.
The cache policy.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the cache policy.
", "location":"header", "locationName":"ETag" } }, "payload":"CachePolicy" }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's ID.
", "location":"uri", "locationName":"Id" } }, "documentation":"The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfig.
" }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.
The returned result of the corresponding request.
", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's ID.
", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's information.
" }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.
The returned result of the corresponding request.
", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution configuration.
" }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.
The returned result of the corresponding request.
", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution's information.
" }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.
The returned result of the corresponding request.
", "payload":"Distribution" }, "GetFieldLevelEncryptionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"Request the ID for the field-level encryption configuration information.
", "location":"uri", "locationName":"Id" } } }, "GetFieldLevelEncryptionConfigResult":{ "type":"structure", "members":{ "FieldLevelEncryptionConfig":{ "shape":"FieldLevelEncryptionConfig", "documentation":"Return the field-level encryption configuration information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
Get the ID for the field-level encryption profile configuration information.
", "location":"uri", "locationName":"Id" } } }, "GetFieldLevelEncryptionProfileConfigResult":{ "type":"structure", "members":{ "FieldLevelEncryptionProfileConfig":{ "shape":"FieldLevelEncryptionProfileConfig", "documentation":"Return the field-level encryption profile configuration information.
" }, "ETag":{ "shape":"string", "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.
", "location":"uri", "locationName":"Id" } } }, "GetFieldLevelEncryptionProfileResult":{ "type":"structure", "members":{ "FieldLevelEncryptionProfile":{ "shape":"FieldLevelEncryptionProfile", "documentation":"Return the field-level encryption profile information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.
Request the ID for the field-level encryption configuration information.
", "location":"uri", "locationName":"Id" } } }, "GetFieldLevelEncryptionResult":{ "type":"structure", "members":{ "FieldLevelEncryption":{ "shape":"FieldLevelEncryption", "documentation":"Return the field-level encryption configuration information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
The distribution's ID.
", "location":"uri", "locationName":"DistributionId" }, "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request, for example, IDFDVBD632BHDS5.
The request to get an invalidation's information.
" }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information. For more information, see Invalidation Complex Type.
" } }, "documentation":"The returned result of the corresponding request.
", "payload":"Invalidation" }, "GetKeyGroupConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identifier of the key group whose configuration you are getting. To get the identifier, use ListKeyGroups.
The key group configuration.
" }, "ETag":{ "shape":"string", "documentation":"The identifier for this version of the key group.
", "location":"header", "locationName":"ETag" } }, "payload":"KeyGroupConfig" }, "GetKeyGroupRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identifier of the key group that you are getting. To get the identifier, use ListKeyGroups.
The key group.
" }, "ETag":{ "shape":"string", "documentation":"The identifier for this version of the key group.
", "location":"header", "locationName":"ETag" } }, "payload":"KeyGroup" }, "GetMonitoringSubscriptionRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "documentation":"The ID of the distribution that you are getting metrics information for.
", "location":"uri", "locationName":"DistributionId" } } }, "GetMonitoringSubscriptionResult":{ "type":"structure", "members":{ "MonitoringSubscription":{ "shape":"MonitoringSubscription", "documentation":"A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
" } }, "payload":"MonitoringSubscription" }, "GetOriginRequestPolicyConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The unique identifier for the origin request policy. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
The origin request policy configuration.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin request policy.
", "location":"header", "locationName":"ETag" } }, "payload":"OriginRequestPolicyConfig" }, "GetOriginRequestPolicyRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The unique identifier for the origin request policy. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
The origin request policy.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin request policy.
", "location":"header", "locationName":"ETag" } }, "payload":"OriginRequestPolicy" }, "GetPublicKeyConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identifier of the public key whose configuration you are getting.
", "location":"uri", "locationName":"Id" } } }, "GetPublicKeyConfigResult":{ "type":"structure", "members":{ "PublicKeyConfig":{ "shape":"PublicKeyConfig", "documentation":"A public key configuration.
" }, "ETag":{ "shape":"string", "documentation":"The identifier for this version of the public key configuration.
", "location":"header", "locationName":"ETag" } }, "payload":"PublicKeyConfig" }, "GetPublicKeyRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identifier of the public key you are getting.
", "location":"uri", "locationName":"Id" } } }, "GetPublicKeyResult":{ "type":"structure", "members":{ "PublicKey":{ "shape":"PublicKey", "documentation":"The public key.
" }, "ETag":{ "shape":"string", "documentation":"The identifier for this version of the public key.
", "location":"header", "locationName":"ETag" } }, "payload":"PublicKey" }, "GetRealtimeLogConfigRequest":{ "type":"structure", "members":{ "Name":{ "shape":"string", "documentation":"The name of the real-time log configuration to get.
" }, "ARN":{ "shape":"string", "documentation":"The Amazon Resource Name (ARN) of the real-time log configuration to get.
" } } }, "GetRealtimeLogConfigResult":{ "type":"structure", "members":{ "RealtimeLogConfig":{ "shape":"RealtimeLogConfig", "documentation":"A real-time log configuration.
" } } }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's ID.
", "location":"uri", "locationName":"Id" } }, "documentation":"To request to get a streaming distribution configuration.
" }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.
The returned result of the corresponding request.
", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's ID.
", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a streaming distribution's information.
" }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.
The returned result of the corresponding request.
", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of header names in the Items list.
A list of HTTP header names.
" } }, "documentation":"Contains a list of HTTP header names.
" }, "HttpVersion":{ "type":"string", "enum":[ "http1.1", "http2" ] }, "ICPRecordalStatus":{ "type":"string", "enum":[ "APPROVED", "SUSPENDED", "PENDING" ] }, "IllegalDelete":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot delete a managed policy.
", "error":{"httpStatusCode":400}, "exception":true }, "IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified configuration for field-level encryption can't be associated with the specified cache behavior.
", "error":{"httpStatusCode":400}, "exception":true }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The update contains modifications that are not allowed.
", "error":{"httpStatusCode":400}, "exception":true }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The value of Quantity and the size of Items don't match.
An argument is invalid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The default root object file name is too big or contains an invalid character.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"An invalid error code was specified.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.
The specified geo restriction parameter is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The headers specified are not valid for an Amazon S3 origin.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The If-Match version is missing or not valid.
The specified Lambda function association is invalid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The location code specified is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidMinimumProtocolVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The minimum protocol version specified is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The origin access identity is not valid or doesn't exist.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOriginKeepaliveTimeout":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The keep alive timeout specified for the origin is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOriginReadTimeout":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The read timeout specified for the origin is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidQueryStringParameters":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The query string parameters specified are not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.
A response code is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidTTLOrder":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The TTL order specified is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidTagging":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The tagging specified is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"A viewer certificate specified is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidWebACLId":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.
The identifier for the invalidation request. For example: IDFDVBD632BHDS5.
The status of the invalidation request. When the invalidation batch is finished, the status is Completed.
The date and time the invalidation request was first made.
" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request.
" } }, "documentation":"An invalidation.
" }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "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.
" }, "CallerReference":{ "shape":"string", "documentation":"A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.
If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.
If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.
An invalidation batch.
" }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value that you provided for the Marker request parameter.
If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your 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 your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.
The number of invalidation batches that were created by the current AWS account.
" }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account.
The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.
The unique ID for an invalidation request.
" }, "CreateTime":{ "shape":"timestamp", "documentation":"The time that an invalidation request was created.
" }, "Status":{ "shape":"string", "documentation":"The status of an invalidation request.
" } }, "documentation":"A summary of an invalidation request.
" }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KGKeyPairIds":{ "type":"structure", "members":{ "KeyGroupId":{ "shape":"string", "documentation":"The identifier of the key group that contains the public keys.
" }, "KeyPairIds":{"shape":"KeyPairIds"} }, "documentation":"A list of identifiers for the public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" }, "KGKeyPairIdsList":{ "type":"list", "member":{ "shape":"KGKeyPairIds", "locationName":"KeyGroup" } }, "KeyGroup":{ "type":"structure", "required":[ "Id", "LastModifiedTime", "KeyGroupConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the key group.
" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time when the key group was last modified.
" }, "KeyGroupConfig":{ "shape":"KeyGroupConfig", "documentation":"The key group configuration.
" } }, "documentation":"A key group.
A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.
" }, "KeyGroupAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"A key group with this name already exists. You must provide a unique name. To modify an existing key group, use UpdateKeyGroup.
A name to identify the key group.
" }, "Items":{ "shape":"PublicKeyIdList", "documentation":"A list of the identifiers of the public keys in the key group.
" }, "Comment":{ "shape":"string", "documentation":"A comment to describe the key group.
" } }, "documentation":"A key group configuration.
A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.
" }, "KeyGroupList":{ "type":"structure", "required":[ "MaxItems", "Quantity" ], "members":{ "NextMarker":{ "shape":"string", "documentation":"If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing key groups.
The maximum number of key groups requested.
" }, "Quantity":{ "shape":"integer", "documentation":"The number of key groups returned in the response.
" }, "Items":{ "shape":"KeyGroupSummaryList", "documentation":"A list of key groups.
" } }, "documentation":"A list of key groups.
" }, "KeyGroupSummary":{ "type":"structure", "required":["KeyGroup"], "members":{ "KeyGroup":{ "shape":"KeyGroup", "documentation":"A key group.
" } }, "documentation":"Contains information about a key group.
" }, "KeyGroupSummaryList":{ "type":"list", "member":{ "shape":"KeyGroupSummary", "locationName":"KeyGroupSummary" } }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of key pair identifiers in the list.
" }, "Items":{ "shape":"KeyPairIdList", "documentation":"A list of CloudFront key pair identifiers.
" } }, "documentation":"A list of CloudFront key pair identifiers.
" }, "KinesisStreamConfig":{ "type":"structure", "required":[ "RoleARN", "StreamARN" ], "members":{ "RoleARN":{ "shape":"string", "documentation":"The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.
For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide.
" }, "StreamARN":{ "shape":"string", "documentation":"The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
" } }, "documentation":"Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
" }, "LambdaFunctionARN":{"type":"string"}, "LambdaFunctionAssociation":{ "type":"structure", "required":[ "LambdaFunctionARN", "EventType" ], "members":{ "LambdaFunctionARN":{ "shape":"LambdaFunctionARN", "documentation":"The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.
" }, "EventType":{ "shape":"EventType", "documentation":"Specifies the event type that triggers a Lambda function invocation. You can specify the following values:
viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.
origin-request: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.
origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.
viewer-response: The function executes before CloudFront returns the requested object to the viewer. The 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.
A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
" } }, "documentation":"A complex type that contains a Lambda function association.
" }, "LambdaFunctionAssociationList":{ "type":"list", "member":{ "shape":"LambdaFunctionAssociation", "locationName":"LambdaFunctionAssociation" } }, "LambdaFunctionAssociations":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of Lambda function associations for this cache behavior.
" }, "Items":{ "shape":"LambdaFunctionAssociationList", "documentation":" Optional: A complex type that contains LambdaFunctionAssociation items for 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 behavior.
If you want to invoke one or more Lambda functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with the Lambda function only once.
If you don't want to invoke any Lambda functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.
A filter to return only the specified kinds of cache policies. Valid values are:
managed – Returns only the managed policies created by AWS.
custom – Returns only the custom policies created in your AWS account.
Use this field when paginating results to indicate where to begin in your list of cache policies. The response includes cache policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.
The maximum number of cache policies that you want in the response.
", "location":"querystring", "locationName":"MaxItems" } } }, "ListCachePoliciesResult":{ "type":"structure", "members":{ "CachePolicyList":{ "shape":"CachePolicyList", "documentation":"A list of cache policies.
" } }, "payload":"CachePolicyList" }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities 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 identity on that page).
The maximum number of origin access identities you want in the response body.
", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list origin access identities.
" }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type.
The returned result of the corresponding request.
", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsByCachePolicyIdRequest":{ "type":"structure", "required":["CachePolicyId"], "members":{ "Marker":{ "shape":"string", "documentation":"Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.
The maximum number of distribution IDs that you want in the response.
", "location":"querystring", "locationName":"MaxItems" }, "CachePolicyId":{ "shape":"string", "documentation":"The ID of the cache policy whose associated distribution IDs you want to list.
", "location":"uri", "locationName":"CachePolicyId" } } }, "ListDistributionsByCachePolicyIdResult":{ "type":"structure", "members":{ "DistributionIdList":{ "shape":"DistributionIdList", "documentation":"A list of distribution IDs.
" } }, "payload":"DistributionIdList" }, "ListDistributionsByKeyGroupRequest":{ "type":"structure", "required":["KeyGroupId"], "members":{ "Marker":{ "shape":"string", "documentation":"Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.
The maximum number of distribution IDs that you want in the response.
", "location":"querystring", "locationName":"MaxItems" }, "KeyGroupId":{ "shape":"string", "documentation":"The ID of the key group whose associated distribution IDs you are listing.
", "location":"uri", "locationName":"KeyGroupId" } } }, "ListDistributionsByKeyGroupResult":{ "type":"structure", "members":{ "DistributionIdList":{"shape":"DistributionIdList"} }, "payload":"DistributionIdList" }, "ListDistributionsByOriginRequestPolicyIdRequest":{ "type":"structure", "required":["OriginRequestPolicyId"], "members":{ "Marker":{ "shape":"string", "documentation":"Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.
The maximum number of distribution IDs that you want in the response.
", "location":"querystring", "locationName":"MaxItems" }, "OriginRequestPolicyId":{ "shape":"string", "documentation":"The ID of the origin request policy whose associated distribution IDs you want to list.
", "location":"uri", "locationName":"OriginRequestPolicyId" } } }, "ListDistributionsByOriginRequestPolicyIdResult":{ "type":"structure", "members":{ "DistributionIdList":{ "shape":"DistributionIdList", "documentation":"A list of distribution IDs.
" } }, "payload":"DistributionIdList" }, "ListDistributionsByRealtimeLogConfigRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"Use this field when paginating results to indicate where to begin in your list of distributions. The response includes distributions in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.
The maximum number of distributions that you want in the response.
" }, "RealtimeLogConfigName":{ "shape":"string", "documentation":"The name of the real-time log configuration whose associated distributions you want to list.
" }, "RealtimeLogConfigArn":{ "shape":"string", "documentation":"The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list.
" } } }, "ListDistributionsByRealtimeLogConfigResult":{ "type":"structure", "members":{ "DistributionList":{"shape":"DistributionList"} }, "payload":"DistributionList" }, "ListDistributionsByWebACLIdRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)
The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
", "location":"querystring", "locationName":"MaxItems" }, "WebACLId":{ "shape":"string", "documentation":"The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.
", "location":"uri", "locationName":"WebACLId" } }, "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL.
" }, "ListDistributionsByWebACLIdResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type.
The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.
", "payload":"DistributionList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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" }, "ListKeyGroupsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"Use this field when paginating results to indicate where to begin in your list of key groups. The response includes key groups in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.
The maximum number of key groups that you want in the response.
", "location":"querystring", "locationName":"MaxItems" } } }, "ListKeyGroupsResult":{ "type":"structure", "members":{ "KeyGroupList":{ "shape":"KeyGroupList", "documentation":"A list of key groups.
" } }, "payload":"KeyGroupList" }, "ListOriginRequestPoliciesRequest":{ "type":"structure", "members":{ "Type":{ "shape":"OriginRequestPolicyType", "documentation":"A filter to return only the specified kinds of origin request policies. Valid values are:
managed – Returns only the managed policies created by AWS.
custom – Returns only the custom policies created in your AWS account.
Use this field when paginating results to indicate where to begin in your list of origin request policies. The response includes origin request policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.
The maximum number of origin request policies that you want in the response.
", "location":"querystring", "locationName":"MaxItems" } } }, "ListOriginRequestPoliciesResult":{ "type":"structure", "members":{ "OriginRequestPolicyList":{ "shape":"OriginRequestPolicyList", "documentation":"A list of origin request policies.
" } }, "payload":"OriginRequestPolicyList" }, "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" }, "ListRealtimeLogConfigsRequest":{ "type":"structure", "members":{ "MaxItems":{ "shape":"string", "documentation":"The maximum number of real-time log configurations that you want in the response.
", "location":"querystring", "locationName":"MaxItems" }, "Marker":{ "shape":"string", "documentation":"Use this field when paginating results to indicate where to begin in your list of real-time log configurations. The response includes real-time log configurations in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.
A list of real-time log configurations.
" } }, "payload":"RealtimeLogConfigs" }, "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", "TLSv1.2_2019" ] }, "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.
A subscription configuration for additional CloudWatch metrics.
" } }, "documentation":"A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
" }, "NoSuchCachePolicy":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The cache policy does not exist.
", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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 origin request policy does not exist.
", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchPublicKey":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified public key doesn't exist.
", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchRealtimeLogConfig":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The real-time log configuration does not exist.
", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchResource":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"A resource that was specified is not valid.
", "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. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.
The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
" }, "OriginPath":{ "shape":"string", "documentation":"An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide.
" }, "CustomHeaders":{ "shape":"CustomHeaders", "documentation":"A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
" }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
" }, "ConnectionTimeout":{ "shape":"integer", "documentation":"The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
" }, "OriginShield":{ "shape":"OriginShield", "documentation":"CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.
For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
" } }, "documentation":"An origin.
An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:
Use S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.
Use CustomOriginConfig to specify all other kinds of origins, including:
An Amazon S3 bucket that is configured with static website hosting
An Elastic Load Balancing load balancer
An AWS Elemental MediaPackage endpoint
An AWS Elemental MediaStore container
Any other HTTP server, running on an Amazon EC2 instance or any other kind of host
For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the Amazon CloudFront Developer Guide (quotas were formerly referred to as limits).
" }, "OriginCustomHeader":{ "type":"structure", "required":[ "HeaderName", "HeaderValue" ], "members":{ "HeaderName":{ "shape":"string", "documentation":"The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the 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 origin group's ID.
" }, "FailoverCriteria":{ "shape":"OriginGroupFailoverCriteria", "documentation":"A complex type that contains information about the failover criteria for an origin group.
" }, "Members":{ "shape":"OriginGroupMembers", "documentation":"A complex type that contains information about the origins in an origin group.
" } }, "documentation":"An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specifiy the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you've chosen.
" }, "OriginGroupFailoverCriteria":{ "type":"structure", "required":["StatusCodes"], "members":{ "StatusCodes":{ "shape":"StatusCodes", "documentation":"The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.
" } }, "documentation":"A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.
" }, "OriginGroupList":{ "type":"list", "member":{ "shape":"OriginGroup", "locationName":"OriginGroup" }, "documentation":"List of origin groups for a distribution.
" }, "OriginGroupMember":{ "type":"structure", "required":["OriginId"], "members":{ "OriginId":{ "shape":"string", "documentation":"The ID for an origin in an origin group.
" } }, "documentation":"An origin in an origin group.
" }, "OriginGroupMemberList":{ "type":"list", "member":{ "shape":"OriginGroupMember", "locationName":"OriginGroupMember" }, "documentation":"List of origins in an origin group.
", "max":2, "min":2 }, "OriginGroupMembers":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins in an origin group.
" }, "Items":{ "shape":"OriginGroupMemberList", "documentation":"Items (origins) in an origin group.
" } }, "documentation":"A complex data type for the origins included in an origin group.
" }, "OriginGroups":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origin groups.
" }, "Items":{ "shape":"OriginGroupList", "documentation":"The items (origin groups) in a distribution.
" } }, "documentation":"A complex data type for the origin groups specified for a distribution.
" }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer", "https-only" ] }, "OriginRequestPolicy":{ "type":"structure", "required":[ "Id", "LastModifiedTime", "OriginRequestPolicyConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique identifier for the origin request policy.
" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time when the origin request policy was last modified.
" }, "OriginRequestPolicyConfig":{ "shape":"OriginRequestPolicyConfig", "documentation":"The origin request policy configuration.
" } }, "documentation":"An origin request policy.
When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can’t find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.
An origin request policy with this name already exists. You must provide a unique name. To modify an existing origin request policy, use UpdateOriginRequestPolicy.
A comment to describe the origin request policy.
" }, "Name":{ "shape":"string", "documentation":"A unique name to identify the origin request policy.
" }, "HeadersConfig":{ "shape":"OriginRequestPolicyHeadersConfig", "documentation":"The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
" }, "CookiesConfig":{ "shape":"OriginRequestPolicyCookiesConfig", "documentation":"The cookies from viewer requests to include in origin requests.
" }, "QueryStringsConfig":{ "shape":"OriginRequestPolicyQueryStringsConfig", "documentation":"The URL query strings from viewer requests to include in origin requests.
" } }, "documentation":"An origin request policy configuration.
This configuration determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can’t find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in a CachePolicy are included in origin requests.
whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.
all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.
An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin.
" }, "OriginRequestPolicyHeaderBehavior":{ "type":"string", "enum":[ "none", "whitelist", "allViewer", "allViewerAndWhitelistCloudFront" ] }, "OriginRequestPolicyHeadersConfig":{ "type":"structure", "required":["HeaderBehavior"], "members":{ "HeaderBehavior":{ "shape":"OriginRequestPolicyHeaderBehavior", "documentation":"Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:
none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in a CachePolicy are included in origin requests.
whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.
allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.
allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.
An object that determines whether any HTTP headers (and if so, which headers) are included in requests that CloudFront sends to the origin.
" }, "OriginRequestPolicyInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Cannot delete the origin request policy because it is attached to one or more cache behaviors.
", "error":{"httpStatusCode":409}, "exception":true }, "OriginRequestPolicyList":{ "type":"structure", "required":[ "MaxItems", "Quantity" ], "members":{ "NextMarker":{ "shape":"string", "documentation":"If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing origin request policies where you left off.
The maximum number of origin request policies requested.
" }, "Quantity":{ "shape":"integer", "documentation":"The total number of origin request policies returned in the response.
" }, "Items":{ "shape":"OriginRequestPolicySummaryList", "documentation":"Contains the origin request policies in the list.
" } }, "documentation":"A list of origin request policies.
" }, "OriginRequestPolicyQueryStringBehavior":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "OriginRequestPolicyQueryStringsConfig":{ "type":"structure", "required":["QueryStringBehavior"], "members":{ "QueryStringBehavior":{ "shape":"OriginRequestPolicyQueryStringBehavior", "documentation":"Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in a CachePolicy are included in origin requests.
whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.
all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.
Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.
" } }, "documentation":"An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in requests that CloudFront sends to the origin.
" }, "OriginRequestPolicySummary":{ "type":"structure", "required":[ "Type", "OriginRequestPolicy" ], "members":{ "Type":{ "shape":"OriginRequestPolicyType", "documentation":"The type of origin request policy, either managed (created by AWS) or custom (created in this AWS account).
The origin request policy.
" } }, "documentation":"Contains an origin request policy.
" }, "OriginRequestPolicySummaryList":{ "type":"list", "member":{ "shape":"OriginRequestPolicySummary", "locationName":"OriginRequestPolicySummary" } }, "OriginRequestPolicyType":{ "type":"string", "enum":[ "managed", "custom" ] }, "OriginShield":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"boolean", "documentation":"A flag that specifies whether Origin Shield is enabled.
When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
" }, "OriginShieldRegion":{ "shape":"OriginShieldRegion", "documentation":"The AWS Region for Origin Shield.
Specify the AWS Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. 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 Shield. For the list of AWS Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the AWS Region for Origin Shield in the Amazon CloudFront Developer Guide.
" } }, "documentation":"CloudFront Origin Shield.
Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
" }, "OriginShieldRegion":{ "type":"string", "max":32, "min":1, "pattern":"[a-z]{2}-[a-z]+-\\d" }, "OriginSslProtocols":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"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", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution.
" }, "Items":{ "shape":"OriginList", "documentation":"A list of origins.
" } }, "documentation":"Contains information about the origins for this distribution.
" }, "ParametersInCacheKeyAndForwardedToOrigin":{ "type":"structure", "required":[ "EnableAcceptEncodingGzip", "HeadersConfig", "CookiesConfig", "QueryStringsConfig" ], "members":{ "EnableAcceptEncodingGzip":{ "shape":"boolean", "documentation":"A flag that can affect whether the Accept-Encoding HTTP header is included 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 both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Normalizes the value of the viewer’s Accept-Encoding header
Includes the normalized header in the cache key
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.
If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
A flag that can affect whether the Accept-Encoding HTTP header is included 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 both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Normalizes the value of the viewer’s Accept-Encoding header
Includes the normalized header in the cache key
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.
If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
" }, "CookiesConfig":{ "shape":"CachePolicyCookiesConfig", "documentation":"An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
" }, "QueryStringsConfig":{ "shape":"CachePolicyQueryStringsConfig", "documentation":"An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
" } }, "documentation":"This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.
The number of invalidation paths specified for the 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.
The identifier of the public key.
" }, "CreatedTime":{ "shape":"timestamp", "documentation":"The date and time when the public key was uploaded.
" }, "PublicKeyConfig":{ "shape":"PublicKeyConfig", "documentation":"Configuration information about a public key that you can use with signed URLs and signed cookies, or with field-level encryption.
" } }, "documentation":"A public key that you can use with signed URLs and signed cookies, or with 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 string included in the request to help make sure that the request can’t be replayed.
" }, "Name":{ "shape":"string", "documentation":"A name to help identify the public key.
" }, "EncodedKey":{ "shape":"string", "documentation":"The public key that you can use with signed URLs and signed cookies, or with field-level encryption.
" }, "Comment":{ "shape":"string", "documentation":"A comment to describe the public key.
" } }, "documentation":"Configuration information about a public key that you can use with signed URLs and signed cookies, or with field-level encryption.
" }, "PublicKeyIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"PublicKey" } }, "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.
" }, "Quantity":{ "shape":"integer", "documentation":"The number of public keys in the list.
" }, "Items":{ "shape":"PublicKeySummaryList", "documentation":"A list of public keys.
" } }, "documentation":"A list of public keys that you can use with signed URLs and signed cookies, or with field-level encryption.
" }, "PublicKeySummary":{ "type":"structure", "required":[ "Id", "Name", "CreatedTime", "EncodedKey" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier of the public key.
" }, "Name":{ "shape":"string", "documentation":"A name to help identify the public key.
" }, "CreatedTime":{ "shape":"timestamp", "documentation":"The date and time when the public key was uploaded.
" }, "EncodedKey":{ "shape":"string", "documentation":"The public key.
" }, "Comment":{ "shape":"string", "documentation":"A comment to describe the public key.
" } }, "documentation":"Contains information about a public key.
" }, "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 a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use QueryStringsConfig in a cache policy. See CachePolicy.
If you want to send query strings to the origin but not include them in the cache key, use QueryStringsConfig in an origin request policy. See OriginRequestPolicy.
A complex type that contains information about the query string parameters that you want CloudFront to use for caching for a cache behavior.
" }, "QueryStringCacheKeysList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "QueryStringNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of query string names in the Items list.
A list of query string names.
" } }, "documentation":"Contains a list of query string names.
" }, "QueryStringNamesList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "RealtimeLogConfig":{ "type":"structure", "required":[ "ARN", "Name", "SamplingRate", "EndPoints", "Fields" ], "members":{ "ARN":{ "shape":"string", "documentation":"The Amazon Resource Name (ARN) of this real-time log configuration.
" }, "Name":{ "shape":"string", "documentation":"The unique name of this real-time log configuration.
" }, "SamplingRate":{ "shape":"long", "documentation":"The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.
" }, "EndPoints":{ "shape":"EndPointList", "documentation":"Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
" }, "Fields":{ "shape":"FieldList", "documentation":"A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
" } }, "documentation":"A real-time log configuration.
" }, "RealtimeLogConfigAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"A real-time log configuration with this name already exists. You must provide a unique name. To modify an existing real-time log configuration, use UpdateRealtimeLogConfig.
Cannot delete the real-time log configuration because it is attached to one or more cache behaviors.
", "error":{"httpStatusCode":400}, "exception":true }, "RealtimeLogConfigList":{ "type":"list", "member":{"shape":"RealtimeLogConfig"} }, "RealtimeLogConfigs":{ "type":"structure", "required":[ "MaxItems", "IsTruncated", "Marker" ], "members":{ "MaxItems":{ "shape":"integer", "documentation":"The maximum number of real-time log configurations requested.
" }, "Items":{ "shape":"RealtimeLogConfigList", "documentation":"Contains the list of real-time log configurations.
" }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether there are more real-time log configurations than are contained in this list.
" }, "Marker":{ "shape":"string", "documentation":"This parameter indicates where this list of real-time log configurations begins. This list includes real-time log configurations that occur after the marker.
" }, "NextMarker":{ "shape":"string", "documentation":"If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing real-time log configurations where you left off.
A list of real-time log configurations.
" }, "RealtimeMetricsSubscriptionConfig":{ "type":"structure", "required":["RealtimeMetricsSubscriptionStatus"], "members":{ "RealtimeMetricsSubscriptionStatus":{ "shape":"RealtimeMetricsSubscriptionStatus", "documentation":"A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
" } }, "documentation":"A subscription configuration for additional CloudWatch metrics.
" }, "RealtimeMetricsSubscriptionStatus":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "ResourceARN":{ "type":"string", "pattern":"arn:aws(-cn)?:cloudfront::[0-9]+:.*" }, "ResourceInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Cannot delete this resource because it is in use.
", "error":{"httpStatusCode":409}, "exception":true }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{ "shape":"GeoRestriction", "documentation":"A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
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 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 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 or an S3 bucket that is configured as a website endpoint, use the CustomOriginConfig element instead.
An AWS account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the AWS account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self.
A list of CloudFront key pair identifiers.
" } }, "documentation":"A list of AWS accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "SslProtocol":{ "type":"string", "enum":[ "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2" ] }, "SslProtocolsList":{ "type":"list", "member":{ "shape":"SslProtocol", "locationName":"SslProtocol" } }, "StatusCodeList":{ "type":"list", "member":{ "shape":"integer", "locationName":"StatusCode" }, "documentation":"List of status codes for origin failover.
", "min":1 }, "StatusCodes":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of status codes.
" }, "Items":{ "shape":"StatusCodeList", "documentation":"The items (status codes) for an origin group.
" } }, "documentation":"A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.
" }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.
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 tells CloudFront where you want RTMP content to be delivered from, and the details about how to track and manage content delivery.
" }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The caller reference you attempted to create the streaming distribution with is associated with another distribution
", "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, 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"} }, "documentation":"The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.
", "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.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
" }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created.
" }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution.
" }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content.
" } }, "documentation":"A summary of the information for a 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 }, "TooManyCachePolicies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You have reached the maximum number of cache policies for this AWS account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "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 }, "TooManyCookiesInCachePolicy":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The number of cookies in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCookiesInOriginRequestPolicy":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The number of cookies in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "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 }, "TooManyDistributionsAssociatedToCachePolicy":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The maximum number of distributions have been associated with the specified cache policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "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 }, "TooManyDistributionsAssociatedToKeyGroup":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The number of distributions that reference this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionsAssociatedToOriginRequestPolicy":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The maximum number of distributions have been associated with the specified origin request policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "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 }, "TooManyDistributionsWithSingleFunctionARN":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The maximum number of distributions have been associated with the specified Lambda function.
", "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 }, "TooManyHeadersInCachePolicy":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The number of headers in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains too many headers in forwarded values.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyHeadersInOriginRequestPolicy":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The number of headers in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "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 }, "TooManyKeyGroups":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You have reached the maximum number of key groups for this AWS account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyKeyGroupsAssociatedToDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The number of key groups referenced by this distribution is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "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"} }, "documentation":"Your request contains too many origin custom headers.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyOriginGroupsPerDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of origin groups allowed.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyOriginRequestPolicies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You have reached the maximum number of origin request policies for this AWS account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "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 }, "TooManyPublicKeysInKeyGroup":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The number of public keys in this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyQueryStringParameters":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains too many query string parameters.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyQueryStringsInCachePolicy":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The number of query strings in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyQueryStringsInOriginRequestPolicy":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The number of query strings in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyRealtimeLogConfigs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You have reached the maximum number of real-time log configurations for this AWS account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more CNAMEs than are allowed per distribution.
", "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 }, "TrustedKeyGroupDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified key group does not exist.
", "error":{"httpStatusCode":400}, "exception":true }, "TrustedKeyGroupIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyGroup" } }, "TrustedKeyGroups":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
The number of key groups in the list.
" }, "Items":{ "shape":"TrustedKeyGroupIdList", "documentation":"A list of key groups identifiers.
" } }, "documentation":"A list of key groups whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.
" }, "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":"This field is true if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
The number of AWS accounts in the list.
" }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"A list of AWS account identifiers.
" } }, "documentation":"A list of AWS accounts whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.
" }, "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" }, "UpdateCachePolicyRequest":{ "type":"structure", "required":[ "CachePolicyConfig", "Id" ], "members":{ "CachePolicyConfig":{ "shape":"CachePolicyConfig", "documentation":"A cache policy configuration.
", "locationName":"CachePolicyConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} }, "Id":{ "shape":"string", "documentation":"The unique identifier for the cache policy that you are updating. The identifier is returned in a cache behavior’s CachePolicyId field in the response to GetDistributionConfig.
The version of the cache policy that you are updating. The version is returned in the cache policy’s ETag field in the response to GetCachePolicyConfig.
A cache policy.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the cache policy.
", "location":"header", "locationName":"ETag" } }, "payload":"CachePolicy" }, "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/2020-05-31/"} }, "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/2020-05-31/"} }, "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/2020-05-31/"} }, "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/2020-05-31/"} }, "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" }, "UpdateKeyGroupRequest":{ "type":"structure", "required":[ "KeyGroupConfig", "Id" ], "members":{ "KeyGroupConfig":{ "shape":"KeyGroupConfig", "documentation":"The key group configuration.
", "locationName":"KeyGroupConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} }, "Id":{ "shape":"string", "documentation":"The identifier of the key group that you are updating.
", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The version of the key group that you are updating. The version is the key group’s ETag value.
The key group that was just updated.
" }, "ETag":{ "shape":"string", "documentation":"The identifier for this version of the key group.
", "location":"header", "locationName":"ETag" } }, "payload":"KeyGroup" }, "UpdateOriginRequestPolicyRequest":{ "type":"structure", "required":[ "OriginRequestPolicyConfig", "Id" ], "members":{ "OriginRequestPolicyConfig":{ "shape":"OriginRequestPolicyConfig", "documentation":"An origin request policy configuration.
", "locationName":"OriginRequestPolicyConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} }, "Id":{ "shape":"string", "documentation":"The unique identifier for the origin request policy that you are updating. The identifier is returned in a cache behavior’s OriginRequestPolicyId field in the response to GetDistributionConfig.
The version of the origin request policy that you are updating. The version is returned in the origin request policy’s ETag field in the response to GetOriginRequestPolicyConfig.
An origin request policy.
" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin request policy.
", "location":"header", "locationName":"ETag" } }, "payload":"OriginRequestPolicy" }, "UpdatePublicKeyRequest":{ "type":"structure", "required":[ "PublicKeyConfig", "Id" ], "members":{ "PublicKeyConfig":{ "shape":"PublicKeyConfig", "documentation":"A public key configuration.
", "locationName":"PublicKeyConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} }, "Id":{ "shape":"string", "documentation":"The identifier of the public key that you are updating.
", "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.
The public key.
" }, "ETag":{ "shape":"string", "documentation":"The identifier of the current version of the public key.
", "location":"header", "locationName":"ETag" } }, "payload":"PublicKey" }, "UpdateRealtimeLogConfigRequest":{ "type":"structure", "members":{ "EndPoints":{ "shape":"EndPointList", "documentation":"Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
" }, "Fields":{ "shape":"FieldList", "documentation":"A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
" }, "Name":{ "shape":"string", "documentation":"The name for this real-time log configuration.
" }, "ARN":{ "shape":"string", "documentation":"The Amazon Resource Name (ARN) for this real-time log configuration.
" }, "SamplingRate":{ "shape":"long", "documentation":"The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.
" } } }, "UpdateRealtimeLogConfigResult":{ "type":"structure", "members":{ "RealtimeLogConfig":{ "shape":"RealtimeLogConfig", "documentation":"A real-time log configuration.
" } } }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.
", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} }, "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":"If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, set this field to true.
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)
MinimumProtocolVersion
SSLSupportMethod
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM), provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Certificate Manager (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.
vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.
static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the AWS Support Center.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.
On the CloudFront console, this setting is called Security Policy.
When you’re using SNI only (you set SSLSupportMethod to sni-only), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificate
This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificate
A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
If the distribution doesn’t use Aliases (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net—set CloudFrontDefaultCertificate to true and leave all other fields empty.
If the distribution uses Aliases (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:
Which viewers the distribution accepts HTTPS connections from: only viewers that support server name indication (SNI) (recommended), or all viewers including those that don’t support SNI.
To accept HTTPS connections from only viewers that support SNI, set SSLSupportMethod to sni-only. This is recommended. Most browsers and clients support SNI.
To accept HTTPS connections from all viewers, including those that don’t support SNI, set SSLSupportMethod to vip. This is not recommended, and results in additional monthly charges from CloudFront.
The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for MinimumProtocolVersion. For more information, see Security Policy in the Amazon CloudFront Developer Guide.
The location of the SSL/TLS certificate, AWS Certificate Manager (ACM) (recommended) or AWS Identity and Access Management (AWS IAM). You specify the location by setting a value in one of the following fields (not both):
ACMCertificateArn
IAMCertificateId
All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy in the CacheBehavior or DefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use CustomOriginConfig.
For more information, see Using HTTPS with CloudFront and 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.
" }