@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe 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_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AssociateAliasResponse |
associateAlias(AssociateAliasRequest associateAliasRequest)
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
|
default AssociateAliasResponse |
associateAlias(Consumer<AssociateAliasRequest.Builder> associateAliasRequest)
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
|
static CloudFrontClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudFrontClient . |
static CloudFrontClient |
create()
Create a
CloudFrontClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateCachePolicyResponse |
createCachePolicy(Consumer<CreateCachePolicyRequest.Builder> createCachePolicyRequest)
Creates a cache policy.
|
default CreateCachePolicyResponse |
createCachePolicy(CreateCachePolicyRequest createCachePolicyRequest)
Creates a cache policy.
|
default CreateCloudFrontOriginAccessIdentityResponse |
createCloudFrontOriginAccessIdentity(Consumer<CreateCloudFrontOriginAccessIdentityRequest.Builder> createCloudFrontOriginAccessIdentityRequest)
Creates a new origin access identity.
|
default CreateCloudFrontOriginAccessIdentityResponse |
createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest createCloudFrontOriginAccessIdentityRequest)
Creates a new origin access identity.
|
default CreateDistributionResponse |
createDistribution(Consumer<CreateDistributionRequest.Builder> createDistributionRequest)
Creates a new web distribution.
|
default CreateDistributionResponse |
createDistribution(CreateDistributionRequest createDistributionRequest)
Creates a new web distribution.
|
default CreateDistributionWithTagsResponse |
createDistributionWithTags(Consumer<CreateDistributionWithTagsRequest.Builder> createDistributionWithTagsRequest)
Create a new distribution with tags.
|
default CreateDistributionWithTagsResponse |
createDistributionWithTags(CreateDistributionWithTagsRequest createDistributionWithTagsRequest)
Create a new distribution with tags.
|
default CreateFieldLevelEncryptionConfigResponse |
createFieldLevelEncryptionConfig(Consumer<CreateFieldLevelEncryptionConfigRequest.Builder> createFieldLevelEncryptionConfigRequest)
Create a new field-level encryption configuration.
|
default CreateFieldLevelEncryptionConfigResponse |
createFieldLevelEncryptionConfig(CreateFieldLevelEncryptionConfigRequest createFieldLevelEncryptionConfigRequest)
Create a new field-level encryption configuration.
|
default CreateFieldLevelEncryptionProfileResponse |
createFieldLevelEncryptionProfile(Consumer<CreateFieldLevelEncryptionProfileRequest.Builder> createFieldLevelEncryptionProfileRequest)
Create a field-level encryption profile.
|
default CreateFieldLevelEncryptionProfileResponse |
createFieldLevelEncryptionProfile(CreateFieldLevelEncryptionProfileRequest createFieldLevelEncryptionProfileRequest)
Create a field-level encryption profile.
|
default CreateFunctionResponse |
createFunction(Consumer<CreateFunctionRequest.Builder> createFunctionRequest)
Creates a CloudFront function.
|
default CreateFunctionResponse |
createFunction(CreateFunctionRequest createFunctionRequest)
Creates a CloudFront function.
|
default CreateInvalidationResponse |
createInvalidation(Consumer<CreateInvalidationRequest.Builder> createInvalidationRequest)
Create a new invalidation.
|
default CreateInvalidationResponse |
createInvalidation(CreateInvalidationRequest createInvalidationRequest)
Create a new invalidation.
|
default CreateKeyGroupResponse |
createKeyGroup(Consumer<CreateKeyGroupRequest.Builder> createKeyGroupRequest)
Creates a key group that you can use with CloudFront signed
URLs and signed cookies.
|
default CreateKeyGroupResponse |
createKeyGroup(CreateKeyGroupRequest createKeyGroupRequest)
Creates a key group that you can use with CloudFront signed
URLs and signed cookies.
|
default CreateMonitoringSubscriptionResponse |
createMonitoringSubscription(Consumer<CreateMonitoringSubscriptionRequest.Builder> createMonitoringSubscriptionRequest)
Enables additional CloudWatch metrics for the specified CloudFront distribution.
|
default CreateMonitoringSubscriptionResponse |
createMonitoringSubscription(CreateMonitoringSubscriptionRequest createMonitoringSubscriptionRequest)
Enables additional CloudWatch metrics for the specified CloudFront distribution.
|
default CreateOriginRequestPolicyResponse |
createOriginRequestPolicy(Consumer<CreateOriginRequestPolicyRequest.Builder> createOriginRequestPolicyRequest)
Creates an origin request policy.
|
default CreateOriginRequestPolicyResponse |
createOriginRequestPolicy(CreateOriginRequestPolicyRequest createOriginRequestPolicyRequest)
Creates an origin request policy.
|
default CreatePublicKeyResponse |
createPublicKey(Consumer<CreatePublicKeyRequest.Builder> createPublicKeyRequest)
Uploads a public key to CloudFront that you can use with signed URLs and
signed cookies, or with field-level
encryption.
|
default CreatePublicKeyResponse |
createPublicKey(CreatePublicKeyRequest createPublicKeyRequest)
Uploads a public key to CloudFront that you can use with signed URLs and
signed cookies, or with field-level
encryption.
|
default CreateRealtimeLogConfigResponse |
createRealtimeLogConfig(Consumer<CreateRealtimeLogConfigRequest.Builder> createRealtimeLogConfigRequest)
Creates a real-time log configuration.
|
default CreateRealtimeLogConfigResponse |
createRealtimeLogConfig(CreateRealtimeLogConfigRequest createRealtimeLogConfigRequest)
Creates a real-time log configuration.
|
default CreateStreamingDistributionResponse |
createStreamingDistribution(Consumer<CreateStreamingDistributionRequest.Builder> createStreamingDistributionRequest)
This API is deprecated.
|
default CreateStreamingDistributionResponse |
createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest)
This API is deprecated.
|
default CreateStreamingDistributionWithTagsResponse |
createStreamingDistributionWithTags(Consumer<CreateStreamingDistributionWithTagsRequest.Builder> createStreamingDistributionWithTagsRequest)
This API is deprecated.
|
default CreateStreamingDistributionWithTagsResponse |
createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest createStreamingDistributionWithTagsRequest)
This API is deprecated.
|
default DeleteCachePolicyResponse |
deleteCachePolicy(Consumer<DeleteCachePolicyRequest.Builder> deleteCachePolicyRequest)
Deletes a cache policy.
|
default DeleteCachePolicyResponse |
deleteCachePolicy(DeleteCachePolicyRequest deleteCachePolicyRequest)
Deletes a cache policy.
|
default DeleteCloudFrontOriginAccessIdentityResponse |
deleteCloudFrontOriginAccessIdentity(Consumer<DeleteCloudFrontOriginAccessIdentityRequest.Builder> deleteCloudFrontOriginAccessIdentityRequest)
Delete an origin access identity.
|
default DeleteCloudFrontOriginAccessIdentityResponse |
deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest)
Delete an origin access identity.
|
default DeleteDistributionResponse |
deleteDistribution(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest)
Delete a distribution.
|
default DeleteDistributionResponse |
deleteDistribution(DeleteDistributionRequest deleteDistributionRequest)
Delete a distribution.
|
default DeleteFieldLevelEncryptionConfigResponse |
deleteFieldLevelEncryptionConfig(Consumer<DeleteFieldLevelEncryptionConfigRequest.Builder> deleteFieldLevelEncryptionConfigRequest)
Remove a field-level encryption configuration.
|
default DeleteFieldLevelEncryptionConfigResponse |
deleteFieldLevelEncryptionConfig(DeleteFieldLevelEncryptionConfigRequest deleteFieldLevelEncryptionConfigRequest)
Remove a field-level encryption configuration.
|
default DeleteFieldLevelEncryptionProfileResponse |
deleteFieldLevelEncryptionProfile(Consumer<DeleteFieldLevelEncryptionProfileRequest.Builder> deleteFieldLevelEncryptionProfileRequest)
Remove a field-level encryption profile.
|
default DeleteFieldLevelEncryptionProfileResponse |
deleteFieldLevelEncryptionProfile(DeleteFieldLevelEncryptionProfileRequest deleteFieldLevelEncryptionProfileRequest)
Remove a field-level encryption profile.
|
default DeleteFunctionResponse |
deleteFunction(Consumer<DeleteFunctionRequest.Builder> deleteFunctionRequest)
Deletes a CloudFront function.
|
default DeleteFunctionResponse |
deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
Deletes a CloudFront function.
|
default DeleteKeyGroupResponse |
deleteKeyGroup(Consumer<DeleteKeyGroupRequest.Builder> deleteKeyGroupRequest)
Deletes a key group.
|
default DeleteKeyGroupResponse |
deleteKeyGroup(DeleteKeyGroupRequest deleteKeyGroupRequest)
Deletes a key group.
|
default DeleteMonitoringSubscriptionResponse |
deleteMonitoringSubscription(Consumer<DeleteMonitoringSubscriptionRequest.Builder> deleteMonitoringSubscriptionRequest)
Disables additional CloudWatch metrics for the specified CloudFront distribution.
|
default DeleteMonitoringSubscriptionResponse |
deleteMonitoringSubscription(DeleteMonitoringSubscriptionRequest deleteMonitoringSubscriptionRequest)
Disables additional CloudWatch metrics for the specified CloudFront distribution.
|
default DeleteOriginRequestPolicyResponse |
deleteOriginRequestPolicy(Consumer<DeleteOriginRequestPolicyRequest.Builder> deleteOriginRequestPolicyRequest)
Deletes an origin request policy.
|
default DeleteOriginRequestPolicyResponse |
deleteOriginRequestPolicy(DeleteOriginRequestPolicyRequest deleteOriginRequestPolicyRequest)
Deletes an origin request policy.
|
default DeletePublicKeyResponse |
deletePublicKey(Consumer<DeletePublicKeyRequest.Builder> deletePublicKeyRequest)
Remove a public key you previously added to CloudFront.
|
default DeletePublicKeyResponse |
deletePublicKey(DeletePublicKeyRequest deletePublicKeyRequest)
Remove a public key you previously added to CloudFront.
|
default DeleteRealtimeLogConfigResponse |
deleteRealtimeLogConfig(Consumer<DeleteRealtimeLogConfigRequest.Builder> deleteRealtimeLogConfigRequest)
Deletes a real-time log configuration.
|
default DeleteRealtimeLogConfigResponse |
deleteRealtimeLogConfig(DeleteRealtimeLogConfigRequest deleteRealtimeLogConfigRequest)
Deletes a real-time log configuration.
|
default DeleteStreamingDistributionResponse |
deleteStreamingDistribution(Consumer<DeleteStreamingDistributionRequest.Builder> deleteStreamingDistributionRequest)
Delete a streaming distribution.
|
default DeleteStreamingDistributionResponse |
deleteStreamingDistribution(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest)
Delete a streaming distribution.
|
default DescribeFunctionResponse |
describeFunction(Consumer<DescribeFunctionRequest.Builder> describeFunctionRequest)
Gets configuration information and metadata about a CloudFront function, but not the function’s code.
|
default DescribeFunctionResponse |
describeFunction(DescribeFunctionRequest describeFunctionRequest)
Gets configuration information and metadata about a CloudFront function, but not the function’s code.
|
default GetCachePolicyResponse |
getCachePolicy(Consumer<GetCachePolicyRequest.Builder> getCachePolicyRequest)
Gets a cache policy, including the following metadata:
|
default GetCachePolicyResponse |
getCachePolicy(GetCachePolicyRequest getCachePolicyRequest)
Gets a cache policy, including the following metadata:
|
default GetCachePolicyConfigResponse |
getCachePolicyConfig(Consumer<GetCachePolicyConfigRequest.Builder> getCachePolicyConfigRequest)
Gets a cache policy configuration.
|
default GetCachePolicyConfigResponse |
getCachePolicyConfig(GetCachePolicyConfigRequest getCachePolicyConfigRequest)
Gets a cache policy configuration.
|
default GetCloudFrontOriginAccessIdentityResponse |
getCloudFrontOriginAccessIdentity(Consumer<GetCloudFrontOriginAccessIdentityRequest.Builder> getCloudFrontOriginAccessIdentityRequest)
Get the information about an origin access identity.
|
default GetCloudFrontOriginAccessIdentityResponse |
getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest)
Get the information about an origin access identity.
|
default GetCloudFrontOriginAccessIdentityConfigResponse |
getCloudFrontOriginAccessIdentityConfig(Consumer<GetCloudFrontOriginAccessIdentityConfigRequest.Builder> getCloudFrontOriginAccessIdentityConfigRequest)
Get the configuration information about an origin access identity.
|
default GetCloudFrontOriginAccessIdentityConfigResponse |
getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest)
Get the configuration information about an origin access identity.
|
default GetDistributionResponse |
getDistribution(Consumer<GetDistributionRequest.Builder> getDistributionRequest)
Get the information about a distribution.
|
default GetDistributionResponse |
getDistribution(GetDistributionRequest getDistributionRequest)
Get the information about a distribution.
|
default GetDistributionConfigResponse |
getDistributionConfig(Consumer<GetDistributionConfigRequest.Builder> getDistributionConfigRequest)
Get the configuration information about a distribution.
|
default GetDistributionConfigResponse |
getDistributionConfig(GetDistributionConfigRequest getDistributionConfigRequest)
Get the configuration information about a distribution.
|
default GetFieldLevelEncryptionResponse |
getFieldLevelEncryption(Consumer<GetFieldLevelEncryptionRequest.Builder> getFieldLevelEncryptionRequest)
Get the field-level encryption configuration information.
|
default GetFieldLevelEncryptionResponse |
getFieldLevelEncryption(GetFieldLevelEncryptionRequest getFieldLevelEncryptionRequest)
Get the field-level encryption configuration information.
|
default GetFieldLevelEncryptionConfigResponse |
getFieldLevelEncryptionConfig(Consumer<GetFieldLevelEncryptionConfigRequest.Builder> getFieldLevelEncryptionConfigRequest)
Get the field-level encryption configuration information.
|
default GetFieldLevelEncryptionConfigResponse |
getFieldLevelEncryptionConfig(GetFieldLevelEncryptionConfigRequest getFieldLevelEncryptionConfigRequest)
Get the field-level encryption configuration information.
|
default GetFieldLevelEncryptionProfileResponse |
getFieldLevelEncryptionProfile(Consumer<GetFieldLevelEncryptionProfileRequest.Builder> getFieldLevelEncryptionProfileRequest)
Get the field-level encryption profile information.
|
default GetFieldLevelEncryptionProfileResponse |
getFieldLevelEncryptionProfile(GetFieldLevelEncryptionProfileRequest getFieldLevelEncryptionProfileRequest)
Get the field-level encryption profile information.
|
default GetFieldLevelEncryptionProfileConfigResponse |
getFieldLevelEncryptionProfileConfig(Consumer<GetFieldLevelEncryptionProfileConfigRequest.Builder> getFieldLevelEncryptionProfileConfigRequest)
Get the field-level encryption profile configuration information.
|
default GetFieldLevelEncryptionProfileConfigResponse |
getFieldLevelEncryptionProfileConfig(GetFieldLevelEncryptionProfileConfigRequest getFieldLevelEncryptionProfileConfigRequest)
Get the field-level encryption profile configuration information.
|
default GetFunctionResponse |
getFunction(Consumer<GetFunctionRequest.Builder> getFunctionRequest)
Gets the code of a CloudFront function.
|
default GetFunctionResponse |
getFunction(GetFunctionRequest getFunctionRequest)
Gets the code of a CloudFront function.
|
default GetInvalidationResponse |
getInvalidation(Consumer<GetInvalidationRequest.Builder> getInvalidationRequest)
Get the information about an invalidation.
|
default GetInvalidationResponse |
getInvalidation(GetInvalidationRequest getInvalidationRequest)
Get the information about an invalidation.
|
default GetKeyGroupResponse |
getKeyGroup(Consumer<GetKeyGroupRequest.Builder> getKeyGroupRequest)
Gets a key group, including the date and time when the key group was last modified.
|
default GetKeyGroupResponse |
getKeyGroup(GetKeyGroupRequest getKeyGroupRequest)
Gets a key group, including the date and time when the key group was last modified.
|
default GetKeyGroupConfigResponse |
getKeyGroupConfig(Consumer<GetKeyGroupConfigRequest.Builder> getKeyGroupConfigRequest)
Gets a key group configuration.
|
default GetKeyGroupConfigResponse |
getKeyGroupConfig(GetKeyGroupConfigRequest getKeyGroupConfigRequest)
Gets a key group configuration.
|
default GetMonitoringSubscriptionResponse |
getMonitoringSubscription(Consumer<GetMonitoringSubscriptionRequest.Builder> getMonitoringSubscriptionRequest)
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront
distribution.
|
default GetMonitoringSubscriptionResponse |
getMonitoringSubscription(GetMonitoringSubscriptionRequest getMonitoringSubscriptionRequest)
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront
distribution.
|
default GetOriginRequestPolicyResponse |
getOriginRequestPolicy(Consumer<GetOriginRequestPolicyRequest.Builder> getOriginRequestPolicyRequest)
Gets an origin request policy, including the following metadata:
|
default GetOriginRequestPolicyResponse |
getOriginRequestPolicy(GetOriginRequestPolicyRequest getOriginRequestPolicyRequest)
Gets an origin request policy, including the following metadata:
|
default GetOriginRequestPolicyConfigResponse |
getOriginRequestPolicyConfig(Consumer<GetOriginRequestPolicyConfigRequest.Builder> getOriginRequestPolicyConfigRequest)
Gets an origin request policy configuration.
|
default GetOriginRequestPolicyConfigResponse |
getOriginRequestPolicyConfig(GetOriginRequestPolicyConfigRequest getOriginRequestPolicyConfigRequest)
Gets an origin request policy configuration.
|
default GetPublicKeyResponse |
getPublicKey(Consumer<GetPublicKeyRequest.Builder> getPublicKeyRequest)
Gets a public key.
|
default GetPublicKeyResponse |
getPublicKey(GetPublicKeyRequest getPublicKeyRequest)
Gets a public key.
|
default GetPublicKeyConfigResponse |
getPublicKeyConfig(Consumer<GetPublicKeyConfigRequest.Builder> getPublicKeyConfigRequest)
Gets a public key configuration.
|
default GetPublicKeyConfigResponse |
getPublicKeyConfig(GetPublicKeyConfigRequest getPublicKeyConfigRequest)
Gets a public key configuration.
|
default GetRealtimeLogConfigResponse |
getRealtimeLogConfig(Consumer<GetRealtimeLogConfigRequest.Builder> getRealtimeLogConfigRequest)
Gets a real-time log configuration.
|
default GetRealtimeLogConfigResponse |
getRealtimeLogConfig(GetRealtimeLogConfigRequest getRealtimeLogConfigRequest)
Gets a real-time log configuration.
|
default GetStreamingDistributionResponse |
getStreamingDistribution(Consumer<GetStreamingDistributionRequest.Builder> getStreamingDistributionRequest)
Gets information about a specified RTMP distribution, including the distribution configuration.
|
default GetStreamingDistributionResponse |
getStreamingDistribution(GetStreamingDistributionRequest getStreamingDistributionRequest)
Gets information about a specified RTMP distribution, including the distribution configuration.
|
default GetStreamingDistributionConfigResponse |
getStreamingDistributionConfig(Consumer<GetStreamingDistributionConfigRequest.Builder> getStreamingDistributionConfigRequest)
Get the configuration information about a streaming distribution.
|
default GetStreamingDistributionConfigResponse |
getStreamingDistributionConfig(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest)
Get the configuration information about a streaming distribution.
|
default ListCachePoliciesResponse |
listCachePolicies(Consumer<ListCachePoliciesRequest.Builder> listCachePoliciesRequest)
Gets a list of cache policies.
|
default ListCachePoliciesResponse |
listCachePolicies(ListCachePoliciesRequest listCachePoliciesRequest)
Gets a list of cache policies.
|
default ListCloudFrontOriginAccessIdentitiesResponse |
listCloudFrontOriginAccessIdentities()
Lists origin access identities.
|
default ListCloudFrontOriginAccessIdentitiesResponse |
listCloudFrontOriginAccessIdentities(Consumer<ListCloudFrontOriginAccessIdentitiesRequest.Builder> listCloudFrontOriginAccessIdentitiesRequest)
Lists origin access identities.
|
default ListCloudFrontOriginAccessIdentitiesResponse |
listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest)
Lists origin access identities.
|
default ListConflictingAliasesResponse |
listConflictingAliases(Consumer<ListConflictingAliasesRequest.Builder> listConflictingAliasesRequest)
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided
alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias.
|
default ListConflictingAliasesResponse |
listConflictingAliases(ListConflictingAliasesRequest listConflictingAliasesRequest)
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided
alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias.
|
default ListDistributionsResponse |
listDistributions()
List CloudFront distributions.
|
default ListDistributionsResponse |
listDistributions(Consumer<ListDistributionsRequest.Builder> listDistributionsRequest)
List CloudFront distributions.
|
default ListDistributionsResponse |
listDistributions(ListDistributionsRequest listDistributionsRequest)
List CloudFront distributions.
|
default ListDistributionsByCachePolicyIdResponse |
listDistributionsByCachePolicyId(Consumer<ListDistributionsByCachePolicyIdRequest.Builder> listDistributionsByCachePolicyIdRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified
cache policy.
|
default ListDistributionsByCachePolicyIdResponse |
listDistributionsByCachePolicyId(ListDistributionsByCachePolicyIdRequest listDistributionsByCachePolicyIdRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified
cache policy.
|
default ListDistributionsByKeyGroupResponse |
listDistributionsByKeyGroup(Consumer<ListDistributionsByKeyGroupRequest.Builder> listDistributionsByKeyGroupRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key
group.
|
default ListDistributionsByKeyGroupResponse |
listDistributionsByKeyGroup(ListDistributionsByKeyGroupRequest listDistributionsByKeyGroupRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key
group.
|
default ListDistributionsByOriginRequestPolicyIdResponse |
listDistributionsByOriginRequestPolicyId(Consumer<ListDistributionsByOriginRequestPolicyIdRequest.Builder> listDistributionsByOriginRequestPolicyIdRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified
origin request policy.
|
default ListDistributionsByOriginRequestPolicyIdResponse |
listDistributionsByOriginRequestPolicyId(ListDistributionsByOriginRequestPolicyIdRequest listDistributionsByOriginRequestPolicyIdRequest)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified
origin request policy.
|
default ListDistributionsByRealtimeLogConfigResponse |
listDistributionsByRealtimeLogConfig(Consumer<ListDistributionsByRealtimeLogConfigRequest.Builder> listDistributionsByRealtimeLogConfigRequest)
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log
configuration.
|
default ListDistributionsByRealtimeLogConfigResponse |
listDistributionsByRealtimeLogConfig(ListDistributionsByRealtimeLogConfigRequest listDistributionsByRealtimeLogConfigRequest)
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log
configuration.
|
default ListDistributionsByWebAclIdResponse |
listDistributionsByWebACLId(Consumer<ListDistributionsByWebAclIdRequest.Builder> listDistributionsByWebAclIdRequest)
List the distributions that are associated with a specified WAF web ACL.
|
default ListDistributionsByWebAclIdResponse |
listDistributionsByWebACLId(ListDistributionsByWebAclIdRequest listDistributionsByWebAclIdRequest)
List the distributions that are associated with a specified WAF web ACL.
|
default ListFieldLevelEncryptionConfigsResponse |
listFieldLevelEncryptionConfigs()
List all field-level encryption configurations that have been created in CloudFront for this account.
|
default ListFieldLevelEncryptionConfigsResponse |
listFieldLevelEncryptionConfigs(Consumer<ListFieldLevelEncryptionConfigsRequest.Builder> listFieldLevelEncryptionConfigsRequest)
List all field-level encryption configurations that have been created in CloudFront for this account.
|
default ListFieldLevelEncryptionConfigsResponse |
listFieldLevelEncryptionConfigs(ListFieldLevelEncryptionConfigsRequest listFieldLevelEncryptionConfigsRequest)
List all field-level encryption configurations that have been created in CloudFront for this account.
|
default ListFieldLevelEncryptionProfilesResponse |
listFieldLevelEncryptionProfiles()
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
|
default ListFieldLevelEncryptionProfilesResponse |
listFieldLevelEncryptionProfiles(Consumer<ListFieldLevelEncryptionProfilesRequest.Builder> listFieldLevelEncryptionProfilesRequest)
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
|
default ListFieldLevelEncryptionProfilesResponse |
listFieldLevelEncryptionProfiles(ListFieldLevelEncryptionProfilesRequest listFieldLevelEncryptionProfilesRequest)
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
|
default ListFunctionsResponse |
listFunctions(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest)
Gets a list of all CloudFront functions in your account.
|
default ListFunctionsResponse |
listFunctions(ListFunctionsRequest listFunctionsRequest)
Gets a list of all CloudFront functions in your account.
|
default ListInvalidationsResponse |
listInvalidations(Consumer<ListInvalidationsRequest.Builder> listInvalidationsRequest)
Lists invalidation batches.
|
default ListInvalidationsResponse |
listInvalidations(ListInvalidationsRequest listInvalidationsRequest)
Lists invalidation batches.
|
default ListKeyGroupsResponse |
listKeyGroups(Consumer<ListKeyGroupsRequest.Builder> listKeyGroupsRequest)
Gets a list of key groups.
|
default ListKeyGroupsResponse |
listKeyGroups(ListKeyGroupsRequest listKeyGroupsRequest)
Gets a list of key groups.
|
default ListOriginRequestPoliciesResponse |
listOriginRequestPolicies(Consumer<ListOriginRequestPoliciesRequest.Builder> listOriginRequestPoliciesRequest)
Gets a list of origin request policies.
|
default ListOriginRequestPoliciesResponse |
listOriginRequestPolicies(ListOriginRequestPoliciesRequest listOriginRequestPoliciesRequest)
Gets a list of origin request policies.
|
default ListPublicKeysResponse |
listPublicKeys()
List all public keys that have been added to CloudFront for this account.
|
default ListPublicKeysResponse |
listPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest)
List all public keys that have been added to CloudFront for this account.
|
default ListPublicKeysResponse |
listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
List all public keys that have been added to CloudFront for this account.
|
default ListRealtimeLogConfigsResponse |
listRealtimeLogConfigs(Consumer<ListRealtimeLogConfigsRequest.Builder> listRealtimeLogConfigsRequest)
Gets a list of real-time log configurations.
|
default ListRealtimeLogConfigsResponse |
listRealtimeLogConfigs(ListRealtimeLogConfigsRequest listRealtimeLogConfigsRequest)
Gets a list of real-time log configurations.
|
default ListStreamingDistributionsResponse |
listStreamingDistributions()
List streaming distributions.
|
default ListStreamingDistributionsResponse |
listStreamingDistributions(Consumer<ListStreamingDistributionsRequest.Builder> listStreamingDistributionsRequest)
List streaming distributions.
|
default ListStreamingDistributionsResponse |
listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest)
List streaming distributions.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List tags for a CloudFront resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a CloudFront resource.
|
default PublishFunctionResponse |
publishFunction(Consumer<PublishFunctionRequest.Builder> publishFunctionRequest)
Publishes a CloudFront function by copying the function code from the
DEVELOPMENT stage to
LIVE . |
default PublishFunctionResponse |
publishFunction(PublishFunctionRequest publishFunctionRequest)
Publishes a CloudFront function by copying the function code from the
DEVELOPMENT stage to
LIVE . |
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Add tags to a CloudFront resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Add tags to a CloudFront resource.
|
default TestFunctionResponse |
testFunction(Consumer<TestFunctionRequest.Builder> testFunctionRequest)
Tests a CloudFront function.
|
default TestFunctionResponse |
testFunction(TestFunctionRequest testFunctionRequest)
Tests a CloudFront function.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Remove tags from a CloudFront resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Remove tags from a CloudFront resource.
|
default UpdateCachePolicyResponse |
updateCachePolicy(Consumer<UpdateCachePolicyRequest.Builder> updateCachePolicyRequest)
Updates a cache policy configuration.
|
default UpdateCachePolicyResponse |
updateCachePolicy(UpdateCachePolicyRequest updateCachePolicyRequest)
Updates a cache policy configuration.
|
default UpdateCloudFrontOriginAccessIdentityResponse |
updateCloudFrontOriginAccessIdentity(Consumer<UpdateCloudFrontOriginAccessIdentityRequest.Builder> updateCloudFrontOriginAccessIdentityRequest)
Update an origin access identity.
|
default UpdateCloudFrontOriginAccessIdentityResponse |
updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest)
Update an origin access identity.
|
default UpdateDistributionResponse |
updateDistribution(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest)
Updates the configuration for a web distribution.
|
default UpdateDistributionResponse |
updateDistribution(UpdateDistributionRequest updateDistributionRequest)
Updates the configuration for a web distribution.
|
default UpdateFieldLevelEncryptionConfigResponse |
updateFieldLevelEncryptionConfig(Consumer<UpdateFieldLevelEncryptionConfigRequest.Builder> updateFieldLevelEncryptionConfigRequest)
Update a field-level encryption configuration.
|
default UpdateFieldLevelEncryptionConfigResponse |
updateFieldLevelEncryptionConfig(UpdateFieldLevelEncryptionConfigRequest updateFieldLevelEncryptionConfigRequest)
Update a field-level encryption configuration.
|
default UpdateFieldLevelEncryptionProfileResponse |
updateFieldLevelEncryptionProfile(Consumer<UpdateFieldLevelEncryptionProfileRequest.Builder> updateFieldLevelEncryptionProfileRequest)
Update a field-level encryption profile.
|
default UpdateFieldLevelEncryptionProfileResponse |
updateFieldLevelEncryptionProfile(UpdateFieldLevelEncryptionProfileRequest updateFieldLevelEncryptionProfileRequest)
Update a field-level encryption profile.
|
default UpdateFunctionResponse |
updateFunction(Consumer<UpdateFunctionRequest.Builder> updateFunctionRequest)
Updates a CloudFront function.
|
default UpdateFunctionResponse |
updateFunction(UpdateFunctionRequest updateFunctionRequest)
Updates a CloudFront function.
|
default UpdateKeyGroupResponse |
updateKeyGroup(Consumer<UpdateKeyGroupRequest.Builder> updateKeyGroupRequest)
Updates a key group.
|
default UpdateKeyGroupResponse |
updateKeyGroup(UpdateKeyGroupRequest updateKeyGroupRequest)
Updates a key group.
|
default UpdateOriginRequestPolicyResponse |
updateOriginRequestPolicy(Consumer<UpdateOriginRequestPolicyRequest.Builder> updateOriginRequestPolicyRequest)
Updates an origin request policy configuration.
|
default UpdateOriginRequestPolicyResponse |
updateOriginRequestPolicy(UpdateOriginRequestPolicyRequest updateOriginRequestPolicyRequest)
Updates an origin request policy configuration.
|
default UpdatePublicKeyResponse |
updatePublicKey(Consumer<UpdatePublicKeyRequest.Builder> updatePublicKeyRequest)
Update public key information.
|
default UpdatePublicKeyResponse |
updatePublicKey(UpdatePublicKeyRequest updatePublicKeyRequest)
Update public key information.
|
default UpdateRealtimeLogConfigResponse |
updateRealtimeLogConfig(Consumer<UpdateRealtimeLogConfigRequest.Builder> updateRealtimeLogConfigRequest)
Updates a real-time log configuration.
|
default UpdateRealtimeLogConfigResponse |
updateRealtimeLogConfig(UpdateRealtimeLogConfigRequest updateRealtimeLogConfigRequest)
Updates a real-time log configuration.
|
default UpdateStreamingDistributionResponse |
updateStreamingDistribution(Consumer<UpdateStreamingDistributionRequest.Builder> updateStreamingDistributionRequest)
Update a streaming distribution.
|
default UpdateStreamingDistributionResponse |
updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest)
Update a streaming distribution.
|
default CloudFrontWaiter |
waiter()
Create an instance of
CloudFrontWaiter using this client. |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static CloudFrontClient create()
CloudFrontClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CloudFrontClientBuilder builder()
CloudFrontClient
.default AssociateAliasResponse associateAlias(AssociateAliasRequest associateAliasRequest) throws InvalidArgumentException, NoSuchDistributionException, TooManyDistributionCnamEsException, IllegalUpdateException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that’s already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
associateAliasRequest
- InvalidArgumentException
- An argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.TooManyDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.IllegalUpdateException
- The update contains modifications that are not allowed.AccessDeniedException
- Access denied.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 AssociateAliasResponse associateAlias(Consumer<AssociateAliasRequest.Builder> associateAliasRequest) throws InvalidArgumentException, NoSuchDistributionException, TooManyDistributionCnamEsException, IllegalUpdateException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that’s already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the AssociateAliasRequest.Builder
avoiding the need to
create one manually via AssociateAliasRequest.builder()
associateAliasRequest
- A Consumer
that will call methods on AssociateAliasRequest.Builder
to create a request.InvalidArgumentException
- An argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.TooManyDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.IllegalUpdateException
- The update contains modifications that are not allowed.AccessDeniedException
- Access denied.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 CreateCachePolicyResponse createCachePolicy(CreateCachePolicyRequest createCachePolicyRequest) throws AccessDeniedException, InconsistentQuantitiesException, InvalidArgumentException, CachePolicyAlreadyExistsException, TooManyCachePoliciesException, TooManyHeadersInCachePolicyException, TooManyCookiesInCachePolicyException, TooManyQueryStringsInCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException
Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests
that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that
matches the request’s cache key. If you want to send values to the origin but not include them in the
cache key, use OriginRequestPolicy
.
For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
createCachePolicyRequest
- AccessDeniedException
- Access denied.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.CachePolicyAlreadyExistsException
- A cache policy with this name already exists. You must provide a unique name. To modify an existing cache
policy, use UpdateCachePolicy
.TooManyCachePoliciesException
- You have reached the maximum number of cache policies for this account. For more information, see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyHeadersInCachePolicyException
- The number of headers in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyCookiesInCachePolicyException
- The number of cookies in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyQueryStringsInCachePolicyException
- The number of query strings in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.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 CreateCachePolicyResponse createCachePolicy(Consumer<CreateCachePolicyRequest.Builder> createCachePolicyRequest) throws AccessDeniedException, InconsistentQuantitiesException, InvalidArgumentException, CachePolicyAlreadyExistsException, TooManyCachePoliciesException, TooManyHeadersInCachePolicyException, TooManyCookiesInCachePolicyException, TooManyQueryStringsInCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException
Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests
that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that
matches the request’s cache key. If you want to send values to the origin but not include them in the
cache key, use OriginRequestPolicy
.
For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the CreateCachePolicyRequest.Builder
avoiding the need
to create one manually via CreateCachePolicyRequest.builder()
createCachePolicyRequest
- A Consumer
that will call methods on CreateCachePolicyRequest.Builder
to create a request.AccessDeniedException
- Access denied.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.CachePolicyAlreadyExistsException
- A cache policy with this name already exists. You must provide a unique name. To modify an existing cache
policy, use UpdateCachePolicy
.TooManyCachePoliciesException
- You have reached the maximum number of cache policies for this account. For more information, see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyHeadersInCachePolicyException
- The number of headers in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyCookiesInCachePolicyException
- The number of cookies in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyQueryStringsInCachePolicyException
- The number of query strings in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.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(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
- An 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
- An 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, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, 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
- An argument is invalid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use
the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda@Edge function
associations per owner to be exceeded.TooManyDistributionsWithSingleFunctionArnException
- The maximum number of distributions have been associated with the specified Lambda@Edge function.TooManyLambdaFunctionAssociationsException
- Your request contains more Lambda@Edge function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException
- The specified Lambda@Edge function association is invalid.TooManyDistributionsWithFunctionAssociationsException
- You have reached the maximum number of distributions that are associated with a CloudFront function. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyFunctionAssociationsException
- You have reached the maximum number of CloudFront function associations for this distribution. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidFunctionAssociationException
- A CloudFront function association is invalid.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.NoSuchCachePolicyException
- The cache policy does not exist.TooManyDistributionsAssociatedToCachePolicyException
- The maximum number of distributions have been associated with the specified cache policy. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.TooManyDistributionsAssociatedToOriginRequestPolicyException
- The maximum number of distributions have been associated with the specified origin request policy. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyDistributionsAssociatedToKeyGroupException
- The number of distributions that reference this key group is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyKeyGroupsAssociatedToDistributionException
- The number of key groups referenced by this distribution is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TrustedKeyGroupDoesNotExistException
- The specified key group does not exist.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigOwnerMismatchException
- The specified real-time log configuration belongs to a different account.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, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, 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
- An argument is invalid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use
the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda@Edge function
associations per owner to be exceeded.TooManyDistributionsWithSingleFunctionArnException
- The maximum number of distributions have been associated with the specified Lambda@Edge function.TooManyLambdaFunctionAssociationsException
- Your request contains more Lambda@Edge function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException
- The specified Lambda@Edge function association is invalid.TooManyDistributionsWithFunctionAssociationsException
- You have reached the maximum number of distributions that are associated with a CloudFront function. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyFunctionAssociationsException
- You have reached the maximum number of CloudFront function associations for this distribution. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidFunctionAssociationException
- A CloudFront function association is invalid.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.NoSuchCachePolicyException
- The cache policy does not exist.TooManyDistributionsAssociatedToCachePolicyException
- The maximum number of distributions have been associated with the specified cache policy. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.TooManyDistributionsAssociatedToOriginRequestPolicyException
- The maximum number of distributions have been associated with the specified origin request policy. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyDistributionsAssociatedToKeyGroupException
- The number of distributions that reference this key group is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyKeyGroupsAssociatedToDistributionException
- The number of key groups referenced by this distribution is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TrustedKeyGroupDoesNotExistException
- The specified key group does not exist.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigOwnerMismatchException
- The specified real-time log configuration belongs to a different account.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, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, 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
- An argument is invalid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use
the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.InvalidTaggingException
- The tagging specified is not valid.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda@Edge function
associations per owner to be exceeded.TooManyDistributionsWithSingleFunctionArnException
- The maximum number of distributions have been associated with the specified Lambda@Edge function.TooManyLambdaFunctionAssociationsException
- Your request contains more Lambda@Edge function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException
- The specified Lambda@Edge function association is invalid.TooManyDistributionsWithFunctionAssociationsException
- You have reached the maximum number of distributions that are associated with a CloudFront function. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyFunctionAssociationsException
- You have reached the maximum number of CloudFront function associations for this distribution. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidFunctionAssociationException
- A CloudFront function association is invalid.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.NoSuchCachePolicyException
- The cache policy does not exist.TooManyDistributionsAssociatedToCachePolicyException
- The maximum number of distributions have been associated with the specified cache policy. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.TooManyDistributionsAssociatedToOriginRequestPolicyException
- The maximum number of distributions have been associated with the specified origin request policy. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyDistributionsAssociatedToKeyGroupException
- The number of distributions that reference this key group is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyKeyGroupsAssociatedToDistributionException
- The number of key groups referenced by this distribution is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TrustedKeyGroupDoesNotExistException
- The specified key group does not exist.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigOwnerMismatchException
- The specified real-time log configuration belongs to a different account.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, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, 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
- An argument is invalid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidProtocolSettingsException
- You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that
support Server Name Indication (SNI).InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use
the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.InvalidTaggingException
- The tagging specified is not valid.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda@Edge function
associations per owner to be exceeded.TooManyDistributionsWithSingleFunctionArnException
- The maximum number of distributions have been associated with the specified Lambda@Edge function.TooManyLambdaFunctionAssociationsException
- Your request contains more Lambda@Edge function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException
- The specified Lambda@Edge function association is invalid.TooManyDistributionsWithFunctionAssociationsException
- You have reached the maximum number of distributions that are associated with a CloudFront function. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyFunctionAssociationsException
- You have reached the maximum number of CloudFront function associations for this distribution. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidFunctionAssociationException
- A CloudFront function association is invalid.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.NoSuchCachePolicyException
- The cache policy does not exist.TooManyDistributionsAssociatedToCachePolicyException
- The maximum number of distributions have been associated with the specified cache policy. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.TooManyDistributionsAssociatedToOriginRequestPolicyException
- The maximum number of distributions have been associated with the specified origin request policy. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyDistributionsAssociatedToKeyGroupException
- The number of distributions that reference this key group is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyKeyGroupsAssociatedToDistributionException
- The number of key groups referenced by this distribution is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TrustedKeyGroupDoesNotExistException
- The specified key group does not exist.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigOwnerMismatchException
- The specified real-time log configuration belongs to a different account.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
- An argument is invalid.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.FieldLevelEncryptionConfigAlreadyExistsException
- The specified configuration for field-level encryption already exists.TooManyFieldLevelEncryptionConfigsException
- The maximum number of configurations for field-level encryption have been created.TooManyFieldLevelEncryptionQueryArgProfilesException
- The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException
- The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException
- No profile specified for the field-level encryption query argument.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
- An argument is invalid.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.FieldLevelEncryptionConfigAlreadyExistsException
- The specified configuration for field-level encryption already exists.TooManyFieldLevelEncryptionConfigsException
- The maximum number of configurations for field-level encryption have been created.TooManyFieldLevelEncryptionQueryArgProfilesException
- The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException
- The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException
- No profile specified for the field-level encryption query argument.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
- An argument is invalid.NoSuchPublicKeyException
- The specified public key doesn't exist.FieldLevelEncryptionProfileAlreadyExistsException
- The specified profile for field-level encryption already exists.FieldLevelEncryptionProfileSizeExceededException
- The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionProfilesException
- The maximum number of profiles for field-level encryption have been created.TooManyFieldLevelEncryptionEncryptionEntitiesException
- The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException
- The maximum number of field patterns for field-level encryption have been created.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
- An argument is invalid.NoSuchPublicKeyException
- The specified public key doesn't exist.FieldLevelEncryptionProfileAlreadyExistsException
- The specified profile for field-level encryption already exists.FieldLevelEncryptionProfileSizeExceededException
- The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionProfilesException
- The maximum number of profiles for field-level encryption have been created.TooManyFieldLevelEncryptionEncryptionEntitiesException
- The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException
- The maximum number of field patterns for field-level encryption have been created.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 CreateFunctionResponse createFunction(CreateFunctionRequest createFunctionRequest) throws TooManyFunctionsException, FunctionAlreadyExistsException, FunctionSizeLimitExceededException, InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it’s in the DEVELOPMENT
stage. In this stage, you can test the function
with TestFunction
, and update it with UpdateFunction
.
When you’re ready to use your function with a CloudFront distribution, use PublishFunction
to copy
the function from the DEVELOPMENT
stage to LIVE
. When it’s live, you can attach the
function to a distribution’s cache behavior, using the function’s ARN.
createFunctionRequest
- TooManyFunctionsException
- You have reached the maximum number of CloudFront functions for this account. For more information, see
Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.FunctionAlreadyExistsException
- A function with the same name already exists in this account. To create a function, you must provide a
unique name. To update an existing function, use UpdateFunction
.FunctionSizeLimitExceededException
- The function is too large. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidArgumentException
- An argument is invalid.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default CreateFunctionResponse createFunction(Consumer<CreateFunctionRequest.Builder> createFunctionRequest) throws TooManyFunctionsException, FunctionAlreadyExistsException, FunctionSizeLimitExceededException, InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it’s in the DEVELOPMENT
stage. In this stage, you can test the function
with TestFunction
, and update it with UpdateFunction
.
When you’re ready to use your function with a CloudFront distribution, use PublishFunction
to copy
the function from the DEVELOPMENT
stage to LIVE
. When it’s live, you can attach the
function to a distribution’s cache behavior, using the function’s ARN.
This is a convenience which creates an instance of the CreateFunctionRequest.Builder
avoiding the need to
create one manually via CreateFunctionRequest.builder()
createFunctionRequest
- A Consumer
that will call methods on CreateFunctionRequest.Builder
to create a request.TooManyFunctionsException
- You have reached the maximum number of CloudFront functions for this account. For more information, see
Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.FunctionAlreadyExistsException
- A function with the same name already exists in this account. To create a function, you must provide a
unique name. To update an existing function, use UpdateFunction
.FunctionSizeLimitExceededException
- The function is too large. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidArgumentException
- An argument is invalid.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
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
- An argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.BatchTooLargeException
- Invalidation batch specified is too large.TooManyInvalidationsInProgressException
- You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation
objects.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.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
- An argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.BatchTooLargeException
- Invalidation batch specified is too large.TooManyInvalidationsInProgressException
- You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation
objects.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.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 CreateKeyGroupResponse createKeyGroup(CreateKeyGroupRequest createKeyGroupRequest) throws InvalidArgumentException, KeyGroupAlreadyExistsException, TooManyKeyGroupsException, TooManyPublicKeysInKeyGroupException, AwsServiceException, SdkClientException, CloudFrontException
Creates a key group that you can use with CloudFront signed URLs and signed cookies.
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
createKeyGroupRequest
- InvalidArgumentException
- An argument is invalid.KeyGroupAlreadyExistsException
- A key group with this name already exists. You must provide a unique name. To modify an existing key
group, use UpdateKeyGroup
.TooManyKeyGroupsException
- You have reached the maximum number of key groups for this account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyPublicKeysInKeyGroupException
- The number of public keys in this key group is more than the maximum allowed. For more information, see
Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.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 CreateKeyGroupResponse createKeyGroup(Consumer<CreateKeyGroupRequest.Builder> createKeyGroupRequest) throws InvalidArgumentException, KeyGroupAlreadyExistsException, TooManyKeyGroupsException, TooManyPublicKeysInKeyGroupException, AwsServiceException, SdkClientException, CloudFrontException
Creates a key group that you can use with CloudFront signed URLs and signed cookies.
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the CreateKeyGroupRequest.Builder
avoiding the need to
create one manually via CreateKeyGroupRequest.builder()
createKeyGroupRequest
- A Consumer
that will call methods on CreateKeyGroupRequest.Builder
to create a request.InvalidArgumentException
- An argument is invalid.KeyGroupAlreadyExistsException
- A key group with this name already exists. You must provide a unique name. To modify an existing key
group, use UpdateKeyGroup
.TooManyKeyGroupsException
- You have reached the maximum number of key groups for this account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyPublicKeysInKeyGroupException
- The number of public keys in this key group is more than the maximum allowed. For more information, see
Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.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 CreateMonitoringSubscriptionResponse createMonitoringSubscription(CreateMonitoringSubscriptionRequest createMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
createMonitoringSubscriptionRequest
- AccessDeniedException
- Access denied.NoSuchDistributionException
- The specified distribution does not exist.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default CreateMonitoringSubscriptionResponse createMonitoringSubscription(Consumer<CreateMonitoringSubscriptionRequest.Builder> createMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the CreateMonitoringSubscriptionRequest.Builder
avoiding the need to create one manually via CreateMonitoringSubscriptionRequest.builder()
createMonitoringSubscriptionRequest
- A Consumer
that will call methods on CreateMonitoringSubscriptionRequest.Builder
to create
a request.AccessDeniedException
- Access denied.NoSuchDistributionException
- The specified distribution does not exist.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default CreateOriginRequestPolicyResponse createOriginRequestPolicy(CreateOriginRequestPolicyRequest createOriginRequestPolicyRequest) throws AccessDeniedException, InconsistentQuantitiesException, InvalidArgumentException, OriginRequestPolicyAlreadyExistsException, TooManyOriginRequestPoliciesException, TooManyHeadersInOriginRequestPolicyException, TooManyCookiesInOriginRequestPolicyException, TooManyQueryStringsInOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException
Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host
,
User-Agent
, and X-Amz-Cf-Id
.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can’t find a valid object in its cache that matches the request. If you want
to send values to the origin and also include them in the cache key, use CachePolicy
.
For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.
createOriginRequestPolicyRequest
- AccessDeniedException
- Access denied.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.OriginRequestPolicyAlreadyExistsException
- An origin request policy with this name already exists. You must provide a unique name. To modify an
existing origin request policy, use UpdateOriginRequestPolicy
.TooManyOriginRequestPoliciesException
- You have reached the maximum number of origin request policies for this account. For more information,
see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyHeadersInOriginRequestPolicyException
- The number of headers in the origin request policy exceeds the maximum. For more information, see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyCookiesInOriginRequestPolicyException
- The number of cookies in the origin request policy exceeds the maximum. For more information, see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyQueryStringsInOriginRequestPolicyException
- The number of query strings in the origin request policy exceeds the maximum. For more information, see
Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.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 CreateOriginRequestPolicyResponse createOriginRequestPolicy(Consumer<CreateOriginRequestPolicyRequest.Builder> createOriginRequestPolicyRequest) throws AccessDeniedException, InconsistentQuantitiesException, InvalidArgumentException, OriginRequestPolicyAlreadyExistsException, TooManyOriginRequestPoliciesException, TooManyHeadersInOriginRequestPolicyException, TooManyCookiesInOriginRequestPolicyException, TooManyQueryStringsInOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException
Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host
,
User-Agent
, and X-Amz-Cf-Id
.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can’t find a valid object in its cache that matches the request. If you want
to send values to the origin and also include them in the cache key, use CachePolicy
.
For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the CreateOriginRequestPolicyRequest.Builder
avoiding
the need to create one manually via CreateOriginRequestPolicyRequest.builder()
createOriginRequestPolicyRequest
- A Consumer
that will call methods on CreateOriginRequestPolicyRequest.Builder
to create a
request.AccessDeniedException
- Access denied.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.OriginRequestPolicyAlreadyExistsException
- An origin request policy with this name already exists. You must provide a unique name. To modify an
existing origin request policy, use UpdateOriginRequestPolicy
.TooManyOriginRequestPoliciesException
- You have reached the maximum number of origin request policies for this account. For more information,
see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyHeadersInOriginRequestPolicyException
- The number of headers in the origin request policy exceeds the maximum. For more information, see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyCookiesInOriginRequestPolicyException
- The number of cookies in the origin request policy exceeds the maximum. For more information, see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyQueryStringsInOriginRequestPolicyException
- The number of query strings in the origin request policy exceeds the maximum. For more information, see
Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.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
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
createPublicKeyRequest
- PublicKeyAlreadyExistsException
- The specified public key already exists.InvalidArgumentException
- An argument is invalid.TooManyPublicKeysException
- The maximum number of public keys for field-level encryption have been created. To create a new public
key, delete one of the existing keys.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
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
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
- An argument is invalid.TooManyPublicKeysException
- The maximum number of public keys for field-level encryption have been created. To create a new public
key, delete one of the existing keys.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 CreateRealtimeLogConfigResponse createRealtimeLogConfig(CreateRealtimeLogConfigRequest createRealtimeLogConfigRequest) throws RealtimeLogConfigAlreadyExistsException, TooManyRealtimeLogConfigsException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
createRealtimeLogConfigRequest
- RealtimeLogConfigAlreadyExistsException
- A real-time log configuration with this name already exists. You must provide a unique name. To modify an
existing real-time log configuration, use UpdateRealtimeLogConfig
.TooManyRealtimeLogConfigsException
- You have reached the maximum number of real-time log configurations for this account. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidArgumentException
- An argument is invalid.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 CreateRealtimeLogConfigResponse createRealtimeLogConfig(Consumer<CreateRealtimeLogConfigRequest.Builder> createRealtimeLogConfigRequest) throws RealtimeLogConfigAlreadyExistsException, TooManyRealtimeLogConfigsException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the CreateRealtimeLogConfigRequest.Builder
avoiding
the need to create one manually via CreateRealtimeLogConfigRequest.builder()
createRealtimeLogConfigRequest
- A Consumer
that will call methods on CreateRealtimeLogConfigRequest.Builder
to create a
request.RealtimeLogConfigAlreadyExistsException
- A real-time log configuration with this name already exists. You must provide a unique name. To modify an
existing real-time log configuration, use UpdateRealtimeLogConfig
.TooManyRealtimeLogConfigsException
- You have reached the maximum number of real-time log configurations for this account. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidArgumentException
- An argument is invalid.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 CreateStreamingDistributionResponse createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest) throws CnameAlreadyExistsException, StreamingDistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, MissingBodyException, TooManyStreamingDistributionCnamEsException, TooManyStreamingDistributionsException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
createStreamingDistributionRequest
- The request to create a new streaming distribution.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.StreamingDistributionAlreadyExistsException
- The caller reference you attempted to create the streaming distribution with is associated with another
distributionInvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyStreamingDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyStreamingDistributionsException
- Processing your request would cause you to exceed the maximum number of streaming distributions allowed.InvalidArgumentException
- An argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.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
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
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
- An 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
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
createStreamingDistributionWithTagsRequest
- The request to create a new streaming distribution with tags.CnameAlreadyExistsException
- The CNAME specified is already defined for CloudFront.StreamingDistributionAlreadyExistsException
- The caller reference you attempted to create the streaming distribution with is associated with another
distributionInvalidOriginException
- The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.AccessDeniedException
- Access denied.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.TooManyStreamingDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.TooManyStreamingDistributionsException
- Processing your request would cause you to exceed the maximum number of streaming distributions allowed.InvalidArgumentException
- An argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidTaggingException
- The tagging specified is not valid.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
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
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
- An 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 DeleteCachePolicyResponse deleteCachePolicy(DeleteCachePolicyRequest deleteCachePolicyRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchCachePolicyException, PreconditionFailedException, IllegalDeleteException, CachePolicyInUseException, AwsServiceException, SdkClientException, CloudFrontException
Deletes a cache policy.
You cannot delete a cache policy if it’s attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy’s identifier and version. To get these values, you can use
ListCachePolicies
or GetCachePolicy
.
deleteCachePolicyRequest
- AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchCachePolicyException
- The cache policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.IllegalDeleteException
- You cannot delete a managed policy.CachePolicyInUseException
- Cannot delete the cache policy because it is attached to one or more cache behaviors.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 DeleteCachePolicyResponse deleteCachePolicy(Consumer<DeleteCachePolicyRequest.Builder> deleteCachePolicyRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchCachePolicyException, PreconditionFailedException, IllegalDeleteException, CachePolicyInUseException, AwsServiceException, SdkClientException, CloudFrontException
Deletes a cache policy.
You cannot delete a cache policy if it’s attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy’s identifier and version. To get these values, you can use
ListCachePolicies
or GetCachePolicy
.
This is a convenience which creates an instance of the DeleteCachePolicyRequest.Builder
avoiding the need
to create one manually via DeleteCachePolicyRequest.builder()
deleteCachePolicyRequest
- A Consumer
that will call methods on DeleteCachePolicyRequest.Builder
to create a request.AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchCachePolicyException
- The cache policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.IllegalDeleteException
- You cannot delete a managed policy.CachePolicyInUseException
- Cannot delete the cache policy because it is attached to one or more cache behaviors.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.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.CloudFrontOriginAccessIdentityInUseException
- The Origin Access Identity specified is already in use.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.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.CloudFrontOriginAccessIdentityInUseException
- The Origin Access Identity specified is already in use.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.NoSuchDistributionException
- The specified distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request 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.NoSuchDistributionException
- The specified distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request 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.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FieldLevelEncryptionConfigInUseException
- The specified configuration for field-level encryption is in use.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.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FieldLevelEncryptionConfigInUseException
- The specified configuration for field-level encryption is in use.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.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FieldLevelEncryptionProfileInUseException
- The specified profile for field-level encryption is in use.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.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FieldLevelEncryptionProfileInUseException
- The specified profile for field-level encryption is in use.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 DeleteFunctionResponse deleteFunction(DeleteFunctionRequest deleteFunctionRequest) throws InvalidIfMatchVersionException, NoSuchFunctionExistsException, FunctionInUseException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Deletes a CloudFront function.
You cannot delete a function if it’s associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function’s name and version (ETag
value). To get these
values, you can use ListFunctions
and DescribeFunction
.
deleteFunctionRequest
- InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.FunctionInUseException
- Cannot delete the function because it’s attached to one or more cache behaviors.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default DeleteFunctionResponse deleteFunction(Consumer<DeleteFunctionRequest.Builder> deleteFunctionRequest) throws InvalidIfMatchVersionException, NoSuchFunctionExistsException, FunctionInUseException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Deletes a CloudFront function.
You cannot delete a function if it’s associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function’s name and version (ETag
value). To get these
values, you can use ListFunctions
and DescribeFunction
.
This is a convenience which creates an instance of the DeleteFunctionRequest.Builder
avoiding the need to
create one manually via DeleteFunctionRequest.builder()
deleteFunctionRequest
- A Consumer
that will call methods on DeleteFunctionRequest.Builder
to create a request.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.FunctionInUseException
- Cannot delete the function because it’s attached to one or more cache behaviors.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default DeleteKeyGroupResponse deleteKeyGroup(DeleteKeyGroupRequest deleteKeyGroupRequest) throws InvalidIfMatchVersionException, NoSuchResourceException, PreconditionFailedException, ResourceInUseException, AwsServiceException, SdkClientException, CloudFrontException
Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.
To delete a key group, you must provide the key group’s identifier and version. To get these values, use
ListKeyGroups
followed by GetKeyGroup
or GetKeyGroupConfig
.
deleteKeyGroupRequest
- InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchResourceException
- A resource that was specified is not valid.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.ResourceInUseException
- Cannot delete this resource because it is in use.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 DeleteKeyGroupResponse deleteKeyGroup(Consumer<DeleteKeyGroupRequest.Builder> deleteKeyGroupRequest) throws InvalidIfMatchVersionException, NoSuchResourceException, PreconditionFailedException, ResourceInUseException, AwsServiceException, SdkClientException, CloudFrontException
Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.
To delete a key group, you must provide the key group’s identifier and version. To get these values, use
ListKeyGroups
followed by GetKeyGroup
or GetKeyGroupConfig
.
This is a convenience which creates an instance of the DeleteKeyGroupRequest.Builder
avoiding the need to
create one manually via DeleteKeyGroupRequest.builder()
deleteKeyGroupRequest
- A Consumer
that will call methods on DeleteKeyGroupRequest.Builder
to create a request.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchResourceException
- A resource that was specified is not valid.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.ResourceInUseException
- Cannot delete this resource because it is in use.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 DeleteMonitoringSubscriptionResponse deleteMonitoringSubscription(DeleteMonitoringSubscriptionRequest deleteMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Disables additional CloudWatch metrics for the specified CloudFront distribution.
deleteMonitoringSubscriptionRequest
- AccessDeniedException
- Access denied.NoSuchDistributionException
- The specified distribution does not exist.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default DeleteMonitoringSubscriptionResponse deleteMonitoringSubscription(Consumer<DeleteMonitoringSubscriptionRequest.Builder> deleteMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Disables additional CloudWatch metrics for the specified CloudFront distribution.
This is a convenience which creates an instance of the DeleteMonitoringSubscriptionRequest.Builder
avoiding the need to create one manually via DeleteMonitoringSubscriptionRequest.builder()
deleteMonitoringSubscriptionRequest
- A Consumer
that will call methods on DeleteMonitoringSubscriptionRequest.Builder
to create
a request.AccessDeniedException
- Access denied.NoSuchDistributionException
- The specified distribution does not exist.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default DeleteOriginRequestPolicyResponse deleteOriginRequestPolicy(DeleteOriginRequestPolicyRequest deleteOriginRequestPolicyRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchOriginRequestPolicyException, PreconditionFailedException, IllegalDeleteException, OriginRequestPolicyInUseException, AwsServiceException, SdkClientException, CloudFrontException
Deletes an origin request policy.
You cannot delete an origin request policy if it’s attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.
To delete an origin request policy, you must provide the policy’s identifier and version. To get the identifier,
you can use ListOriginRequestPolicies
or GetOriginRequestPolicy
.
deleteOriginRequestPolicyRequest
- AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.IllegalDeleteException
- You cannot delete a managed policy.OriginRequestPolicyInUseException
- Cannot delete the origin request policy because it is attached to one or more cache behaviors.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 DeleteOriginRequestPolicyResponse deleteOriginRequestPolicy(Consumer<DeleteOriginRequestPolicyRequest.Builder> deleteOriginRequestPolicyRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchOriginRequestPolicyException, PreconditionFailedException, IllegalDeleteException, OriginRequestPolicyInUseException, AwsServiceException, SdkClientException, CloudFrontException
Deletes an origin request policy.
You cannot delete an origin request policy if it’s attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.
To delete an origin request policy, you must provide the policy’s identifier and version. To get the identifier,
you can use ListOriginRequestPolicies
or GetOriginRequestPolicy
.
This is a convenience which creates an instance of the DeleteOriginRequestPolicyRequest.Builder
avoiding
the need to create one manually via DeleteOriginRequestPolicyRequest.builder()
deleteOriginRequestPolicyRequest
- A Consumer
that will call methods on DeleteOriginRequestPolicyRequest.Builder
to create a
request.AccessDeniedException
- Access denied.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.IllegalDeleteException
- You cannot delete a managed policy.OriginRequestPolicyInUseException
- Cannot delete the origin request policy because it is attached to one or more cache behaviors.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.NoSuchPublicKeyException
- The specified public key doesn't exist.PreconditionFailedException
- The precondition in one or more of the request 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.NoSuchPublicKeyException
- The specified public key doesn't exist.PreconditionFailedException
- The precondition in one or more of the request 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 DeleteRealtimeLogConfigResponse deleteRealtimeLogConfig(DeleteRealtimeLogConfigRequest deleteRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, RealtimeLogConfigInUseException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it’s attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
deleteRealtimeLogConfigRequest
- NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigInUseException
- Cannot delete the real-time log configuration because it is attached to one or more cache behaviors.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.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 DeleteRealtimeLogConfigResponse deleteRealtimeLogConfig(Consumer<DeleteRealtimeLogConfigRequest.Builder> deleteRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, RealtimeLogConfigInUseException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it’s attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
This is a convenience which creates an instance of the DeleteRealtimeLogConfigRequest.Builder
avoiding
the need to create one manually via DeleteRealtimeLogConfigRequest.builder()
deleteRealtimeLogConfigRequest
- A Consumer
that will call methods on DeleteRealtimeLogConfigRequest.Builder
to create a
request.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigInUseException
- Cannot delete the real-time log configuration because it is attached to one or more cache behaviors.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.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.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request 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.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request 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 DescribeFunctionResponse describeFunction(DescribeFunctionRequest describeFunctionRequest) throws NoSuchFunctionExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Gets configuration information and metadata about a CloudFront function, but not the function’s code. To get a
function’s code, use GetFunction
.
To get configuration information and metadata about a function, you must provide the function’s name and stage.
To get these values, you can use ListFunctions
.
describeFunctionRequest
- NoSuchFunctionExistsException
- The function does not exist.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default DescribeFunctionResponse describeFunction(Consumer<DescribeFunctionRequest.Builder> describeFunctionRequest) throws NoSuchFunctionExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Gets configuration information and metadata about a CloudFront function, but not the function’s code. To get a
function’s code, use GetFunction
.
To get configuration information and metadata about a function, you must provide the function’s name and stage.
To get these values, you can use ListFunctions
.
This is a convenience which creates an instance of the DescribeFunctionRequest.Builder
avoiding the need
to create one manually via DescribeFunctionRequest.builder()
describeFunctionRequest
- A Consumer
that will call methods on DescribeFunctionRequest.Builder
to create a request.NoSuchFunctionExistsException
- The function does not exist.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default GetCachePolicyResponse getCachePolicy(GetCachePolicyRequest getCachePolicyRequest) throws AccessDeniedException, NoSuchCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException
Gets a cache policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy’s identifier. If the cache policy is attached to a
distribution’s cache behavior, you can get the policy’s identifier using ListDistributions
or
GetDistribution
. If the cache policy is not attached to a cache behavior, you can get the identifier
using ListCachePolicies
.
getCachePolicyRequest
- AccessDeniedException
- Access denied.NoSuchCachePolicyException
- The cache policy does not exist.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 GetCachePolicyResponse getCachePolicy(Consumer<GetCachePolicyRequest.Builder> getCachePolicyRequest) throws AccessDeniedException, NoSuchCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException
Gets a cache policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy’s identifier. If the cache policy is attached to a
distribution’s cache behavior, you can get the policy’s identifier using ListDistributions
or
GetDistribution
. If the cache policy is not attached to a cache behavior, you can get the identifier
using ListCachePolicies
.
This is a convenience which creates an instance of the GetCachePolicyRequest.Builder
avoiding the need to
create one manually via GetCachePolicyRequest.builder()
getCachePolicyRequest
- A Consumer
that will call methods on GetCachePolicyRequest.Builder
to create a request.AccessDeniedException
- Access denied.NoSuchCachePolicyException
- The cache policy does not 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 GetCachePolicyConfigResponse getCachePolicyConfig(GetCachePolicyConfigRequest getCachePolicyConfigRequest) throws AccessDeniedException, NoSuchCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException
Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy’s identifier. If the cache policy is attached to
a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions
or
GetDistribution
. If the cache policy is not attached to a cache behavior, you can get the identifier
using ListCachePolicies
.
getCachePolicyConfigRequest
- AccessDeniedException
- Access denied.NoSuchCachePolicyException
- The cache policy does not exist.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 GetCachePolicyConfigResponse getCachePolicyConfig(Consumer<GetCachePolicyConfigRequest.Builder> getCachePolicyConfigRequest) throws AccessDeniedException, NoSuchCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException
Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy’s identifier. If the cache policy is attached to
a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions
or
GetDistribution
. If the cache policy is not attached to a cache behavior, you can get the identifier
using ListCachePolicies
.
This is a convenience which creates an instance of the GetCachePolicyConfigRequest.Builder
avoiding the
need to create one manually via GetCachePolicyConfigRequest.builder()
getCachePolicyConfigRequest
- A Consumer
that will call methods on GetCachePolicyConfigRequest.Builder
to create a
request.AccessDeniedException
- Access denied.NoSuchCachePolicyException
- The cache policy does not 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 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 GetFunctionResponse getFunction(GetFunctionRequest getFunctionRequest) throws NoSuchFunctionExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Gets the code of a CloudFront function. To get configuration information and metadata about a function, use
DescribeFunction
.
To get a function’s code, you must provide the function’s name and stage. To get these values, you can use
ListFunctions
.
getFunctionRequest
- NoSuchFunctionExistsException
- The function does not exist.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default GetFunctionResponse getFunction(Consumer<GetFunctionRequest.Builder> getFunctionRequest) throws NoSuchFunctionExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Gets the code of a CloudFront function. To get configuration information and metadata about a function, use
DescribeFunction
.
To get a function’s code, you must provide the function’s name and stage. To get these values, you can use
ListFunctions
.
This is a convenience which creates an instance of the GetFunctionRequest.Builder
avoiding the need to
create one manually via GetFunctionRequest.builder()
getFunctionRequest
- A Consumer
that will call methods on GetFunctionRequest.Builder
to create a request.NoSuchFunctionExistsException
- The function does not exist.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
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 GetKeyGroupResponse getKeyGroup(GetKeyGroupRequest getKeyGroupRequest) throws NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException
Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group’s identifier. If the key group is referenced in a
distribution’s cache behavior, you can get the key group’s identifier using ListDistributions
or
GetDistribution
. If the key group is not referenced in a cache behavior, you can get the identifier
using ListKeyGroups
.
getKeyGroupRequest
- NoSuchResourceException
- A resource that was specified is not valid.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 GetKeyGroupResponse getKeyGroup(Consumer<GetKeyGroupRequest.Builder> getKeyGroupRequest) throws NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException
Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group’s identifier. If the key group is referenced in a
distribution’s cache behavior, you can get the key group’s identifier using ListDistributions
or
GetDistribution
. If the key group is not referenced in a cache behavior, you can get the identifier
using ListKeyGroups
.
This is a convenience which creates an instance of the GetKeyGroupRequest.Builder
avoiding the need to
create one manually via GetKeyGroupRequest.builder()
getKeyGroupRequest
- A Consumer
that will call methods on GetKeyGroupRequest.Builder
to create a request.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 GetKeyGroupConfigResponse getKeyGroupConfig(GetKeyGroupConfigRequest getKeyGroupConfigRequest) throws NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException
Gets a key group configuration.
To get a key group configuration, you must provide the key group’s identifier. If the key group is referenced in
a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions
or
GetDistribution
. If the key group is not referenced in a cache behavior, you can get the identifier
using ListKeyGroups
.
getKeyGroupConfigRequest
- NoSuchResourceException
- A resource that was specified is not valid.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 GetKeyGroupConfigResponse getKeyGroupConfig(Consumer<GetKeyGroupConfigRequest.Builder> getKeyGroupConfigRequest) throws NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException
Gets a key group configuration.
To get a key group configuration, you must provide the key group’s identifier. If the key group is referenced in
a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions
or
GetDistribution
. If the key group is not referenced in a cache behavior, you can get the identifier
using ListKeyGroups
.
This is a convenience which creates an instance of the GetKeyGroupConfigRequest.Builder
avoiding the need
to create one manually via GetKeyGroupConfigRequest.builder()
getKeyGroupConfigRequest
- A Consumer
that will call methods on GetKeyGroupConfigRequest.Builder
to create a request.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 GetMonitoringSubscriptionResponse getMonitoringSubscription(GetMonitoringSubscriptionRequest getMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
getMonitoringSubscriptionRequest
- AccessDeniedException
- Access denied.NoSuchDistributionException
- The specified distribution does not exist.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default GetMonitoringSubscriptionResponse getMonitoringSubscription(Consumer<GetMonitoringSubscriptionRequest.Builder> getMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
This is a convenience which creates an instance of the GetMonitoringSubscriptionRequest.Builder
avoiding
the need to create one manually via GetMonitoringSubscriptionRequest.builder()
getMonitoringSubscriptionRequest
- A Consumer
that will call methods on GetMonitoringSubscriptionRequest.Builder
to create a
request.AccessDeniedException
- Access denied.NoSuchDistributionException
- The specified distribution does not exist.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default GetOriginRequestPolicyResponse getOriginRequestPolicy(GetOriginRequestPolicyRequest getOriginRequestPolicyRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException
Gets an origin request policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
To get an origin request policy, you must provide the policy’s identifier. If the origin request policy is
attached to a distribution’s cache behavior, you can get the policy’s identifier using
ListDistributions
or GetDistribution
. If the origin request policy is not attached to a
cache behavior, you can get the identifier using ListOriginRequestPolicies
.
getOriginRequestPolicyRequest
- AccessDeniedException
- Access denied.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.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 GetOriginRequestPolicyResponse getOriginRequestPolicy(Consumer<GetOriginRequestPolicyRequest.Builder> getOriginRequestPolicyRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException
Gets an origin request policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
To get an origin request policy, you must provide the policy’s identifier. If the origin request policy is
attached to a distribution’s cache behavior, you can get the policy’s identifier using
ListDistributions
or GetDistribution
. If the origin request policy is not attached to a
cache behavior, you can get the identifier using ListOriginRequestPolicies
.
This is a convenience which creates an instance of the GetOriginRequestPolicyRequest.Builder
avoiding the
need to create one manually via GetOriginRequestPolicyRequest.builder()
getOriginRequestPolicyRequest
- A Consumer
that will call methods on GetOriginRequestPolicyRequest.Builder
to create a
request.AccessDeniedException
- Access denied.NoSuchOriginRequestPolicyException
- The origin request policy does not 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 GetOriginRequestPolicyConfigResponse getOriginRequestPolicyConfig(GetOriginRequestPolicyConfigRequest getOriginRequestPolicyConfigRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException
Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy’s identifier. If the origin request
policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using
ListDistributions
or GetDistribution
. If the origin request policy is not attached to a
cache behavior, you can get the identifier using ListOriginRequestPolicies
.
getOriginRequestPolicyConfigRequest
- AccessDeniedException
- Access denied.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.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 GetOriginRequestPolicyConfigResponse getOriginRequestPolicyConfig(Consumer<GetOriginRequestPolicyConfigRequest.Builder> getOriginRequestPolicyConfigRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException
Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy’s identifier. If the origin request
policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using
ListDistributions
or GetDistribution
. If the origin request policy is not attached to a
cache behavior, you can get the identifier using ListOriginRequestPolicies
.
This is a convenience which creates an instance of the GetOriginRequestPolicyConfigRequest.Builder
avoiding the need to create one manually via GetOriginRequestPolicyConfigRequest.builder()
getOriginRequestPolicyConfigRequest
- A Consumer
that will call methods on GetOriginRequestPolicyConfigRequest.Builder
to create
a request.AccessDeniedException
- Access denied.NoSuchOriginRequestPolicyException
- The origin request policy does not 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(GetPublicKeyRequest getPublicKeyRequest) throws AccessDeniedException, NoSuchPublicKeyException, AwsServiceException, SdkClientException, CloudFrontException
Gets a public key.
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
Gets a public key.
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
Gets a public key configuration.
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
Gets a public key configuration.
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 GetRealtimeLogConfigResponse getRealtimeLogConfig(GetRealtimeLogConfigRequest getRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Gets a real-time log configuration.
To get a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.
getRealtimeLogConfigRequest
- NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.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 GetRealtimeLogConfigResponse getRealtimeLogConfig(Consumer<GetRealtimeLogConfigRequest.Builder> getRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Gets a real-time log configuration.
To get a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.
This is a convenience which creates an instance of the GetRealtimeLogConfigRequest.Builder
avoiding the
need to create one manually via GetRealtimeLogConfigRequest.builder()
getRealtimeLogConfigRequest
- A Consumer
that will call methods on GetRealtimeLogConfigRequest.Builder
to create a
request.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.InvalidArgumentException
- An argument is invalid.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(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 ListCachePoliciesResponse listCachePolicies(ListCachePoliciesRequest listCachePoliciesRequest) throws AccessDeniedException, NoSuchCachePolicyException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listCachePoliciesRequest
- AccessDeniedException
- Access denied.NoSuchCachePolicyException
- The cache policy does not exist.InvalidArgumentException
- An argument is invalid.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 ListCachePoliciesResponse listCachePolicies(Consumer<ListCachePoliciesRequest.Builder> listCachePoliciesRequest) throws AccessDeniedException, NoSuchCachePolicyException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListCachePoliciesRequest.Builder
avoiding the need
to create one manually via ListCachePoliciesRequest.builder()
listCachePoliciesRequest
- A Consumer
that will call methods on ListCachePoliciesRequest.Builder
to create a request.AccessDeniedException
- Access denied.NoSuchCachePolicyException
- The cache policy does not exist.InvalidArgumentException
- An 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() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Lists origin access identities.
InvalidArgumentException
- An 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
- An 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
- An 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 ListConflictingAliasesResponse listConflictingAliases(ListConflictingAliasesRequest listConflictingAliasesRequest) throws InvalidArgumentException, NoSuchDistributionException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don’t own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided
alias. For example, if you provide www.example.com
as input, the returned list can include
www.example.com
and the overlapping wildcard alternate domain name (*.example.com
), if
they exist. If you provide *.example.com
as input, the returned list can include
*.example.com
and any alternate domain names covered by that wildcard (for example,
www.example.com
, test.example.com
, dev.example.com
, and so on), if they
exist.
To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listConflictingAliasesRequest
- InvalidArgumentException
- An argument is invalid.NoSuchDistributionException
- The specified distribution does not exist.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 ListConflictingAliasesResponse listConflictingAliases(Consumer<ListConflictingAliasesRequest.Builder> listConflictingAliasesRequest) throws InvalidArgumentException, NoSuchDistributionException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don’t own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided
alias. For example, if you provide www.example.com
as input, the returned list can include
www.example.com
and the overlapping wildcard alternate domain name (*.example.com
), if
they exist. If you provide *.example.com
as input, the returned list can include
*.example.com
and any alternate domain names covered by that wildcard (for example,
www.example.com
, test.example.com
, dev.example.com
, and so on), if they
exist.
To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListConflictingAliasesRequest.Builder
avoiding the
need to create one manually via ListConflictingAliasesRequest.builder()
listConflictingAliasesRequest
- A Consumer
that will call methods on ListConflictingAliasesRequest.Builder
to create a
request.InvalidArgumentException
- An argument is invalid.NoSuchDistributionException
- The specified distribution does not 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 ListDistributionsResponse listDistributions() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List CloudFront distributions.
InvalidArgumentException
- An 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
- An 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
- An 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 ListDistributionsByCachePolicyIdResponse listDistributionsByCachePolicyId(ListDistributionsByCachePolicyIdRequest listDistributionsByCachePolicyIdRequest) throws NoSuchCachePolicyException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByCachePolicyIdRequest
- NoSuchCachePolicyException
- The cache policy does not exist.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.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 ListDistributionsByCachePolicyIdResponse listDistributionsByCachePolicyId(Consumer<ListDistributionsByCachePolicyIdRequest.Builder> listDistributionsByCachePolicyIdRequest) throws NoSuchCachePolicyException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListDistributionsByCachePolicyIdRequest.Builder
avoiding the need to create one manually via ListDistributionsByCachePolicyIdRequest.builder()
listDistributionsByCachePolicyIdRequest
- A Consumer
that will call methods on ListDistributionsByCachePolicyIdRequest.Builder
to
create a request.NoSuchCachePolicyException
- The cache policy does not exist.InvalidArgumentException
- An argument is invalid.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 ListDistributionsByKeyGroupResponse listDistributionsByKeyGroup(ListDistributionsByKeyGroupRequest listDistributionsByKeyGroupRequest) throws NoSuchResourceException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByKeyGroupRequest
- NoSuchResourceException
- A resource that was specified is not valid.InvalidArgumentException
- An argument is invalid.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 ListDistributionsByKeyGroupResponse listDistributionsByKeyGroup(Consumer<ListDistributionsByKeyGroupRequest.Builder> listDistributionsByKeyGroupRequest) throws NoSuchResourceException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListDistributionsByKeyGroupRequest.Builder
avoiding the need to create one manually via ListDistributionsByKeyGroupRequest.builder()
listDistributionsByKeyGroupRequest
- A Consumer
that will call methods on ListDistributionsByKeyGroupRequest.Builder
to create
a request.NoSuchResourceException
- A resource that was specified is not valid.InvalidArgumentException
- An 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 ListDistributionsByOriginRequestPolicyIdResponse listDistributionsByOriginRequestPolicyId(ListDistributionsByOriginRequestPolicyIdRequest listDistributionsByOriginRequestPolicyIdRequest) throws NoSuchOriginRequestPolicyException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByOriginRequestPolicyIdRequest
- NoSuchOriginRequestPolicyException
- The origin request policy does not exist.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.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 ListDistributionsByOriginRequestPolicyIdResponse listDistributionsByOriginRequestPolicyId(Consumer<ListDistributionsByOriginRequestPolicyIdRequest.Builder> listDistributionsByOriginRequestPolicyIdRequest) throws NoSuchOriginRequestPolicyException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByOriginRequestPolicyIdRequest.Builder
avoiding the need to create one manually via
ListDistributionsByOriginRequestPolicyIdRequest.builder()
listDistributionsByOriginRequestPolicyIdRequest
- A Consumer
that will call methods on
ListDistributionsByOriginRequestPolicyIdRequest.Builder
to create a request.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.InvalidArgumentException
- An argument is invalid.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 ListDistributionsByRealtimeLogConfigResponse listDistributionsByRealtimeLogConfig(ListDistributionsByRealtimeLogConfigRequest listDistributionsByRealtimeLogConfigRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByRealtimeLogConfigRequest
- InvalidArgumentException
- An argument is invalid.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 ListDistributionsByRealtimeLogConfigResponse listDistributionsByRealtimeLogConfig(Consumer<ListDistributionsByRealtimeLogConfigRequest.Builder> listDistributionsByRealtimeLogConfigRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByRealtimeLogConfigRequest.Builder
avoiding the need to create one manually via
ListDistributionsByRealtimeLogConfigRequest.builder()
listDistributionsByRealtimeLogConfigRequest
- A Consumer
that will call methods on ListDistributionsByRealtimeLogConfigRequest.Builder
to create a request.InvalidArgumentException
- An 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 WAF web ACL.
listDistributionsByWebAclIdRequest
- The request to list distributions that are associated with a specified WAF web ACL.InvalidArgumentException
- An argument is invalid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use
the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.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 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 WAF web ACL.InvalidArgumentException
- An argument is invalid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use
the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.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
- An 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
- An 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
- An 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
- An 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
- An 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
- An 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 ListFunctionsResponse listFunctions(ListFunctionsRequest listFunctionsRequest) throws InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of all CloudFront functions in your account.
You can optionally apply a filter to return only the functions that are in the specified stage, either
DEVELOPMENT
or LIVE
.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listFunctionsRequest
- InvalidArgumentException
- An argument is invalid.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default ListFunctionsResponse listFunctions(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest) throws InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of all CloudFront functions in your account.
You can optionally apply a filter to return only the functions that are in the specified stage, either
DEVELOPMENT
or LIVE
.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListFunctionsRequest.Builder
avoiding the need to
create one manually via ListFunctionsRequest.builder()
listFunctionsRequest
- A Consumer
that will call methods on ListFunctionsRequest.Builder
to create a request.InvalidArgumentException
- An argument is invalid.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default ListInvalidationsResponse listInvalidations(ListInvalidationsRequest listInvalidationsRequest) throws InvalidArgumentException, NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Lists invalidation batches.
listInvalidationsRequest
- The request to list invalidations.InvalidArgumentException
- An 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
- An 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 ListKeyGroupsResponse listKeyGroups(ListKeyGroupsRequest listKeyGroupsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listKeyGroupsRequest
- InvalidArgumentException
- An argument is invalid.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 ListKeyGroupsResponse listKeyGroups(Consumer<ListKeyGroupsRequest.Builder> listKeyGroupsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListKeyGroupsRequest.Builder
avoiding the need to
create one manually via ListKeyGroupsRequest.builder()
listKeyGroupsRequest
- A Consumer
that will call methods on ListKeyGroupsRequest.Builder
to create a request.InvalidArgumentException
- An 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 ListOriginRequestPoliciesResponse listOriginRequestPolicies(ListOriginRequestPoliciesRequest listOriginRequestPoliciesRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listOriginRequestPoliciesRequest
- AccessDeniedException
- Access denied.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.InvalidArgumentException
- An argument is invalid.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 ListOriginRequestPoliciesResponse listOriginRequestPolicies(Consumer<ListOriginRequestPoliciesRequest.Builder> listOriginRequestPoliciesRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListOriginRequestPoliciesRequest.Builder
avoiding
the need to create one manually via ListOriginRequestPoliciesRequest.builder()
listOriginRequestPoliciesRequest
- A Consumer
that will call methods on ListOriginRequestPoliciesRequest.Builder
to create a
request.AccessDeniedException
- Access denied.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.InvalidArgumentException
- An 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() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List all public keys that have been added to CloudFront for this account.
InvalidArgumentException
- An 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
- An 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
- An 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 ListRealtimeLogConfigsResponse listRealtimeLogConfigs(ListRealtimeLogConfigsRequest listRealtimeLogConfigsRequest) throws InvalidArgumentException, AccessDeniedException, NoSuchRealtimeLogConfigException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of real-time log configurations.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listRealtimeLogConfigsRequest
- InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.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 ListRealtimeLogConfigsResponse listRealtimeLogConfigs(Consumer<ListRealtimeLogConfigsRequest.Builder> listRealtimeLogConfigsRequest) throws InvalidArgumentException, AccessDeniedException, NoSuchRealtimeLogConfigException, AwsServiceException, SdkClientException, CloudFrontException
Gets a list of real-time log configurations.
You can optionally specify the maximum number of items to receive in the response. If the total number of items
in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the
next page of items, send a subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
This is a convenience which creates an instance of the ListRealtimeLogConfigsRequest.Builder
avoiding the
need to create one manually via ListRealtimeLogConfigsRequest.builder()
listRealtimeLogConfigsRequest
- A Consumer
that will call methods on ListRealtimeLogConfigsRequest.Builder
to create a
request.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.NoSuchRealtimeLogConfigException
- The real-time log configuration does not 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 ListStreamingDistributionsResponse listStreamingDistributions() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException
List streaming distributions.
InvalidArgumentException
- An 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
- An 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
- An 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
- An 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
- An 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 PublishFunctionResponse publishFunction(PublishFunctionRequest publishFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Publishes a CloudFront function by copying the function code from the DEVELOPMENT
stage to
LIVE
. This automatically updates all cache behaviors that are using this function to use the newly
published copy in the LIVE
stage.
When a function is published to the LIVE
stage, you can attach the function to a distribution’s
cache behavior, using the function’s Amazon Resource Name (ARN).
To publish a function, you must provide the function’s name and version (ETag
value). To get these
values, you can use ListFunctions
and DescribeFunction
.
publishFunctionRequest
- InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default PublishFunctionResponse publishFunction(Consumer<PublishFunctionRequest.Builder> publishFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Publishes a CloudFront function by copying the function code from the DEVELOPMENT
stage to
LIVE
. This automatically updates all cache behaviors that are using this function to use the newly
published copy in the LIVE
stage.
When a function is published to the LIVE
stage, you can attach the function to a distribution’s
cache behavior, using the function’s Amazon Resource Name (ARN).
To publish a function, you must provide the function’s name and version (ETag
value). To get these
values, you can use ListFunctions
and DescribeFunction
.
This is a convenience which creates an instance of the PublishFunctionRequest.Builder
avoiding the need
to create one manually via PublishFunctionRequest.builder()
publishFunctionRequest
- A Consumer
that will call methods on PublishFunctionRequest.Builder
to create a request.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
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
- An 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
- An 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 TestFunctionResponse testFunction(TestFunctionRequest testFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, TestFunctionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Tests a CloudFront function.
To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function’s result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.
To test a function, you provide the function’s name and version (ETag
value) along with the event
object. To get the function’s name and version, you can use ListFunctions
and
DescribeFunction
.
testFunctionRequest
- InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.TestFunctionFailedException
- The CloudFront function failed.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default TestFunctionResponse testFunction(Consumer<TestFunctionRequest.Builder> testFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, TestFunctionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Tests a CloudFront function.
To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function’s result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.
To test a function, you provide the function’s name and version (ETag
value) along with the event
object. To get the function’s name and version, you can use ListFunctions
and
DescribeFunction
.
This is a convenience which creates an instance of the TestFunctionRequest.Builder
avoiding the need to
create one manually via TestFunctionRequest.builder()
testFunctionRequest
- A Consumer
that will call methods on TestFunctionRequest.Builder
to create a request.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.TestFunctionFailedException
- The CloudFront function failed.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
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
- An 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
- An 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 UpdateCachePolicyResponse updateCachePolicy(UpdateCachePolicyRequest updateCachePolicyRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchCachePolicyException, PreconditionFailedException, CachePolicyAlreadyExistsException, TooManyHeadersInCachePolicyException, TooManyCookiesInCachePolicyException, TooManyQueryStringsInCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException
Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
Use GetCachePolicyConfig
to get the current configuration.
Locally modify the fields in the cache policy configuration that you want to update.
Call UpdateCachePolicy
by providing the entire cache policy configuration, including the fields that
you modified and those that you didn’t.
updateCachePolicyRequest
- AccessDeniedException
- Access denied.IllegalUpdateException
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchCachePolicyException
- The cache policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.CachePolicyAlreadyExistsException
- A cache policy with this name already exists. You must provide a unique name. To modify an existing cache
policy, use UpdateCachePolicy
.TooManyHeadersInCachePolicyException
- The number of headers in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyCookiesInCachePolicyException
- The number of cookies in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyQueryStringsInCachePolicyException
- The number of query strings in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.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 UpdateCachePolicyResponse updateCachePolicy(Consumer<UpdateCachePolicyRequest.Builder> updateCachePolicyRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchCachePolicyException, PreconditionFailedException, CachePolicyAlreadyExistsException, TooManyHeadersInCachePolicyException, TooManyCookiesInCachePolicyException, TooManyQueryStringsInCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException
Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
Use GetCachePolicyConfig
to get the current configuration.
Locally modify the fields in the cache policy configuration that you want to update.
Call UpdateCachePolicy
by providing the entire cache policy configuration, including the fields that
you modified and those that you didn’t.
This is a convenience which creates an instance of the UpdateCachePolicyRequest.Builder
avoiding the need
to create one manually via UpdateCachePolicyRequest.builder()
updateCachePolicyRequest
- A Consumer
that will call methods on UpdateCachePolicyRequest.Builder
to create a request.AccessDeniedException
- Access denied.IllegalUpdateException
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchCachePolicyException
- The cache policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.CachePolicyAlreadyExistsException
- A cache policy with this name already exists. You must provide a unique name. To modify an existing cache
policy, use UpdateCachePolicy
.TooManyHeadersInCachePolicyException
- The number of headers in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyCookiesInCachePolicyException
- The number of cookies in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyQueryStringsInCachePolicyException
- The number of query strings in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.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
- The update contains modifications that are not allowed.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.InvalidArgumentException
- An argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.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
- The update contains modifications that are not allowed.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.NoSuchCloudFrontOriginAccessIdentityException
- The specified origin access identity does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.InvalidArgumentException
- An argument is invalid.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.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, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, 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
- The update contains modifications that are not allowed.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.NoSuchDistributionException
- The specified distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.TooManyDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- An argument is invalid.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use
the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda@Edge function
associations per owner to be exceeded.TooManyDistributionsWithSingleFunctionArnException
- The maximum number of distributions have been associated with the specified Lambda@Edge function.TooManyLambdaFunctionAssociationsException
- Your request contains more Lambda@Edge function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException
- The specified Lambda@Edge function association is invalid.TooManyDistributionsWithFunctionAssociationsException
- You have reached the maximum number of distributions that are associated with a CloudFront function. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyFunctionAssociationsException
- You have reached the maximum number of CloudFront function associations for this distribution. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidFunctionAssociationException
- A CloudFront function association is invalid.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.NoSuchCachePolicyException
- The cache policy does not exist.TooManyDistributionsAssociatedToCachePolicyException
- The maximum number of distributions have been associated with the specified cache policy. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.TooManyDistributionsAssociatedToOriginRequestPolicyException
- The maximum number of distributions have been associated with the specified origin request policy. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyDistributionsAssociatedToKeyGroupException
- The number of distributions that reference this key group is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyKeyGroupsAssociatedToDistributionException
- The number of key groups referenced by this distribution is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TrustedKeyGroupDoesNotExistException
- The specified key group does not exist.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigOwnerMismatchException
- The specified real-time log configuration belongs to a different account.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, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, 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
- The update contains modifications that are not allowed.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.NoSuchDistributionException
- The specified distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.TooManyDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.InvalidDefaultRootObjectException
- The default root object file name is too big or contains an invalid character.InvalidRelativePathException
- The relative path is too big, is not URL-encoded, or does not begin with a slash (/).InvalidErrorCodeException
- An invalid error code was specified.InvalidResponseCodeException
- A response code is not valid.InvalidArgumentException
- An argument is invalid.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.TooManyTrustedSignersException
- Your request contains more trusted signers than are allowed per distribution.TrustedSignerDoesNotExistException
- One or more of your trusted signers don't exist.InvalidViewerCertificateException
- A viewer certificate specified is not valid.InvalidMinimumProtocolVersionException
- The minimum protocol version specified is not valid.InvalidRequiredProtocolException
- This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request,
or omit the RequiredProtocols
element from your distribution configuration.NoSuchOriginException
- No origin exists with the specified Origin Id
.TooManyOriginsException
- You cannot create more origins for the distribution.TooManyOriginGroupsPerDistributionException
- Processing your request would cause you to exceed the maximum number of origin groups allowed.TooManyCacheBehaviorsException
- You cannot create more cache behaviors for the distribution.TooManyCookieNamesInWhiteListException
- Your request contains more cookie names in the whitelist than are allowed per cache behavior.InvalidForwardCookiesException
- Your request contains forward cookies option which doesn't match with the expectation for the
whitelisted
list of cookie names. Either list of cookie names has been specified when not
allowed or list of cookie names is missing when expected.TooManyHeadersInForwardedValuesException
- Your request contains too many headers in forwarded values.InvalidHeadersForS3OriginException
- The headers specified are not valid for an Amazon S3 origin.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.TooManyCertificatesException
- You cannot create anymore custom SSL/TLS certificates.InvalidLocationCodeException
- The location code specified is not valid.InvalidGeoRestrictionParameterException
- The specified geo restriction parameter is not valid.InvalidTtlOrderException
- The TTL order specified is not valid.InvalidWebAclIdException
- A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use
the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
. To specify a web ACL created using WAF Classic, use the ACL ID, for example
473e64fd-f30b-4765-81a0-62ad96dd167a
.TooManyOriginCustomHeadersException
- Your request contains too many origin custom headers.TooManyQueryStringParametersException
- Your request contains too many query string parameters.InvalidQueryStringParametersException
- The query string parameters specified are not valid.TooManyDistributionsWithLambdaAssociationsException
- Processing your request would cause the maximum number of distributions with Lambda@Edge function
associations per owner to be exceeded.TooManyDistributionsWithSingleFunctionArnException
- The maximum number of distributions have been associated with the specified Lambda@Edge function.TooManyLambdaFunctionAssociationsException
- Your request contains more Lambda@Edge function associations than are allowed per distribution.InvalidLambdaFunctionAssociationException
- The specified Lambda@Edge function association is invalid.TooManyDistributionsWithFunctionAssociationsException
- You have reached the maximum number of distributions that are associated with a CloudFront function. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyFunctionAssociationsException
- You have reached the maximum number of CloudFront function associations for this distribution. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.InvalidFunctionAssociationException
- A CloudFront function association is invalid.InvalidOriginReadTimeoutException
- The read timeout specified for the origin is not valid.InvalidOriginKeepaliveTimeoutException
- The keep alive timeout specified for the origin is not valid.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException
- The specified configuration for field-level encryption can't be associated with the specified cache
behavior.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException
- The maximum number of distributions have been associated with the specified configuration for field-level
encryption.NoSuchCachePolicyException
- The cache policy does not exist.TooManyDistributionsAssociatedToCachePolicyException
- The maximum number of distributions have been associated with the specified cache policy. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.TooManyDistributionsAssociatedToOriginRequestPolicyException
- The maximum number of distributions have been associated with the specified origin request policy. For
more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyDistributionsAssociatedToKeyGroupException
- The number of distributions that reference this key group is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyKeyGroupsAssociatedToDistributionException
- The number of key groups referenced by this distribution is more than the maximum allowed. For more
information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.TrustedKeyGroupDoesNotExistException
- The specified key group does not exist.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.RealtimeLogConfigOwnerMismatchException
- The specified real-time log configuration belongs to a different account.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
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.TooManyFieldLevelEncryptionQueryArgProfilesException
- The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException
- The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException
- No profile specified for the field-level encryption query argument.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
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.NoSuchFieldLevelEncryptionConfigException
- The specified configuration for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.TooManyFieldLevelEncryptionQueryArgProfilesException
- The maximum number of query arg profiles for field-level encryption have been created.TooManyFieldLevelEncryptionContentTypeProfilesException
- The maximum number of content type profiles for field-level encryption have been created.QueryArgProfileEmptyException
- No profile specified for the field-level encryption query argument.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
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchPublicKeyException
- The specified public key doesn't exist.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FieldLevelEncryptionProfileSizeExceededException
- The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionEncryptionEntitiesException
- The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException
- The maximum number of field patterns for field-level encryption have been created.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
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchPublicKeyException
- The specified public key doesn't exist.NoSuchFieldLevelEncryptionProfileException
- The specified profile for field-level encryption doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FieldLevelEncryptionProfileSizeExceededException
- The maximum size of a profile for field-level encryption was exceeded.TooManyFieldLevelEncryptionEncryptionEntitiesException
- The maximum number of encryption entities for field-level encryption have been created.TooManyFieldLevelEncryptionFieldPatternsException
- The maximum number of field patterns for field-level encryption have been created.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 UpdateFunctionResponse updateFunction(UpdateFunctionRequest updateFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, PreconditionFailedException, FunctionSizeLimitExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Updates a CloudFront function.
You can update a function’s code or the comment that describes the function. You cannot update a function’s name.
To update a function, you provide the function’s name and version (ETag
value) along with the
updated function code. To get the name and version, you can use ListFunctions
and
DescribeFunction
.
updateFunctionRequest
- InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FunctionSizeLimitExceededException
- The function is too large. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default UpdateFunctionResponse updateFunction(Consumer<UpdateFunctionRequest.Builder> updateFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, PreconditionFailedException, FunctionSizeLimitExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException
Updates a CloudFront function.
You can update a function’s code or the comment that describes the function. You cannot update a function’s name.
To update a function, you provide the function’s name and version (ETag
value) along with the
updated function code. To get the name and version, you can use ListFunctions
and
DescribeFunction
.
This is a convenience which creates an instance of the UpdateFunctionRequest.Builder
avoiding the need to
create one manually via UpdateFunctionRequest.builder()
updateFunctionRequest
- A Consumer
that will call methods on UpdateFunctionRequest.Builder
to create a request.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchFunctionExistsException
- The function does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.FunctionSizeLimitExceededException
- The function is too large. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.UnsupportedOperationException
- This operation is not supported in this region.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.UnsupportedOperationException
AwsServiceException
default UpdateKeyGroupResponse updateKeyGroup(UpdateKeyGroupRequest updateKeyGroupRequest) throws InvalidIfMatchVersionException, NoSuchResourceException, PreconditionFailedException, KeyGroupAlreadyExistsException, InvalidArgumentException, TooManyPublicKeysInKeyGroupException, AwsServiceException, SdkClientException, CloudFrontException
Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
Get the current key group with GetKeyGroup
or GetKeyGroupConfig
.
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
Call UpdateKeyGroup
with the entire key group object, including the fields that you modified and
those that you didn’t.
updateKeyGroupRequest
- InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchResourceException
- A resource that was specified is not valid.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.KeyGroupAlreadyExistsException
- A key group with this name already exists. You must provide a unique name. To modify an existing key
group, use UpdateKeyGroup
.InvalidArgumentException
- An argument is invalid.TooManyPublicKeysInKeyGroupException
- The number of public keys in this key group is more than the maximum allowed. For more information, see
Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.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 UpdateKeyGroupResponse updateKeyGroup(Consumer<UpdateKeyGroupRequest.Builder> updateKeyGroupRequest) throws InvalidIfMatchVersionException, NoSuchResourceException, PreconditionFailedException, KeyGroupAlreadyExistsException, InvalidArgumentException, TooManyPublicKeysInKeyGroupException, AwsServiceException, SdkClientException, CloudFrontException
Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
Get the current key group with GetKeyGroup
or GetKeyGroupConfig
.
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
Call UpdateKeyGroup
with the entire key group object, including the fields that you modified and
those that you didn’t.
This is a convenience which creates an instance of the UpdateKeyGroupRequest.Builder
avoiding the need to
create one manually via UpdateKeyGroupRequest.builder()
updateKeyGroupRequest
- A Consumer
that will call methods on UpdateKeyGroupRequest.Builder
to create a request.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchResourceException
- A resource that was specified is not valid.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.KeyGroupAlreadyExistsException
- A key group with this name already exists. You must provide a unique name. To modify an existing key
group, use UpdateKeyGroup
.InvalidArgumentException
- An argument is invalid.TooManyPublicKeysInKeyGroupException
- The number of public keys in this key group is more than the maximum allowed. For more information, see
Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.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 UpdateOriginRequestPolicyResponse updateOriginRequestPolicy(UpdateOriginRequestPolicyRequest updateOriginRequestPolicyRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchOriginRequestPolicyException, PreconditionFailedException, OriginRequestPolicyAlreadyExistsException, TooManyHeadersInOriginRequestPolicyException, TooManyCookiesInOriginRequestPolicyException, TooManyQueryStringsInOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException
Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
Use GetOriginRequestPolicyConfig
to get the current configuration.
Locally modify the fields in the origin request policy configuration that you want to update.
Call UpdateOriginRequestPolicy
by providing the entire origin request policy configuration,
including the fields that you modified and those that you didn’t.
updateOriginRequestPolicyRequest
- AccessDeniedException
- Access denied.IllegalUpdateException
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.OriginRequestPolicyAlreadyExistsException
- An origin request policy with this name already exists. You must provide a unique name. To modify an
existing origin request policy, use UpdateOriginRequestPolicy
.TooManyHeadersInOriginRequestPolicyException
- The number of headers in the origin request policy exceeds the maximum. For more information, see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyCookiesInOriginRequestPolicyException
- The number of cookies in the origin request policy exceeds the maximum. For more information, see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyQueryStringsInOriginRequestPolicyException
- The number of query strings in the origin request policy exceeds the maximum. For more information, see
Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.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 UpdateOriginRequestPolicyResponse updateOriginRequestPolicy(Consumer<UpdateOriginRequestPolicyRequest.Builder> updateOriginRequestPolicyRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchOriginRequestPolicyException, PreconditionFailedException, OriginRequestPolicyAlreadyExistsException, TooManyHeadersInOriginRequestPolicyException, TooManyCookiesInOriginRequestPolicyException, TooManyQueryStringsInOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException
Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
Use GetOriginRequestPolicyConfig
to get the current configuration.
Locally modify the fields in the origin request policy configuration that you want to update.
Call UpdateOriginRequestPolicy
by providing the entire origin request policy configuration,
including the fields that you modified and those that you didn’t.
This is a convenience which creates an instance of the UpdateOriginRequestPolicyRequest.Builder
avoiding
the need to create one manually via UpdateOriginRequestPolicyRequest.builder()
updateOriginRequestPolicyRequest
- A Consumer
that will call methods on UpdateOriginRequestPolicyRequest.Builder
to create a
request.AccessDeniedException
- Access denied.IllegalUpdateException
- The update contains modifications that are not allowed.InconsistentQuantitiesException
- The value of Quantity
and the size of Items
don't match.InvalidArgumentException
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.NoSuchOriginRequestPolicyException
- The origin request policy does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.OriginRequestPolicyAlreadyExistsException
- An origin request policy with this name already exists. You must provide a unique name. To modify an
existing origin request policy, use UpdateOriginRequestPolicy
.TooManyHeadersInOriginRequestPolicyException
- The number of headers in the origin request policy exceeds the maximum. For more information, see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyCookiesInOriginRequestPolicyException
- The number of cookies in the origin request policy exceeds the maximum. For more information, see Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.TooManyQueryStringsInOriginRequestPolicyException
- The number of query strings in the origin request policy exceeds the maximum. For more information, see
Quotas
(formerly known as limits) in the Amazon CloudFront Developer Guide.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
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.IllegalUpdateException
- The update contains modifications that are not allowed.NoSuchPublicKeyException
- The specified public key doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.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
- An argument is invalid.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.IllegalUpdateException
- The update contains modifications that are not allowed.NoSuchPublicKeyException
- The specified public key doesn't exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.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 UpdateRealtimeLogConfigResponse updateRealtimeLogConfig(UpdateRealtimeLogConfigRequest updateRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
Call GetRealtimeLogConfig
to get the current real-time log configuration.
Locally modify the parameters in the real-time log configuration that you want to update.
Call this API (UpdateRealtimeLogConfig
) by providing the entire real-time log configuration,
including the parameters that you modified and those that you didn’t.
You cannot update a real-time log configuration’s Name
or ARN
.
updateRealtimeLogConfigRequest
- NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.InvalidArgumentException
- An argument is invalid.AccessDeniedException
- Access denied.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 UpdateRealtimeLogConfigResponse updateRealtimeLogConfig(Consumer<UpdateRealtimeLogConfigRequest.Builder> updateRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException
Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
Call GetRealtimeLogConfig
to get the current real-time log configuration.
Locally modify the parameters in the real-time log configuration that you want to update.
Call this API (UpdateRealtimeLogConfig
) by providing the entire real-time log configuration,
including the parameters that you modified and those that you didn’t.
You cannot update a real-time log configuration’s Name
or ARN
.
This is a convenience which creates an instance of the UpdateRealtimeLogConfigRequest.Builder
avoiding
the need to create one manually via UpdateRealtimeLogConfigRequest.builder()
updateRealtimeLogConfigRequest
- A Consumer
that will call methods on UpdateRealtimeLogConfigRequest.Builder
to create a
request.NoSuchRealtimeLogConfigException
- The real-time log configuration does not exist.InvalidArgumentException
- An argument is invalid.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 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
- The update contains modifications that are not allowed.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.TooManyStreamingDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.InvalidArgumentException
- An argument is invalid.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.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
- The update contains modifications that are not allowed.InvalidIfMatchVersionException
- The If-Match
version is missing or not valid.MissingBodyException
- This operation requires a body. Ensure that the body is present and the Content-Type
header
is set.NoSuchStreamingDistributionException
- The specified streaming distribution does not exist.PreconditionFailedException
- The precondition in one or more of the request fields evaluated to false
.TooManyStreamingDistributionCnamEsException
- Your request contains more CNAMEs than are allowed per distribution.InvalidArgumentException
- An argument is invalid.InvalidOriginAccessIdentityException
- The origin access identity is not valid or doesn't exist.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()
default CloudFrontWaiter waiter()
CloudFrontWaiter
using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
CloudFrontWaiter
Copyright © 2021. All rights reserved.