@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCloudFront
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCloudFront instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AssociateAliasResult |
associateAlias(AssociateAliasRequest associateAliasRequest)
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
|
CreateCachePolicyResult |
createCachePolicy(CreateCachePolicyRequest createCachePolicyRequest)
Creates a cache policy.
|
CreateCloudFrontOriginAccessIdentityResult |
createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest createCloudFrontOriginAccessIdentityRequest)
Creates a new origin access identity.
|
CreateDistributionResult |
createDistribution(CreateDistributionRequest createDistributionRequest)
Creates a new web distribution.
|
CreateDistributionWithTagsResult |
createDistributionWithTags(CreateDistributionWithTagsRequest createDistributionWithTagsRequest)
Create a new distribution with tags.
|
CreateFieldLevelEncryptionConfigResult |
createFieldLevelEncryptionConfig(CreateFieldLevelEncryptionConfigRequest createFieldLevelEncryptionConfigRequest)
Create a new field-level encryption configuration.
|
CreateFieldLevelEncryptionProfileResult |
createFieldLevelEncryptionProfile(CreateFieldLevelEncryptionProfileRequest createFieldLevelEncryptionProfileRequest)
Create a field-level encryption profile.
|
CreateFunctionResult |
createFunction(CreateFunctionRequest createFunctionRequest)
Creates a CloudFront function.
|
CreateInvalidationResult |
createInvalidation(CreateInvalidationRequest createInvalidationRequest)
Create a new invalidation.
|
CreateKeyGroupResult |
createKeyGroup(CreateKeyGroupRequest createKeyGroupRequest)
Creates a key group that you can use with CloudFront signed
URLs and signed cookies.
|
CreateMonitoringSubscriptionResult |
createMonitoringSubscription(CreateMonitoringSubscriptionRequest createMonitoringSubscriptionRequest)
Enables additional CloudWatch metrics for the specified CloudFront distribution.
|
CreateOriginAccessControlResult |
createOriginAccessControl(CreateOriginAccessControlRequest createOriginAccessControlRequest)
Creates a new origin access control in CloudFront.
|
CreateOriginRequestPolicyResult |
createOriginRequestPolicy(CreateOriginRequestPolicyRequest createOriginRequestPolicyRequest)
Creates an origin request policy.
|
CreatePublicKeyResult |
createPublicKey(CreatePublicKeyRequest createPublicKeyRequest)
Uploads a public key to CloudFront that you can use with signed URLs and
signed cookies, or with field-level
encryption.
|
CreateRealtimeLogConfigResult |
createRealtimeLogConfig(CreateRealtimeLogConfigRequest createRealtimeLogConfigRequest)
Creates a real-time log configuration.
|
CreateResponseHeadersPolicyResult |
createResponseHeadersPolicy(CreateResponseHeadersPolicyRequest createResponseHeadersPolicyRequest)
Creates a response headers policy.
|
CreateStreamingDistributionResult |
createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest)
This API is deprecated.
|
CreateStreamingDistributionWithTagsResult |
createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest createStreamingDistributionWithTagsRequest)
This API is deprecated.
|
DeleteCachePolicyResult |
deleteCachePolicy(DeleteCachePolicyRequest deleteCachePolicyRequest)
Deletes a cache policy.
|
DeleteCloudFrontOriginAccessIdentityResult |
deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest)
Delete an origin access identity.
|
DeleteDistributionResult |
deleteDistribution(DeleteDistributionRequest deleteDistributionRequest)
Delete a distribution.
|
DeleteFieldLevelEncryptionConfigResult |
deleteFieldLevelEncryptionConfig(DeleteFieldLevelEncryptionConfigRequest deleteFieldLevelEncryptionConfigRequest)
Remove a field-level encryption configuration.
|
DeleteFieldLevelEncryptionProfileResult |
deleteFieldLevelEncryptionProfile(DeleteFieldLevelEncryptionProfileRequest deleteFieldLevelEncryptionProfileRequest)
Remove a field-level encryption profile.
|
DeleteFunctionResult |
deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
Deletes a CloudFront function.
|
DeleteKeyGroupResult |
deleteKeyGroup(DeleteKeyGroupRequest deleteKeyGroupRequest)
Deletes a key group.
|
DeleteMonitoringSubscriptionResult |
deleteMonitoringSubscription(DeleteMonitoringSubscriptionRequest deleteMonitoringSubscriptionRequest)
Disables additional CloudWatch metrics for the specified CloudFront distribution.
|
DeleteOriginAccessControlResult |
deleteOriginAccessControl(DeleteOriginAccessControlRequest deleteOriginAccessControlRequest)
Deletes a CloudFront origin access control.
|
DeleteOriginRequestPolicyResult |
deleteOriginRequestPolicy(DeleteOriginRequestPolicyRequest deleteOriginRequestPolicyRequest)
Deletes an origin request policy.
|
DeletePublicKeyResult |
deletePublicKey(DeletePublicKeyRequest deletePublicKeyRequest)
Remove a public key you previously added to CloudFront.
|
DeleteRealtimeLogConfigResult |
deleteRealtimeLogConfig(DeleteRealtimeLogConfigRequest deleteRealtimeLogConfigRequest)
Deletes a real-time log configuration.
|
DeleteResponseHeadersPolicyResult |
deleteResponseHeadersPolicy(DeleteResponseHeadersPolicyRequest deleteResponseHeadersPolicyRequest)
Deletes a response headers policy.
|
DeleteStreamingDistributionResult |
deleteStreamingDistribution(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest)
Delete a streaming distribution.
|
DescribeFunctionResult |
describeFunction(DescribeFunctionRequest describeFunctionRequest)
Gets configuration information and metadata about a CloudFront function, but not the function’s code.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCachePolicyResult |
getCachePolicy(GetCachePolicyRequest getCachePolicyRequest)
Gets a cache policy, including the following metadata:
|
GetCachePolicyConfigResult |
getCachePolicyConfig(GetCachePolicyConfigRequest getCachePolicyConfigRequest)
Gets a cache policy configuration.
|
GetCloudFrontOriginAccessIdentityResult |
getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest)
Get the information about an origin access identity.
|
GetCloudFrontOriginAccessIdentityConfigResult |
getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest)
Get the configuration information about an origin access identity.
|
GetDistributionResult |
getDistribution(GetDistributionRequest getDistributionRequest)
Get the information about a distribution.
|
GetDistributionConfigResult |
getDistributionConfig(GetDistributionConfigRequest getDistributionConfigRequest)
Get the configuration information about a distribution.
|
GetFieldLevelEncryptionResult |
getFieldLevelEncryption(GetFieldLevelEncryptionRequest getFieldLevelEncryptionRequest)
Get the field-level encryption configuration information.
|
GetFieldLevelEncryptionConfigResult |
getFieldLevelEncryptionConfig(GetFieldLevelEncryptionConfigRequest getFieldLevelEncryptionConfigRequest)
Get the field-level encryption configuration information.
|
GetFieldLevelEncryptionProfileResult |
getFieldLevelEncryptionProfile(GetFieldLevelEncryptionProfileRequest getFieldLevelEncryptionProfileRequest)
Get the field-level encryption profile information.
|
GetFieldLevelEncryptionProfileConfigResult |
getFieldLevelEncryptionProfileConfig(GetFieldLevelEncryptionProfileConfigRequest getFieldLevelEncryptionProfileConfigRequest)
Get the field-level encryption profile configuration information.
|
GetFunctionResult |
getFunction(GetFunctionRequest getFunctionRequest)
Gets the code of a CloudFront function.
|
GetInvalidationResult |
getInvalidation(GetInvalidationRequest getInvalidationRequest)
Get the information about an invalidation.
|
GetKeyGroupResult |
getKeyGroup(GetKeyGroupRequest getKeyGroupRequest)
Gets a key group, including the date and time when the key group was last modified.
|
GetKeyGroupConfigResult |
getKeyGroupConfig(GetKeyGroupConfigRequest getKeyGroupConfigRequest)
Gets a key group configuration.
|
GetMonitoringSubscriptionResult |
getMonitoringSubscription(GetMonitoringSubscriptionRequest getMonitoringSubscriptionRequest)
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront
distribution.
|
GetOriginAccessControlResult |
getOriginAccessControl(GetOriginAccessControlRequest getOriginAccessControlRequest)
Gets a CloudFront origin access control, including its unique identifier.
|
GetOriginAccessControlConfigResult |
getOriginAccessControlConfig(GetOriginAccessControlConfigRequest getOriginAccessControlConfigRequest)
Gets a CloudFront origin access control configuration.
|
GetOriginRequestPolicyResult |
getOriginRequestPolicy(GetOriginRequestPolicyRequest getOriginRequestPolicyRequest)
Gets an origin request policy, including the following metadata:
|
GetOriginRequestPolicyConfigResult |
getOriginRequestPolicyConfig(GetOriginRequestPolicyConfigRequest getOriginRequestPolicyConfigRequest)
Gets an origin request policy configuration.
|
GetPublicKeyResult |
getPublicKey(GetPublicKeyRequest getPublicKeyRequest)
Gets a public key.
|
GetPublicKeyConfigResult |
getPublicKeyConfig(GetPublicKeyConfigRequest getPublicKeyConfigRequest)
Gets a public key configuration.
|
GetRealtimeLogConfigResult |
getRealtimeLogConfig(GetRealtimeLogConfigRequest getRealtimeLogConfigRequest)
Gets a real-time log configuration.
|
GetResponseHeadersPolicyResult |
getResponseHeadersPolicy(GetResponseHeadersPolicyRequest getResponseHeadersPolicyRequest)
Gets a response headers policy, including metadata (the policy’s identifier and the date and time when the policy
was last modified).
|
GetResponseHeadersPolicyConfigResult |
getResponseHeadersPolicyConfig(GetResponseHeadersPolicyConfigRequest getResponseHeadersPolicyConfigRequest)
Gets a response headers policy configuration.
|
GetStreamingDistributionResult |
getStreamingDistribution(GetStreamingDistributionRequest getStreamingDistributionRequest)
Gets information about a specified RTMP distribution, including the distribution configuration.
|
GetStreamingDistributionConfigResult |
getStreamingDistributionConfig(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest)
Get the configuration information about a streaming distribution.
|
ListCachePoliciesResult |
listCachePolicies(ListCachePoliciesRequest listCachePoliciesRequest)
Gets a list of cache policies.
|
ListCloudFrontOriginAccessIdentitiesResult |
listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest)
Lists origin access identities.
|
ListConflictingAliasesResult |
listConflictingAliases(ListConflictingAliasesRequest listConflictingAliasesRequest)
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.
|
ListDistributionsResult |
listDistributions(ListDistributionsRequest listDistributionsRequest)
List CloudFront distributions.
|
ListDistributionsByCachePolicyIdResult |
listDistributionsByCachePolicyId(ListDistributionsByCachePolicyIdRequest listDistributionsByCachePolicyIdRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified
cache policy.
|
ListDistributionsByKeyGroupResult |
listDistributionsByKeyGroup(ListDistributionsByKeyGroupRequest listDistributionsByKeyGroupRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key
group.
|
ListDistributionsByOriginRequestPolicyIdResult |
listDistributionsByOriginRequestPolicyId(ListDistributionsByOriginRequestPolicyIdRequest listDistributionsByOriginRequestPolicyIdRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified
origin request policy.
|
ListDistributionsByRealtimeLogConfigResult |
listDistributionsByRealtimeLogConfig(ListDistributionsByRealtimeLogConfigRequest listDistributionsByRealtimeLogConfigRequest)
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log
configuration.
|
ListDistributionsByResponseHeadersPolicyIdResult |
listDistributionsByResponseHeadersPolicyId(ListDistributionsByResponseHeadersPolicyIdRequest listDistributionsByResponseHeadersPolicyIdRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified
response headers policy.
|
ListDistributionsByWebACLIdResult |
listDistributionsByWebACLId(ListDistributionsByWebACLIdRequest listDistributionsByWebACLIdRequest)
List the distributions that are associated with a specified WAF web ACL.
|
ListFieldLevelEncryptionConfigsResult |
listFieldLevelEncryptionConfigs(ListFieldLevelEncryptionConfigsRequest listFieldLevelEncryptionConfigsRequest)
List all field-level encryption configurations that have been created in CloudFront for this account.
|
ListFieldLevelEncryptionProfilesResult |
listFieldLevelEncryptionProfiles(ListFieldLevelEncryptionProfilesRequest listFieldLevelEncryptionProfilesRequest)
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
|
ListFunctionsResult |
listFunctions(ListFunctionsRequest listFunctionsRequest)
Gets a list of all CloudFront functions in your Amazon Web Services account.
|
ListInvalidationsResult |
listInvalidations(ListInvalidationsRequest listInvalidationsRequest)
Lists invalidation batches.
|
ListKeyGroupsResult |
listKeyGroups(ListKeyGroupsRequest listKeyGroupsRequest)
Gets a list of key groups.
|
ListOriginAccessControlsResult |
listOriginAccessControls(ListOriginAccessControlsRequest listOriginAccessControlsRequest)
Gets the list of CloudFront origin access controls in this Amazon Web Services account.
|
ListOriginRequestPoliciesResult |
listOriginRequestPolicies(ListOriginRequestPoliciesRequest listOriginRequestPoliciesRequest)
Gets a list of origin request policies.
|
ListPublicKeysResult |
listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
List all public keys that have been added to CloudFront for this account.
|
ListRealtimeLogConfigsResult |
listRealtimeLogConfigs(ListRealtimeLogConfigsRequest listRealtimeLogConfigsRequest)
Gets a list of real-time log configurations.
|
ListResponseHeadersPoliciesResult |
listResponseHeadersPolicies(ListResponseHeadersPoliciesRequest listResponseHeadersPoliciesRequest)
Gets a list of response headers policies.
|
ListStreamingDistributionsResult |
listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest)
List streaming distributions.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a CloudFront resource.
|
PublishFunctionResult |
publishFunction(PublishFunctionRequest publishFunctionRequest)
Publishes a CloudFront function by copying the function code from the
DEVELOPMENT stage to
LIVE. |
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Add tags to a CloudFront resource.
|
TestFunctionResult |
testFunction(TestFunctionRequest testFunctionRequest)
Tests a CloudFront function.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Remove tags from a CloudFront resource.
|
UpdateCachePolicyResult |
updateCachePolicy(UpdateCachePolicyRequest updateCachePolicyRequest)
Updates a cache policy configuration.
|
UpdateCloudFrontOriginAccessIdentityResult |
updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest)
Update an origin access identity.
|
UpdateDistributionResult |
updateDistribution(UpdateDistributionRequest updateDistributionRequest)
Updates the configuration for a web distribution.
|
UpdateFieldLevelEncryptionConfigResult |
updateFieldLevelEncryptionConfig(UpdateFieldLevelEncryptionConfigRequest updateFieldLevelEncryptionConfigRequest)
Update a field-level encryption configuration.
|
UpdateFieldLevelEncryptionProfileResult |
updateFieldLevelEncryptionProfile(UpdateFieldLevelEncryptionProfileRequest updateFieldLevelEncryptionProfileRequest)
Update a field-level encryption profile.
|
UpdateFunctionResult |
updateFunction(UpdateFunctionRequest updateFunctionRequest)
Updates a CloudFront function.
|
UpdateKeyGroupResult |
updateKeyGroup(UpdateKeyGroupRequest updateKeyGroupRequest)
Updates a key group.
|
UpdateOriginAccessControlResult |
updateOriginAccessControl(UpdateOriginAccessControlRequest updateOriginAccessControlRequest)
Updates a CloudFront origin access control.
|
UpdateOriginRequestPolicyResult |
updateOriginRequestPolicy(UpdateOriginRequestPolicyRequest updateOriginRequestPolicyRequest)
Updates an origin request policy configuration.
|
UpdatePublicKeyResult |
updatePublicKey(UpdatePublicKeyRequest updatePublicKeyRequest)
Update public key information.
|
UpdateRealtimeLogConfigResult |
updateRealtimeLogConfig(UpdateRealtimeLogConfigRequest updateRealtimeLogConfigRequest)
Updates a real-time log configuration.
|
UpdateResponseHeadersPolicyResult |
updateResponseHeadersPolicy(UpdateResponseHeadersPolicyRequest updateResponseHeadersPolicyRequest)
Updates a response headers policy.
|
UpdateStreamingDistributionResult |
updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest)
Update a streaming distribution.
|
AmazonCloudFrontWaiters |
waiters() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "cloudfront.amazonaws.com/") or a full URL, including the protocol
(ex: "https://cloudfront.amazonaws.com/"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "cloudfront.amazonaws.com/") or a full URL, including the protocol (ex:
"https://cloudfront.amazonaws.com/") of the region specific AWS endpoint this client will communicate
with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AssociateAliasResult associateAlias(AssociateAliasRequest associateAliasRequest)
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.
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.CreateCachePolicyResult createCachePolicy(CreateCachePolicyRequest createCachePolicyRequest)
Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests
that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that
matches the request’s cache key. If you want to send values to the origin but not include them in the
cache key, use OriginRequestPolicy.
For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
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.CreateCloudFrontOriginAccessIdentityResult createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest createCloudFrontOriginAccessIdentityRequest)
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.
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.CreateDistributionResult createDistribution(CreateDistributionRequest createDistributionRequest)
Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to
be delivered from, and the details about how to track and manage content delivery. Send a POST
request to the /CloudFront API version/distribution/distribution ID resource.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
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.InvalidDomainNameForOriginAccessControlException - An origin access control is associated with an origin whose domain name is not supported.CreateDistributionWithTagsResult createDistributionWithTags(CreateDistributionWithTagsRequest createDistributionWithTagsRequest)
Create a new distribution with tags.
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.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.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.InvalidDomainNameForOriginAccessControlException - An origin access control is associated with an origin whose domain name is not supported.CreateFieldLevelEncryptionConfigResult createFieldLevelEncryptionConfig(CreateFieldLevelEncryptionConfigRequest createFieldLevelEncryptionConfigRequest)
Create a new field-level encryption configuration.
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.CreateFieldLevelEncryptionProfileResult createFieldLevelEncryptionProfile(CreateFieldLevelEncryptionProfileRequest createFieldLevelEncryptionProfileRequest)
Create a field-level encryption profile.
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.CreateFunctionResult createFunction(CreateFunctionRequest createFunctionRequest)
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.
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.CreateInvalidationResult createInvalidation(CreateInvalidationRequest createInvalidationRequest)
Create a new invalidation.
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.CreateKeyGroupResult createKeyGroup(CreateKeyGroupRequest createKeyGroupRequest)
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.
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.CreateMonitoringSubscriptionResult createMonitoringSubscription(CreateMonitoringSubscriptionRequest createMonitoringSubscriptionRequest)
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.
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.CreateOriginAccessControlResult createOriginAccessControl(CreateOriginAccessControlRequest createOriginAccessControlRequest)
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.
For an Amazon S3 origin, this makes it possible to block public access to the Amazon S3 bucket so that viewers (users) can access the content in the bucket only through CloudFront.
For more information about using a CloudFront origin access control, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
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.CreateOriginRequestPolicyResult createOriginRequestPolicy(CreateOriginRequestPolicyRequest createOriginRequestPolicyRequest)
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.
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.CreatePublicKeyResult createPublicKey(CreatePublicKeyRequest createPublicKeyRequest)
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
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.CreateRealtimeLogConfigResult createRealtimeLogConfig(CreateRealtimeLogConfigRequest createRealtimeLogConfigRequest)
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.
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.CreateResponseHeadersPolicyResult createResponseHeadersPolicy(CreateResponseHeadersPolicyRequest createResponseHeadersPolicyRequest)
Creates a response headers policy.
A response headers policy contains information about a set of HTTP response headers and their values. To create a response headers policy, you provide some metadata about the policy, and a set of configurations that specify the response 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, CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match the cache behavior.
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.
CreateStreamingDistributionResult createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest)
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.
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.CreateStreamingDistributionWithTagsResult createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest createStreamingDistributionWithTagsRequest)
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.
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.DeleteCachePolicyResult deleteCachePolicy(DeleteCachePolicyRequest deleteCachePolicyRequest)
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.
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.DeleteCloudFrontOriginAccessIdentityResult deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest)
Delete an origin access identity.
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.DeleteDistributionResult deleteDistribution(DeleteDistributionRequest deleteDistributionRequest)
Delete a distribution.
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.DeleteFieldLevelEncryptionConfigResult deleteFieldLevelEncryptionConfig(DeleteFieldLevelEncryptionConfigRequest deleteFieldLevelEncryptionConfigRequest)
Remove a field-level encryption configuration.
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.DeleteFieldLevelEncryptionProfileResult deleteFieldLevelEncryptionProfile(DeleteFieldLevelEncryptionProfileRequest deleteFieldLevelEncryptionProfileRequest)
Remove a field-level encryption profile.
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.DeleteFunctionResult deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
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.
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.DeleteKeyGroupResult deleteKeyGroup(DeleteKeyGroupRequest deleteKeyGroupRequest)
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.
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.DeleteMonitoringSubscriptionResult deleteMonitoringSubscription(DeleteMonitoringSubscriptionRequest deleteMonitoringSubscriptionRequest)
Disables additional CloudWatch metrics for the specified CloudFront distribution.
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.DeleteOriginAccessControlResult deleteOriginAccessControl(DeleteOriginAccessControlRequest deleteOriginAccessControlRequest)
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.
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.DeleteOriginRequestPolicyResult deleteOriginRequestPolicy(DeleteOriginRequestPolicyRequest deleteOriginRequestPolicyRequest)
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.
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.DeletePublicKeyResult deletePublicKey(DeletePublicKeyRequest deletePublicKeyRequest)
Remove a public key you previously added to CloudFront.
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.DeleteRealtimeLogConfigResult deleteRealtimeLogConfig(DeleteRealtimeLogConfigRequest deleteRealtimeLogConfigRequest)
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.
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.DeleteResponseHeadersPolicyResult deleteResponseHeadersPolicy(DeleteResponseHeadersPolicyRequest deleteResponseHeadersPolicyRequest)
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.
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.DeleteStreamingDistributionResult deleteStreamingDistribution(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest)
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.
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.DescribeFunctionResult describeFunction(DescribeFunctionRequest describeFunctionRequest)
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.
describeFunctionRequest - NoSuchFunctionExistsException - The function does not exist.UnsupportedOperationException - This operation is not supported in this region.GetCachePolicyResult getCachePolicy(GetCachePolicyRequest getCachePolicyRequest)
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.
getCachePolicyRequest - AccessDeniedException - Access denied.NoSuchCachePolicyException - The cache policy does not exist.GetCachePolicyConfigResult getCachePolicyConfig(GetCachePolicyConfigRequest getCachePolicyConfigRequest)
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.
getCachePolicyConfigRequest - AccessDeniedException - Access denied.NoSuchCachePolicyException - The cache policy does not exist.GetCloudFrontOriginAccessIdentityResult getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest)
Get the information about an origin access identity.
getCloudFrontOriginAccessIdentityRequest - The request to get an origin access identity's information.NoSuchCloudFrontOriginAccessIdentityException - The specified origin access identity does not exist.AccessDeniedException - Access denied.GetCloudFrontOriginAccessIdentityConfigResult getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest)
Get the configuration information about an origin access identity.
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.GetDistributionResult getDistribution(GetDistributionRequest getDistributionRequest)
Get the information about a distribution.
getDistributionRequest - The request to get a distribution's information.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.GetDistributionConfigResult getDistributionConfig(GetDistributionConfigRequest getDistributionConfigRequest)
Get the configuration information about a distribution.
getDistributionConfigRequest - The request to get a distribution configuration.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.GetFieldLevelEncryptionResult getFieldLevelEncryption(GetFieldLevelEncryptionRequest getFieldLevelEncryptionRequest)
Get the field-level encryption configuration information.
getFieldLevelEncryptionRequest - AccessDeniedException - Access denied.NoSuchFieldLevelEncryptionConfigException - The specified configuration for field-level encryption doesn't exist.GetFieldLevelEncryptionConfigResult getFieldLevelEncryptionConfig(GetFieldLevelEncryptionConfigRequest getFieldLevelEncryptionConfigRequest)
Get the field-level encryption configuration information.
getFieldLevelEncryptionConfigRequest - AccessDeniedException - Access denied.NoSuchFieldLevelEncryptionConfigException - The specified configuration for field-level encryption doesn't exist.GetFieldLevelEncryptionProfileResult getFieldLevelEncryptionProfile(GetFieldLevelEncryptionProfileRequest getFieldLevelEncryptionProfileRequest)
Get the field-level encryption profile information.
getFieldLevelEncryptionProfileRequest - AccessDeniedException - Access denied.NoSuchFieldLevelEncryptionProfileException - The specified profile for field-level encryption doesn't exist.GetFieldLevelEncryptionProfileConfigResult getFieldLevelEncryptionProfileConfig(GetFieldLevelEncryptionProfileConfigRequest getFieldLevelEncryptionProfileConfigRequest)
Get the field-level encryption profile configuration information.
getFieldLevelEncryptionProfileConfigRequest - AccessDeniedException - Access denied.NoSuchFieldLevelEncryptionProfileException - The specified profile for field-level encryption doesn't exist.GetFunctionResult getFunction(GetFunctionRequest getFunctionRequest)
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.
getFunctionRequest - NoSuchFunctionExistsException - The function does not exist.UnsupportedOperationException - This operation is not supported in this region.GetInvalidationResult getInvalidation(GetInvalidationRequest getInvalidationRequest)
Get the information about an invalidation.
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.GetKeyGroupResult getKeyGroup(GetKeyGroupRequest getKeyGroupRequest)
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.
getKeyGroupRequest - NoSuchResourceException - A resource that was specified is not valid.GetKeyGroupConfigResult getKeyGroupConfig(GetKeyGroupConfigRequest getKeyGroupConfigRequest)
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.
getKeyGroupConfigRequest - NoSuchResourceException - A resource that was specified is not valid.GetMonitoringSubscriptionResult getMonitoringSubscription(GetMonitoringSubscriptionRequest getMonitoringSubscriptionRequest)
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
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.GetOriginAccessControlResult getOriginAccessControl(GetOriginAccessControlRequest getOriginAccessControlRequest)
Gets a CloudFront origin access control, including its unique identifier.
getOriginAccessControlRequest - NoSuchOriginAccessControlException - The origin access control does not exist.AccessDeniedException - Access denied.GetOriginAccessControlConfigResult getOriginAccessControlConfig(GetOriginAccessControlConfigRequest getOriginAccessControlConfigRequest)
Gets a CloudFront origin access control configuration.
getOriginAccessControlConfigRequest - NoSuchOriginAccessControlException - The origin access control does not exist.AccessDeniedException - Access denied.GetOriginRequestPolicyResult getOriginRequestPolicy(GetOriginRequestPolicyRequest getOriginRequestPolicyRequest)
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.
getOriginRequestPolicyRequest - AccessDeniedException - Access denied.NoSuchOriginRequestPolicyException - The origin request policy does not exist.GetOriginRequestPolicyConfigResult getOriginRequestPolicyConfig(GetOriginRequestPolicyConfigRequest getOriginRequestPolicyConfigRequest)
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.
getOriginRequestPolicyConfigRequest - AccessDeniedException - Access denied.NoSuchOriginRequestPolicyException - The origin request policy does not exist.GetPublicKeyResult getPublicKey(GetPublicKeyRequest getPublicKeyRequest)
Gets a public key.
getPublicKeyRequest - AccessDeniedException - Access denied.NoSuchPublicKeyException - The specified public key doesn't exist.GetPublicKeyConfigResult getPublicKeyConfig(GetPublicKeyConfigRequest getPublicKeyConfigRequest)
Gets a public key configuration.
getPublicKeyConfigRequest - AccessDeniedException - Access denied.NoSuchPublicKeyException - The specified public key doesn't exist.GetRealtimeLogConfigResult getRealtimeLogConfig(GetRealtimeLogConfigRequest getRealtimeLogConfigRequest)
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.
getRealtimeLogConfigRequest - NoSuchRealtimeLogConfigException - The real-time log configuration does not exist.InvalidArgumentException - An argument is invalid.AccessDeniedException - Access denied.GetResponseHeadersPolicyResult getResponseHeadersPolicy(GetResponseHeadersPolicyRequest getResponseHeadersPolicyRequest)
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.
getResponseHeadersPolicyRequest - AccessDeniedException - Access denied.NoSuchResponseHeadersPolicyException - The response headers policy does not exist.GetResponseHeadersPolicyConfigResult getResponseHeadersPolicyConfig(GetResponseHeadersPolicyConfigRequest getResponseHeadersPolicyConfigRequest)
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.
getResponseHeadersPolicyConfigRequest - AccessDeniedException - Access denied.NoSuchResponseHeadersPolicyException - The response headers policy does not exist.GetStreamingDistributionResult getStreamingDistribution(GetStreamingDistributionRequest getStreamingDistributionRequest)
Gets information about a specified RTMP distribution, including the distribution configuration.
getStreamingDistributionRequest - The request to get a streaming distribution's information.NoSuchStreamingDistributionException - The specified streaming distribution does not exist.AccessDeniedException - Access denied.GetStreamingDistributionConfigResult getStreamingDistributionConfig(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest)
Get the configuration information about a streaming distribution.
getStreamingDistributionConfigRequest - To request to get a streaming distribution configuration.NoSuchStreamingDistributionException - The specified streaming distribution does not exist.AccessDeniedException - Access denied.ListCachePoliciesResult listCachePolicies(ListCachePoliciesRequest listCachePoliciesRequest)
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.
listCachePoliciesRequest - AccessDeniedException - Access denied.NoSuchCachePolicyException - The cache policy does not exist.InvalidArgumentException - An argument is invalid.ListCloudFrontOriginAccessIdentitiesResult listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest)
Lists origin access identities.
listCloudFrontOriginAccessIdentitiesRequest - The request to list origin access identities.InvalidArgumentException - An argument is invalid.ListConflictingAliasesResult listConflictingAliases(ListConflictingAliasesRequest listConflictingAliasesRequest)
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.
listConflictingAliasesRequest - InvalidArgumentException - An argument is invalid.NoSuchDistributionException - The specified distribution does not exist.ListDistributionsResult listDistributions(ListDistributionsRequest listDistributionsRequest)
List CloudFront distributions.
listDistributionsRequest - The request to list your distributions.InvalidArgumentException - An argument is invalid.ListDistributionsByCachePolicyIdResult listDistributionsByCachePolicyId(ListDistributionsByCachePolicyIdRequest listDistributionsByCachePolicyIdRequest)
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.
listDistributionsByCachePolicyIdRequest - NoSuchCachePolicyException - The cache policy does not exist.InvalidArgumentException - An argument is invalid.AccessDeniedException - Access denied.ListDistributionsByKeyGroupResult listDistributionsByKeyGroup(ListDistributionsByKeyGroupRequest listDistributionsByKeyGroupRequest)
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.
listDistributionsByKeyGroupRequest - NoSuchResourceException - A resource that was specified is not valid.InvalidArgumentException - An argument is invalid.ListDistributionsByOriginRequestPolicyIdResult listDistributionsByOriginRequestPolicyId(ListDistributionsByOriginRequestPolicyIdRequest listDistributionsByOriginRequestPolicyIdRequest)
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.
listDistributionsByOriginRequestPolicyIdRequest - NoSuchOriginRequestPolicyException - The origin request policy does not exist.InvalidArgumentException - An argument is invalid.AccessDeniedException - Access denied.ListDistributionsByRealtimeLogConfigResult listDistributionsByRealtimeLogConfig(ListDistributionsByRealtimeLogConfigRequest listDistributionsByRealtimeLogConfigRequest)
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.
listDistributionsByRealtimeLogConfigRequest - InvalidArgumentException - An argument is invalid.ListDistributionsByResponseHeadersPolicyIdResult listDistributionsByResponseHeadersPolicyId(ListDistributionsByResponseHeadersPolicyIdRequest listDistributionsByResponseHeadersPolicyIdRequest)
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.
listDistributionsByResponseHeadersPolicyIdRequest - NoSuchResponseHeadersPolicyException - The response headers policy does not exist.InvalidArgumentException - An argument is invalid.AccessDeniedException - Access denied.ListDistributionsByWebACLIdResult listDistributionsByWebACLId(ListDistributionsByWebACLIdRequest listDistributionsByWebACLIdRequest)
List the distributions that are associated with a specified WAF web ACL.
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.ListFieldLevelEncryptionConfigsResult listFieldLevelEncryptionConfigs(ListFieldLevelEncryptionConfigsRequest listFieldLevelEncryptionConfigsRequest)
List all field-level encryption configurations that have been created in CloudFront for this account.
listFieldLevelEncryptionConfigsRequest - InvalidArgumentException - An argument is invalid.ListFieldLevelEncryptionProfilesResult listFieldLevelEncryptionProfiles(ListFieldLevelEncryptionProfilesRequest listFieldLevelEncryptionProfilesRequest)
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
listFieldLevelEncryptionProfilesRequest - InvalidArgumentException - An argument is invalid.ListFunctionsResult listFunctions(ListFunctionsRequest listFunctionsRequest)
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.
listFunctionsRequest - InvalidArgumentException - An argument is invalid.UnsupportedOperationException - This operation is not supported in this region.ListInvalidationsResult listInvalidations(ListInvalidationsRequest listInvalidationsRequest)
Lists invalidation batches.
listInvalidationsRequest - The request to list invalidations.InvalidArgumentException - An argument is invalid.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.ListKeyGroupsResult listKeyGroups(ListKeyGroupsRequest listKeyGroupsRequest)
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.
listKeyGroupsRequest - InvalidArgumentException - An argument is invalid.ListOriginAccessControlsResult listOriginAccessControls(ListOriginAccessControlsRequest listOriginAccessControlsRequest)
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.
listOriginAccessControlsRequest - InvalidArgumentException - An argument is invalid.ListOriginRequestPoliciesResult listOriginRequestPolicies(ListOriginRequestPoliciesRequest listOriginRequestPoliciesRequest)
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.
listOriginRequestPoliciesRequest - AccessDeniedException - Access denied.NoSuchOriginRequestPolicyException - The origin request policy does not exist.InvalidArgumentException - An argument is invalid.ListPublicKeysResult listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
List all public keys that have been added to CloudFront for this account.
listPublicKeysRequest - InvalidArgumentException - An argument is invalid.ListRealtimeLogConfigsResult listRealtimeLogConfigs(ListRealtimeLogConfigsRequest listRealtimeLogConfigsRequest)
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.
listRealtimeLogConfigsRequest - InvalidArgumentException - An argument is invalid.AccessDeniedException - Access denied.NoSuchRealtimeLogConfigException - The real-time log configuration does not exist.ListResponseHeadersPoliciesResult listResponseHeadersPolicies(ListResponseHeadersPoliciesRequest listResponseHeadersPoliciesRequest)
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.
listResponseHeadersPoliciesRequest - AccessDeniedException - Access denied.NoSuchResponseHeadersPolicyException - The response headers policy does not exist.InvalidArgumentException - An argument is invalid.ListStreamingDistributionsResult listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest)
List streaming distributions.
listStreamingDistributionsRequest - The request to list your streaming distributions.InvalidArgumentException - An argument is invalid.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a CloudFront resource.
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.PublishFunctionResult publishFunction(PublishFunctionRequest publishFunctionRequest)
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.
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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Add tags to a CloudFront resource.
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.TestFunctionResult testFunction(TestFunctionRequest testFunctionRequest)
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.
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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Remove tags from a CloudFront resource.
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.UpdateCachePolicyResult updateCachePolicy(UpdateCachePolicyRequest updateCachePolicyRequest)
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.
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.UpdateCloudFrontOriginAccessIdentityResult updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest)
Update an origin access identity.
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.UpdateDistributionResult updateDistribution(UpdateDistributionRequest updateDistributionRequest)
Updates the configuration for a web distribution.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
The update process includes getting the current distribution configuration, updating the XML document that is
returned to make your changes, and then submitting an UpdateDistribution request to make the
updates.
For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.
To update a web distribution using the CloudFront API
Submit a
GetDistributionConfig request to get the current configuration and an Etag header for the
distribution.
If you update the distribution again, you must get a new Etag header.
Update the XML document that was returned in the response to your GetDistributionConfig request to
include your changes.
When you edit the XML file, be aware of the following:
You must strip out the ETag parameter that is returned.
Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.
You can't change the value of CallerReference. If you try to change this value, CloudFront returns
an IllegalUpdate error.
The new configuration replaces the existing configuration; the values that you specify in an
UpdateDistribution request are not merged into your existing configuration. When you add, delete, or
replace values in an element that allows multiple values (for example, CNAME), you must specify all
of the values that you want to appear in the updated distribution. In addition, you must update the corresponding
Quantity element.
Submit an UpdateDistribution request to update the configuration for your distribution:
In the request body, include the XML document that you updated in Step 2. The request body must include an XML
document with a DistributionConfig element.
Set the value of the HTTP If-Match header to the value of the ETag header that
CloudFront returned when you submitted the GetDistributionConfig request in Step 1.
Review the response to the UpdateDistribution request to confirm that the configuration was
successfully updated.
Optional: Submit a GetDistribution
request to confirm that your changes have propagated. When propagation is complete, the value of
Status is Deployed.
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.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.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.UpdateFieldLevelEncryptionConfigResult updateFieldLevelEncryptionConfig(UpdateFieldLevelEncryptionConfigRequest updateFieldLevelEncryptionConfigRequest)
Update a field-level encryption configuration.
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.UpdateFieldLevelEncryptionProfileResult updateFieldLevelEncryptionProfile(UpdateFieldLevelEncryptionProfileRequest updateFieldLevelEncryptionProfileRequest)
Update a field-level encryption profile.
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.UpdateFunctionResult updateFunction(UpdateFunctionRequest updateFunctionRequest)
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.
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.UpdateKeyGroupResult updateKeyGroup(UpdateKeyGroupRequest updateKeyGroupRequest)
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.
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.UpdateOriginAccessControlResult updateOriginAccessControl(UpdateOriginAccessControlRequest updateOriginAccessControlRequest)
Updates a CloudFront origin access control.
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.UpdateOriginRequestPolicyResult updateOriginRequestPolicy(UpdateOriginRequestPolicyRequest updateOriginRequestPolicyRequest)
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.
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.UpdatePublicKeyResult updatePublicKey(UpdatePublicKeyRequest updatePublicKeyRequest)
Update public key information. Note that the only value you can change is the comment.
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.UpdateRealtimeLogConfigResult updateRealtimeLogConfig(UpdateRealtimeLogConfigRequest updateRealtimeLogConfigRequest)
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.
updateRealtimeLogConfigRequest - NoSuchRealtimeLogConfigException - The real-time log configuration does not exist.InvalidArgumentException - An argument is invalid.AccessDeniedException - Access denied.UpdateResponseHeadersPolicyResult updateResponseHeadersPolicy(UpdateResponseHeadersPolicyRequest updateResponseHeadersPolicyRequest)
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.
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.
UpdateStreamingDistributionResult updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest)
Update a streaming distribution.
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.void shutdown()
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 a request.
request - The originally executed request.AmazonCloudFrontWaiters waiters()
Copyright © 2022. All rights reserved.