@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCloudFront
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCloudFront instead.
This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateCloudFrontOriginAccessIdentityResult |
createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest createCloudFrontOriginAccessIdentityRequest)
Creates a new origin access identity.
|
CreateDistributionResult |
createDistribution(CreateDistributionRequest createDistributionRequest)
Creates a new web distribution.
|
CreateDistributionWithTagsResult |
createDistributionWithTags(CreateDistributionWithTagsRequest createDistributionWithTagsRequest)
Create a new distribution with tags.
|
CreateInvalidationResult |
createInvalidation(CreateInvalidationRequest createInvalidationRequest)
Create a new invalidation.
|
CreateStreamingDistributionResult |
createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest)
Creates a new RMTP distribution.
|
CreateStreamingDistributionWithTagsResult |
createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest createStreamingDistributionWithTagsRequest)
Create a new streaming distribution with tags.
|
DeleteCloudFrontOriginAccessIdentityResult |
deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest)
Delete an origin access identity.
|
DeleteDistributionResult |
deleteDistribution(DeleteDistributionRequest deleteDistributionRequest)
Delete a distribution.
|
DeleteServiceLinkedRoleResult |
deleteServiceLinkedRole(DeleteServiceLinkedRoleRequest deleteServiceLinkedRoleRequest) |
DeleteStreamingDistributionResult |
deleteStreamingDistribution(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest)
Delete a streaming distribution.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCloudFrontOriginAccessIdentityResult |
getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest)
Get the information about an origin access identity.
|
GetCloudFrontOriginAccessIdentityConfigResult |
getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest)
Get the configuration information about an origin access identity.
|
GetDistributionResult |
getDistribution(GetDistributionRequest getDistributionRequest)
Get the information about a distribution.
|
GetDistributionConfigResult |
getDistributionConfig(GetDistributionConfigRequest getDistributionConfigRequest)
Get the configuration information about a distribution.
|
GetInvalidationResult |
getInvalidation(GetInvalidationRequest getInvalidationRequest)
Get the information about an invalidation.
|
GetStreamingDistributionResult |
getStreamingDistribution(GetStreamingDistributionRequest getStreamingDistributionRequest)
Gets information about a specified RTMP distribution, including the distribution configuration.
|
GetStreamingDistributionConfigResult |
getStreamingDistributionConfig(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest)
Get the configuration information about a streaming distribution.
|
ListCloudFrontOriginAccessIdentitiesResult |
listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest)
Lists origin access identities.
|
ListDistributionsResult |
listDistributions(ListDistributionsRequest listDistributionsRequest)
List distributions.
|
ListDistributionsByWebACLIdResult |
listDistributionsByWebACLId(ListDistributionsByWebACLIdRequest listDistributionsByWebACLIdRequest)
List the distributions that are associated with a specified AWS WAF web ACL.
|
ListInvalidationsResult |
listInvalidations(ListInvalidationsRequest listInvalidationsRequest)
Lists invalidation batches.
|
ListStreamingDistributionsResult |
listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest)
List streaming distributions.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a CloudFront resource.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Add tags to a CloudFront resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Remove tags from a CloudFront resource.
|
UpdateCloudFrontOriginAccessIdentityResult |
updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest)
Update an origin access identity.
|
UpdateDistributionResult |
updateDistribution(UpdateDistributionRequest updateDistributionRequest)
Updates the configuration for a web distribution.
|
UpdateStreamingDistributionResult |
updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest)
Update a streaming distribution.
|
AmazonCloudFrontWaiters |
waiters() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "cloudfront.amazonaws.com/") or a full URL, including the protocol
(ex: "https://cloudfront.amazonaws.com/"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "cloudfront.amazonaws.com/") or a full URL, including the protocol (ex:
"https://cloudfront.amazonaws.com/") of the region specific AWS endpoint this client will communicate
with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)CreateCloudFrontOriginAccessIdentityResult createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest createCloudFrontOriginAccessIdentityRequest)
Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
createCloudFrontOriginAccessIdentityRequest - The request to create a new origin access identity.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.CreateDistributionResult createDistribution(CreateDistributionRequest createDistributionRequest)
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 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.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.InvalidOriginReadTimeoutExceptionInvalidOriginKeepaliveTimeoutExceptionCreateDistributionWithTagsResult createDistributionWithTags(CreateDistributionWithTagsRequest createDistributionWithTagsRequest)
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 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.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.InvalidOriginReadTimeoutExceptionInvalidOriginKeepaliveTimeoutExceptionCreateInvalidationResult createInvalidation(CreateInvalidationRequest createInvalidationRequest)
Create a new invalidation.
createInvalidationRequest - The request to create an invalidation.AccessDeniedException - Access denied.MissingBodyException - This operation requires a body. Ensure that the body is present and the Content-Type header
is set.InvalidArgumentException - 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.CreateStreamingDistributionResult createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest)
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 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.CreateStreamingDistributionWithTagsResult createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest createStreamingDistributionWithTagsRequest)
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 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.InvalidTaggingExceptionDeleteCloudFrontOriginAccessIdentityResult deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest)
Delete an origin access identity.
deleteCloudFrontOriginAccessIdentityRequest - Deletes a origin access identity.AccessDeniedException - Access denied.InvalidIfMatchVersionException - The If-Match version is missing or not valid 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.CloudFrontOriginAccessIdentityInUseExceptionDeleteDistributionResult deleteDistribution(DeleteDistributionRequest deleteDistributionRequest)
Delete a distribution.
deleteDistributionRequest - This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the
following steps.
To delete a web distribution using the CloudFront API:
Disable the web distribution
Submit a GET Distribution Config request to get the current configuration and the
Etag header for the distribution.
Update the XML document that was returned in the response to your GET Distribution Config
request to change the value of Enabled to false.
Submit a PUT Distribution Config request to update the configuration for your distribution.
In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP
If-Match header to the value of the ETag header that CloudFront returned when
you submitted the GET Distribution Config request in Step 2.
Review the response to the PUT Distribution Config request to confirm that the distribution
was successfully disabled.
Submit a GET Distribution request to confirm that your changes have propagated. When
propagation is complete, the value of Status is Deployed.
Submit a DELETE Distribution request. Set the value of the HTTP If-Match header
to the value of the ETag header that CloudFront returned when you submitted the
GET Distribution Config request in Step 6.
Review the response to your DELETE Distribution request to confirm that the distribution was
successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
AccessDeniedException - Access denied.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.DeleteServiceLinkedRoleResult deleteServiceLinkedRole(DeleteServiceLinkedRoleRequest deleteServiceLinkedRoleRequest)
deleteServiceLinkedRoleRequest - InvalidArgumentException - The argument is invalid.AccessDeniedException - Access denied.ResourceInUseExceptionNoSuchResourceExceptionDeleteStreamingDistributionResult deleteStreamingDistribution(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest)
Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API:
Disable the RTMP distribution.
Submit a GET Streaming Distribution Config request to get the current configuration and the
Etag header for the distribution.
Update the XML document that was returned in the response to your GET Streaming Distribution Config
request to change the value of Enabled to false.
Submit a PUT Streaming Distribution Config request to update the configuration for your
distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the
HTTP If-Match header to the value of the ETag header that CloudFront returned when you
submitted the GET Streaming Distribution Config request in Step 2.
Review the response to the PUT Streaming Distribution Config request to confirm that the
distribution was successfully disabled.
Submit a GET Streaming Distribution Config request to confirm that your changes have propagated.
When propagation is complete, the value of Status is Deployed.
Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match
header to the value of the ETag header that CloudFront returned when you submitted the
GET Streaming Distribution Config request in Step 2.
Review the response to your DELETE Streaming Distribution request to confirm that the distribution
was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
deleteStreamingDistributionRequest - The request to delete a streaming distribution.AccessDeniedException - Access denied.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.GetCloudFrontOriginAccessIdentityResult getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest)
Get the information about an origin access identity.
getCloudFrontOriginAccessIdentityRequest - The request to get an origin access identity's information.NoSuchCloudFrontOriginAccessIdentityException - The specified origin access identity does not exist.AccessDeniedException - Access denied.GetCloudFrontOriginAccessIdentityConfigResult getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest)
Get the configuration information about an origin access identity.
getCloudFrontOriginAccessIdentityConfigRequest - The origin access identity's configuration information. For more information, see
CloudFrontOriginAccessIdentityConfigComplexType.NoSuchCloudFrontOriginAccessIdentityException - The specified origin access identity does not exist.AccessDeniedException - Access denied.GetDistributionResult getDistribution(GetDistributionRequest getDistributionRequest)
Get the information about a distribution.
getDistributionRequest - The request to get a distribution's information.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.GetDistributionConfigResult getDistributionConfig(GetDistributionConfigRequest getDistributionConfigRequest)
Get the configuration information about a distribution.
getDistributionConfigRequest - The request to get a distribution configuration.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.GetInvalidationResult getInvalidation(GetInvalidationRequest getInvalidationRequest)
Get the information about an invalidation.
getInvalidationRequest - The request to get an invalidation's information.NoSuchInvalidationException - The specified invalidation does not exist.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.GetStreamingDistributionResult getStreamingDistribution(GetStreamingDistributionRequest getStreamingDistributionRequest)
Gets information about a specified RTMP distribution, including the distribution configuration.
getStreamingDistributionRequest - The request to get a streaming distribution's information.NoSuchStreamingDistributionException - The specified streaming distribution does not exist.AccessDeniedException - Access denied.GetStreamingDistributionConfigResult getStreamingDistributionConfig(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest)
Get the configuration information about a streaming distribution.
getStreamingDistributionConfigRequest - To request to get a streaming distribution configuration.NoSuchStreamingDistributionException - The specified streaming distribution does not exist.AccessDeniedException - Access denied.ListCloudFrontOriginAccessIdentitiesResult listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest)
Lists origin access identities.
listCloudFrontOriginAccessIdentitiesRequest - The request to list origin access identities.InvalidArgumentException - The argument is invalid.ListDistributionsResult listDistributions(ListDistributionsRequest listDistributionsRequest)
List distributions.
listDistributionsRequest - The request to list your distributions.InvalidArgumentException - The argument is invalid.ListDistributionsByWebACLIdResult listDistributionsByWebACLId(ListDistributionsByWebACLIdRequest listDistributionsByWebACLIdRequest)
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.InvalidWebACLIdExceptionListInvalidationsResult listInvalidations(ListInvalidationsRequest listInvalidationsRequest)
Lists invalidation batches.
listInvalidationsRequest - The request to list invalidations.InvalidArgumentException - The argument is invalid.NoSuchDistributionException - The specified distribution does not exist.AccessDeniedException - Access denied.ListStreamingDistributionsResult listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest)
List streaming distributions.
listStreamingDistributionsRequest - The request to list your streaming distributions.InvalidArgumentException - The argument is invalid.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a CloudFront resource.
listTagsForResourceRequest - The request to list tags for a CloudFront resource.AccessDeniedException - Access denied.InvalidArgumentException - The argument is invalid.InvalidTaggingExceptionNoSuchResourceExceptionTagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Add tags to a CloudFront resource.
tagResourceRequest - The request to add tags to a CloudFront resource.AccessDeniedException - Access denied.InvalidArgumentException - The argument is invalid.InvalidTaggingExceptionNoSuchResourceExceptionUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Remove tags from a CloudFront resource.
untagResourceRequest - The request to remove tags from a CloudFront resource.AccessDeniedException - Access denied.InvalidArgumentException - The argument is invalid.InvalidTaggingExceptionNoSuchResourceExceptionUpdateCloudFrontOriginAccessIdentityResult updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest)
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 don't match.UpdateDistributionResult updateDistribution(UpdateDistributionRequest updateDistributionRequest)
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 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.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.InvalidOriginReadTimeoutExceptionInvalidOriginKeepaliveTimeoutExceptionUpdateStreamingDistributionResult updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest)
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 don't exist.InconsistentQuantitiesException - The value of Quantity and the size of Items don't match.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.AmazonCloudFrontWaiters waiters()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.