@Generated(value="software.amazon.awssdk:codegen") public interface CloudFrontClient extends SdkClient
builder()
method.
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 |
SERVICE_NAME |
serviceName
close
static 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, AwsServiceException, 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 (OAI). An origin access identity is a special
CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of
your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon
CloudFront Developer Guide.CloudFrontOriginAccessIdentityAlreadyExistsException
- If the CallerReference
is a value you already sent in a previous request to create an
identity but the content of the CloudFrontOriginAccessIdentityConfig
is different from the
original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists
error.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyCloudFrontOriginAccessIdentitiesException
- Processing your request would cause you to exceed the maximum number of origin access identities allowed.InvalidArgumentException
- The argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateCloudFrontOriginAccessIdentityResponse createCloudFrontOriginAccessIdentity(Consumer<CreateCloudFrontOriginAccessIdentityRequest.Builder> createCloudFrontOriginAccessIdentityRequest) throws CloudFrontOriginAccessIdentityAlreadyExistsException, MissingBodyException, TooManyCloudFrontOriginAccessIdentitiesException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, 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.
This is a convenience which creates an instance of the
CreateCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via
CreateCloudFrontOriginAccessIdentityRequest.builder()
createCloudFrontOriginAccessIdentityRequest
- A Consumer
that will call methods on CreateCloudFrontOriginAccessIdentityRequest.Builder
to create a request. The request to create a new origin access identity (OAI). An origin access identity
is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or
just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon
CloudFront Developer Guide.CloudFrontOriginAccessIdentityAlreadyExistsException
- If the CallerReference
is a value you already sent in a previous request to create an
identity but the content of the CloudFrontOriginAccessIdentityConfig
is different from the
original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists
error.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyCloudFrontOriginAccessIdentitiesException
- Processing your request would cause you to exceed the maximum number of origin access identities allowed.InvalidArgumentException
- The argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException
Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to
be delivered from, and the details about how to track and manage content delivery. Send a POST
request to the /CloudFront API version/distribution
/distribution ID
resource.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
createDistributionRequest
- The request to create a new distribution.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.DistributionAlreadyExistsException
- The caller reference you attempted to create the distribution with is associated with another
distribution.InvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyDistributionsException
- Processing your request would cause you to exceed the maximum number of distributions allowed.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- The argument is invalid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF,
use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda 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.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDistributionResponse createDistribution(Consumer<CreateDistributionRequest.Builder> createDistributionRequest) throws CnameAlreadyExistsException, DistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, MissingBodyException, TooManyDistributionCnamEsException, TooManyDistributionsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException
Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to
be delivered from, and the details about how to track and manage content delivery. Send a POST
request to the /CloudFront API version/distribution
/distribution ID
resource.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the CreateDistributionRequest.Builder
avoiding the
need to create one manually via CreateDistributionRequest.builder()
createDistributionRequest
- A Consumer
that will call methods on CreateDistributionRequest.Builder
to create a
request. The request to create a new distribution.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.DistributionAlreadyExistsException
- The caller reference you attempted to create the distribution with is associated with another
distribution.InvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyDistributionsException
- Processing your request would cause you to exceed the maximum number of distributions allowed.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- The argument is invalid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF,
use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda 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.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, InvalidTaggingException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException
Create a new distribution with tags.
createDistributionWithTagsRequest
- The request to create a new distribution with tags.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.DistributionAlreadyExistsException
- The caller reference you attempted to create the distribution with is associated with another
distribution.InvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyDistributionsException
- Processing your request would cause you to exceed the maximum number of distributions allowed.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- The argument is invalid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF,
use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.InvalidTaggingException
- The tagging specified is not valid.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda 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.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDistributionWithTagsResponse createDistributionWithTags(Consumer<CreateDistributionWithTagsRequest.Builder> createDistributionWithTagsRequest) throws CnameAlreadyExistsException, DistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, MissingBodyException, TooManyDistributionCnamEsException, TooManyDistributionsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, InvalidTaggingException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException
Create a new distribution with tags.
This is a convenience which creates an instance of the CreateDistributionWithTagsRequest.Builder
avoiding
the need to create one manually via CreateDistributionWithTagsRequest.builder()
createDistributionWithTagsRequest
- A Consumer
that will call methods on CreateDistributionWithTagsRequest.Builder
to create a
request. The request to create a new distribution with tags.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.DistributionAlreadyExistsException
- The caller reference you attempted to create the distribution with is associated with another
distribution.InvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyDistributionsException
- Processing your request would cause you to exceed the maximum number of distributions allowed.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- The argument is invalid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF,
use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.InvalidTaggingException
- The tagging specified is not valid.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda 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.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateFieldLevelEncryptionConfigResponse createFieldLevelEncryptionConfig(CreateFieldLevelEncryptionConfigRequest createFieldLevelEncryptionConfigRequest) throws InconsistentQuantitiesException, InvalidArgumentException, NoSuchFieldLevelEncryptionProfileException, FieldLevelEncryptionConfigAlreadyExistsException, TooManyFieldLevelEncryptionConfigsException, TooManyFieldLevelEncryptionQueryArgProfilesException, TooManyFieldLevelEncryptionContentTypeProfilesException, QueryArgProfileEmptyException, AwsServiceException, SdkClientException, CloudFrontException
Create a new field-level encryption configuration.
createFieldLevelEncryptionConfigRequest
- InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- The argument is invalid.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.FieldLevelEncryptionConfigAlreadyExistsException
- The specified configuration for field-level encryption already exists.TooManyFieldLevelEncryptionConfigsException
- The maximum number of configurations for field-level encryption have been created.TooManyFieldLevelEncryptionQueryArgProfilesException
- The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException
- The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException
- No profile specified for the field-level encryption query argument.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateFieldLevelEncryptionConfigResponse createFieldLevelEncryptionConfig(Consumer<CreateFieldLevelEncryptionConfigRequest.Builder> createFieldLevelEncryptionConfigRequest) throws InconsistentQuantitiesException, InvalidArgumentException, NoSuchFieldLevelEncryptionProfileException, FieldLevelEncryptionConfigAlreadyExistsException, TooManyFieldLevelEncryptionConfigsException, TooManyFieldLevelEncryptionQueryArgProfilesException, TooManyFieldLevelEncryptionContentTypeProfilesException, QueryArgProfileEmptyException, AwsServiceException, SdkClientException, CloudFrontException
Create a new field-level encryption configuration.
This is a convenience which creates an instance of the CreateFieldLevelEncryptionConfigRequest.Builder
avoiding the need to create one manually via CreateFieldLevelEncryptionConfigRequest.builder()
createFieldLevelEncryptionConfigRequest
- A Consumer
that will call methods on CreateFieldLevelEncryptionConfigRequest.Builder
to
create a request.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- The argument is invalid.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.FieldLevelEncryptionConfigAlreadyExistsException
- The specified configuration for field-level encryption already exists.TooManyFieldLevelEncryptionConfigsException
- The maximum number of configurations for field-level encryption have been created.TooManyFieldLevelEncryptionQueryArgProfilesException
- The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException
- The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException
- No profile specified for the field-level encryption query argument.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateFieldLevelEncryptionProfileResponse createFieldLevelEncryptionProfile(CreateFieldLevelEncryptionProfileRequest createFieldLevelEncryptionProfileRequest) throws InconsistentQuantitiesException, InvalidArgumentException, NoSuchPublicKeyException, FieldLevelEncryptionProfileAlreadyExistsException, FieldLevelEncryptionProfileSizeExceededException, TooManyFieldLevelEncryptionProfilesException, TooManyFieldLevelEncryptionEncryptionEntitiesException, TooManyFieldLevelEncryptionFieldPatternsException, AwsServiceException, SdkClientException, CloudFrontException
Create a field-level encryption profile.
createFieldLevelEncryptionProfileRequest
- InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- The argument is invalid.NoSuchPublicKeyException
- The specified public key doesn't exist.FieldLevelEncryptionProfileAlreadyExistsException
- The specified profile for field-level encryption already exists.FieldLevelEncryptionProfileSizeExceededException
- The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionProfilesException
- The maximum number of profiles for field-level encryption have been created.TooManyFieldLevelEncryptionEncryptionEntitiesException
- The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException
- The maximum number of field patterns for field-level encryption have been created.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateFieldLevelEncryptionProfileResponse createFieldLevelEncryptionProfile(Consumer<CreateFieldLevelEncryptionProfileRequest.Builder> createFieldLevelEncryptionProfileRequest) throws InconsistentQuantitiesException, InvalidArgumentException, NoSuchPublicKeyException, FieldLevelEncryptionProfileAlreadyExistsException, FieldLevelEncryptionProfileSizeExceededException, TooManyFieldLevelEncryptionProfilesException, TooManyFieldLevelEncryptionEncryptionEntitiesException, TooManyFieldLevelEncryptionFieldPatternsException, AwsServiceException, SdkClientException, CloudFrontException
Create a field-level encryption profile.
This is a convenience which creates an instance of the CreateFieldLevelEncryptionProfileRequest.Builder
avoiding the need to create one manually via CreateFieldLevelEncryptionProfileRequest.builder()
createFieldLevelEncryptionProfileRequest
- A Consumer
that will call methods on CreateFieldLevelEncryptionProfileRequest.Builder
to
create a request.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- The argument is invalid.NoSuchPublicKeyException
- The specified public key doesn't exist.FieldLevelEncryptionProfileAlreadyExistsException
- The specified profile for field-level encryption already exists.FieldLevelEncryptionProfileSizeExceededException
- The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionProfilesException
- The maximum number of profiles for field-level encryption have been created.TooManyFieldLevelEncryptionEncryptionEntitiesException
- The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException
- The maximum number of field patterns for field-level encryption have been created.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateInvalidationResponse createInvalidation(CreateInvalidationRequest createInvalidationRequest) throws AccessDeniedException, MissingBodyException, InvalidArgumentException, NoSuchDistributionException, BatchTooLargeException, TooManyInvalidationsInProgressException, InconsistentQuantitiesException, AwsServiceException, 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.BatchTooLargeException
- Invalidation batch specified is too large.TooManyInvalidationsInProgressException
- You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation
objects.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateInvalidationResponse createInvalidation(Consumer<CreateInvalidationRequest.Builder> createInvalidationRequest) throws AccessDeniedException, MissingBodyException, InvalidArgumentException, NoSuchDistributionException, BatchTooLargeException, TooManyInvalidationsInProgressException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException
Create a new invalidation.
This is a convenience which creates an instance of the CreateInvalidationRequest.Builder
avoiding the
need to create one manually via CreateInvalidationRequest.builder()
createInvalidationRequest
- A Consumer
that will call methods on CreateInvalidationRequest.Builder
to create a
request. 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.BatchTooLargeException
- Invalidation batch specified is too large.TooManyInvalidationsInProgressException
- You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation
objects.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreatePublicKeyResponse createPublicKey(CreatePublicKeyRequest createPublicKeyRequest) throws PublicKeyAlreadyExistsException, InvalidArgumentException, TooManyPublicKeysException, AwsServiceException, SdkClientException, CloudFrontException
Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.
createPublicKeyRequest
- PublicKeyAlreadyExistsException
- The specified public key already exists.InvalidArgumentException
- The argument is invalid.TooManyPublicKeysException
- The maximum number of public keys for field-level encryption have been created. To create a new public
key, delete one of the existing keys.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreatePublicKeyResponse createPublicKey(Consumer<CreatePublicKeyRequest.Builder> createPublicKeyRequest) throws PublicKeyAlreadyExistsException, InvalidArgumentException, TooManyPublicKeysException, AwsServiceException, SdkClientException, CloudFrontException
Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.
This is a convenience which creates an instance of the CreatePublicKeyRequest.Builder
avoiding the need
to create one manually via CreatePublicKeyRequest.builder()
createPublicKeyRequest
- A Consumer
that will call methods on CreatePublicKeyRequest.Builder
to create a request.PublicKeyAlreadyExistsException
- The specified public key already exists.InvalidArgumentException
- The argument is invalid.TooManyPublicKeysException
- The maximum number of public keys for field-level encryption have been created. To create a new public
key, delete one of the existing keys.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateStreamingDistributionResponse createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest) throws CnameAlreadyExistsException, StreamingDistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, MissingBodyException, TooManyStreamingDistributionCnamEsException, TooManyStreamingDistributionsException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException
Creates a new RTMP 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 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.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.StreamingDistributionAlreadyExistsException
- The caller reference you attempted to create the streaming distribution with is associated with another
distributionInvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyStreamingDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyStreamingDistributionsException
- Processing your request would cause you to exceed the maximum number of streaming distributions allowed.InvalidArgumentException
- The argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateStreamingDistributionResponse createStreamingDistribution(Consumer<CreateStreamingDistributionRequest.Builder> createStreamingDistributionRequest) throws CnameAlreadyExistsException, StreamingDistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, MissingBodyException, TooManyStreamingDistributionCnamEsException, TooManyStreamingDistributionsException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException
Creates a new RTMP 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 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.
This is a convenience which creates an instance of the CreateStreamingDistributionRequest.Builder
avoiding the need to create one manually via CreateStreamingDistributionRequest.builder()
createStreamingDistributionRequest
- A Consumer
that will call methods on CreateStreamingDistributionRequest.Builder
to create
a request. The request to create a new streaming distribution.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.StreamingDistributionAlreadyExistsException
- The caller reference you attempted to create the streaming distribution with is associated with another
distributionInvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyStreamingDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyStreamingDistributionsException
- Processing your request would cause you to exceed the maximum number of streaming distributions allowed.InvalidArgumentException
- The argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateStreamingDistributionWithTagsResponse createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest createStreamingDistributionWithTagsRequest) throws CnameAlreadyExistsException, StreamingDistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, MissingBodyException, TooManyStreamingDistributionCnamEsException, TooManyStreamingDistributionsException, InvalidArgumentException, InconsistentQuantitiesException, InvalidTaggingException, AwsServiceException, SdkClientException, CloudFrontException
Create a new streaming distribution with tags.
createStreamingDistributionWithTagsRequest
- The request to create a new streaming distribution with tags.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.StreamingDistributionAlreadyExistsException
- The caller reference you attempted to create the streaming distribution with is associated with another
distributionInvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyStreamingDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyStreamingDistributionsException
- Processing your request would cause you to exceed the maximum number of streaming distributions allowed.InvalidArgumentException
- The argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidTaggingException
- The tagging specified is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateStreamingDistributionWithTagsResponse createStreamingDistributionWithTags(Consumer<CreateStreamingDistributionWithTagsRequest.Builder> createStreamingDistributionWithTagsRequest) throws CnameAlreadyExistsException, StreamingDistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, MissingBodyException, TooManyStreamingDistributionCnamEsException, TooManyStreamingDistributionsException, InvalidArgumentException, InconsistentQuantitiesException, InvalidTaggingException, AwsServiceException, SdkClientException, CloudFrontException
Create a new streaming distribution with tags.
This is a convenience which creates an instance of the CreateStreamingDistributionWithTagsRequest.Builder
avoiding the need to create one manually via CreateStreamingDistributionWithTagsRequest.builder()
createStreamingDistributionWithTagsRequest
- A Consumer
that will call methods on CreateStreamingDistributionWithTagsRequest.Builder
to
create a request. The request to create a new streaming distribution with tags.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.StreamingDistributionAlreadyExistsException
- The caller reference you attempted to create the streaming distribution with is associated with another
distributionInvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyStreamingDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyStreamingDistributionsException
- Processing your request would cause you to exceed the maximum number of streaming distributions allowed.InvalidArgumentException
- The argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidTaggingException
- The tagging specified is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteCloudFrontOriginAccessIdentityResponse deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchCloudFrontOriginAccessIdentityException, PreconditionFailedException, CloudFrontOriginAccessIdentityInUseException, AwsServiceException, 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
.CloudFrontOriginAccessIdentityInUseException
- The Origin Access Identity specified is already in use.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteCloudFrontOriginAccessIdentityResponse deleteCloudFrontOriginAccessIdentity(Consumer<DeleteCloudFrontOriginAccessIdentityRequest.Builder> deleteCloudFrontOriginAccessIdentityRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchCloudFrontOriginAccessIdentityException, PreconditionFailedException, CloudFrontOriginAccessIdentityInUseException, AwsServiceException, SdkClientException, CloudFrontException
Delete an origin access identity.
This is a convenience which creates an instance of the
DeleteCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via
DeleteCloudFrontOriginAccessIdentityRequest.builder()
deleteCloudFrontOriginAccessIdentityRequest
- A Consumer
that will call methods on DeleteCloudFrontOriginAccessIdentityRequest.Builder
to create a request. 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
.CloudFrontOriginAccessIdentityInUseException
- The Origin Access Identity specified is already in use.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDistributionResponse deleteDistribution(DeleteDistributionRequest deleteDistributionRequest) throws AccessDeniedException, DistributionNotDisabledException, InvalidIfMatchVersionException, NoSuchDistributionException, PreconditionFailedException, AwsServiceException, 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.DistributionNotDisabledException
- The specified CloudFront distribution is not disabled. You must disable the distribution before you can
delete it.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid 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
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDistributionResponse deleteDistribution(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest) throws AccessDeniedException, DistributionNotDisabledException, InvalidIfMatchVersionException, NoSuchDistributionException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException
Delete a distribution.
This is a convenience which creates an instance of the DeleteDistributionRequest.Builder
avoiding the
need to create one manually via DeleteDistributionRequest.builder()
deleteDistributionRequest
- A Consumer
that will call methods on DeleteDistributionRequest.Builder
to create a
request. This action deletes a web distribution. To delete a web distribution using the CloudFront API,
perform the following steps.
To delete a web distribution using the CloudFront API:
Disable the web distribution
Submit a GET Distribution Config
request to get the current configuration and the
Etag
header for the distribution.
Update the XML document that was returned in the response to your GET Distribution Config
request to change the value of Enabled
to false
.
Submit a PUT Distribution Config
request to update the configuration for your distribution.
In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP
If-Match
header to the value of the ETag
header that CloudFront returned when
you submitted the GET Distribution Config
request in Step 2.
Review the response to the PUT Distribution Config
request to confirm that the distribution
was successfully disabled.
Submit a GET Distribution
request to confirm that your changes have propagated. When
propagation is complete, the value of Status
is Deployed
.
Submit a DELETE Distribution
request. Set the value of the HTTP If-Match
header
to the value of the ETag
header that CloudFront returned when you submitted the
GET Distribution Config
request in Step 6.
Review the response to your DELETE Distribution
request to confirm that the distribution was
successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
AccessDeniedException
- Access denied.DistributionNotDisabledException
- The specified CloudFront distribution is not disabled. You must disable the distribution before you can
delete it.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid 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
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteFieldLevelEncryptionConfigResponse deleteFieldLevelEncryptionConfig(DeleteFieldLevelEncryptionConfigRequest deleteFieldLevelEncryptionConfigRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionConfigException, PreconditionFailedException, FieldLevelEncryptionConfigInUseException, AwsServiceException, SdkClientException, CloudFrontException
Remove a field-level encryption configuration.
deleteFieldLevelEncryptionConfigRequest
- AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.FieldLevelEncryptionConfigInUseException
- The specified configuration for field-level encryption is in use.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteFieldLevelEncryptionConfigResponse deleteFieldLevelEncryptionConfig(Consumer<DeleteFieldLevelEncryptionConfigRequest.Builder> deleteFieldLevelEncryptionConfigRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionConfigException, PreconditionFailedException, FieldLevelEncryptionConfigInUseException, AwsServiceException, SdkClientException, CloudFrontException
Remove a field-level encryption configuration.
This is a convenience which creates an instance of the DeleteFieldLevelEncryptionConfigRequest.Builder
avoiding the need to create one manually via DeleteFieldLevelEncryptionConfigRequest.builder()
deleteFieldLevelEncryptionConfigRequest
- A Consumer
that will call methods on DeleteFieldLevelEncryptionConfigRequest.Builder
to
create a request.AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.FieldLevelEncryptionConfigInUseException
- The specified configuration for field-level encryption is in use.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteFieldLevelEncryptionProfileResponse deleteFieldLevelEncryptionProfile(DeleteFieldLevelEncryptionProfileRequest deleteFieldLevelEncryptionProfileRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionProfileException, PreconditionFailedException, FieldLevelEncryptionProfileInUseException, AwsServiceException, SdkClientException, CloudFrontException
Remove a field-level encryption profile.
deleteFieldLevelEncryptionProfileRequest
- AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.FieldLevelEncryptionProfileInUseException
- The specified profile for field-level encryption is in use.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteFieldLevelEncryptionProfileResponse deleteFieldLevelEncryptionProfile(Consumer<DeleteFieldLevelEncryptionProfileRequest.Builder> deleteFieldLevelEncryptionProfileRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionProfileException, PreconditionFailedException, FieldLevelEncryptionProfileInUseException, AwsServiceException, SdkClientException, CloudFrontException
Remove a field-level encryption profile.
This is a convenience which creates an instance of the DeleteFieldLevelEncryptionProfileRequest.Builder
avoiding the need to create one manually via DeleteFieldLevelEncryptionProfileRequest.builder()
deleteFieldLevelEncryptionProfileRequest
- A Consumer
that will call methods on DeleteFieldLevelEncryptionProfileRequest.Builder
to
create a request.AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.FieldLevelEncryptionProfileInUseException
- The specified profile for field-level encryption is in use.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeletePublicKeyResponse deletePublicKey(DeletePublicKeyRequest deletePublicKeyRequest) throws AccessDeniedException, PublicKeyInUseException, InvalidIfMatchVersionException, NoSuchPublicKeyException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException
Remove a public key you previously added to CloudFront.
deletePublicKeyRequest
- AccessDeniedException
- Access denied.PublicKeyInUseException
- The specified public key is in use.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.NoSuchPublicKeyException
- The specified public key doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeletePublicKeyResponse deletePublicKey(Consumer<DeletePublicKeyRequest.Builder> deletePublicKeyRequest) throws AccessDeniedException, PublicKeyInUseException, InvalidIfMatchVersionException, NoSuchPublicKeyException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException
Remove a public key you previously added to CloudFront.
This is a convenience which creates an instance of the DeletePublicKeyRequest.Builder
avoiding the need
to create one manually via DeletePublicKeyRequest.builder()
deletePublicKeyRequest
- A Consumer
that will call methods on DeletePublicKeyRequest.Builder
to create a request.AccessDeniedException
- Access denied.PublicKeyInUseException
- The specified public key is in use.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.NoSuchPublicKeyException
- The specified public key doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteStreamingDistributionResponse deleteStreamingDistribution(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest) throws AccessDeniedException, StreamingDistributionNotDisabledException, InvalidIfMatchVersionException, NoSuchStreamingDistributionException, PreconditionFailedException, AwsServiceException, 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.StreamingDistributionNotDisabledException
- The specified CloudFront distribution is not disabled. You must disable the distribution before you can
delete it.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid 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
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteStreamingDistributionResponse deleteStreamingDistribution(Consumer<DeleteStreamingDistributionRequest.Builder> deleteStreamingDistributionRequest) throws AccessDeniedException, StreamingDistributionNotDisabledException, InvalidIfMatchVersionException, NoSuchStreamingDistributionException, PreconditionFailedException, AwsServiceException, 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.
This is a convenience which creates an instance of the DeleteStreamingDistributionRequest.Builder
avoiding the need to create one manually via DeleteStreamingDistributionRequest.builder()
deleteStreamingDistributionRequest
- A Consumer
that will call methods on DeleteStreamingDistributionRequest.Builder
to create
a request. The request to delete a streaming distribution.AccessDeniedException
- Access denied.StreamingDistributionNotDisabledException
- The specified CloudFront distribution is not disabled. You must disable the distribution before you can
delete it.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid 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
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCloudFrontOriginAccessIdentityResponse getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest) throws NoSuchCloudFrontOriginAccessIdentityException, AccessDeniedException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCloudFrontOriginAccessIdentityResponse getCloudFrontOriginAccessIdentity(Consumer<GetCloudFrontOriginAccessIdentityRequest.Builder> getCloudFrontOriginAccessIdentityRequest) throws NoSuchCloudFrontOriginAccessIdentityException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Get the information about an origin access identity.
This is a convenience which creates an instance of the GetCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via GetCloudFrontOriginAccessIdentityRequest.builder()
getCloudFrontOriginAccessIdentityRequest
- A Consumer
that will call methods on GetCloudFrontOriginAccessIdentityRequest.Builder
to
create a request. The request to get an origin access identity's information.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.AccessDeniedException
- Access denied.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCloudFrontOriginAccessIdentityConfigResponse getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest) throws NoSuchCloudFrontOriginAccessIdentityException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Get the configuration information about an origin access identity.
getCloudFrontOriginAccessIdentityConfigRequest
- The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfig.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.AccessDeniedException
- Access denied.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCloudFrontOriginAccessIdentityConfigResponse getCloudFrontOriginAccessIdentityConfig(Consumer<GetCloudFrontOriginAccessIdentityConfigRequest.Builder> getCloudFrontOriginAccessIdentityConfigRequest) throws NoSuchCloudFrontOriginAccessIdentityException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Get the configuration information about an origin access identity.
This is a convenience which creates an instance of the
GetCloudFrontOriginAccessIdentityConfigRequest.Builder
avoiding the need to create one manually via
GetCloudFrontOriginAccessIdentityConfigRequest.builder()
getCloudFrontOriginAccessIdentityConfigRequest
- A Consumer
that will call methods on
GetCloudFrontOriginAccessIdentityConfigRequest.Builder
to create a request. The origin access
identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfig.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.AccessDeniedException
- Access denied.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDistributionResponse getDistribution(GetDistributionRequest getDistributionRequest) throws NoSuchDistributionException, AccessDeniedException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDistributionResponse getDistribution(Consumer<GetDistributionRequest.Builder> getDistributionRequest) throws NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Get the information about a distribution.
This is a convenience which creates an instance of the GetDistributionRequest.Builder
avoiding the need
to create one manually via GetDistributionRequest.builder()
getDistributionRequest
- A Consumer
that will call methods on GetDistributionRequest.Builder
to create a request.
The request to get a distribution's information.NoSuchDistributionException
- The specified distribution does not exist.AccessDeniedException
- Access denied.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDistributionConfigResponse getDistributionConfig(GetDistributionConfigRequest getDistributionConfigRequest) throws NoSuchDistributionException, AccessDeniedException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDistributionConfigResponse getDistributionConfig(Consumer<GetDistributionConfigRequest.Builder> getDistributionConfigRequest) throws NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Get the configuration information about a distribution.
This is a convenience which creates an instance of the GetDistributionConfigRequest.Builder
avoiding the
need to create one manually via GetDistributionConfigRequest.builder()
getDistributionConfigRequest
- A Consumer
that will call methods on GetDistributionConfigRequest.Builder
to create a
request. The request to get a distribution configuration.NoSuchDistributionException
- The specified distribution does not exist.AccessDeniedException
- Access denied.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFieldLevelEncryptionResponse getFieldLevelEncryption(GetFieldLevelEncryptionRequest getFieldLevelEncryptionRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException
Get the field-level encryption configuration information.
getFieldLevelEncryptionRequest
- AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFieldLevelEncryptionResponse getFieldLevelEncryption(Consumer<GetFieldLevelEncryptionRequest.Builder> getFieldLevelEncryptionRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException
Get the field-level encryption configuration information.
This is a convenience which creates an instance of the GetFieldLevelEncryptionRequest.Builder
avoiding
the need to create one manually via GetFieldLevelEncryptionRequest.builder()
getFieldLevelEncryptionRequest
- A Consumer
that will call methods on GetFieldLevelEncryptionRequest.Builder
to create a
request.AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFieldLevelEncryptionConfigResponse getFieldLevelEncryptionConfig(GetFieldLevelEncryptionConfigRequest getFieldLevelEncryptionConfigRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException
Get the field-level encryption configuration information.
getFieldLevelEncryptionConfigRequest
- AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFieldLevelEncryptionConfigResponse getFieldLevelEncryptionConfig(Consumer<GetFieldLevelEncryptionConfigRequest.Builder> getFieldLevelEncryptionConfigRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException
Get the field-level encryption configuration information.
This is a convenience which creates an instance of the GetFieldLevelEncryptionConfigRequest.Builder
avoiding the need to create one manually via GetFieldLevelEncryptionConfigRequest.builder()
getFieldLevelEncryptionConfigRequest
- A Consumer
that will call methods on GetFieldLevelEncryptionConfigRequest.Builder
to
create a request.AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFieldLevelEncryptionProfileResponse getFieldLevelEncryptionProfile(GetFieldLevelEncryptionProfileRequest getFieldLevelEncryptionProfileRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionProfileException, AwsServiceException, SdkClientException, CloudFrontException
Get the field-level encryption profile information.
getFieldLevelEncryptionProfileRequest
- AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFieldLevelEncryptionProfileResponse getFieldLevelEncryptionProfile(Consumer<GetFieldLevelEncryptionProfileRequest.Builder> getFieldLevelEncryptionProfileRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionProfileException, AwsServiceException, SdkClientException, CloudFrontException
Get the field-level encryption profile information.
This is a convenience which creates an instance of the GetFieldLevelEncryptionProfileRequest.Builder
avoiding the need to create one manually via GetFieldLevelEncryptionProfileRequest.builder()
getFieldLevelEncryptionProfileRequest
- A Consumer
that will call methods on GetFieldLevelEncryptionProfileRequest.Builder
to
create a request.AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFieldLevelEncryptionProfileConfigResponse getFieldLevelEncryptionProfileConfig(GetFieldLevelEncryptionProfileConfigRequest getFieldLevelEncryptionProfileConfigRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionProfileException, AwsServiceException, SdkClientException, CloudFrontException
Get the field-level encryption profile configuration information.
getFieldLevelEncryptionProfileConfigRequest
- AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetFieldLevelEncryptionProfileConfigResponse getFieldLevelEncryptionProfileConfig(Consumer<GetFieldLevelEncryptionProfileConfigRequest.Builder> getFieldLevelEncryptionProfileConfigRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionProfileException, AwsServiceException, SdkClientException, CloudFrontException
Get the field-level encryption profile configuration information.
This is a convenience which creates an instance of the
GetFieldLevelEncryptionProfileConfigRequest.Builder
avoiding the need to create one manually via
GetFieldLevelEncryptionProfileConfigRequest.builder()
getFieldLevelEncryptionProfileConfigRequest
- A Consumer
that will call methods on GetFieldLevelEncryptionProfileConfigRequest.Builder
to create a request.AccessDeniedException
- Access denied.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetInvalidationResponse getInvalidation(GetInvalidationRequest getInvalidationRequest) throws NoSuchInvalidationException, NoSuchDistributionException, AccessDeniedException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetInvalidationResponse getInvalidation(Consumer<GetInvalidationRequest.Builder> getInvalidationRequest) throws NoSuchInvalidationException, NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Get the information about an invalidation.
This is a convenience which creates an instance of the GetInvalidationRequest.Builder
avoiding the need
to create one manually via GetInvalidationRequest.builder()
getInvalidationRequest
- A Consumer
that will call methods on GetInvalidationRequest.Builder
to create a request.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPublicKeyResponse getPublicKey(GetPublicKeyRequest getPublicKeyRequest) throws AccessDeniedException, NoSuchPublicKeyException, AwsServiceException, SdkClientException, CloudFrontException
Get the public key information.
getPublicKeyRequest
- AccessDeniedException
- Access denied.NoSuchPublicKeyException
- The specified public key doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPublicKeyResponse getPublicKey(Consumer<GetPublicKeyRequest.Builder> getPublicKeyRequest) throws AccessDeniedException, NoSuchPublicKeyException, AwsServiceException, SdkClientException, CloudFrontException
Get the public key information.
This is a convenience which creates an instance of the GetPublicKeyRequest.Builder
avoiding the need to
create one manually via GetPublicKeyRequest.builder()
getPublicKeyRequest
- A Consumer
that will call methods on GetPublicKeyRequest.Builder
to create a request.AccessDeniedException
- Access denied.NoSuchPublicKeyException
- The specified public key doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPublicKeyConfigResponse getPublicKeyConfig(GetPublicKeyConfigRequest getPublicKeyConfigRequest) throws AccessDeniedException, NoSuchPublicKeyException, AwsServiceException, SdkClientException, CloudFrontException
Return public key configuration informaation
getPublicKeyConfigRequest
- AccessDeniedException
- Access denied.NoSuchPublicKeyException
- The specified public key doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetPublicKeyConfigResponse getPublicKeyConfig(Consumer<GetPublicKeyConfigRequest.Builder> getPublicKeyConfigRequest) throws AccessDeniedException, NoSuchPublicKeyException, AwsServiceException, SdkClientException, CloudFrontException
Return public key configuration informaation
This is a convenience which creates an instance of the GetPublicKeyConfigRequest.Builder
avoiding the
need to create one manually via GetPublicKeyConfigRequest.builder()
getPublicKeyConfigRequest
- A Consumer
that will call methods on GetPublicKeyConfigRequest.Builder
to create a
request.AccessDeniedException
- Access denied.NoSuchPublicKeyException
- The specified public key doesn't exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetStreamingDistributionResponse getStreamingDistribution(GetStreamingDistributionRequest getStreamingDistributionRequest) throws NoSuchStreamingDistributionException, AccessDeniedException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetStreamingDistributionResponse getStreamingDistribution(Consumer<GetStreamingDistributionRequest.Builder> getStreamingDistributionRequest) throws NoSuchStreamingDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Gets information about a specified RTMP distribution, including the distribution configuration.
This is a convenience which creates an instance of the GetStreamingDistributionRequest.Builder
avoiding
the need to create one manually via GetStreamingDistributionRequest.builder()
getStreamingDistributionRequest
- A Consumer
that will call methods on GetStreamingDistributionRequest.Builder
to create a
request. The request to get a streaming distribution's information.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.AccessDeniedException
- Access denied.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetStreamingDistributionConfigResponse getStreamingDistributionConfig(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest) throws NoSuchStreamingDistributionException, AccessDeniedException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetStreamingDistributionConfigResponse getStreamingDistributionConfig(Consumer<GetStreamingDistributionConfigRequest.Builder> getStreamingDistributionConfigRequest) throws NoSuchStreamingDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Get the configuration information about a streaming distribution.
This is a convenience which creates an instance of the GetStreamingDistributionConfigRequest.Builder
avoiding the need to create one manually via GetStreamingDistributionConfigRequest.builder()
getStreamingDistributionConfigRequest
- A Consumer
that will call methods on GetStreamingDistributionConfigRequest.Builder
to
create a request. To request to get a streaming distribution configuration.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.AccessDeniedException
- Access denied.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCloudFrontOriginAccessIdentitiesResponse listCloudFrontOriginAccessIdentities() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Lists origin access identities.
InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest)
,
AWS API Documentationdefault ListCloudFrontOriginAccessIdentitiesResponse listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Lists origin access identities.
listCloudFrontOriginAccessIdentitiesRequest
- The request to list origin access identities.InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCloudFrontOriginAccessIdentitiesResponse listCloudFrontOriginAccessIdentities(Consumer<ListCloudFrontOriginAccessIdentitiesRequest.Builder> listCloudFrontOriginAccessIdentitiesRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Lists origin access identities.
This is a convenience which creates an instance of the
ListCloudFrontOriginAccessIdentitiesRequest.Builder
avoiding the need to create one manually via
ListCloudFrontOriginAccessIdentitiesRequest.builder()
listCloudFrontOriginAccessIdentitiesRequest
- A Consumer
that will call methods on ListCloudFrontOriginAccessIdentitiesRequest.Builder
to create a request. The request to list origin access identities.InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDistributionsResponse listDistributions() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List CloudFront distributions.
InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDistributions(ListDistributionsRequest)
,
AWS
API Documentationdefault ListDistributionsResponse listDistributions(ListDistributionsRequest listDistributionsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List CloudFront distributions.
listDistributionsRequest
- The request to list your distributions.InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDistributionsResponse listDistributions(Consumer<ListDistributionsRequest.Builder> listDistributionsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List CloudFront distributions.
This is a convenience which creates an instance of the ListDistributionsRequest.Builder
avoiding the need
to create one manually via ListDistributionsRequest.builder()
listDistributionsRequest
- A Consumer
that will call methods on ListDistributionsRequest.Builder
to create a request.
The request to list your distributions.InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDistributionsByWebAclIdResponse listDistributionsByWebACLId(ListDistributionsByWebAclIdRequest listDistributionsByWebAclIdRequest) throws InvalidArgumentException, InvalidWebAclIdException, AwsServiceException, 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.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF,
use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDistributionsByWebAclIdResponse listDistributionsByWebACLId(Consumer<ListDistributionsByWebAclIdRequest.Builder> listDistributionsByWebAclIdRequest) throws InvalidArgumentException, InvalidWebAclIdException, AwsServiceException, SdkClientException, CloudFrontException
List the distributions that are associated with a specified AWS WAF web ACL.
This is a convenience which creates an instance of the ListDistributionsByWebAclIdRequest.Builder
avoiding the need to create one manually via ListDistributionsByWebAclIdRequest.builder()
listDistributionsByWebAclIdRequest
- A Consumer
that will call methods on ListDistributionsByWebACLIdRequest.Builder
to create
a request. The request to list distributions that are associated with a specified AWS WAF web ACL.InvalidArgumentException
- The argument is invalid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF,
use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFieldLevelEncryptionConfigsResponse listFieldLevelEncryptionConfigs() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List all field-level encryption configurations that have been created in CloudFront for this account.
InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listFieldLevelEncryptionConfigs(ListFieldLevelEncryptionConfigsRequest)
,
AWS API Documentationdefault ListFieldLevelEncryptionConfigsResponse listFieldLevelEncryptionConfigs(ListFieldLevelEncryptionConfigsRequest listFieldLevelEncryptionConfigsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List all field-level encryption configurations that have been created in CloudFront for this account.
listFieldLevelEncryptionConfigsRequest
- InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFieldLevelEncryptionConfigsResponse listFieldLevelEncryptionConfigs(Consumer<ListFieldLevelEncryptionConfigsRequest.Builder> listFieldLevelEncryptionConfigsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List all field-level encryption configurations that have been created in CloudFront for this account.
This is a convenience which creates an instance of the ListFieldLevelEncryptionConfigsRequest.Builder
avoiding the need to create one manually via ListFieldLevelEncryptionConfigsRequest.builder()
listFieldLevelEncryptionConfigsRequest
- A Consumer
that will call methods on ListFieldLevelEncryptionConfigsRequest.Builder
to
create a request.InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFieldLevelEncryptionProfilesResponse listFieldLevelEncryptionProfiles() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listFieldLevelEncryptionProfiles(ListFieldLevelEncryptionProfilesRequest)
,
AWS API Documentationdefault ListFieldLevelEncryptionProfilesResponse listFieldLevelEncryptionProfiles(ListFieldLevelEncryptionProfilesRequest listFieldLevelEncryptionProfilesRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
listFieldLevelEncryptionProfilesRequest
- InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFieldLevelEncryptionProfilesResponse listFieldLevelEncryptionProfiles(Consumer<ListFieldLevelEncryptionProfilesRequest.Builder> listFieldLevelEncryptionProfilesRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
This is a convenience which creates an instance of the ListFieldLevelEncryptionProfilesRequest.Builder
avoiding the need to create one manually via ListFieldLevelEncryptionProfilesRequest.builder()
listFieldLevelEncryptionProfilesRequest
- A Consumer
that will call methods on ListFieldLevelEncryptionProfilesRequest.Builder
to
create a request.InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListInvalidationsResponse listInvalidations(ListInvalidationsRequest listInvalidationsRequest) throws InvalidArgumentException, NoSuchDistributionException, AccessDeniedException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListInvalidationsResponse listInvalidations(Consumer<ListInvalidationsRequest.Builder> listInvalidationsRequest) throws InvalidArgumentException, NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Lists invalidation batches.
This is a convenience which creates an instance of the ListInvalidationsRequest.Builder
avoiding the need
to create one manually via ListInvalidationsRequest.builder()
listInvalidationsRequest
- A Consumer
that will call methods on ListInvalidationsRequest.Builder
to create a request.
The request to list invalidations.InvalidArgumentException
- The argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.AccessDeniedException
- Access denied.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPublicKeysResponse listPublicKeys() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List all public keys that have been added to CloudFront for this account.
InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listPublicKeys(ListPublicKeysRequest)
,
AWS API
Documentationdefault ListPublicKeysResponse listPublicKeys(ListPublicKeysRequest listPublicKeysRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List all public keys that have been added to CloudFront for this account.
listPublicKeysRequest
- InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPublicKeysResponse listPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List all public keys that have been added to CloudFront for this account.
This is a convenience which creates an instance of the ListPublicKeysRequest.Builder
avoiding the need to
create one manually via ListPublicKeysRequest.builder()
listPublicKeysRequest
- A Consumer
that will call methods on ListPublicKeysRequest.Builder
to create a request.InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListStreamingDistributionsResponse listStreamingDistributions() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List streaming distributions.
InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listStreamingDistributions(ListStreamingDistributionsRequest)
,
AWS API Documentationdefault ListStreamingDistributionsResponse listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List streaming distributions.
listStreamingDistributionsRequest
- The request to list your streaming distributions.InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListStreamingDistributionsResponse listStreamingDistributions(Consumer<ListStreamingDistributionsRequest.Builder> listStreamingDistributionsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List streaming distributions.
This is a convenience which creates an instance of the ListStreamingDistributionsRequest.Builder
avoiding
the need to create one manually via ListStreamingDistributionsRequest.builder()
listStreamingDistributionsRequest
- A Consumer
that will call methods on ListStreamingDistributionsRequest.Builder
to create a
request. The request to list your streaming distributions.InvalidArgumentException
- The argument is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, 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.InvalidTaggingException
- The tagging specified is not valid.NoSuchResourceException
- A resource that was specified is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException
List tags for a CloudFront resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request. The request to list tags for a CloudFront resource.AccessDeniedException
- Access denied.InvalidArgumentException
- The argument is invalid.InvalidTaggingException
- The tagging specified is not valid.NoSuchResourceException
- A resource that was specified is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, 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.InvalidTaggingException
- The tagging specified is not valid.NoSuchResourceException
- A resource that was specified is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException
Add tags to a CloudFront resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request. The
request to add tags to a CloudFront resource.AccessDeniedException
- Access denied.InvalidArgumentException
- The argument is invalid.InvalidTaggingException
- The tagging specified is not valid.NoSuchResourceException
- A resource that was specified is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, 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.InvalidTaggingException
- The tagging specified is not valid.NoSuchResourceException
- A resource that was specified is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException
Remove tags from a CloudFront resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request. The
request to remove tags from a CloudFront resource.AccessDeniedException
- Access denied.InvalidArgumentException
- The argument is invalid.InvalidTaggingException
- The tagging specified is not valid.NoSuchResourceException
- A resource that was specified is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateCloudFrontOriginAccessIdentityResponse updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest) throws AccessDeniedException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchCloudFrontOriginAccessIdentityException, PreconditionFailedException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, 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
don't match.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateCloudFrontOriginAccessIdentityResponse updateCloudFrontOriginAccessIdentity(Consumer<UpdateCloudFrontOriginAccessIdentityRequest.Builder> updateCloudFrontOriginAccessIdentityRequest) throws AccessDeniedException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchCloudFrontOriginAccessIdentityException, PreconditionFailedException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException
Update an origin access identity.
This is a convenience which creates an instance of the
UpdateCloudFrontOriginAccessIdentityRequest.Builder
avoiding the need to create one manually via
UpdateCloudFrontOriginAccessIdentityRequest.builder()
updateCloudFrontOriginAccessIdentityRequest
- A Consumer
that will call methods on UpdateCloudFrontOriginAccessIdentityRequest.Builder
to create a request. 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException
Updates the configuration for a web distribution.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
The update process includes getting the current distribution configuration, updating the XML document that is
returned to make your changes, and then submitting an UpdateDistribution
request to make the
updates.
For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.
To update a web distribution using the CloudFront API
Submit a
GetDistributionConfig request to get the current configuration and an Etag
header for the
distribution.
If you update the distribution again, you must get a new Etag
header.
Update the XML document that was returned in the response to your GetDistributionConfig
request to
include your changes.
When you edit the XML file, be aware of the following:
You must strip out the ETag parameter that is returned.
Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.
You can't change the value of CallerReference
. If you try to change this value, CloudFront returns
an IllegalUpdate
error.
The new configuration replaces the existing configuration; the values that you specify in an
UpdateDistribution
request are not merged into your existing configuration. When you add, delete, or
replace values in an element that allows multiple values (for example, CNAME
), you must specify all
of the values that you want to appear in the updated distribution. In addition, you must update the corresponding
Quantity
element.
Submit an UpdateDistribution
request to update the configuration for your distribution:
In the request body, include the XML document that you updated in Step 2. The request body must include an XML
document with a DistributionConfig
element.
Set the value of the HTTP If-Match
header to the value of the ETag
header that
CloudFront returned when you submitted the GetDistributionConfig
request in Step 1.
Review the response to the UpdateDistribution
request to confirm that the configuration was
successfully updated.
Optional: Submit a GetDistribution
request to confirm that your changes have propagated. When propagation is complete, the value of
Status
is Deployed
.
updateDistributionRequest
- The request to update a distribution.AccessDeniedException
- Access denied.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.IllegalUpdateException
- 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 (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- 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.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF,
use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda 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.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDistributionResponse updateDistribution(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest) throws AccessDeniedException, CnameAlreadyExistsException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchDistributionException, PreconditionFailedException, TooManyDistributionCnamEsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidOriginAccessIdentityException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException
Updates the configuration for a web distribution.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
The update process includes getting the current distribution configuration, updating the XML document that is
returned to make your changes, and then submitting an UpdateDistribution
request to make the
updates.
For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.
To update a web distribution using the CloudFront API
Submit a
GetDistributionConfig request to get the current configuration and an Etag
header for the
distribution.
If you update the distribution again, you must get a new Etag
header.
Update the XML document that was returned in the response to your GetDistributionConfig
request to
include your changes.
When you edit the XML file, be aware of the following:
You must strip out the ETag parameter that is returned.
Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.
You can't change the value of CallerReference
. If you try to change this value, CloudFront returns
an IllegalUpdate
error.
The new configuration replaces the existing configuration; the values that you specify in an
UpdateDistribution
request are not merged into your existing configuration. When you add, delete, or
replace values in an element that allows multiple values (for example, CNAME
), you must specify all
of the values that you want to appear in the updated distribution. In addition, you must update the corresponding
Quantity
element.
Submit an UpdateDistribution
request to update the configuration for your distribution:
In the request body, include the XML document that you updated in Step 2. The request body must include an XML
document with a DistributionConfig
element.
Set the value of the HTTP If-Match
header to the value of the ETag
header that
CloudFront returned when you submitted the GetDistributionConfig
request in Step 1.
Review the response to the UpdateDistribution
request to confirm that the configuration was
successfully updated.
Optional: Submit a GetDistribution
request to confirm that your changes have propagated. When propagation is complete, the value of
Status
is Deployed
.
This is a convenience which creates an instance of the UpdateDistributionRequest.Builder
avoiding the
need to create one manually via UpdateDistributionRequest.builder()
updateDistributionRequest
- A Consumer
that will call methods on UpdateDistributionRequest.Builder
to create a
request. The request to update a distribution.AccessDeniedException
- Access denied.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.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.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 (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- 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.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF,
use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda 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.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateFieldLevelEncryptionConfigResponse updateFieldLevelEncryptionConfig(UpdateFieldLevelEncryptionConfigRequest updateFieldLevelEncryptionConfigRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionProfileException, NoSuchFieldLevelEncryptionConfigException, PreconditionFailedException, TooManyFieldLevelEncryptionQueryArgProfilesException, TooManyFieldLevelEncryptionContentTypeProfilesException, QueryArgProfileEmptyException, AwsServiceException, SdkClientException, CloudFrontException
Update a field-level encryption configuration.
updateFieldLevelEncryptionConfigRequest
- AccessDeniedException
- Access denied.IllegalUpdateException
- Origin and CallerReference
cannot be updated.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- The argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.TooManyFieldLevelEncryptionQueryArgProfilesException
- The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException
- The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException
- No profile specified for the field-level encryption query argument.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateFieldLevelEncryptionConfigResponse updateFieldLevelEncryptionConfig(Consumer<UpdateFieldLevelEncryptionConfigRequest.Builder> updateFieldLevelEncryptionConfigRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionProfileException, NoSuchFieldLevelEncryptionConfigException, PreconditionFailedException, TooManyFieldLevelEncryptionQueryArgProfilesException, TooManyFieldLevelEncryptionContentTypeProfilesException, QueryArgProfileEmptyException, AwsServiceException, SdkClientException, CloudFrontException
Update a field-level encryption configuration.
This is a convenience which creates an instance of the UpdateFieldLevelEncryptionConfigRequest.Builder
avoiding the need to create one manually via UpdateFieldLevelEncryptionConfigRequest.builder()
updateFieldLevelEncryptionConfigRequest
- A Consumer
that will call methods on UpdateFieldLevelEncryptionConfigRequest.Builder
to
create a request.AccessDeniedException
- Access denied.IllegalUpdateException
- Origin and CallerReference
cannot be updated.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- The argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.TooManyFieldLevelEncryptionQueryArgProfilesException
- The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException
- The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException
- No profile specified for the field-level encryption query argument.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateFieldLevelEncryptionProfileResponse updateFieldLevelEncryptionProfile(UpdateFieldLevelEncryptionProfileRequest updateFieldLevelEncryptionProfileRequest) throws AccessDeniedException, FieldLevelEncryptionProfileAlreadyExistsException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchPublicKeyException, NoSuchFieldLevelEncryptionProfileException, PreconditionFailedException, FieldLevelEncryptionProfileSizeExceededException, TooManyFieldLevelEncryptionEncryptionEntitiesException, TooManyFieldLevelEncryptionFieldPatternsException, AwsServiceException, SdkClientException, CloudFrontException
Update a field-level encryption profile.
updateFieldLevelEncryptionProfileRequest
- AccessDeniedException
- Access denied.FieldLevelEncryptionProfileAlreadyExistsException
- The specified profile for field-level encryption already exists.IllegalUpdateException
- Origin and CallerReference
cannot be updated.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- The argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.NoSuchPublicKeyException
- The specified public key doesn't exist.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.FieldLevelEncryptionProfileSizeExceededException
- The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionEncryptionEntitiesException
- The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException
- The maximum number of field patterns for field-level encryption have been created.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateFieldLevelEncryptionProfileResponse updateFieldLevelEncryptionProfile(Consumer<UpdateFieldLevelEncryptionProfileRequest.Builder> updateFieldLevelEncryptionProfileRequest) throws AccessDeniedException, FieldLevelEncryptionProfileAlreadyExistsException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchPublicKeyException, NoSuchFieldLevelEncryptionProfileException, PreconditionFailedException, FieldLevelEncryptionProfileSizeExceededException, TooManyFieldLevelEncryptionEncryptionEntitiesException, TooManyFieldLevelEncryptionFieldPatternsException, AwsServiceException, SdkClientException, CloudFrontException
Update a field-level encryption profile.
This is a convenience which creates an instance of the UpdateFieldLevelEncryptionProfileRequest.Builder
avoiding the need to create one manually via UpdateFieldLevelEncryptionProfileRequest.builder()
updateFieldLevelEncryptionProfileRequest
- A Consumer
that will call methods on UpdateFieldLevelEncryptionProfileRequest.Builder
to
create a request.AccessDeniedException
- Access denied.FieldLevelEncryptionProfileAlreadyExistsException
- The specified profile for field-level encryption already exists.IllegalUpdateException
- Origin and CallerReference
cannot be updated.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- The argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.NoSuchPublicKeyException
- The specified public key doesn't exist.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.FieldLevelEncryptionProfileSizeExceededException
- The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionEncryptionEntitiesException
- The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException
- The maximum number of field patterns for field-level encryption have been created.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdatePublicKeyResponse updatePublicKey(UpdatePublicKeyRequest updatePublicKeyRequest) throws AccessDeniedException, CannotChangeImmutablePublicKeyFieldsException, InvalidArgumentException, InvalidIfMatchVersionException, IllegalUpdateException, NoSuchPublicKeyException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException
Update public key information. Note that the only value you can change is the comment.
updatePublicKeyRequest
- AccessDeniedException
- Access denied.CannotChangeImmutablePublicKeyFieldsException
- You can't change the value of a public key.InvalidArgumentException
- The argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.IllegalUpdateException
- Origin and CallerReference
cannot be updated.NoSuchPublicKeyException
- The specified public key doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdatePublicKeyResponse updatePublicKey(Consumer<UpdatePublicKeyRequest.Builder> updatePublicKeyRequest) throws AccessDeniedException, CannotChangeImmutablePublicKeyFieldsException, InvalidArgumentException, InvalidIfMatchVersionException, IllegalUpdateException, NoSuchPublicKeyException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException
Update public key information. Note that the only value you can change is the comment.
This is a convenience which creates an instance of the UpdatePublicKeyRequest.Builder
avoiding the need
to create one manually via UpdatePublicKeyRequest.builder()
updatePublicKeyRequest
- A Consumer
that will call methods on UpdatePublicKeyRequest.Builder
to create a request.AccessDeniedException
- Access denied.CannotChangeImmutablePublicKeyFieldsException
- You can't change the value of a public key.InvalidArgumentException
- The argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid for the distribution.IllegalUpdateException
- Origin and CallerReference
cannot be updated.NoSuchPublicKeyException
- The specified public key doesn't exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateStreamingDistributionResponse updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest) throws AccessDeniedException, CnameAlreadyExistsException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchStreamingDistributionException, PreconditionFailedException, TooManyStreamingDistributionCnamEsException, InvalidArgumentException, InvalidOriginAccessIdentityException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException
Update a streaming distribution.
updateStreamingDistributionRequest
- The request to update a streaming distribution.AccessDeniedException
- Access denied.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.IllegalUpdateException
- 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
.TooManyStreamingDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.InvalidArgumentException
- 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateStreamingDistributionResponse updateStreamingDistribution(Consumer<UpdateStreamingDistributionRequest.Builder> updateStreamingDistributionRequest) throws AccessDeniedException, CnameAlreadyExistsException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchStreamingDistributionException, PreconditionFailedException, TooManyStreamingDistributionCnamEsException, InvalidArgumentException, InvalidOriginAccessIdentityException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException
Update a streaming distribution.
This is a convenience which creates an instance of the UpdateStreamingDistributionRequest.Builder
avoiding the need to create one manually via UpdateStreamingDistributionRequest.builder()
updateStreamingDistributionRequest
- A Consumer
that will call methods on UpdateStreamingDistributionRequest.Builder
to create
a request. The request to update a streaming distribution.AccessDeniedException
- Access denied.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.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.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.PreconditionFailedException
- The precondition given in one or more of the request-header fields evaluated to false
.TooManyStreamingDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.InvalidArgumentException
- 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2020. All rights reserved.