@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonCloudFrontClient extends AmazonWebServiceClient implements AmazonCloudFront
This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonCloudFrontClient()
Deprecated.
|
AmazonCloudFrontClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonCloudFrontClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonCloudFrontClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonCloudFrontClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AmazonCloudFrontClient()
AmazonCloudFrontClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonCloudFrontClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to CloudFront (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonCloudFrontClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonCloudFrontClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonCloudFrontClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to CloudFront (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to CloudFront (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonCloudFrontClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to CloudFront (ex: proxy settings,
retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AmazonCloudFrontClientBuilder builder()
public CreateCloudFrontOriginAccessIdentityResult createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest request)
Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
createCloudFrontOriginAccessIdentity in interface AmazonCloudFrontcreateCloudFrontOriginAccessIdentityRequest - The request to create a new origin access identity.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 - The argument is invalid.InconsistentQuantitiesException - The value of Quantity and the size of Items don't match.public CreateDistributionResult createDistribution(CreateDistributionRequest request)
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.
If you are using Adobe Flash Media Server's RTMP protocol, you set up a different kind of CloudFront distribution. For more information, see CreateStreamingDistribution.
createDistribution in interface AmazonCloudFrontcreateDistributionRequest - The request to create a new distribution.CNAMEAlreadyExistsExceptionDistributionAlreadyExistsException - 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.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.InvalidViewerCertificateExceptionInvalidMinimumProtocolVersionExceptionMissingBodyException - 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 (/).InvalidErrorCodeExceptionInvalidResponseCodeExceptionInvalidArgumentException - The 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.TooManyHeadersInForwardedValuesExceptionInvalidHeadersForS3OriginExceptionInconsistentQuantitiesException - The value of Quantity and the size of Items don't match.TooManyCertificatesException - You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeExceptionInvalidGeoRestrictionParameterExceptionInvalidProtocolSettingsException - You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTTLOrderExceptionInvalidWebACLIdExceptionTooManyOriginCustomHeadersExceptionTooManyQueryStringParametersExceptionInvalidQueryStringParametersExceptionTooManyDistributionsWithLambdaAssociationsException - Processing your request would cause the maximum number of distributions with Lambda function associations
per owner to be exceeded.TooManyLambdaFunctionAssociationsException - Your request contains more Lambda function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException - The specified Lambda function association is invalid.InvalidOriginReadTimeoutExceptionInvalidOriginKeepaliveTimeoutExceptionNoSuchFieldLevelEncryptionConfigException - 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.public CreateDistributionWithTagsResult createDistributionWithTags(CreateDistributionWithTagsRequest request)
Create a new distribution with tags.
createDistributionWithTags in interface AmazonCloudFrontcreateDistributionWithTagsRequest - The request to create a new distribution with tags.CNAMEAlreadyExistsExceptionDistributionAlreadyExistsException - 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.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.InvalidViewerCertificateExceptionInvalidMinimumProtocolVersionExceptionMissingBodyException - 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 (/).InvalidErrorCodeExceptionInvalidResponseCodeExceptionInvalidArgumentException - The 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.TooManyHeadersInForwardedValuesExceptionInvalidHeadersForS3OriginExceptionInconsistentQuantitiesException - The value of Quantity and the size of Items don't match.TooManyCertificatesException - You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeExceptionInvalidGeoRestrictionParameterExceptionInvalidProtocolSettingsException - You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTTLOrderExceptionInvalidWebACLIdExceptionTooManyOriginCustomHeadersExceptionInvalidTaggingExceptionTooManyQueryStringParametersExceptionInvalidQueryStringParametersExceptionTooManyDistributionsWithLambdaAssociationsException - Processing your request would cause the maximum number of distributions with Lambda function associations
per owner to be exceeded.TooManyLambdaFunctionAssociationsException - Your request contains more Lambda function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException - The specified Lambda function association is invalid.InvalidOriginReadTimeoutExceptionInvalidOriginKeepaliveTimeoutExceptionNoSuchFieldLevelEncryptionConfigException - 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.public CreateFieldLevelEncryptionConfigResult createFieldLevelEncryptionConfig(CreateFieldLevelEncryptionConfigRequest request)
Create a new field-level encryption configuration.
createFieldLevelEncryptionConfig in interface AmazonCloudFrontcreateFieldLevelEncryptionConfigRequest - InconsistentQuantitiesException - The value of Quantity and the size of Items don't match.InvalidArgumentException - The argument is invalid.NoSuchFieldLevelEncryptionProfileException - The specified profile for field-level encryption doesn't exist.FieldLevelEncryptionConfigAlreadyExistsException - The specified configuration for field-level encryption already exists.TooManyFieldLevelEncryptionConfigsException - The maximum number of configurations for field-level encryption have been created.TooManyFieldLevelEncryptionQueryArgProfilesException - The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException - The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException - No profile specified for the field-level encryption query argument.public CreateFieldLevelEncryptionProfileResult createFieldLevelEncryptionProfile(CreateFieldLevelEncryptionProfileRequest request)
Create a field-level encryption profile.
createFieldLevelEncryptionProfile in interface AmazonCloudFrontcreateFieldLevelEncryptionProfileRequest - InconsistentQuantitiesException - The value of Quantity and the size of Items don't match.InvalidArgumentException - The argument is invalid.NoSuchPublicKeyException - The specified public key doesn't exist.FieldLevelEncryptionProfileAlreadyExistsException - The specified profile for field-level encryption already exists.FieldLevelEncryptionProfileSizeExceededException - The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionProfilesException - The maximum number of profiles for field-level encryption have been created.TooManyFieldLevelEncryptionEncryptionEntitiesException - The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException - The maximum number of field patterns for field-level encryption have been created.public CreateInvalidationResult createInvalidation(CreateInvalidationRequest request)
Create a new invalidation.
createInvalidation in interface AmazonCloudFrontcreateInvalidationRequest - 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 - The argument is invalid.NoSuchDistributionException - The specified distribution does not exist.BatchTooLargeExceptionTooManyInvalidationsInProgressException - You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation
objects.InconsistentQuantitiesException - The value of Quantity and the size of Items don't match.public CreatePublicKeyResult createPublicKey(CreatePublicKeyRequest request)
Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.
createPublicKey in interface AmazonCloudFrontcreatePublicKeyRequest - PublicKeyAlreadyExistsException - The specified public key already exists.InvalidArgumentException - The argument is invalid.TooManyPublicKeysException - The maximum number of public keys for field-level encryption have been created. To create a new public
key, delete one of the existing keys.public CreateStreamingDistributionResult createStreamingDistribution(CreateStreamingDistributionRequest request)
Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.
To create a new web distribution, submit a POST request to the CloudFront API
version/distribution resource. The request body must include a document with a
StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig
element and returns other information about the RTMP distribution.
To get the status of your request, use the GET StreamingDistribution API action. When the value of
Enabled is true and the value of Status is Deployed, your
distribution is ready. A distribution usually deploys in less than 15 minutes.
For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.
Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML
document that you include in the request body when you create or update a web distribution or an RTMP
distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too
easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs
and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions
and to notify you when there's a mismatch between the number of values you say you're specifying in the
Quantity element and the number of values specified.
createStreamingDistribution in interface AmazonCloudFrontcreateStreamingDistributionRequest - The request to create a new streaming distribution.CNAMEAlreadyExistsExceptionStreamingDistributionAlreadyExistsExceptionInvalidOriginException - 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.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.TooManyStreamingDistributionCNAMEsExceptionTooManyStreamingDistributionsException - Processing your request would cause you to exceed the maximum number of streaming distributions allowed.InvalidArgumentException - The argument is invalid.InconsistentQuantitiesException - The value of Quantity and the size of Items don't match.public CreateStreamingDistributionWithTagsResult createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest request)
Create a new streaming distribution with tags.
createStreamingDistributionWithTags in interface AmazonCloudFrontcreateStreamingDistributionWithTagsRequest - The request to create a new streaming distribution with tags.CNAMEAlreadyExistsExceptionStreamingDistributionAlreadyExistsExceptionInvalidOriginException - 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.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.TooManyStreamingDistributionCNAMEsExceptionTooManyStreamingDistributionsException - Processing your request would cause you to exceed the maximum number of streaming distributions allowed.InvalidArgumentException - The argument is invalid.InconsistentQuantitiesException - The value of Quantity and the size of Items don't match.InvalidTaggingExceptionpublic DeleteCloudFrontOriginAccessIdentityResult deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest request)
Delete an origin access identity.
deleteCloudFrontOriginAccessIdentity in interface AmazonCloudFrontdeleteCloudFrontOriginAccessIdentityRequest - Deletes a origin access identity.AccessDeniedException - Access denied.InvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.NoSuchCloudFrontOriginAccessIdentityException - The specified origin access identity does not exist.PreconditionFailedException - The precondition given in one or more of the request-header fields evaluated to false.CloudFrontOriginAccessIdentityInUseExceptionpublic DeleteDistributionResult deleteDistribution(DeleteDistributionRequest request)
Delete a distribution.
deleteDistribution in interface AmazonCloudFrontdeleteDistributionRequest - 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.DistributionNotDisabledExceptionInvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.NoSuchDistributionException - The specified distribution does not exist.PreconditionFailedException - The precondition given in one or more of the request-header fields evaluated to false.public DeleteFieldLevelEncryptionConfigResult deleteFieldLevelEncryptionConfig(DeleteFieldLevelEncryptionConfigRequest request)
Remove a field-level encryption configuration.
deleteFieldLevelEncryptionConfig in interface AmazonCloudFrontdeleteFieldLevelEncryptionConfigRequest - AccessDeniedException - Access denied.InvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.NoSuchFieldLevelEncryptionConfigException - The specified configuration for field-level encryption doesn't exist.PreconditionFailedException - The precondition given in one or more of the request-header fields evaluated to false.FieldLevelEncryptionConfigInUseException - The specified configuration for field-level encryption is in use.public DeleteFieldLevelEncryptionProfileResult deleteFieldLevelEncryptionProfile(DeleteFieldLevelEncryptionProfileRequest request)
Remove a field-level encryption profile.
deleteFieldLevelEncryptionProfile in interface AmazonCloudFrontdeleteFieldLevelEncryptionProfileRequest - AccessDeniedException - Access denied.InvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.NoSuchFieldLevelEncryptionProfileException - The specified profile for field-level encryption doesn't exist.PreconditionFailedException - The precondition given in one or more of the request-header fields evaluated to false.FieldLevelEncryptionProfileInUseException - The specified profile for field-level encryption is in use.public DeletePublicKeyResult deletePublicKey(DeletePublicKeyRequest request)
Remove a public key you previously added to CloudFront.
deletePublicKey in interface AmazonCloudFrontdeletePublicKeyRequest - AccessDeniedException - Access denied.PublicKeyInUseException - The specified public key is in use.InvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.NoSuchPublicKeyException - The specified public key doesn't exist.PreconditionFailedException - The precondition given in one or more of the request-header fields evaluated to false.public DeleteStreamingDistributionResult deleteStreamingDistribution(DeleteStreamingDistributionRequest request)
Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API:
Disable the RTMP distribution.
Submit a GET Streaming Distribution Config request to get the current configuration and the
Etag header for the distribution.
Update the XML document that was returned in the response to your GET Streaming Distribution Config
request to change the value of Enabled to false.
Submit a PUT Streaming Distribution Config request to update the configuration for your
distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the
HTTP If-Match header to the value of the ETag header that CloudFront returned when you
submitted the GET Streaming Distribution Config request in Step 2.
Review the response to the PUT Streaming Distribution Config request to confirm that the
distribution was successfully disabled.
Submit a GET Streaming Distribution Config request to confirm that your changes have propagated.
When propagation is complete, the value of Status is Deployed.
Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match
header to the value of the ETag header that CloudFront returned when you submitted the
GET Streaming Distribution Config request in Step 2.
Review the response to your DELETE Streaming Distribution request to confirm that the distribution
was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
deleteStreamingDistribution in interface AmazonCloudFrontdeleteStreamingDistributionRequest - The request to delete a streaming distribution.AccessDeniedException - Access denied.StreamingDistributionNotDisabledExceptionInvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.NoSuchStreamingDistributionException - The specified streaming distribution does not exist.PreconditionFailedException - The precondition given in one or more of the request-header fields evaluated to false.public GetCloudFrontOriginAccessIdentityResult getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest request)
Get the information about an origin access identity.
getCloudFrontOriginAccessIdentity in interface AmazonCloudFrontgetCloudFrontOriginAccessIdentityRequest - The request to get an origin access identity's information.NoSuchCloudFrontOriginAccessIdentityException - The specified origin access identity does not exist.AccessDeniedException - Access denied.public GetCloudFrontOriginAccessIdentityConfigResult getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest request)
Get the configuration information about an origin access identity.
getCloudFrontOriginAccessIdentityConfig in interface AmazonCloudFrontgetCloudFrontOriginAccessIdentityConfigRequest - The origin access identity's configuration information. For more information, see
CloudFrontOriginAccessIdentityConfigComplexType.NoSuchCloudFrontOriginAccessIdentityException - The specified origin access identity does not exist.AccessDeniedException - Access denied.public GetDistributionResult getDistribution(GetDistributionRequest request)
Get the information about a distribution.
getDistribution in interface AmazonCloudFrontgetDistributionRequest - The request to get a distribution's information.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.public GetDistributionConfigResult getDistributionConfig(GetDistributionConfigRequest request)
Get the configuration information about a distribution.
getDistributionConfig in interface AmazonCloudFrontgetDistributionConfigRequest - The request to get a distribution configuration.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.public GetFieldLevelEncryptionResult getFieldLevelEncryption(GetFieldLevelEncryptionRequest request)
Get the field-level encryption configuration information.
getFieldLevelEncryption in interface AmazonCloudFrontgetFieldLevelEncryptionRequest - AccessDeniedException - Access denied.NoSuchFieldLevelEncryptionConfigException - The specified configuration for field-level encryption doesn't exist.public GetFieldLevelEncryptionConfigResult getFieldLevelEncryptionConfig(GetFieldLevelEncryptionConfigRequest request)
Get the field-level encryption configuration information.
getFieldLevelEncryptionConfig in interface AmazonCloudFrontgetFieldLevelEncryptionConfigRequest - AccessDeniedException - Access denied.NoSuchFieldLevelEncryptionConfigException - The specified configuration for field-level encryption doesn't exist.public GetFieldLevelEncryptionProfileResult getFieldLevelEncryptionProfile(GetFieldLevelEncryptionProfileRequest request)
Get the field-level encryption profile information.
getFieldLevelEncryptionProfile in interface AmazonCloudFrontgetFieldLevelEncryptionProfileRequest - AccessDeniedException - Access denied.NoSuchFieldLevelEncryptionProfileException - The specified profile for field-level encryption doesn't exist.public GetFieldLevelEncryptionProfileConfigResult getFieldLevelEncryptionProfileConfig(GetFieldLevelEncryptionProfileConfigRequest request)
Get the field-level encryption profile configuration information.
getFieldLevelEncryptionProfileConfig in interface AmazonCloudFrontgetFieldLevelEncryptionProfileConfigRequest - AccessDeniedException - Access denied.NoSuchFieldLevelEncryptionProfileException - The specified profile for field-level encryption doesn't exist.public GetInvalidationResult getInvalidation(GetInvalidationRequest request)
Get the information about an invalidation.
getInvalidation in interface AmazonCloudFrontgetInvalidationRequest - The request to get an invalidation's information.NoSuchInvalidationException - The specified invalidation does not exist.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.public GetPublicKeyResult getPublicKey(GetPublicKeyRequest request)
Get the public key information.
getPublicKey in interface AmazonCloudFrontgetPublicKeyRequest - AccessDeniedException - Access denied.NoSuchPublicKeyException - The specified public key doesn't exist.public GetPublicKeyConfigResult getPublicKeyConfig(GetPublicKeyConfigRequest request)
Return public key configuration informaation
getPublicKeyConfig in interface AmazonCloudFrontgetPublicKeyConfigRequest - AccessDeniedException - Access denied.NoSuchPublicKeyException - The specified public key doesn't exist.public GetStreamingDistributionResult getStreamingDistribution(GetStreamingDistributionRequest request)
Gets information about a specified RTMP distribution, including the distribution configuration.
getStreamingDistribution in interface AmazonCloudFrontgetStreamingDistributionRequest - The request to get a streaming distribution's information.NoSuchStreamingDistributionException - The specified streaming distribution does not exist.AccessDeniedException - Access denied.public GetStreamingDistributionConfigResult getStreamingDistributionConfig(GetStreamingDistributionConfigRequest request)
Get the configuration information about a streaming distribution.
getStreamingDistributionConfig in interface AmazonCloudFrontgetStreamingDistributionConfigRequest - To request to get a streaming distribution configuration.NoSuchStreamingDistributionException - The specified streaming distribution does not exist.AccessDeniedException - Access denied.public ListCloudFrontOriginAccessIdentitiesResult listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest request)
Lists origin access identities.
listCloudFrontOriginAccessIdentities in interface AmazonCloudFrontlistCloudFrontOriginAccessIdentitiesRequest - The request to list origin access identities.InvalidArgumentException - The argument is invalid.public ListDistributionsResult listDistributions(ListDistributionsRequest request)
List distributions.
listDistributions in interface AmazonCloudFrontlistDistributionsRequest - The request to list your distributions.InvalidArgumentException - The argument is invalid.public ListDistributionsByWebACLIdResult listDistributionsByWebACLId(ListDistributionsByWebACLIdRequest request)
List the distributions that are associated with a specified AWS WAF web ACL.
listDistributionsByWebACLId in interface AmazonCloudFrontlistDistributionsByWebACLIdRequest - The request to list distributions that are associated with a specified AWS WAF web ACL.InvalidArgumentException - The argument is invalid.InvalidWebACLIdExceptionpublic ListFieldLevelEncryptionConfigsResult listFieldLevelEncryptionConfigs(ListFieldLevelEncryptionConfigsRequest request)
List all field-level encryption configurations that have been created in CloudFront for this account.
listFieldLevelEncryptionConfigs in interface AmazonCloudFrontlistFieldLevelEncryptionConfigsRequest - InvalidArgumentException - The argument is invalid.public ListFieldLevelEncryptionProfilesResult listFieldLevelEncryptionProfiles(ListFieldLevelEncryptionProfilesRequest request)
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
listFieldLevelEncryptionProfiles in interface AmazonCloudFrontlistFieldLevelEncryptionProfilesRequest - InvalidArgumentException - The argument is invalid.public ListInvalidationsResult listInvalidations(ListInvalidationsRequest request)
Lists invalidation batches.
listInvalidations in interface AmazonCloudFrontlistInvalidationsRequest - The request to list invalidations.InvalidArgumentException - The argument is invalid.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.public ListPublicKeysResult listPublicKeys(ListPublicKeysRequest request)
List all public keys that have been added to CloudFront for this account.
listPublicKeys in interface AmazonCloudFrontlistPublicKeysRequest - InvalidArgumentException - The argument is invalid.public ListStreamingDistributionsResult listStreamingDistributions(ListStreamingDistributionsRequest request)
List streaming distributions.
listStreamingDistributions in interface AmazonCloudFrontlistStreamingDistributionsRequest - The request to list your streaming distributions.InvalidArgumentException - The argument is invalid.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List tags for a CloudFront resource.
listTagsForResource in interface AmazonCloudFrontlistTagsForResourceRequest - The request to list tags for a CloudFront resource.AccessDeniedException - Access denied.InvalidArgumentException - The argument is invalid.InvalidTaggingExceptionNoSuchResourceExceptionpublic TagResourceResult tagResource(TagResourceRequest request)
Add tags to a CloudFront resource.
tagResource in interface AmazonCloudFronttagResourceRequest - The request to add tags to a CloudFront resource.AccessDeniedException - Access denied.InvalidArgumentException - The argument is invalid.InvalidTaggingExceptionNoSuchResourceExceptionpublic UntagResourceResult untagResource(UntagResourceRequest request)
Remove tags from a CloudFront resource.
untagResource in interface AmazonCloudFrontuntagResourceRequest - The request to remove tags from a CloudFront resource.AccessDeniedException - Access denied.InvalidArgumentException - The argument is invalid.InvalidTaggingExceptionNoSuchResourceExceptionpublic UpdateCloudFrontOriginAccessIdentityResult updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest request)
Update an origin access identity.
updateCloudFrontOriginAccessIdentity in interface AmazonCloudFrontupdateCloudFrontOriginAccessIdentityRequest - The request to update an origin access identity.AccessDeniedException - Access denied.IllegalUpdateException - Origin and CallerReference cannot be updated.InvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.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 given in one or more of the request-header fields evaluated to false.InvalidArgumentException - The argument is invalid.InconsistentQuantitiesException - The value of Quantity and the size of Items don't match.public UpdateDistributionResult updateDistribution(UpdateDistributionRequest request)
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.
updateDistribution in interface AmazonCloudFrontupdateDistributionRequest - The request to update a distribution.AccessDeniedException - Access denied.CNAMEAlreadyExistsExceptionIllegalUpdateException - Origin and CallerReference cannot be updated.InvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.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 given in one or more of the request-header 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 (/).InvalidErrorCodeExceptionInvalidResponseCodeExceptionInvalidArgumentException - The argument is invalid.InvalidOriginAccessIdentityException - The origin access identity is not valid or doesn't exist.TooManyTrustedSignersException - Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException - One or more of your trusted signers don't exist.InvalidViewerCertificateExceptionInvalidMinimumProtocolVersionExceptionInvalidRequiredProtocolException - 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.TooManyHeadersInForwardedValuesExceptionInvalidHeadersForS3OriginExceptionInconsistentQuantitiesException - The value of Quantity and the size of Items don't match.TooManyCertificatesException - You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeExceptionInvalidGeoRestrictionParameterExceptionInvalidTTLOrderExceptionInvalidWebACLIdExceptionTooManyOriginCustomHeadersExceptionTooManyQueryStringParametersExceptionInvalidQueryStringParametersExceptionTooManyDistributionsWithLambdaAssociationsException - Processing your request would cause the maximum number of distributions with Lambda function associations
per owner to be exceeded.TooManyLambdaFunctionAssociationsException - Your request contains more Lambda function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException - The specified Lambda function association is invalid.InvalidOriginReadTimeoutExceptionInvalidOriginKeepaliveTimeoutExceptionNoSuchFieldLevelEncryptionConfigException - 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.public UpdateFieldLevelEncryptionConfigResult updateFieldLevelEncryptionConfig(UpdateFieldLevelEncryptionConfigRequest request)
Update a field-level encryption configuration.
updateFieldLevelEncryptionConfig in interface AmazonCloudFrontupdateFieldLevelEncryptionConfigRequest - AccessDeniedException - Access denied.IllegalUpdateException - Origin and CallerReference cannot be updated.InconsistentQuantitiesException - The value of Quantity and the size of Items don't match.InvalidArgumentException - The argument is invalid.InvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.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 given in one or more of the request-header fields evaluated to false.TooManyFieldLevelEncryptionQueryArgProfilesException - The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException - The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException - No profile specified for the field-level encryption query argument.public UpdateFieldLevelEncryptionProfileResult updateFieldLevelEncryptionProfile(UpdateFieldLevelEncryptionProfileRequest request)
Update a field-level encryption profile.
updateFieldLevelEncryptionProfile in interface AmazonCloudFrontupdateFieldLevelEncryptionProfileRequest - AccessDeniedException - Access denied.FieldLevelEncryptionProfileAlreadyExistsException - The specified profile for field-level encryption already exists.IllegalUpdateException - Origin and CallerReference cannot be updated.InconsistentQuantitiesException - The value of Quantity and the size of Items don't match.InvalidArgumentException - The argument is invalid.InvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.NoSuchPublicKeyException - The specified public key doesn't exist.NoSuchFieldLevelEncryptionProfileException - The specified profile for field-level encryption doesn't exist.PreconditionFailedException - The precondition given in one or more of the request-header fields evaluated to false.FieldLevelEncryptionProfileSizeExceededException - The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionEncryptionEntitiesException - The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException - The maximum number of field patterns for field-level encryption have been created.public UpdatePublicKeyResult updatePublicKey(UpdatePublicKeyRequest request)
Update public key information. Note that the only value you can change is the comment.
updatePublicKey in interface AmazonCloudFrontupdatePublicKeyRequest - AccessDeniedException - Access denied.CannotChangeImmutablePublicKeyFieldsException - You can't change the value of a public key.InvalidArgumentException - The argument is invalid.InvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.IllegalUpdateException - Origin and CallerReference cannot be updated.NoSuchPublicKeyException - The specified public key doesn't exist.PreconditionFailedException - The precondition given in one or more of the request-header fields evaluated to false.public UpdateStreamingDistributionResult updateStreamingDistribution(UpdateStreamingDistributionRequest request)
Update a streaming distribution.
updateStreamingDistribution in interface AmazonCloudFrontupdateStreamingDistributionRequest - The request to update a streaming distribution.AccessDeniedException - Access denied.CNAMEAlreadyExistsExceptionIllegalUpdateException - Origin and CallerReference cannot be updated.InvalidIfMatchVersionException - The If-Match version is missing or not valid for the distribution.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 given in one or more of the request-header fields evaluated to false.TooManyStreamingDistributionCNAMEsExceptionInvalidArgumentException - The argument is invalid.InvalidOriginAccessIdentityException - The origin access identity is not valid or doesn't exist.TooManyTrustedSignersException - Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException - One or more of your trusted signers don't exist.InconsistentQuantitiesException - The value of Quantity and the size of Items don't match.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonCloudFrontrequest - The originally executed requestpublic AmazonCloudFrontWaiters waiters()
waiters in interface AmazonCloudFrontpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonCloudFrontshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.