UpdateDistributionWithStagingConfig
Copies the staging distribution's configuration to its corresponding primary
distribution. The primary distribution retains its Aliases
(also known as
alternate domain names or CNAMEs) and ContinuousDeploymentPolicyId
value,
but otherwise its configuration is overwritten to match the staging distribution.
You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution.
This API operation requires the following IAM permissions:
Request Syntax
PUT /2020-05-31/distribution/Id
/promote-staging-config?StagingDistributionId=StagingDistributionId
HTTP/1.1
If-Match: IfMatch
URI Request Parameters
The request uses the following URI parameters.
- Id
-
The identifier of the primary distribution to which you are copying a staging distribution's configuration.
Required: Yes
- If-Match
-
The current versions (
ETag
values) of both primary and staging distributions. Provide these in the following format:<primary ETag>, <staging ETag>
- StagingDistributionId
-
The identifier of the staging distribution whose configuration you are copying to the primary distribution.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<Distribution>
<ActiveTrustedKeyGroups>
<Enabled>boolean</Enabled>
<Items>
<KeyGroup>
<KeyGroupId>string</KeyGroupId>
<KeyPairIds>
<Items>
<KeyPairId>string</KeyPairId>
</Items>
<Quantity>integer</Quantity>
</KeyPairIds>
</KeyGroup>
</Items>
<Quantity>integer</Quantity>
</ActiveTrustedKeyGroups>
<ActiveTrustedSigners>
<Enabled>boolean</Enabled>
<Items>
<Signer>
<AwsAccountNumber>string</AwsAccountNumber>
<KeyPairIds>
<Items>
<KeyPairId>string</KeyPairId>
</Items>
<Quantity>integer</Quantity>
</KeyPairIds>
</Signer>
</Items>
<Quantity>integer</Quantity>
</ActiveTrustedSigners>
<AliasICPRecordals>
<AliasICPRecordal>
<CNAME>string</CNAME>
<ICPRecordalStatus>string</ICPRecordalStatus>
</AliasICPRecordal>
</AliasICPRecordals>
<ARN>string</ARN>
<DistributionConfig>
<Aliases>
<Items>
<CNAME>string</CNAME>
</Items>
<Quantity>integer</Quantity>
</Aliases>
<CacheBehaviors>
<Items>
<CacheBehavior>
<AllowedMethods>
<CachedMethods>
<Items>
<Method>string</Method>
</Items>
<Quantity>integer</Quantity>
</CachedMethods>
<Items>
<Method>string</Method>
</Items>
<Quantity>integer</Quantity>
</AllowedMethods>
<CachePolicyId>string</CachePolicyId>
<Compress>boolean</Compress>
<DefaultTTL>long</DefaultTTL>
<FieldLevelEncryptionId>string</FieldLevelEncryptionId>
<ForwardedValues>
<Cookies>
<Forward>string</Forward>
<WhitelistedNames>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</WhitelistedNames>
</Cookies>
<Headers>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</Headers>
<QueryString>boolean</QueryString>
<QueryStringCacheKeys>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</QueryStringCacheKeys>
</ForwardedValues>
<FunctionAssociations>
<Items>
<FunctionAssociation>
<EventType>string</EventType>
<FunctionARN>string</FunctionARN>
</FunctionAssociation>
</Items>
<Quantity>integer</Quantity>
</FunctionAssociations>
<LambdaFunctionAssociations>
<Items>
<LambdaFunctionAssociation>
<EventType>string</EventType>
<IncludeBody>boolean</IncludeBody>
<LambdaFunctionARN>string</LambdaFunctionARN>
</LambdaFunctionAssociation>
</Items>
<Quantity>integer</Quantity>
</LambdaFunctionAssociations>
<MaxTTL>long</MaxTTL>
<MinTTL>long</MinTTL>
<OriginRequestPolicyId>string</OriginRequestPolicyId>
<PathPattern>string</PathPattern>
<RealtimeLogConfigArn>string</RealtimeLogConfigArn>
<ResponseHeadersPolicyId>string</ResponseHeadersPolicyId>
<SmoothStreaming>boolean</SmoothStreaming>
<TargetOriginId>string</TargetOriginId>
<TrustedKeyGroups>
<Enabled>boolean</Enabled>
<Items>
<KeyGroup>string</KeyGroup>
</Items>
<Quantity>integer</Quantity>
</TrustedKeyGroups>
<TrustedSigners>
<Enabled>boolean</Enabled>
<Items>
<AwsAccountNumber>string</AwsAccountNumber>
</Items>
<Quantity>integer</Quantity>
</TrustedSigners>
<ViewerProtocolPolicy>string</ViewerProtocolPolicy>
</CacheBehavior>
</Items>
<Quantity>integer</Quantity>
</CacheBehaviors>
<CallerReference>string</CallerReference>
<Comment>string</Comment>
<ContinuousDeploymentPolicyId>string</ContinuousDeploymentPolicyId>
<CustomErrorResponses>
<Items>
<CustomErrorResponse>
<ErrorCachingMinTTL>long</ErrorCachingMinTTL>
<ErrorCode>integer</ErrorCode>
<ResponseCode>string</ResponseCode>
<ResponsePagePath>string</ResponsePagePath>
</CustomErrorResponse>
</Items>
<Quantity>integer</Quantity>
</CustomErrorResponses>
<DefaultCacheBehavior>
<AllowedMethods>
<CachedMethods>
<Items>
<Method>string</Method>
</Items>
<Quantity>integer</Quantity>
</CachedMethods>
<Items>
<Method>string</Method>
</Items>
<Quantity>integer</Quantity>
</AllowedMethods>
<CachePolicyId>string</CachePolicyId>
<Compress>boolean</Compress>
<DefaultTTL>long</DefaultTTL>
<FieldLevelEncryptionId>string</FieldLevelEncryptionId>
<ForwardedValues>
<Cookies>
<Forward>string</Forward>
<WhitelistedNames>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</WhitelistedNames>
</Cookies>
<Headers>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</Headers>
<QueryString>boolean</QueryString>
<QueryStringCacheKeys>
<Items>
<Name>string</Name>
</Items>
<Quantity>integer</Quantity>
</QueryStringCacheKeys>
</ForwardedValues>
<FunctionAssociations>
<Items>
<FunctionAssociation>
<EventType>string</EventType>
<FunctionARN>string</FunctionARN>
</FunctionAssociation>
</Items>
<Quantity>integer</Quantity>
</FunctionAssociations>
<LambdaFunctionAssociations>
<Items>
<LambdaFunctionAssociation>
<EventType>string</EventType>
<IncludeBody>boolean</IncludeBody>
<LambdaFunctionARN>string</LambdaFunctionARN>
</LambdaFunctionAssociation>
</Items>
<Quantity>integer</Quantity>
</LambdaFunctionAssociations>
<MaxTTL>long</MaxTTL>
<MinTTL>long</MinTTL>
<OriginRequestPolicyId>string</OriginRequestPolicyId>
<RealtimeLogConfigArn>string</RealtimeLogConfigArn>
<ResponseHeadersPolicyId>string</ResponseHeadersPolicyId>
<SmoothStreaming>boolean</SmoothStreaming>
<TargetOriginId>string</TargetOriginId>
<TrustedKeyGroups>
<Enabled>boolean</Enabled>
<Items>
<KeyGroup>string</KeyGroup>
</Items>
<Quantity>integer</Quantity>
</TrustedKeyGroups>
<TrustedSigners>
<Enabled>boolean</Enabled>
<Items>
<AwsAccountNumber>string</AwsAccountNumber>
</Items>
<Quantity>integer</Quantity>
</TrustedSigners>
<ViewerProtocolPolicy>string</ViewerProtocolPolicy>
</DefaultCacheBehavior>
<DefaultRootObject>string</DefaultRootObject>
<Enabled>boolean</Enabled>
<HttpVersion>string</HttpVersion>
<IsIPV6Enabled>boolean</IsIPV6Enabled>
<Logging>
<Bucket>string</Bucket>
<Enabled>boolean</Enabled>
<IncludeCookies>boolean</IncludeCookies>
<Prefix>string</Prefix>
</Logging>
<OriginGroups>
<Items>
<OriginGroup>
<FailoverCriteria>
<StatusCodes>
<Items>
<StatusCode>integer</StatusCode>
</Items>
<Quantity>integer</Quantity>
</StatusCodes>
</FailoverCriteria>
<Id>string</Id>
<Members>
<Items>
<OriginGroupMember>
<OriginId>string</OriginId>
</OriginGroupMember>
</Items>
<Quantity>integer</Quantity>
</Members>
</OriginGroup>
</Items>
<Quantity>integer</Quantity>
</OriginGroups>
<Origins>
<Items>
<Origin>
<ConnectionAttempts>integer</ConnectionAttempts>
<ConnectionTimeout>integer</ConnectionTimeout>
<CustomHeaders>
<Items>
<OriginCustomHeader>
<HeaderName>string</HeaderName>
<HeaderValue>string</HeaderValue>
</OriginCustomHeader>
</Items>
<Quantity>integer</Quantity>
</CustomHeaders>
<CustomOriginConfig>
<HTTPPort>integer</HTTPPort>
<HTTPSPort>integer</HTTPSPort>
<OriginKeepaliveTimeout>integer</OriginKeepaliveTimeout>
<OriginProtocolPolicy>string</OriginProtocolPolicy>
<OriginReadTimeout>integer</OriginReadTimeout>
<OriginSslProtocols>
<Items>
<SslProtocol>string</SslProtocol>
</Items>
<Quantity>integer</Quantity>
</OriginSslProtocols>
</CustomOriginConfig>
<DomainName>string</DomainName>
<Id>string</Id>
<OriginAccessControlId>string</OriginAccessControlId>
<OriginPath>string</OriginPath>
<OriginShield>
<Enabled>boolean</Enabled>
<OriginShieldRegion>string</OriginShieldRegion>
</OriginShield>
<S3OriginConfig>
<OriginAccessIdentity>string</OriginAccessIdentity>
</S3OriginConfig>
</Origin>
</Items>
<Quantity>integer</Quantity>
</Origins>
<PriceClass>string</PriceClass>
<Restrictions>
<GeoRestriction>
<Items>
<Location>string</Location>
</Items>
<Quantity>integer</Quantity>
<RestrictionType>string</RestrictionType>
</GeoRestriction>
</Restrictions>
<Staging>boolean</Staging>
<ViewerCertificate>
<ACMCertificateArn>string</ACMCertificateArn>
<Certificate>string</Certificate>
<CertificateSource>string</CertificateSource>
<CloudFrontDefaultCertificate>boolean</CloudFrontDefaultCertificate>
<IAMCertificateId>string</IAMCertificateId>
<MinimumProtocolVersion>string</MinimumProtocolVersion>
<SSLSupportMethod>string</SSLSupportMethod>
</ViewerCertificate>
<WebACLId>string</WebACLId>
</DistributionConfig>
<DomainName>string</DomainName>
<Id>string</Id>
<InProgressInvalidationBatches>integer</InProgressInvalidationBatches>
<LastModifiedTime>timestamp</LastModifiedTime>
<Status>string</Status>
</Distribution>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- Distribution
-
Root level tag for the Distribution parameters.
Required: Yes
- ActiveTrustedKeyGroups
-
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.
Type: ActiveTrustedKeyGroups object
- ActiveTrustedSigners
-
Important
We recommend using
TrustedKeyGroups
instead ofTrustedSigners
.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.
Type: ActiveTrustedSigners object
- AliasICPRecordals
-
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. Type: Array of AliasICPRecordal objects
- ARN
-
The distribution's Amazon Resource Name (ARN).
Type: String
- DistributionConfig
-
The distribution's configuration.
Type: DistributionConfig object
- DomainName
-
The distribution's CloudFront domain name. For example:
d111111abcdef8.cloudfront.net
.Type: String
- Id
-
The distribution's identifier. For example:
E1U5RQF7T870K0
.Type: String
- InProgressInvalidationBatches
-
The number of invalidation batches currently in progress.
Type: Integer
- LastModifiedTime
-
The date and time when the distribution was last modified.
Type: Timestamp
- Status
-
The distribution's status. When the status is
Deployed
, the distribution's information is fully propagated to all CloudFront edge locations.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDenied
-
Access denied.
HTTP Status Code: 403
- CNAMEAlreadyExists
-
The CNAME specified is already defined for CloudFront.
HTTP Status Code: 409
- IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior
-
The specified configuration for field-level encryption can't be associated with the specified cache behavior.
HTTP Status Code: 400
- IllegalUpdate
-
The update contains modifications that are not allowed.
HTTP Status Code: 400
- InconsistentQuantities
-
The value of
Quantity
and the size ofItems
don't match.HTTP Status Code: 400
- InvalidArgument
-
An argument is invalid.
HTTP Status Code: 400
- InvalidDefaultRootObject
-
The default root object file name is too big or contains an invalid character.
HTTP Status Code: 400
- InvalidErrorCode
-
An invalid error code was specified.
HTTP Status Code: 400
- InvalidForwardCookies
-
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.HTTP Status Code: 400
- InvalidFunctionAssociation
-
A CloudFront function association is invalid.
HTTP Status Code: 400
- InvalidGeoRestrictionParameter
-
The specified geo restriction parameter is not valid.
HTTP Status Code: 400
- InvalidHeadersForS3Origin
-
The headers specified are not valid for an Amazon S3 origin.
HTTP Status Code: 400
- InvalidIfMatchVersion
-
The
If-Match
version is missing or not valid.HTTP Status Code: 400
- InvalidLambdaFunctionAssociation
-
The specified Lambda@Edge function association is invalid.
HTTP Status Code: 400
- InvalidLocationCode
-
The location code specified is not valid.
HTTP Status Code: 400
- InvalidMinimumProtocolVersion
-
The minimum protocol version specified is not valid.
HTTP Status Code: 400
- InvalidOriginAccessControl
-
The origin access control is not valid.
HTTP Status Code: 400
- InvalidOriginAccessIdentity
-
The origin access identity is not valid or doesn't exist.
HTTP Status Code: 400
- InvalidOriginKeepaliveTimeout
-
The keep alive timeout specified for the origin is not valid.
HTTP Status Code: 400
- InvalidOriginReadTimeout
-
The read timeout specified for the origin is not valid.
HTTP Status Code: 400
- InvalidQueryStringParameters
-
The query string parameters specified are not valid.
HTTP Status Code: 400
- InvalidRelativePath
-
The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
HTTP Status Code: 400
- InvalidRequiredProtocol
-
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.HTTP Status Code: 400
- InvalidResponseCode
-
A response code is not valid.
HTTP Status Code: 400
- InvalidTTLOrder
-
The TTL order specified is not valid.
HTTP Status Code: 400
- InvalidViewerCertificate
-
A viewer certificate specified is not valid.
HTTP Status Code: 400
- InvalidWebACLId
-
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 example473e64fd-f30b-4765-81a0-62ad96dd167a
.HTTP Status Code: 400
- MissingBody
-
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.HTTP Status Code: 400
- NoSuchCachePolicy
-
The cache policy does not exist.
HTTP Status Code: 404
- NoSuchDistribution
-
The specified distribution does not exist.
HTTP Status Code: 404
- NoSuchFieldLevelEncryptionConfig
-
The specified configuration for field-level encryption doesn't exist.
HTTP Status Code: 404
- NoSuchOrigin
-
No origin exists with the specified
Origin Id
.HTTP Status Code: 404
- NoSuchOriginRequestPolicy
-
The origin request policy does not exist.
HTTP Status Code: 404
- NoSuchRealtimeLogConfig
-
The real-time log configuration does not exist.
HTTP Status Code: 404
- NoSuchResponseHeadersPolicy
-
The response headers policy does not exist.
HTTP Status Code: 404
- PreconditionFailed
-
The precondition in one or more of the request fields evaluated to
false
.HTTP Status Code: 412
- RealtimeLogConfigOwnerMismatch
-
The specified real-time log configuration belongs to a different AWS account.
HTTP Status Code: 401
- TooManyCacheBehaviors
-
You cannot create more cache behaviors for the distribution.
HTTP Status Code: 400
- TooManyCertificates
-
You cannot create anymore custom SSL/TLS certificates.
HTTP Status Code: 400
- TooManyCookieNamesInWhiteList
-
Your request contains more cookie names in the whitelist than are allowed per cache behavior.
HTTP Status Code: 400
- TooManyDistributionCNAMEs
-
Your request contains more CNAMEs than are allowed per distribution.
HTTP Status Code: 400
- TooManyDistributionsAssociatedToCachePolicy
-
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.
HTTP Status Code: 400
- TooManyDistributionsAssociatedToFieldLevelEncryptionConfig
-
The maximum number of distributions have been associated with the specified configuration for field-level encryption.
HTTP Status Code: 400
- TooManyDistributionsAssociatedToKeyGroup
-
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.
HTTP Status Code: 400
- TooManyDistributionsAssociatedToOriginAccessControl
-
The maximum number of distributions have been associated with the specified origin access control.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
- TooManyDistributionsAssociatedToOriginRequestPolicy
-
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.
HTTP Status Code: 400
- TooManyDistributionsAssociatedToResponseHeadersPolicy
-
The maximum number of distributions have been associated with the specified response headers policy.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
- TooManyDistributionsWithFunctionAssociations
-
You have reached the maximum number of distributions that are associated with a CloudFront function. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
- TooManyDistributionsWithLambdaAssociations
-
Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.
HTTP Status Code: 400
- TooManyDistributionsWithSingleFunctionARN
-
The maximum number of distributions have been associated with the specified Lambda@Edge function.
HTTP Status Code: 400
- TooManyFunctionAssociations
-
You have reached the maximum number of CloudFront function associations for this distribution. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
- TooManyHeadersInForwardedValues
-
Your request contains too many headers in forwarded values.
HTTP Status Code: 400
- TooManyKeyGroupsAssociatedToDistribution
-
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.
HTTP Status Code: 400
- TooManyLambdaFunctionAssociations
-
Your request contains more Lambda@Edge function associations than are allowed per distribution.
HTTP Status Code: 400
- TooManyOriginCustomHeaders
-
Your request contains too many origin custom headers.
HTTP Status Code: 400
- TooManyOriginGroupsPerDistribution
-
Processing your request would cause you to exceed the maximum number of origin groups allowed.
HTTP Status Code: 400
- TooManyOrigins
-
You cannot create more origins for the distribution.
HTTP Status Code: 400
- TooManyQueryStringParameters
-
Your request contains too many query string parameters.
HTTP Status Code: 400
- TooManyTrustedSigners
-
Your request contains more trusted signers than are allowed per distribution.
HTTP Status Code: 400
- TrustedKeyGroupDoesNotExist
-
The specified key group does not exist.
HTTP Status Code: 400
- TrustedSignerDoesNotExist
-
One or more of your trusted signers don't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: