AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface CloudFrontClient extends AutoCloseable
builder() method.
This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about the CloudFront API actions, data types, and errors. For detailed information about CloudFront features and their associated API calls, see the Amazon CloudFront Developer Guide.
| Modifier and Type | Field | Description |
|---|---|---|
static String |
SERVICE_NAME |
closestatic final String SERVICE_NAME
static CloudFrontClient create()
CloudFrontClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudFrontClientBuilder builder()
CloudFrontClient.default CreateCloudFrontOriginAccessIdentityResponse createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest createCloudFrontOriginAccessIdentityRequest) throws CloudFrontOriginAccessIdentityAlreadyExistsException, MissingBodyException, TooManyCloudFrontOriginAccessIdentitiesException, InvalidArgumentException, InconsistentQuantitiesException, SdkBaseException, SdkClientException, CloudFrontException
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.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 do not match.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateDistributionResponse createDistribution(CreateDistributionRequest createDistributionRequest) throws CNAMEAlreadyExistsException, DistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, MissingBodyException, TooManyDistributionCNAMEsException, TooManyDistributionsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTTLOrderException, InvalidWebACLIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, SdkBaseException, SdkClientException, CloudFrontException
Creates a new web distribution. Send a POST request to the
/CloudFront API version/distribution/distribution ID resource.
createDistributionRequest - 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 do not 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.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 do not 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.InvalidOriginReadTimeoutExceptionInvalidOriginKeepaliveTimeoutExceptionSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateDistributionWithTagsResponse createDistributionWithTags(CreateDistributionWithTagsRequest createDistributionWithTagsRequest) throws CNAMEAlreadyExistsException, DistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, MissingBodyException, TooManyDistributionCNAMEsException, TooManyDistributionsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTTLOrderException, InvalidWebACLIdException, TooManyOriginCustomHeadersException, InvalidTaggingException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, SdkBaseException, SdkClientException, CloudFrontException
Create a new distribution with tags.
createDistributionWithTagsRequest - 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 do not 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.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 do not 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.InvalidOriginReadTimeoutExceptionInvalidOriginKeepaliveTimeoutExceptionSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateInvalidationResponse createInvalidation(CreateInvalidationRequest createInvalidationRequest) throws AccessDeniedException, MissingBodyException, InvalidArgumentException, NoSuchDistributionException, BatchTooLargeException, TooManyInvalidationsInProgressException, InconsistentQuantitiesException, SdkBaseException, SdkClientException, CloudFrontException
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 - 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 do not match.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateStreamingDistributionResponse createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest) throws CNAMEAlreadyExistsException, StreamingDistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, MissingBodyException, TooManyStreamingDistributionCNAMEsException, TooManyStreamingDistributionsException, InvalidArgumentException, InconsistentQuantitiesException, SdkBaseException, SdkClientException, CloudFrontException
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.
createStreamingDistributionRequest - 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 do not 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 do not match.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateStreamingDistributionWithTagsResponse createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest createStreamingDistributionWithTagsRequest) throws CNAMEAlreadyExistsException, StreamingDistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, MissingBodyException, TooManyStreamingDistributionCNAMEsException, TooManyStreamingDistributionsException, InvalidArgumentException, InconsistentQuantitiesException, InvalidTaggingException, SdkBaseException, SdkClientException, CloudFrontException
Create a new streaming distribution with tags.
createStreamingDistributionWithTagsRequest - 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 do not 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 do not match.InvalidTaggingExceptionSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteCloudFrontOriginAccessIdentityResponse deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchCloudFrontOriginAccessIdentityException, PreconditionFailedException, CloudFrontOriginAccessIdentityInUseException, SdkBaseException, SdkClientException, CloudFrontException
Delete an origin access identity.
deleteCloudFrontOriginAccessIdentityRequest - 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.CloudFrontOriginAccessIdentityInUseExceptionSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDistributionResponse deleteDistribution(DeleteDistributionRequest deleteDistributionRequest) throws AccessDeniedException, DistributionNotDisabledException, InvalidIfMatchVersionException, NoSuchDistributionException, PreconditionFailedException, SdkBaseException, SdkClientException, CloudFrontException
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.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteStreamingDistributionResponse deleteStreamingDistribution(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest) throws AccessDeniedException, StreamingDistributionNotDisabledException, InvalidIfMatchVersionException, NoSuchStreamingDistributionException, PreconditionFailedException, SdkBaseException, SdkClientException, CloudFrontException
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.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetCloudFrontOriginAccessIdentityResponse getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest) throws NoSuchCloudFrontOriginAccessIdentityException, AccessDeniedException, SdkBaseException, SdkClientException, CloudFrontException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetCloudFrontOriginAccessIdentityConfigResponse getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest) throws NoSuchCloudFrontOriginAccessIdentityException, AccessDeniedException, SdkBaseException, SdkClientException, CloudFrontException
Get the configuration information about an origin access identity.
getCloudFrontOriginAccessIdentityConfigRequest - The origin access identity's configuration information. For more information, see
CloudFrontOriginAccessIdentityConfigComplexType.NoSuchCloudFrontOriginAccessIdentityException - The specified origin access identity does not exist.AccessDeniedException - Access denied.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDistributionResponse getDistribution(GetDistributionRequest getDistributionRequest) throws NoSuchDistributionException, AccessDeniedException, SdkBaseException, SdkClientException, CloudFrontException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDistributionConfigResponse getDistributionConfig(GetDistributionConfigRequest getDistributionConfigRequest) throws NoSuchDistributionException, AccessDeniedException, SdkBaseException, SdkClientException, CloudFrontException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetInvalidationResponse getInvalidation(GetInvalidationRequest getInvalidationRequest) throws NoSuchInvalidationException, NoSuchDistributionException, AccessDeniedException, SdkBaseException, SdkClientException, CloudFrontException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetStreamingDistributionResponse getStreamingDistribution(GetStreamingDistributionRequest getStreamingDistributionRequest) throws NoSuchStreamingDistributionException, AccessDeniedException, SdkBaseException, SdkClientException, CloudFrontException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetStreamingDistributionConfigResponse getStreamingDistributionConfig(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest) throws NoSuchStreamingDistributionException, AccessDeniedException, SdkBaseException, SdkClientException, CloudFrontException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListCloudFrontOriginAccessIdentitiesResponse listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest) throws InvalidArgumentException, SdkBaseException, SdkClientException, CloudFrontException
Lists origin access identities.
listCloudFrontOriginAccessIdentitiesRequest - The request to list origin access identities.InvalidArgumentException - The argument is invalid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListDistributionsResponse listDistributions(ListDistributionsRequest listDistributionsRequest) throws InvalidArgumentException, SdkBaseException, SdkClientException, CloudFrontException
List distributions.
listDistributionsRequest - The request to list your distributions.InvalidArgumentException - The argument is invalid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListDistributionsByWebACLIdResponse listDistributionsByWebACLId(ListDistributionsByWebACLIdRequest listDistributionsByWebACLIdRequest) throws InvalidArgumentException, InvalidWebACLIdException, SdkBaseException, SdkClientException, CloudFrontException
List the distributions that are associated with a specified AWS WAF web ACL.
listDistributionsByWebACLIdRequest - The request to list distributions that are associated with a specified AWS WAF web ACL.InvalidArgumentException - The argument is invalid.InvalidWebACLIdExceptionSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListInvalidationsResponse listInvalidations(ListInvalidationsRequest listInvalidationsRequest) throws InvalidArgumentException, NoSuchDistributionException, AccessDeniedException, SdkBaseException, SdkClientException, CloudFrontException
Lists invalidation batches.
listInvalidationsRequest - The request to list invalidations.InvalidArgumentException - The argument is invalid.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListStreamingDistributionsResponse listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest) throws InvalidArgumentException, SdkBaseException, SdkClientException, CloudFrontException
List streaming distributions.
listStreamingDistributionsRequest - The request to list your streaming distributions.InvalidArgumentException - The argument is invalid.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, SdkBaseException, SdkClientException, CloudFrontException
List tags for a CloudFront resource.
listTagsForResourceRequest - The request to list tags for a CloudFront resource.AccessDeniedException - Access denied.InvalidArgumentException - The argument is invalid.InvalidTaggingExceptionNoSuchResourceExceptionSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, SdkBaseException, SdkClientException, CloudFrontException
Add tags to a CloudFront resource.
tagResourceRequest - The request to add tags to a CloudFront resource.AccessDeniedException - Access denied.InvalidArgumentException - The argument is invalid.InvalidTaggingExceptionNoSuchResourceExceptionSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, SdkBaseException, SdkClientException, CloudFrontException
Remove tags from a CloudFront resource.
untagResourceRequest - The request to remove tags from a CloudFront resource.AccessDeniedException - Access denied.InvalidArgumentException - The argument is invalid.InvalidTaggingExceptionNoSuchResourceExceptionSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateCloudFrontOriginAccessIdentityResponse updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest) throws AccessDeniedException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchCloudFrontOriginAccessIdentityException, PreconditionFailedException, InvalidArgumentException, InconsistentQuantitiesException, SdkBaseException, SdkClientException, CloudFrontException
Update an origin access identity.
updateCloudFrontOriginAccessIdentityRequest - 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 do not match.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateDistributionResponse updateDistribution(UpdateDistributionRequest updateDistributionRequest) throws AccessDeniedException, CNAMEAlreadyExistsException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchDistributionException, PreconditionFailedException, TooManyDistributionCNAMEsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidOriginAccessIdentityException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidTTLOrderException, InvalidWebACLIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, SdkBaseException, SdkClientException, CloudFrontException
Updates the configuration for a web distribution. Perform the following steps.
For information about updating a distribution using the CloudFront console, see Creating or Updating a Web Distribution Using the CloudFront Console 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 need to get a new Etag header.
Update the XML document that was returned in the response to your GetDistributionConfig request to
include the desired changes. 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 the 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.
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 distribution. 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 you're actually specifying.
updateDistributionRequest - 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 do not 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.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 do not 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.InvalidOriginReadTimeoutExceptionInvalidOriginKeepaliveTimeoutExceptionSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateStreamingDistributionResponse updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest) throws AccessDeniedException, CNAMEAlreadyExistsException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchStreamingDistributionException, PreconditionFailedException, TooManyStreamingDistributionCNAMEsException, InvalidArgumentException, InvalidOriginAccessIdentityException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InconsistentQuantitiesException, SdkBaseException, SdkClientException, CloudFrontException
Update a streaming distribution.
updateStreamingDistributionRequest - 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 do not exist.InconsistentQuantitiesException - The value of Quantity and the size of Items do not match.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudFrontException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
CloudFrontClientWaiters waiters()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.