@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonCloudFrontClient extends AmazonWebServiceClient implements AmazonCloudFront
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonCloudFrontClient()
Deprecated.
|
AmazonCloudFrontClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonCloudFrontClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonCloudFrontClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonCloudFrontClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonCloudFrontClient()
AmazonCloudFrontClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonCloudFrontClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to CloudFront (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonCloudFrontClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonCloudFrontClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonCloudFrontClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to CloudFront (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to CloudFront (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to CloudFront (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AmazonCloudFrontClientBuilder builder()
public AssociateAliasResult associateAlias(AssociateAliasRequest request)
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
associateAlias
in interface AmazonCloudFront
associateAliasRequest
- InvalidArgumentException
- An argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.TooManyDistributionCNAMEsException
- Your request contains more CNAMEs than are allowed per distribution.IllegalUpdateException
- The update contains modifications that are not allowed.AccessDeniedException
- Access denied.public CopyDistributionResult copyDistribution(CopyDistributionRequest request)
Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow.
After you create a staging distribution, you can use UpdateDistribution
to modify the staging
distribution's configuration. Then you can use CreateContinuousDeploymentPolicy
to incrementally
move traffic to the staging distribution.
This API operation requires the following IAM permissions:
copyDistribution
in interface AmazonCloudFront
copyDistributionRequest
- CNAMEAlreadyExistsException
- The CNAME specified is already defined for CloudFront.DistributionAlreadyExistsException
- The caller reference you attempted to create the distribution with is associated with another
distribution.InvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.InvalidOriginAccessControlException
- The origin access control is not valid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchDistributionException
- The specified distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyDistributionCNAMEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyDistributionsException
- Processing your request would cause you to exceed the maximum number of distributions allowed.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- An argument is invalid.InvalidRequiredProtocolException
- 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.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- 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.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTTLOrderException
- The TTL order specified is not valid.InvalidWebACLIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of 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 WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda@Edge function
associations per owner to be exceeded.TooManyDistributionsWithSingleFunctionARNException
- The maximum number of distributions have been associated with the specified Lambda@Edge function.TooManyLambdaFunctionAssociationsException
- Your request contains more Lambda@Edge function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException
- The specified Lambda@Edge function association is invalid.TooManyDistributionsWithFunctionAssociationsException
- 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.TooManyFunctionAssociationsException
- 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.InvalidFunctionAssociationException
- A CloudFront function association is invalid.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.NoSuchCachePolicyException
- The cache policy does not exist.TooManyDistributionsAssociatedToCachePolicyException
- 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.TooManyDistributionsAssociatedToOriginAccessControlException
- 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.
NoSuchResponseHeadersPolicyException
- The response headers policy does not exist.TooManyDistributionsAssociatedToResponseHeadersPolicyException
- 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.
NoSuchOriginRequestPolicyException
- The origin request policy does not exist.TooManyDistributionsAssociatedToOriginRequestPolicyException
- 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.TooManyDistributionsAssociatedToKeyGroupException
- 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.TooManyKeyGroupsAssociatedToDistributionException
- 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.TrustedKeyGroupDoesNotExistException
- The specified key group does not exist.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigOwnerMismatchException
- The specified real-time log configuration belongs to a different Amazon Web Services account.public CreateCachePolicyResult createCachePolicy(CreateCachePolicyRequest request)
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 also 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.
createCachePolicy
in interface AmazonCloudFront
createCachePolicyRequest
- AccessDeniedException
- Access denied.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.CachePolicyAlreadyExistsException
- A cache policy with this name already exists. You must provide a unique name. To modify an existing cache
policy, use UpdateCachePolicy
.TooManyCachePoliciesException
- You have reached the maximum number of cache policies for this Amazon Web Services account. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyHeadersInCachePolicyException
- 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.TooManyCookiesInCachePolicyException
- 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.TooManyQueryStringsInCachePolicyException
- 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.public CreateCloudFrontOriginAccessIdentityResult createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest request)
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.
createCloudFrontOriginAccessIdentity
in interface AmazonCloudFront
createCloudFrontOriginAccessIdentityRequest
- 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.CloudFrontOriginAccessIdentityAlreadyExistsException
- 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.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyCloudFrontOriginAccessIdentitiesException
- Processing your request would cause you to exceed the maximum number of origin access identities allowed.InvalidArgumentException
- An argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.public CreateContinuousDeploymentPolicyResult createContinuousDeploymentPolicy(CreateContinuousDeploymentPolicyRequest request)
Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
To use a continuous deployment policy, first use CopyDistribution
to create a staging distribution,
then use UpdateDistribution
to modify the staging distribution's configuration.
After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration.
createContinuousDeploymentPolicy
in interface AmazonCloudFront
createContinuousDeploymentPolicyRequest
- AccessDeniedException
- Access denied.InvalidArgumentException
- An argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.ContinuousDeploymentPolicyAlreadyExistsException
- A continuous deployment policy with this configuration already exists.TooManyContinuousDeploymentPoliciesException
- You have reached the maximum number of continuous deployment policies for this Amazon Web Services
account.StagingDistributionInUseException
- A continuous deployment policy for this staging distribution already exists.public CreateDistributionResult createDistribution(CreateDistributionRequest request)
Creates a CloudFront distribution.
createDistribution
in interface AmazonCloudFront
createDistributionRequest
- The request to create a new distribution.CNAMEAlreadyExistsException
- The CNAME specified is already defined for CloudFront.DistributionAlreadyExistsException
- The caller reference you attempted to create the distribution with is associated with another
distribution.InvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.InvalidOriginAccessControlException
- The origin access control is not valid.IllegalOriginAccessConfigurationException
- An origin cannot contain both an origin access control (OAC) and an origin access identity (OAI).TooManyDistributionsAssociatedToOriginAccessControlException
- 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.
AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyDistributionCNAMEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyDistributionsException
- Processing your request would cause you to exceed the maximum number of distributions allowed.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- An argument is invalid.InvalidRequiredProtocolException
- 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.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- 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.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTTLOrderException
- The TTL order specified is not valid.InvalidWebACLIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of 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 WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda@Edge function
associations per owner to be exceeded.TooManyDistributionsWithSingleFunctionARNException
- The maximum number of distributions have been associated with the specified Lambda@Edge function.TooManyLambdaFunctionAssociationsException
- Your request contains more Lambda@Edge function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException
- The specified Lambda@Edge function association is invalid.TooManyDistributionsWithFunctionAssociationsException
- 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.TooManyFunctionAssociationsException
- 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.InvalidFunctionAssociationException
- A CloudFront function association is invalid.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.NoSuchCachePolicyException
- The cache policy does not exist.TooManyDistributionsAssociatedToCachePolicyException
- 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.NoSuchResponseHeadersPolicyException
- The response headers policy does not exist.TooManyDistributionsAssociatedToResponseHeadersPolicyException
- 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.
NoSuchOriginRequestPolicyException
- The origin request policy does not exist.TooManyDistributionsAssociatedToOriginRequestPolicyException
- 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.TooManyDistributionsAssociatedToKeyGroupException
- 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.TooManyKeyGroupsAssociatedToDistributionException
- 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.TrustedKeyGroupDoesNotExistException
- The specified key group does not exist.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigOwnerMismatchException
- The specified real-time log configuration belongs to a different Amazon Web Services account.ContinuousDeploymentPolicyInUseException
- You cannot delete a continuous deployment policy that is associated with a primary distribution.NoSuchContinuousDeploymentPolicyException
- The continuous deployment policy doesn't exist.InvalidDomainNameForOriginAccessControlException
- An origin access control is associated with an origin whose domain name is not supported.public CreateDistributionWithTagsResult createDistributionWithTags(CreateDistributionWithTagsRequest request)
Create a new distribution with tags. This API operation requires the following IAM permissions:
createDistributionWithTags
in interface AmazonCloudFront
createDistributionWithTagsRequest
- The request to create a new distribution with tags.CNAMEAlreadyExistsException
- The CNAME specified is already defined for CloudFront.DistributionAlreadyExistsException
- The caller reference you attempted to create the distribution with is associated with another
distribution.InvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.InvalidOriginAccessControlException
- The origin access control is not valid.IllegalOriginAccessConfigurationException
- An origin cannot contain both an origin access control (OAC) and an origin access identity (OAI).AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyDistributionCNAMEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyDistributionsException
- Processing your request would cause you to exceed the maximum number of distributions allowed.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- An argument is invalid.InvalidRequiredProtocolException
- 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.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- 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.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTTLOrderException
- The TTL order specified is not valid.InvalidWebACLIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of 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 WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.InvalidTaggingException
- The tagging specified is not valid.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda@Edge function
associations per owner to be exceeded.TooManyDistributionsWithSingleFunctionARNException
- The maximum number of distributions have been associated with the specified Lambda@Edge function.TooManyLambdaFunctionAssociationsException
- Your request contains more Lambda@Edge function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException
- The specified Lambda@Edge function association is invalid.TooManyDistributionsWithFunctionAssociationsException
- 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.TooManyFunctionAssociationsException
- 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.InvalidFunctionAssociationException
- A CloudFront function association is invalid.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.NoSuchCachePolicyException
- The cache policy does not exist.TooManyDistributionsAssociatedToCachePolicyException
- 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.TooManyDistributionsAssociatedToOriginAccessControlException
- 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.
NoSuchResponseHeadersPolicyException
- The response headers policy does not exist.TooManyDistributionsAssociatedToResponseHeadersPolicyException
- 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.
NoSuchOriginRequestPolicyException
- The origin request policy does not exist.TooManyDistributionsAssociatedToOriginRequestPolicyException
- 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.TooManyDistributionsAssociatedToKeyGroupException
- 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.TooManyKeyGroupsAssociatedToDistributionException
- 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.TrustedKeyGroupDoesNotExistException
- The specified key group does not exist.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigOwnerMismatchException
- The specified real-time log configuration belongs to a different Amazon Web Services account.ContinuousDeploymentPolicyInUseException
- You cannot delete a continuous deployment policy that is associated with a primary distribution.NoSuchContinuousDeploymentPolicyException
- The continuous deployment policy doesn't exist.InvalidDomainNameForOriginAccessControlException
- An origin access control is associated with an origin whose domain name is not supported.public CreateFieldLevelEncryptionConfigResult createFieldLevelEncryptionConfig(CreateFieldLevelEncryptionConfigRequest request)
Create a new field-level encryption configuration.
createFieldLevelEncryptionConfig
in interface AmazonCloudFront
createFieldLevelEncryptionConfigRequest
- InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.FieldLevelEncryptionConfigAlreadyExistsException
- The specified configuration for field-level encryption already exists.TooManyFieldLevelEncryptionConfigsException
- The maximum number of configurations for field-level encryption have been created.TooManyFieldLevelEncryptionQueryArgProfilesException
- The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException
- The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException
- No profile specified for the field-level encryption query argument.public CreateFieldLevelEncryptionProfileResult createFieldLevelEncryptionProfile(CreateFieldLevelEncryptionProfileRequest request)
Create a field-level encryption profile.
createFieldLevelEncryptionProfile
in interface AmazonCloudFront
createFieldLevelEncryptionProfileRequest
- InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.NoSuchPublicKeyException
- The specified public key doesn't exist.FieldLevelEncryptionProfileAlreadyExistsException
- The specified profile for field-level encryption already exists.FieldLevelEncryptionProfileSizeExceededException
- The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionProfilesException
- The maximum number of profiles for field-level encryption have been created.TooManyFieldLevelEncryptionEncryptionEntitiesException
- The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException
- The maximum number of field patterns for field-level encryption have been created.public CreateFunctionResult createFunction(CreateFunctionRequest request)
Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it's in the DEVELOPMENT
stage. In this stage, you can test the function
with TestFunction
, and update it with UpdateFunction
.
When you're ready to use your function with a CloudFront distribution, use PublishFunction
to copy
the function from the DEVELOPMENT
stage to LIVE
. When it's live, you can attach the
function to a distribution's cache behavior, using the function's ARN.
createFunction
in interface AmazonCloudFront
createFunctionRequest
- TooManyFunctionsException
- You have reached the maximum number of CloudFront functions for this Amazon Web Services account. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.FunctionAlreadyExistsException
- A function with the same name already exists in this Amazon Web Services account. To create a function,
you must provide a unique name. To update an existing function, use UpdateFunction
.FunctionSizeLimitExceededException
- The function is too large. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidArgumentException
- An argument is invalid.UnsupportedOperationException
- This operation is not supported in this region.public CreateInvalidationResult createInvalidation(CreateInvalidationRequest request)
Create a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
createInvalidation
in interface AmazonCloudFront
createInvalidationRequest
- The request to create an invalidation.AccessDeniedException
- Access denied.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.InvalidArgumentException
- An argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.BatchTooLargeException
- Invalidation batch specified is too large.TooManyInvalidationsInProgressException
- You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation
objects.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.public CreateKeyGroupResult createKeyGroup(CreateKeyGroupRequest request)
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.
createKeyGroup
in interface AmazonCloudFront
createKeyGroupRequest
- InvalidArgumentException
- An argument is invalid.KeyGroupAlreadyExistsException
- A key group with this name already exists. You must provide a unique name. To modify an existing key
group, use UpdateKeyGroup
.TooManyKeyGroupsException
- You have reached the maximum number of key groups for this Amazon Web Services account. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyPublicKeysInKeyGroupException
- 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.public CreateKeyValueStoreResult createKeyValueStore(CreateKeyValueStoreRequest request)
Specifies the key value store resource to add to your account. In your account, the key value store names must be
unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid
ImportSource
that you own.
createKeyValueStore
in interface AmazonCloudFront
createKeyValueStoreRequest
- AccessDeniedException
- Access denied.EntityLimitExceededException
- The key value store entity limit has been exceeded.EntityAlreadyExistsException
- The key value store entity already exists. You must provide a unique key value store entity.EntitySizeLimitExceededException
- The key value store entity size limit was exceeded.InvalidArgumentException
- An argument is invalid.UnsupportedOperationException
- This operation is not supported in this region.public CreateMonitoringSubscriptionResult createMonitoringSubscription(CreateMonitoringSubscriptionRequest request)
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.
createMonitoringSubscription
in interface AmazonCloudFront
createMonitoringSubscriptionRequest
- AccessDeniedException
- Access denied.NoSuchDistributionException
- The specified distribution does not exist.MonitoringSubscriptionAlreadyExistsException
- A monitoring subscription already exists for the specified distribution.UnsupportedOperationException
- This operation is not supported in this region.public CreateOriginAccessControlResult createOriginAccessControl(CreateOriginAccessControlRequest request)
Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the Amazon CloudFront Developer Guide.
createOriginAccessControl
in interface AmazonCloudFront
createOriginAccessControlRequest
- OriginAccessControlAlreadyExistsException
- An origin access control with the specified parameters already exists.TooManyOriginAccessControlsException
- The number of origin access controls in your Amazon Web Services account exceeds the maximum allowed.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
InvalidArgumentException
- An argument is invalid.public CreateOriginRequestPolicyResult createOriginRequestPolicy(CreateOriginRequestPolicyRequest request)
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.
createOriginRequestPolicy
in interface AmazonCloudFront
createOriginRequestPolicyRequest
- AccessDeniedException
- Access denied.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.OriginRequestPolicyAlreadyExistsException
- An origin request policy with this name already exists. You must provide a unique name. To modify an
existing origin request policy, use UpdateOriginRequestPolicy
.TooManyOriginRequestPoliciesException
- You have reached the maximum number of origin request policies for this Amazon Web Services account. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyHeadersInOriginRequestPolicyException
- 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.TooManyCookiesInOriginRequestPolicyException
- 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.TooManyQueryStringsInOriginRequestPolicyException
- 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.public CreatePublicKeyResult createPublicKey(CreatePublicKeyRequest request)
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
createPublicKey
in interface AmazonCloudFront
createPublicKeyRequest
- PublicKeyAlreadyExistsException
- The specified public key already exists.InvalidArgumentException
- An argument is invalid.TooManyPublicKeysException
- 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.public CreateRealtimeLogConfigResult createRealtimeLogConfig(CreateRealtimeLogConfigRequest request)
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.
createRealtimeLogConfig
in interface AmazonCloudFront
createRealtimeLogConfigRequest
- RealtimeLogConfigAlreadyExistsException
- 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
.TooManyRealtimeLogConfigsException
- You have reached the maximum number of real-time log configurations for this Amazon Web Services account.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.public CreateResponseHeadersPolicyResult createResponseHeadersPolicy(CreateResponseHeadersPolicyRequest request)
Creates a response headers policy.
A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.
createResponseHeadersPolicy
in interface AmazonCloudFront
createResponseHeadersPolicyRequest
- AccessDeniedException
- Access denied.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.ResponseHeadersPolicyAlreadyExistsException
- A response headers policy with this name already exists. You must provide a unique name. To modify an
existing response headers policy, use UpdateResponseHeadersPolicy
.TooManyResponseHeadersPoliciesException
- You have reached the maximum number of response headers policies for this Amazon Web Services
account.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
TooManyCustomHeadersInResponseHeadersPolicyException
- The number of custom headers in the response headers policy exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
TooLongCSPInResponseHeadersPolicyException
- The length of the Content-Security-Policy
header value in the response headers policy
exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
TooManyRemoveHeadersInResponseHeadersPolicyException
- The number of headers in RemoveHeadersConfig
in the response headers policy exceeds the
maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
public CreateStreamingDistributionResult createStreamingDistribution(CreateStreamingDistributionRequest request)
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.
createStreamingDistribution
in interface AmazonCloudFront
createStreamingDistributionRequest
- The request to create a new streaming distribution.CNAMEAlreadyExistsException
- The CNAME specified is already defined for CloudFront.StreamingDistributionAlreadyExistsException
- The caller reference you attempted to create the streaming distribution with is associated with another
distributionInvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.InvalidOriginAccessControlException
- The origin access control is not valid.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyStreamingDistributionCNAMEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyStreamingDistributionsException
- Processing your request would cause you to exceed the maximum number of streaming distributions allowed.InvalidArgumentException
- An argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.public CreateStreamingDistributionWithTagsResult createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest request)
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
in interface AmazonCloudFront
createStreamingDistributionWithTagsRequest
- The request to create a new streaming distribution with tags.CNAMEAlreadyExistsException
- The CNAME specified is already defined for CloudFront.StreamingDistributionAlreadyExistsException
- The caller reference you attempted to create the streaming distribution with is associated with another
distributionInvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.InvalidOriginAccessControlException
- The origin access control is not valid.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyStreamingDistributionCNAMEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyStreamingDistributionsException
- Processing your request would cause you to exceed the maximum number of streaming distributions allowed.InvalidArgumentException
- An argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidTaggingException
- The tagging specified is not valid.public DeleteCachePolicyResult deleteCachePolicy(DeleteCachePolicyRequest request)
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
.
deleteCachePolicy
in interface AmazonCloudFront
deleteCachePolicyRequest
- AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchCachePolicyException
- The cache policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.IllegalDeleteException
- You cannot delete a managed policy.CachePolicyInUseException
- Cannot delete the cache policy because it is attached to one or more cache behaviors.public DeleteCloudFrontOriginAccessIdentityResult deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest request)
Delete an origin access identity.
deleteCloudFrontOriginAccessIdentity
in interface AmazonCloudFront
deleteCloudFrontOriginAccessIdentityRequest
- Deletes a origin access identity.AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.CloudFrontOriginAccessIdentityInUseException
- The Origin Access Identity specified is already in use.public DeleteContinuousDeploymentPolicyResult deleteContinuousDeploymentPolicy(DeleteContinuousDeploymentPolicyRequest request)
Deletes a continuous deployment policy.
You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy.
deleteContinuousDeploymentPolicy
in interface AmazonCloudFront
deleteContinuousDeploymentPolicyRequest
- InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.ContinuousDeploymentPolicyInUseException
- You cannot delete a continuous deployment policy that is associated with a primary distribution.NoSuchContinuousDeploymentPolicyException
- The continuous deployment policy doesn't exist.public DeleteDistributionResult deleteDistribution(DeleteDistributionRequest request)
Delete a distribution.
deleteDistribution
in interface AmazonCloudFront
deleteDistributionRequest
- 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.
AccessDeniedException
- Access denied.DistributionNotDisabledException
- The specified CloudFront distribution is not disabled. You must disable the distribution before you can
delete it.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchDistributionException
- The specified distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.public DeleteFieldLevelEncryptionConfigResult deleteFieldLevelEncryptionConfig(DeleteFieldLevelEncryptionConfigRequest request)
Remove a field-level encryption configuration.
deleteFieldLevelEncryptionConfig
in interface AmazonCloudFront
deleteFieldLevelEncryptionConfigRequest
- AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FieldLevelEncryptionConfigInUseException
- The specified configuration for field-level encryption is in use.public DeleteFieldLevelEncryptionProfileResult deleteFieldLevelEncryptionProfile(DeleteFieldLevelEncryptionProfileRequest request)
Remove a field-level encryption profile.
deleteFieldLevelEncryptionProfile
in interface AmazonCloudFront
deleteFieldLevelEncryptionProfileRequest
- AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FieldLevelEncryptionProfileInUseException
- The specified profile for field-level encryption is in use.public DeleteFunctionResult deleteFunction(DeleteFunctionRequest request)
Deletes a CloudFront function.
You cannot delete a function if it's associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function's name and version (ETag
value). To get these
values, you can use ListFunctions
and DescribeFunction
.
deleteFunction
in interface AmazonCloudFront
deleteFunctionRequest
- InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.FunctionInUseException
- Cannot delete the function because it's attached to one or more cache behaviors.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.UnsupportedOperationException
- This operation is not supported in this region.public DeleteKeyGroupResult deleteKeyGroup(DeleteKeyGroupRequest request)
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
.
deleteKeyGroup
in interface AmazonCloudFront
deleteKeyGroupRequest
- InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchResourceException
- A resource that was specified is not valid.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.ResourceInUseException
- Cannot delete this resource because it is in use.public DeleteKeyValueStoreResult deleteKeyValueStore(DeleteKeyValueStoreRequest request)
Specifies the key value store to delete.
deleteKeyValueStore
in interface AmazonCloudFront
deleteKeyValueStoreRequest
- AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.EntityNotFoundException
- The key value store entity was not found.CannotDeleteEntityWhileInUseException
- The key value store entity cannot be deleted while it is in use.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.UnsupportedOperationException
- This operation is not supported in this region.public DeleteMonitoringSubscriptionResult deleteMonitoringSubscription(DeleteMonitoringSubscriptionRequest request)
Disables additional CloudWatch metrics for the specified CloudFront distribution.
deleteMonitoringSubscription
in interface AmazonCloudFront
deleteMonitoringSubscriptionRequest
- AccessDeniedException
- Access denied.NoSuchDistributionException
- The specified distribution does not exist.NoSuchMonitoringSubscriptionException
- A monitoring subscription does not exist for the specified distribution.UnsupportedOperationException
- This operation is not supported in this region.public DeleteOriginAccessControlResult deleteOriginAccessControl(DeleteOriginAccessControlRequest request)
Deletes a CloudFront origin access control.
You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control.
deleteOriginAccessControl
in interface AmazonCloudFront
deleteOriginAccessControlRequest
- AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchOriginAccessControlException
- The origin access control does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.OriginAccessControlInUseException
- Cannot delete the origin access control because it's in use by one or more distributions.public DeleteOriginRequestPolicyResult deleteOriginRequestPolicy(DeleteOriginRequestPolicyRequest request)
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
.
deleteOriginRequestPolicy
in interface AmazonCloudFront
deleteOriginRequestPolicyRequest
- AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.IllegalDeleteException
- You cannot delete a managed policy.OriginRequestPolicyInUseException
- Cannot delete the origin request policy because it is attached to one or more cache behaviors.public DeletePublicKeyResult deletePublicKey(DeletePublicKeyRequest request)
Remove a public key you previously added to CloudFront.
deletePublicKey
in interface AmazonCloudFront
deletePublicKeyRequest
- AccessDeniedException
- Access denied.PublicKeyInUseException
- The specified public key is in use.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchPublicKeyException
- The specified public key doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.public DeleteRealtimeLogConfigResult deleteRealtimeLogConfig(DeleteRealtimeLogConfigRequest request)
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.
deleteRealtimeLogConfig
in interface AmazonCloudFront
deleteRealtimeLogConfigRequest
- NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigInUseException
- Cannot delete the real-time log configuration because it is attached to one or more cache behaviors.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.public DeleteResponseHeadersPolicyResult deleteResponseHeadersPolicy(DeleteResponseHeadersPolicyRequest request)
Deletes a response headers policy.
You cannot delete a response headers policy if it's attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy.
To delete a response headers policy, you must provide the policy's identifier and version. To get these values,
you can use ListResponseHeadersPolicies
or GetResponseHeadersPolicy
.
deleteResponseHeadersPolicy
in interface AmazonCloudFront
deleteResponseHeadersPolicyRequest
- AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchResponseHeadersPolicyException
- The response headers policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.IllegalDeleteException
- You cannot delete a managed policy.ResponseHeadersPolicyInUseException
- Cannot delete the response headers policy because it is attached to one or more cache behaviors in a
CloudFront distribution.public DeleteStreamingDistributionResult deleteStreamingDistribution(DeleteStreamingDistributionRequest request)
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.
deleteStreamingDistribution
in interface AmazonCloudFront
deleteStreamingDistributionRequest
- The request to delete a streaming distribution.AccessDeniedException
- Access denied.StreamingDistributionNotDisabledException
- The specified CloudFront distribution is not disabled. You must disable the distribution before you can
delete it.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.public DescribeFunctionResult describeFunction(DescribeFunctionRequest request)
Gets configuration information and metadata about a CloudFront function, but not the function's code. To get a
function's code, use GetFunction
.
To get configuration information and metadata about a function, you must provide the function's name and stage.
To get these values, you can use ListFunctions
.
describeFunction
in interface AmazonCloudFront
describeFunctionRequest
- NoSuchFunctionExistsException
- The function does not exist.UnsupportedOperationException
- This operation is not supported in this region.public DescribeKeyValueStoreResult describeKeyValueStore(DescribeKeyValueStoreRequest request)
Specifies the key value store and its configuration.
describeKeyValueStore
in interface AmazonCloudFront
describeKeyValueStoreRequest
- AccessDeniedException
- Access denied.InvalidArgumentException
- An argument is invalid.EntityNotFoundException
- The key value store entity was not found.UnsupportedOperationException
- This operation is not supported in this region.public GetCachePolicyResult getCachePolicy(GetCachePolicyRequest request)
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
.
getCachePolicy
in interface AmazonCloudFront
getCachePolicyRequest
- AccessDeniedException
- Access denied.NoSuchCachePolicyException
- The cache policy does not exist.public GetCachePolicyConfigResult getCachePolicyConfig(GetCachePolicyConfigRequest request)
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
.
getCachePolicyConfig
in interface AmazonCloudFront
getCachePolicyConfigRequest
- AccessDeniedException
- Access denied.NoSuchCachePolicyException
- The cache policy does not exist.public GetCloudFrontOriginAccessIdentityResult getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest request)
Get the information about an origin access identity.
getCloudFrontOriginAccessIdentity
in interface AmazonCloudFront
getCloudFrontOriginAccessIdentityRequest
- The request to get an origin access identity's information.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.AccessDeniedException
- Access denied.public GetCloudFrontOriginAccessIdentityConfigResult getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest request)
Get the configuration information about an origin access identity.
getCloudFrontOriginAccessIdentityConfig
in interface AmazonCloudFront
getCloudFrontOriginAccessIdentityConfigRequest
- The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfig.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.AccessDeniedException
- Access denied.public GetContinuousDeploymentPolicyResult getContinuousDeploymentPolicy(GetContinuousDeploymentPolicyRequest request)
Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
getContinuousDeploymentPolicy
in interface AmazonCloudFront
getContinuousDeploymentPolicyRequest
- AccessDeniedException
- Access denied.NoSuchContinuousDeploymentPolicyException
- The continuous deployment policy doesn't exist.public GetContinuousDeploymentPolicyConfigResult getContinuousDeploymentPolicyConfig(GetContinuousDeploymentPolicyConfigRequest request)
Gets configuration information about a continuous deployment policy.
getContinuousDeploymentPolicyConfig
in interface AmazonCloudFront
getContinuousDeploymentPolicyConfigRequest
- AccessDeniedException
- Access denied.NoSuchContinuousDeploymentPolicyException
- The continuous deployment policy doesn't exist.public GetDistributionResult getDistribution(GetDistributionRequest request)
Get the information about a distribution.
getDistribution
in interface AmazonCloudFront
getDistributionRequest
- The request to get a distribution's information.NoSuchDistributionException
- The specified distribution does not exist.AccessDeniedException
- Access denied.public GetDistributionConfigResult getDistributionConfig(GetDistributionConfigRequest request)
Get the configuration information about a distribution.
getDistributionConfig
in interface AmazonCloudFront
getDistributionConfigRequest
- The request to get a distribution configuration.NoSuchDistributionException
- The specified distribution does not exist.AccessDeniedException
- Access denied.public GetFieldLevelEncryptionResult getFieldLevelEncryption(GetFieldLevelEncryptionRequest request)
Get the field-level encryption configuration information.
getFieldLevelEncryption
in interface AmazonCloudFront
getFieldLevelEncryptionRequest
- AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.public GetFieldLevelEncryptionConfigResult getFieldLevelEncryptionConfig(GetFieldLevelEncryptionConfigRequest request)
Get the field-level encryption configuration information.
getFieldLevelEncryptionConfig
in interface AmazonCloudFront
getFieldLevelEncryptionConfigRequest
- AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.public GetFieldLevelEncryptionProfileResult getFieldLevelEncryptionProfile(GetFieldLevelEncryptionProfileRequest request)
Get the field-level encryption profile information.
getFieldLevelEncryptionProfile
in interface AmazonCloudFront
getFieldLevelEncryptionProfileRequest
- AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.public GetFieldLevelEncryptionProfileConfigResult getFieldLevelEncryptionProfileConfig(GetFieldLevelEncryptionProfileConfigRequest request)
Get the field-level encryption profile configuration information.
getFieldLevelEncryptionProfileConfig
in interface AmazonCloudFront
getFieldLevelEncryptionProfileConfigRequest
- AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.public GetFunctionResult getFunction(GetFunctionRequest request)
Gets the code of a CloudFront function. To get configuration information and metadata about a function, use
DescribeFunction
.
To get a function's code, you must provide the function's name and stage. To get these values, you can use
ListFunctions
.
getFunction
in interface AmazonCloudFront
getFunctionRequest
- NoSuchFunctionExistsException
- The function does not exist.UnsupportedOperationException
- This operation is not supported in this region.public GetInvalidationResult getInvalidation(GetInvalidationRequest request)
Get the information about an invalidation.
getInvalidation
in interface AmazonCloudFront
getInvalidationRequest
- The request to get an invalidation's information.NoSuchInvalidationException
- The specified invalidation does not exist.NoSuchDistributionException
- The specified distribution does not exist.AccessDeniedException
- Access denied.public GetKeyGroupResult getKeyGroup(GetKeyGroupRequest request)
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
.
getKeyGroup
in interface AmazonCloudFront
getKeyGroupRequest
- NoSuchResourceException
- A resource that was specified is not valid.public GetKeyGroupConfigResult getKeyGroupConfig(GetKeyGroupConfigRequest request)
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
.
getKeyGroupConfig
in interface AmazonCloudFront
getKeyGroupConfigRequest
- NoSuchResourceException
- A resource that was specified is not valid.public GetMonitoringSubscriptionResult getMonitoringSubscription(GetMonitoringSubscriptionRequest request)
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
getMonitoringSubscription
in interface AmazonCloudFront
getMonitoringSubscriptionRequest
- AccessDeniedException
- Access denied.NoSuchDistributionException
- The specified distribution does not exist.NoSuchMonitoringSubscriptionException
- A monitoring subscription does not exist for the specified distribution.UnsupportedOperationException
- This operation is not supported in this region.public GetOriginAccessControlResult getOriginAccessControl(GetOriginAccessControlRequest request)
Gets a CloudFront origin access control, including its unique identifier.
getOriginAccessControl
in interface AmazonCloudFront
getOriginAccessControlRequest
- NoSuchOriginAccessControlException
- The origin access control does not exist.AccessDeniedException
- Access denied.public GetOriginAccessControlConfigResult getOriginAccessControlConfig(GetOriginAccessControlConfigRequest request)
Gets a CloudFront origin access control configuration.
getOriginAccessControlConfig
in interface AmazonCloudFront
getOriginAccessControlConfigRequest
- NoSuchOriginAccessControlException
- The origin access control does not exist.AccessDeniedException
- Access denied.public GetOriginRequestPolicyResult getOriginRequestPolicy(GetOriginRequestPolicyRequest request)
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
.
getOriginRequestPolicy
in interface AmazonCloudFront
getOriginRequestPolicyRequest
- AccessDeniedException
- Access denied.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.public GetOriginRequestPolicyConfigResult getOriginRequestPolicyConfig(GetOriginRequestPolicyConfigRequest request)
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
.
getOriginRequestPolicyConfig
in interface AmazonCloudFront
getOriginRequestPolicyConfigRequest
- AccessDeniedException
- Access denied.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.public GetPublicKeyResult getPublicKey(GetPublicKeyRequest request)
Gets a public key.
getPublicKey
in interface AmazonCloudFront
getPublicKeyRequest
- AccessDeniedException
- Access denied.NoSuchPublicKeyException
- The specified public key doesn't exist.public GetPublicKeyConfigResult getPublicKeyConfig(GetPublicKeyConfigRequest request)
Gets a public key configuration.
getPublicKeyConfig
in interface AmazonCloudFront
getPublicKeyConfigRequest
- AccessDeniedException
- Access denied.NoSuchPublicKeyException
- The specified public key doesn't exist.public GetRealtimeLogConfigResult getRealtimeLogConfig(GetRealtimeLogConfigRequest request)
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.
getRealtimeLogConfig
in interface AmazonCloudFront
getRealtimeLogConfigRequest
- NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.public GetResponseHeadersPolicyResult getResponseHeadersPolicy(GetResponseHeadersPolicyRequest request)
Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
To get a response headers policy, you must provide the policy's identifier. If the response headers policy is
attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributions
or GetDistribution
. If the response headers policy is not attached to
a cache behavior, you can get the identifier using ListResponseHeadersPolicies
.
getResponseHeadersPolicy
in interface AmazonCloudFront
getResponseHeadersPolicyRequest
- AccessDeniedException
- Access denied.NoSuchResponseHeadersPolicyException
- The response headers policy does not exist.public GetResponseHeadersPolicyConfigResult getResponseHeadersPolicyConfig(GetResponseHeadersPolicyConfigRequest request)
Gets a response headers policy configuration.
To get a response headers policy configuration, you must provide the policy's identifier. If the response headers
policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributions
or GetDistribution
. If the response headers policy is not attached to
a cache behavior, you can get the identifier using ListResponseHeadersPolicies
.
getResponseHeadersPolicyConfig
in interface AmazonCloudFront
getResponseHeadersPolicyConfigRequest
- AccessDeniedException
- Access denied.NoSuchResponseHeadersPolicyException
- The response headers policy does not exist.public GetStreamingDistributionResult getStreamingDistribution(GetStreamingDistributionRequest request)
Gets information about a specified RTMP distribution, including the distribution configuration.
getStreamingDistribution
in interface AmazonCloudFront
getStreamingDistributionRequest
- The request to get a streaming distribution's information.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.AccessDeniedException
- Access denied.public GetStreamingDistributionConfigResult getStreamingDistributionConfig(GetStreamingDistributionConfigRequest request)
Get the configuration information about a streaming distribution.
getStreamingDistributionConfig
in interface AmazonCloudFront
getStreamingDistributionConfigRequest
- To request to get a streaming distribution configuration.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.AccessDeniedException
- Access denied.public ListCachePoliciesResult listCachePolicies(ListCachePoliciesRequest request)
Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services 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.
listCachePolicies
in interface AmazonCloudFront
listCachePoliciesRequest
- AccessDeniedException
- Access denied.NoSuchCachePolicyException
- The cache policy does not exist.InvalidArgumentException
- An argument is invalid.public ListCloudFrontOriginAccessIdentitiesResult listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest request)
Lists origin access identities.
listCloudFrontOriginAccessIdentities
in interface AmazonCloudFront
listCloudFrontOriginAccessIdentitiesRequest
- The request to list origin access identities.InvalidArgumentException
- An argument is invalid.public ListConflictingAliasesResult listConflictingAliases(ListConflictingAliasesRequest request)
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided
alias. For example, if you provide www.example.com
as input, the returned list can include
www.example.com
and the overlapping wildcard alternate domain name (*.example.com
), if
they exist. If you provide *.example.com
as input, the returned list can include
*.example.com
and any alternate domain names covered by that wildcard (for example,
www.example.com
, test.example.com
, dev.example.com
, and so on), if they
exist.
To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
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.
listConflictingAliases
in interface AmazonCloudFront
listConflictingAliasesRequest
- InvalidArgumentException
- An argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.public ListContinuousDeploymentPoliciesResult listContinuousDeploymentPolicies(ListContinuousDeploymentPoliciesRequest request)
Gets a list of the continuous deployment policies in your Amazon Web Services 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.
listContinuousDeploymentPolicies
in interface AmazonCloudFront
listContinuousDeploymentPoliciesRequest
- InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.NoSuchContinuousDeploymentPolicyException
- The continuous deployment policy doesn't exist.public ListDistributionsResult listDistributions(ListDistributionsRequest request)
List CloudFront distributions.
listDistributions
in interface AmazonCloudFront
listDistributionsRequest
- The request to list your distributions.InvalidArgumentException
- An argument is invalid.public ListDistributionsByCachePolicyIdResult listDistributionsByCachePolicyId(ListDistributionsByCachePolicyIdRequest request)
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.
listDistributionsByCachePolicyId
in interface AmazonCloudFront
listDistributionsByCachePolicyIdRequest
- NoSuchCachePolicyException
- The cache policy does not exist.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.public ListDistributionsByKeyGroupResult listDistributionsByKeyGroup(ListDistributionsByKeyGroupRequest 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.
listDistributionsByKeyGroup
in interface AmazonCloudFront
listDistributionsByKeyGroupRequest
- NoSuchResourceException
- A resource that was specified is not valid.InvalidArgumentException
- An argument is invalid.public ListDistributionsByOriginRequestPolicyIdResult listDistributionsByOriginRequestPolicyId(ListDistributionsByOriginRequestPolicyIdRequest 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.
listDistributionsByOriginRequestPolicyId
in interface AmazonCloudFront
listDistributionsByOriginRequestPolicyIdRequest
- NoSuchOriginRequestPolicyException
- The origin request policy does not exist.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.public ListDistributionsByRealtimeLogConfigResult listDistributionsByRealtimeLogConfig(ListDistributionsByRealtimeLogConfigRequest 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.
listDistributionsByRealtimeLogConfig
in interface AmazonCloudFront
listDistributionsByRealtimeLogConfigRequest
- InvalidArgumentException
- An argument is invalid.public ListDistributionsByResponseHeadersPolicyIdResult listDistributionsByResponseHeadersPolicyId(ListDistributionsByResponseHeadersPolicyIdRequest request)
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers 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.
listDistributionsByResponseHeadersPolicyId
in interface AmazonCloudFront
listDistributionsByResponseHeadersPolicyIdRequest
- NoSuchResponseHeadersPolicyException
- The response headers policy does not exist.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.public ListDistributionsByWebACLIdResult listDistributionsByWebACLId(ListDistributionsByWebACLIdRequest request)
List the distributions that are associated with a specified WAF web ACL.
listDistributionsByWebACLId
in interface AmazonCloudFront
listDistributionsByWebACLIdRequest
- The request to list distributions that are associated with a specified WAF web ACL.InvalidArgumentException
- An argument is invalid.InvalidWebACLIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of 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 WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.public ListFieldLevelEncryptionConfigsResult listFieldLevelEncryptionConfigs(ListFieldLevelEncryptionConfigsRequest request)
List all field-level encryption configurations that have been created in CloudFront for this account.
listFieldLevelEncryptionConfigs
in interface AmazonCloudFront
listFieldLevelEncryptionConfigsRequest
- InvalidArgumentException
- An argument is invalid.public ListFieldLevelEncryptionProfilesResult listFieldLevelEncryptionProfiles(ListFieldLevelEncryptionProfilesRequest request)
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
listFieldLevelEncryptionProfiles
in interface AmazonCloudFront
listFieldLevelEncryptionProfilesRequest
- InvalidArgumentException
- An argument is invalid.public ListFunctionsResult listFunctions(ListFunctionsRequest request)
Gets a list of all CloudFront functions in your Amazon Web Services account.
You can optionally apply a filter to return only the functions that are in the specified stage, either
DEVELOPMENT
or LIVE
.
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.
listFunctions
in interface AmazonCloudFront
listFunctionsRequest
- InvalidArgumentException
- An argument is invalid.UnsupportedOperationException
- This operation is not supported in this region.public ListInvalidationsResult listInvalidations(ListInvalidationsRequest request)
Lists invalidation batches.
listInvalidations
in interface AmazonCloudFront
listInvalidationsRequest
- The request to list invalidations.InvalidArgumentException
- An argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.AccessDeniedException
- Access denied.public ListKeyGroupsResult listKeyGroups(ListKeyGroupsRequest request)
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.
listKeyGroups
in interface AmazonCloudFront
listKeyGroupsRequest
- InvalidArgumentException
- An argument is invalid.public ListKeyValueStoresResult listKeyValueStores(ListKeyValueStoresRequest request)
Specifies the key value stores to list.
listKeyValueStores
in interface AmazonCloudFront
listKeyValueStoresRequest
- AccessDeniedException
- Access denied.InvalidArgumentException
- An argument is invalid.UnsupportedOperationException
- This operation is not supported in this region.public ListOriginAccessControlsResult listOriginAccessControls(ListOriginAccessControlsRequest request)
Gets the list of CloudFront origin access controls in this Amazon Web Services 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 another request that specifies the NextMarker
value from the current
response as the Marker
value in the next request.
listOriginAccessControls
in interface AmazonCloudFront
listOriginAccessControlsRequest
- InvalidArgumentException
- An argument is invalid.public ListOriginRequestPoliciesResult listOriginRequestPolicies(ListOriginRequestPoliciesRequest request)
Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services 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.
listOriginRequestPolicies
in interface AmazonCloudFront
listOriginRequestPoliciesRequest
- AccessDeniedException
- Access denied.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.InvalidArgumentException
- An argument is invalid.public ListPublicKeysResult listPublicKeys(ListPublicKeysRequest request)
List all public keys that have been added to CloudFront for this account.
listPublicKeys
in interface AmazonCloudFront
listPublicKeysRequest
- InvalidArgumentException
- An argument is invalid.public ListRealtimeLogConfigsResult listRealtimeLogConfigs(ListRealtimeLogConfigsRequest request)
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.
listRealtimeLogConfigs
in interface AmazonCloudFront
listRealtimeLogConfigsRequest
- InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.public ListResponseHeadersPoliciesResult listResponseHeadersPolicies(ListResponseHeadersPoliciesRequest request)
Gets a list of response headers policies.
You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services 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.
listResponseHeadersPolicies
in interface AmazonCloudFront
listResponseHeadersPoliciesRequest
- AccessDeniedException
- Access denied.NoSuchResponseHeadersPolicyException
- The response headers policy does not exist.InvalidArgumentException
- An argument is invalid.public ListStreamingDistributionsResult listStreamingDistributions(ListStreamingDistributionsRequest request)
List streaming distributions.
listStreamingDistributions
in interface AmazonCloudFront
listStreamingDistributionsRequest
- The request to list your streaming distributions.InvalidArgumentException
- An argument is invalid.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List tags for a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
listTagsForResource
in interface AmazonCloudFront
listTagsForResourceRequest
- The request to list tags for a CloudFront resource.AccessDeniedException
- Access denied.InvalidArgumentException
- An argument is invalid.InvalidTaggingException
- The tagging specified is not valid.NoSuchResourceException
- A resource that was specified is not valid.public PublishFunctionResult publishFunction(PublishFunctionRequest request)
Publishes a CloudFront function by copying the function code from the DEVELOPMENT
stage to
LIVE
. This automatically updates all cache behaviors that are using this function to use the newly
published copy in the LIVE
stage.
When a function is published to the LIVE
stage, you can attach the function to a distribution's
cache behavior, using the function's Amazon Resource Name (ARN).
To publish a function, you must provide the function's name and version (ETag
value). To get these
values, you can use ListFunctions
and DescribeFunction
.
publishFunction
in interface AmazonCloudFront
publishFunctionRequest
- InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.UnsupportedOperationException
- This operation is not supported in this region.public TagResourceResult tagResource(TagResourceRequest request)
Add tags to a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
tagResource
in interface AmazonCloudFront
tagResourceRequest
- The request to add tags to a CloudFront resource.AccessDeniedException
- Access denied.InvalidArgumentException
- An argument is invalid.InvalidTaggingException
- The tagging specified is not valid.NoSuchResourceException
- A resource that was specified is not valid.public TestFunctionResult testFunction(TestFunctionRequest request)
Tests a CloudFront function.
To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function's result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.
To test a function, you provide the function's name and version (ETag
value) along with the event
object. To get the function's name and version, you can use ListFunctions
and
DescribeFunction
.
testFunction
in interface AmazonCloudFront
testFunctionRequest
- InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.TestFunctionFailedException
- The CloudFront function failed.UnsupportedOperationException
- This operation is not supported in this region.public UntagResourceResult untagResource(UntagResourceRequest request)
Remove tags from a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
untagResource
in interface AmazonCloudFront
untagResourceRequest
- The request to remove tags from a CloudFront resource.AccessDeniedException
- Access denied.InvalidArgumentException
- An argument is invalid.InvalidTaggingException
- The tagging specified is not valid.NoSuchResourceException
- A resource that was specified is not valid.public UpdateCachePolicyResult updateCachePolicy(UpdateCachePolicyRequest request)
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.
updateCachePolicy
in interface AmazonCloudFront
updateCachePolicyRequest
- AccessDeniedException
- Access denied.IllegalUpdateException
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchCachePolicyException
- The cache policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.CachePolicyAlreadyExistsException
- A cache policy with this name already exists. You must provide a unique name. To modify an existing cache
policy, use UpdateCachePolicy
.TooManyHeadersInCachePolicyException
- 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.TooManyCookiesInCachePolicyException
- 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.TooManyQueryStringsInCachePolicyException
- 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.public UpdateCloudFrontOriginAccessIdentityResult updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest request)
Update an origin access identity.
updateCloudFrontOriginAccessIdentity
in interface AmazonCloudFront
updateCloudFrontOriginAccessIdentityRequest
- The request to update an origin access identity.AccessDeniedException
- Access denied.IllegalUpdateException
- The update contains modifications that are not allowed.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.InvalidArgumentException
- An argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.public UpdateContinuousDeploymentPolicyResult updateContinuousDeploymentPolicy(UpdateContinuousDeploymentPolicyRequest request)
Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to.
When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration:
Use GetContinuousDeploymentPolicyConfig
to get the current configuration.
Locally modify the fields in the continuous deployment policy configuration that you want to update.
Use UpdateContinuousDeploymentPolicy
, providing the entire continuous deployment policy
configuration, including the fields that you modified and those that you didn't.
updateContinuousDeploymentPolicy
in interface AmazonCloudFront
updateContinuousDeploymentPolicyRequest
- InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.StagingDistributionInUseException
- A continuous deployment policy for this staging distribution already exists.NoSuchContinuousDeploymentPolicyException
- The continuous deployment policy doesn't exist.public UpdateDistributionResult updateDistribution(UpdateDistributionRequest request)
Updates the configuration for a CloudFront distribution.
The update process includes getting the current distribution configuration, updating it to make your changes, and
then submitting an UpdateDistribution
request to make the updates.
To update a web distribution using the CloudFront API
Use GetDistributionConfig
to get the current configuration, including the version identifier (
ETag
).
Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:
You must rename the ETag
field to IfMatch
, leaving the value unchanged. (Set the value
of IfMatch
to the value of ETag
, then remove the ETag
field.)
You can't change the value of CallerReference
.
Submit an UpdateDistribution
request, providing the distribution configuration. The new
configuration replaces the existing configuration. The values that you specify in an
UpdateDistribution
request are not merged into your existing configuration. Make sure to include all
fields: the ones that you modified and also the ones that you didn't.
updateDistribution
in interface AmazonCloudFront
updateDistributionRequest
- The request to update a distribution.AccessDeniedException
- Access denied.CNAMEAlreadyExistsException
- The CNAME specified is already defined for CloudFront.IllegalUpdateException
- The update contains modifications that are not allowed.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.NoSuchDistributionException
- The specified distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.TooManyDistributionCNAMEsException
- Your request contains more CNAMEs than are allowed per distribution.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- An argument is invalid.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.InvalidOriginAccessControlException
- The origin access control is not valid.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.InvalidRequiredProtocolException
- 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.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- 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.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidTTLOrderException
- The TTL order specified is not valid.InvalidWebACLIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of 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 WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda@Edge function
associations per owner to be exceeded.TooManyDistributionsWithSingleFunctionARNException
- The maximum number of distributions have been associated with the specified Lambda@Edge function.TooManyLambdaFunctionAssociationsException
- Your request contains more Lambda@Edge function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException
- The specified Lambda@Edge function association is invalid.TooManyDistributionsWithFunctionAssociationsException
- 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.TooManyFunctionAssociationsException
- 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.InvalidFunctionAssociationException
- A CloudFront function association is invalid.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.NoSuchCachePolicyException
- The cache policy does not exist.TooManyDistributionsAssociatedToCachePolicyException
- 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.TooManyDistributionsAssociatedToOriginAccessControlException
- 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.
NoSuchResponseHeadersPolicyException
- The response headers policy does not exist.TooManyDistributionsAssociatedToResponseHeadersPolicyException
- 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.
NoSuchOriginRequestPolicyException
- The origin request policy does not exist.TooManyDistributionsAssociatedToOriginRequestPolicyException
- 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.TooManyDistributionsAssociatedToKeyGroupException
- 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.TooManyKeyGroupsAssociatedToDistributionException
- 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.TrustedKeyGroupDoesNotExistException
- The specified key group does not exist.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigOwnerMismatchException
- The specified real-time log configuration belongs to a different Amazon Web Services account.ContinuousDeploymentPolicyInUseException
- You cannot delete a continuous deployment policy that is associated with a primary distribution.NoSuchContinuousDeploymentPolicyException
- The continuous deployment policy doesn't exist.StagingDistributionInUseException
- A continuous deployment policy for this staging distribution already exists.IllegalOriginAccessConfigurationException
- An origin cannot contain both an origin access control (OAC) and an origin access identity (OAI).InvalidDomainNameForOriginAccessControlException
- An origin access control is associated with an origin whose domain name is not supported.public UpdateDistributionWithStagingConfigResult updateDistributionWithStagingConfig(UpdateDistributionWithStagingConfigRequest request)
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:
updateDistributionWithStagingConfig
in interface AmazonCloudFront
updateDistributionWithStagingConfigRequest
- AccessDeniedException
- Access denied.CNAMEAlreadyExistsException
- The CNAME specified is already defined for CloudFront.IllegalUpdateException
- The update contains modifications that are not allowed.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.NoSuchDistributionException
- The specified distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.TooManyDistributionCNAMEsException
- Your request contains more CNAMEs than are allowed per distribution.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- An argument is invalid.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.InvalidOriginAccessControlException
- The origin access control is not valid.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.InvalidRequiredProtocolException
- 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.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- 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.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidTTLOrderException
- The TTL order specified is not valid.InvalidWebACLIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of 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 WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda@Edge function
associations per owner to be exceeded.TooManyDistributionsWithSingleFunctionARNException
- The maximum number of distributions have been associated with the specified Lambda@Edge function.TooManyLambdaFunctionAssociationsException
- Your request contains more Lambda@Edge function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException
- The specified Lambda@Edge function association is invalid.TooManyDistributionsWithFunctionAssociationsException
- 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.TooManyFunctionAssociationsException
- 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.InvalidFunctionAssociationException
- A CloudFront function association is invalid.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.NoSuchCachePolicyException
- The cache policy does not exist.TooManyDistributionsAssociatedToCachePolicyException
- 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.TooManyDistributionsAssociatedToOriginAccessControlException
- 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.
NoSuchResponseHeadersPolicyException
- The response headers policy does not exist.TooManyDistributionsAssociatedToResponseHeadersPolicyException
- 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.
NoSuchOriginRequestPolicyException
- The origin request policy does not exist.TooManyDistributionsAssociatedToOriginRequestPolicyException
- 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.TooManyDistributionsAssociatedToKeyGroupException
- 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.TooManyKeyGroupsAssociatedToDistributionException
- 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.TrustedKeyGroupDoesNotExistException
- The specified key group does not exist.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigOwnerMismatchException
- The specified real-time log configuration belongs to a different Amazon Web Services account.public UpdateFieldLevelEncryptionConfigResult updateFieldLevelEncryptionConfig(UpdateFieldLevelEncryptionConfigRequest request)
Update a field-level encryption configuration.
updateFieldLevelEncryptionConfig
in interface AmazonCloudFront
updateFieldLevelEncryptionConfigRequest
- AccessDeniedException
- Access denied.IllegalUpdateException
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.TooManyFieldLevelEncryptionQueryArgProfilesException
- The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException
- The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException
- No profile specified for the field-level encryption query argument.public UpdateFieldLevelEncryptionProfileResult updateFieldLevelEncryptionProfile(UpdateFieldLevelEncryptionProfileRequest request)
Update a field-level encryption profile.
updateFieldLevelEncryptionProfile
in interface AmazonCloudFront
updateFieldLevelEncryptionProfileRequest
- AccessDeniedException
- Access denied.FieldLevelEncryptionProfileAlreadyExistsException
- The specified profile for field-level encryption already exists.IllegalUpdateException
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchPublicKeyException
- The specified public key doesn't exist.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FieldLevelEncryptionProfileSizeExceededException
- The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionEncryptionEntitiesException
- The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException
- The maximum number of field patterns for field-level encryption have been created.public UpdateFunctionResult updateFunction(UpdateFunctionRequest request)
Updates a CloudFront function.
You can update a function's code or the comment that describes the function. You cannot update a function's name.
To update a function, you provide the function's name and version (ETag
value) along with the
updated function code. To get the name and version, you can use ListFunctions
and
DescribeFunction
.
updateFunction
in interface AmazonCloudFront
updateFunctionRequest
- InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FunctionSizeLimitExceededException
- The function is too large. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.UnsupportedOperationException
- This operation is not supported in this region.public UpdateKeyGroupResult updateKeyGroup(UpdateKeyGroupRequest request)
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.
updateKeyGroup
in interface AmazonCloudFront
updateKeyGroupRequest
- InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchResourceException
- A resource that was specified is not valid.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.KeyGroupAlreadyExistsException
- A key group with this name already exists. You must provide a unique name. To modify an existing key
group, use UpdateKeyGroup
.InvalidArgumentException
- An argument is invalid.TooManyPublicKeysInKeyGroupException
- 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.public UpdateKeyValueStoreResult updateKeyValueStore(UpdateKeyValueStoreRequest request)
Specifies the key value store to update.
updateKeyValueStore
in interface AmazonCloudFront
updateKeyValueStoreRequest
- AccessDeniedException
- Access denied.InvalidArgumentException
- An argument is invalid.EntityNotFoundException
- The key value store entity was not found.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.UnsupportedOperationException
- This operation is not supported in this region.public UpdateOriginAccessControlResult updateOriginAccessControl(UpdateOriginAccessControlRequest request)
Updates a CloudFront origin access control.
updateOriginAccessControl
in interface AmazonCloudFront
updateOriginAccessControlRequest
- AccessDeniedException
- Access denied.IllegalUpdateException
- The update contains modifications that are not allowed.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.OriginAccessControlAlreadyExistsException
- An origin access control with the specified parameters already exists.NoSuchOriginAccessControlException
- The origin access control does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.InvalidArgumentException
- An argument is invalid.public UpdateOriginRequestPolicyResult updateOriginRequestPolicy(UpdateOriginRequestPolicyRequest request)
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.
updateOriginRequestPolicy
in interface AmazonCloudFront
updateOriginRequestPolicyRequest
- AccessDeniedException
- Access denied.IllegalUpdateException
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.OriginRequestPolicyAlreadyExistsException
- An origin request policy with this name already exists. You must provide a unique name. To modify an
existing origin request policy, use UpdateOriginRequestPolicy
.TooManyHeadersInOriginRequestPolicyException
- 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.TooManyCookiesInOriginRequestPolicyException
- 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.TooManyQueryStringsInOriginRequestPolicyException
- 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.public UpdatePublicKeyResult updatePublicKey(UpdatePublicKeyRequest request)
Update public key information. Note that the only value you can change is the comment.
updatePublicKey
in interface AmazonCloudFront
updatePublicKeyRequest
- AccessDeniedException
- Access denied.CannotChangeImmutablePublicKeyFieldsException
- You can't change the value of a public key.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.IllegalUpdateException
- The update contains modifications that are not allowed.NoSuchPublicKeyException
- The specified public key doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.public UpdateRealtimeLogConfigResult updateRealtimeLogConfig(UpdateRealtimeLogConfigRequest request)
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
.
updateRealtimeLogConfig
in interface AmazonCloudFront
updateRealtimeLogConfigRequest
- NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.public UpdateResponseHeadersPolicyResult updateResponseHeadersPolicy(UpdateResponseHeadersPolicyRequest request)
Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
Use GetResponseHeadersPolicyConfig
to get the current policy's configuration.
Modify the fields in the response headers policy configuration that you want to update.
Call UpdateResponseHeadersPolicy
, providing the entire response headers policy configuration,
including the fields that you modified and those that you didn't.
updateResponseHeadersPolicy
in interface AmazonCloudFront
updateResponseHeadersPolicyRequest
- AccessDeniedException
- Access denied.IllegalUpdateException
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchResponseHeadersPolicyException
- The response headers policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.ResponseHeadersPolicyAlreadyExistsException
- A response headers policy with this name already exists. You must provide a unique name. To modify an
existing response headers policy, use UpdateResponseHeadersPolicy
.TooManyCustomHeadersInResponseHeadersPolicyException
- The number of custom headers in the response headers policy exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
TooLongCSPInResponseHeadersPolicyException
- The length of the Content-Security-Policy
header value in the response headers policy
exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
TooManyRemoveHeadersInResponseHeadersPolicyException
- The number of headers in RemoveHeadersConfig
in the response headers policy exceeds the
maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
public UpdateStreamingDistributionResult updateStreamingDistribution(UpdateStreamingDistributionRequest request)
Update a streaming distribution.
updateStreamingDistribution
in interface AmazonCloudFront
updateStreamingDistributionRequest
- The request to update a streaming distribution.AccessDeniedException
- Access denied.CNAMEAlreadyExistsException
- The CNAME specified is already defined for CloudFront.IllegalUpdateException
- The update contains modifications that are not allowed.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.TooManyStreamingDistributionCNAMEsException
- Your request contains more CNAMEs than are allowed per distribution.InvalidArgumentException
- An argument is invalid.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.InvalidOriginAccessControlException
- The origin access control is not valid.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonCloudFront
request
- The originally executed requestpublic AmazonCloudFrontWaiters waiters()
waiters
in interface AmazonCloudFront
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonCloudFront
shutdown
in class AmazonWebServiceClient