Amazon CloudFront 2020-05-31
- Client: Aws\CloudFront\CloudFrontClient
- Service ID: cloudfront
- Version: 2020-05-31
This page describes the parameters and results for the operations of the Amazon CloudFront (2020-05-31), and shows how to use the Aws\CloudFront\CloudFrontClient object to call the described operations. This documentation is specific to the 2020-05-31 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AssociateAlias ( array $params = [] )
- Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
- CopyDistribution ( array $params = [] )
- Creates a staging distribution using the configuration of the provided primary distribution.
- CreateAnycastIpList ( array $params = [] )
- Creates an Anycast static IP list.
- CreateCachePolicy ( array $params = [] )
- Creates a cache policy.
- CreateCloudFrontOriginAccessIdentity ( array $params = [] )
- Creates a new origin access identity.
- CreateContinuousDeploymentPolicy ( array $params = [] )
- Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
- CreateDistribution ( array $params = [] )
- Creates a CloudFront distribution.
- CreateDistributionWithTags ( array $params = [] )
- Create a new distribution with tags.
- CreateFieldLevelEncryptionConfig ( array $params = [] )
- Create a new field-level encryption configuration.
- CreateFieldLevelEncryptionProfile ( array $params = [] )
- Create a field-level encryption profile.
- CreateFunction ( array $params = [] )
- Creates a CloudFront function.
- CreateInvalidation ( array $params = [] )
- Create a new invalidation.
- CreateKeyGroup ( array $params = [] )
- Creates a key group that you can use with CloudFront signed URLs and signed cookies.
- CreateKeyValueStore ( array $params = [] )
- Specifies the key value store resource to add to your account.
- CreateMonitoringSubscription ( array $params = [] )
- Enables additional CloudWatch metrics for the specified CloudFront distribution.
- CreateOriginAccessControl ( array $params = [] )
- Creates a new origin access control in CloudFront.
- CreateOriginRequestPolicy ( array $params = [] )
- Creates an origin request policy.
- CreatePublicKey ( array $params = [] )
- Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
- CreateRealtimeLogConfig ( array $params = [] )
- Creates a real-time log configuration.
- CreateResponseHeadersPolicy ( array $params = [] )
- Creates a response headers policy.
- CreateStreamingDistribution ( array $params = [] )
- This API is deprecated.
- CreateStreamingDistributionWithTags ( array $params = [] )
- This API is deprecated.
- CreateVpcOrigin ( array $params = [] )
- Create an Amazon CloudFront VPC origin.
- DeleteAnycastIpList ( array $params = [] )
- Deletes an Anycast static IP list.
- DeleteCachePolicy ( array $params = [] )
- Deletes a cache policy.
- DeleteCloudFrontOriginAccessIdentity ( array $params = [] )
- Delete an origin access identity.
- DeleteContinuousDeploymentPolicy ( array $params = [] )
- Deletes a continuous deployment policy.
- DeleteDistribution ( array $params = [] )
- Delete a distribution.
- DeleteFieldLevelEncryptionConfig ( array $params = [] )
- Remove a field-level encryption configuration.
- DeleteFieldLevelEncryptionProfile ( array $params = [] )
- Remove a field-level encryption profile.
- DeleteFunction ( array $params = [] )
- Deletes a CloudFront function.
- DeleteKeyGroup ( array $params = [] )
- Deletes a key group.
- DeleteKeyValueStore ( array $params = [] )
- Specifies the key value store to delete.
- DeleteMonitoringSubscription ( array $params = [] )
- Disables additional CloudWatch metrics for the specified CloudFront distribution.
- DeleteOriginAccessControl ( array $params = [] )
- Deletes a CloudFront origin access control.
- DeleteOriginRequestPolicy ( array $params = [] )
- Deletes an origin request policy.
- DeletePublicKey ( array $params = [] )
- Remove a public key you previously added to CloudFront.
- DeleteRealtimeLogConfig ( array $params = [] )
- Deletes a real-time log configuration.
- DeleteResponseHeadersPolicy ( array $params = [] )
- Deletes a response headers policy.
- DeleteStreamingDistribution ( array $params = [] )
- Delete a streaming distribution.
- DeleteVpcOrigin ( array $params = [] )
- Delete an Amazon CloudFront VPC origin.
- DescribeFunction ( array $params = [] )
- Gets configuration information and metadata about a CloudFront function, but not the function's code.
- DescribeKeyValueStore ( array $params = [] )
- Specifies the key value store and its configuration.
- GetAnycastIpList ( array $params = [] )
- Gets an Anycast static IP list.
- GetCachePolicy ( array $params = [] )
- Gets a cache policy, including the following metadata: The policy's identifier.
- GetCachePolicyConfig ( array $params = [] )
- Gets a cache policy configuration.
- GetCloudFrontOriginAccessIdentity ( array $params = [] )
- Get the information about an origin access identity.
- GetCloudFrontOriginAccessIdentityConfig ( array $params = [] )
- Get the configuration information about an origin access identity.
- GetContinuousDeploymentPolicy ( array $params = [] )
- Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
- GetContinuousDeploymentPolicyConfig ( array $params = [] )
- Gets configuration information about a continuous deployment policy.
- GetDistribution ( array $params = [] )
- Get the information about a distribution.
- GetDistributionConfig ( array $params = [] )
- Get the configuration information about a distribution.
- GetFieldLevelEncryption ( array $params = [] )
- Get the field-level encryption configuration information.
- GetFieldLevelEncryptionConfig ( array $params = [] )
- Get the field-level encryption configuration information.
- GetFieldLevelEncryptionProfile ( array $params = [] )
- Get the field-level encryption profile information.
- GetFieldLevelEncryptionProfileConfig ( array $params = [] )
- Get the field-level encryption profile configuration information.
- GetFunction ( array $params = [] )
- Gets the code of a CloudFront function.
- GetInvalidation ( array $params = [] )
- Get the information about an invalidation.
- GetKeyGroup ( array $params = [] )
- Gets a key group, including the date and time when the key group was last modified.
- GetKeyGroupConfig ( array $params = [] )
- Gets a key group configuration.
- GetMonitoringSubscription ( array $params = [] )
- Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
- GetOriginAccessControl ( array $params = [] )
- Gets a CloudFront origin access control, including its unique identifier.
- GetOriginAccessControlConfig ( array $params = [] )
- Gets a CloudFront origin access control configuration.
- GetOriginRequestPolicy ( array $params = [] )
- Gets an origin request policy, including the following metadata: The policy's identifier.
- GetOriginRequestPolicyConfig ( array $params = [] )
- Gets an origin request policy configuration.
- GetPublicKey ( array $params = [] )
- Gets a public key.
- GetPublicKeyConfig ( array $params = [] )
- Gets a public key configuration.
- GetRealtimeLogConfig ( array $params = [] )
- Gets a real-time log configuration.
- GetResponseHeadersPolicy ( array $params = [] )
- Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
- GetResponseHeadersPolicyConfig ( array $params = [] )
- Gets a response headers policy configuration.
- GetStreamingDistribution ( array $params = [] )
- Gets information about a specified RTMP distribution, including the distribution configuration.
- GetStreamingDistributionConfig ( array $params = [] )
- Get the configuration information about a streaming distribution.
- GetVpcOrigin ( array $params = [] )
- Get the details of an Amazon CloudFront VPC origin.
- ListAnycastIpLists ( array $params = [] )
- Lists your Anycast static IP lists.
- ListCachePolicies ( array $params = [] )
- Gets a list of cache policies.
- ListCloudFrontOriginAccessIdentities ( array $params = [] )
- Lists origin access identities.
- ListConflictingAliases ( array $params = [] )
- 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.
- ListContinuousDeploymentPolicies ( array $params = [] )
- Gets a list of the continuous deployment policies in your Amazon Web Services account.
- ListDistributions ( array $params = [] )
- List CloudFront distributions.
- ListDistributionsByAnycastIpListId ( array $params = [] )
- Lists the distributions in your account that are associated with the specified AnycastIpListId.
- ListDistributionsByCachePolicyId ( array $params = [] )
- Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.
- ListDistributionsByKeyGroup ( array $params = [] )
- Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
- ListDistributionsByOriginRequestPolicyId ( array $params = [] )
- Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy.
- ListDistributionsByRealtimeLogConfig ( array $params = [] )
- Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.
- ListDistributionsByResponseHeadersPolicyId ( array $params = [] )
- Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy.
- ListDistributionsByVpcOriginId ( array $params = [] )
- List CloudFront distributions by their VPC origin ID.
- ListDistributionsByWebACLId ( array $params = [] )
- List the distributions that are associated with a specified WAF web ACL.
- ListFieldLevelEncryptionConfigs ( array $params = [] )
- List all field-level encryption configurations that have been created in CloudFront for this account.
- ListFieldLevelEncryptionProfiles ( array $params = [] )
- Request a list of field-level encryption profiles that have been created in CloudFront for this account.
- ListFunctions ( array $params = [] )
- Gets a list of all CloudFront functions in your Amazon Web Services account.
- ListInvalidations ( array $params = [] )
- Lists invalidation batches.
- ListKeyGroups ( array $params = [] )
- Gets a list of key groups.
- ListKeyValueStores ( array $params = [] )
- Specifies the key value stores to list.
- ListOriginAccessControls ( array $params = [] )
- Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services account.
- ListOriginRequestPolicies ( array $params = [] )
- Gets a list of origin request policies.
- ListPublicKeys ( array $params = [] )
- List all public keys that have been added to CloudFront for this account.
- ListRealtimeLogConfigs ( array $params = [] )
- Gets a list of real-time log configurations.
- ListResponseHeadersPolicies ( array $params = [] )
- Gets a list of response headers policies.
- ListStreamingDistributions ( array $params = [] )
- List streaming distributions.
- ListTagsForResource ( array $params = [] )
- List tags for a CloudFront resource.
- ListVpcOrigins ( array $params = [] )
- List the CloudFront VPC origins in your account.
- PublishFunction ( array $params = [] )
- Publishes a CloudFront function by copying the function code from the DEVELOPMENT stage to LIVE.
- TagResource ( array $params = [] )
- Add tags to a CloudFront resource.
- TestFunction ( array $params = [] )
- Tests a CloudFront function.
- UntagResource ( array $params = [] )
- Remove tags from a CloudFront resource.
- UpdateCachePolicy ( array $params = [] )
- Updates a cache policy configuration.
- UpdateCloudFrontOriginAccessIdentity ( array $params = [] )
- Update an origin access identity.
- UpdateContinuousDeploymentPolicy ( array $params = [] )
- Updates a continuous deployment policy.
- UpdateDistribution ( array $params = [] )
- Updates the configuration for a CloudFront distribution.
- UpdateDistributionWithStagingConfig ( array $params = [] )
- Copies the staging distribution's configuration to its corresponding primary distribution.
- UpdateFieldLevelEncryptionConfig ( array $params = [] )
- Update a field-level encryption configuration.
- UpdateFieldLevelEncryptionProfile ( array $params = [] )
- Update a field-level encryption profile.
- UpdateFunction ( array $params = [] )
- Updates a CloudFront function.
- UpdateKeyGroup ( array $params = [] )
- Updates a key group.
- UpdateKeyValueStore ( array $params = [] )
- Specifies the key value store to update.
- UpdateOriginAccessControl ( array $params = [] )
- Updates a CloudFront origin access control.
- UpdateOriginRequestPolicy ( array $params = [] )
- Updates an origin request policy configuration.
- UpdatePublicKey ( array $params = [] )
- Update public key information.
- UpdateRealtimeLogConfig ( array $params = [] )
- Updates a real-time log configuration.
- UpdateResponseHeadersPolicy ( array $params = [] )
- Updates a response headers policy.
- UpdateStreamingDistribution ( array $params = [] )
- Update a streaming distribution.
- UpdateVpcOrigin ( array $params = [] )
- Update an Amazon CloudFront VPC origin in your account.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListInvalidations
- ListKeyValueStores
- ListPublicKeys
- ListStreamingDistributions
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
Waiter name | API Operation | Delay | Max Attempts |
---|---|---|---|
DistributionDeployed | GetDistribution | 60 | 35 |
InvalidationCompleted | GetInvalidation | 20 | 30 |
StreamingDistributionDeployed | GetStreamingDistribution | 60 | 25 |
Operations
AssociateAlias
$result = $client->associateAlias
([/* ... */]); $promise = $client->associateAliasAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->associateAlias([ 'Alias' => '<string>', // REQUIRED 'TargetDistributionId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Alias
-
- Required: Yes
- Type: string
The alias (also known as a CNAME) to add to the target distribution.
- TargetDistributionId
-
- Required: Yes
- Type: string
The ID of the distribution that you're associating the alias with.
Result Syntax
[]
Result Details
Errors
- NoSuchDistribution:
The specified distribution does not exist.
- AccessDenied:
Access denied.
- InvalidArgument:
An argument is invalid.
- TooManyDistributionCNAMEs:
Your request contains more CNAMEs than are allowed per distribution.
- IllegalUpdate:
The update contains modifications that are not allowed.
CopyDistribution
$result = $client->copyDistribution
([/* ... */]); $promise = $client->copyDistributionAsync
([/* ... */]);
Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow.
After you create a staging distribution, you can use UpdateDistribution
to modify the staging distribution's configuration. Then you can use CreateContinuousDeploymentPolicy
to incrementally move traffic to the staging distribution.
This API operation requires the following IAM permissions:
Parameter Syntax
$result = $client->copyDistribution([ 'CallerReference' => '<string>', // REQUIRED 'Enabled' => true || false, 'IfMatch' => '<string>', 'PrimaryDistributionId' => '<string>', // REQUIRED 'Staging' => true || false, ]);
Parameter Details
Members
- CallerReference
-
- Required: Yes
- Type: string
A value that uniquely identifies a request to create a resource. This helps to prevent CloudFront from creating a duplicate resource if you accidentally resubmit an identical request.
- Enabled
-
- Type: boolean
A Boolean flag to specify the state of the staging distribution when it's created. When you set this value to
True
, the staging distribution is enabled. When you set this value toFalse
, the staging distribution is disabled.If you omit this field, the default value is
True
. - IfMatch
-
- Type: string
The version identifier of the primary distribution whose configuration you are copying. This is the
ETag
value returned in the response toGetDistribution
andGetDistributionConfig
. - PrimaryDistributionId
-
- Required: Yes
- Type: string
The identifier of the primary distribution whose configuration you are copying. To get a distribution ID, use
ListDistributions
. - Staging
-
- Type: boolean
The type of distribution that your primary distribution will be copied to. The only valid value is
True
, indicating that you are copying to a staging distribution.
Result Syntax
[ 'Distribution' => [ 'ARN' => '<string>', 'ActiveTrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => [ [ 'KeyGroupId' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'ActiveTrustedSigners' => [ 'Enabled' => true || false, 'Items' => [ [ 'AwsAccountNumber' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'AliasICPRecordals' => [ [ 'CNAME' => '<string>', 'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING', ], // ... ], 'DistributionConfig' => [ 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], // ... ], 'Quantity' => <integer>, ], 'CallerReference' => '<string>', 'Comment' => '<string>', 'ContinuousDeploymentPolicyId' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'DefaultCacheBehavior' => [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], 'DefaultRootObject' => '<string>', 'Enabled' => true || false, 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'IsIPV6Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'IncludeCookies' => true || false, 'Prefix' => '<string>', ], 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ 'StatusCodes' => [ 'Items' => [<integer>, ...], 'Quantity' => <integer>, ], ], 'Id' => '<string>', 'Members' => [ 'Items' => [ [ 'OriginId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, ], 'Origins' => [ 'Items' => [ [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', 'HeaderValue' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'DomainName' => '<string>', 'Id' => '<string>', 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', ], ], // ... ], 'Quantity' => <integer>, ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, 'RestrictionType' => 'blacklist|whitelist|none', ], ], 'Staging' => true || false, 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], 'DomainName' => '<string>', 'Id' => '<string>', 'InProgressInvalidationBatches' => <integer>, 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', ], 'ETag' => '<string>', 'Location' => '<string>', ]
Result Details
Members
- Distribution
-
- Type: Distribution structure
A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
- ETag
-
- Type: string
The version identifier for the current version of the staging distribution.
- Location
-
- Type: string
The URL of the staging distribution.
Errors
- AccessDenied:
Access denied.
- TooManyDistributionsAssociatedToOriginAccessControl:
The maximum number of distributions have been associated with the specified origin access control.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- InvalidDefaultRootObject:
The default root object file name is too big or contains an invalid character.
- InvalidQueryStringParameters:
The query string parameters specified are not valid.
- TooManyTrustedSigners:
Your request contains more trusted signers than are allowed per distribution.
- TooManyCookieNamesInWhiteList:
Your request contains more cookie names in the whitelist than are allowed per cache behavior.
- NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
- InvalidErrorCode:
An invalid error code was specified.
- InvalidProtocolSettings:
You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).
- TooManyFunctionAssociations:
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.
- TooManyOriginCustomHeaders:
Your request contains too many origin custom headers.
- InvalidOrigin:
The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
- InvalidForwardCookies:
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.- InvalidMinimumProtocolVersion:
The minimum protocol version specified is not valid.
- NoSuchCachePolicy:
The cache policy does not exist.
- TooManyKeyGroupsAssociatedToDistribution:
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.
- TooManyDistributionsAssociatedToCachePolicy:
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.
- InvalidRequiredProtocol:
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.- TooManyDistributionsWithFunctionAssociations:
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.
- TooManyOriginGroupsPerDistribution:
Processing your request would cause you to exceed the maximum number of origin groups allowed.
- TooManyDistributions:
Processing your request would cause you to exceed the maximum number of distributions allowed.
- InvalidTTLOrder:
The TTL order specified is not valid.
- IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior:
The specified configuration for field-level encryption can't be associated with the specified cache behavior.
- InvalidOriginKeepaliveTimeout:
The keep alive timeout specified for the origin is not valid.
- InvalidArgument:
An argument is invalid.
- InvalidOriginReadTimeout:
The read timeout specified for the origin is not valid.
- InvalidOriginAccessControl:
The origin access control is not valid.
- InvalidHeadersForS3Origin:
The headers specified are not valid for an Amazon S3 origin.
- TrustedSignerDoesNotExist:
One or more of your trusted signers don't exist.
- InvalidWebACLId:
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 example473e64fd-f30b-4765-81a0-62ad96dd167a
.- TooManyDistributionsWithSingleFunctionARN:
The maximum number of distributions have been associated with the specified Lambda@Edge function.
- InvalidRelativePath:
The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
- TooManyLambdaFunctionAssociations:
Your request contains more Lambda@Edge function associations than are allowed per distribution.
- NoSuchDistribution:
The specified distribution does not exist.
- NoSuchOriginRequestPolicy:
The origin request policy does not exist.
- TooManyDistributionsAssociatedToFieldLevelEncryptionConfig:
The maximum number of distributions have been associated with the specified configuration for field-level encryption.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidLocationCode:
The location code specified is not valid.
- InvalidOriginAccessIdentity:
The origin access identity is not valid or doesn't exist.
- TooManyDistributionCNAMEs:
Your request contains more CNAMEs than are allowed per distribution.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.- TooManyDistributionsAssociatedToOriginRequestPolicy:
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.
- TooManyQueryStringParameters:
Your request contains too many query string parameters.
- RealtimeLogConfigOwnerMismatch:
The specified real-time log configuration belongs to a different Amazon Web Services account.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- MissingBody:
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.- TooManyHeadersInForwardedValues:
Your request contains too many headers in forwarded values.
- InvalidLambdaFunctionAssociation:
The specified Lambda@Edge function association is invalid.
- CNAMEAlreadyExists:
The CNAME specified is already defined for CloudFront.
- TooManyCertificates:
You cannot create anymore custom SSL/TLS certificates.
- TrustedKeyGroupDoesNotExist:
The specified key group does not exist.
- TooManyDistributionsAssociatedToResponseHeadersPolicy:
The maximum number of distributions have been associated with the specified response headers policy.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- NoSuchResponseHeadersPolicy:
The response headers policy does not exist.
- NoSuchRealtimeLogConfig:
The real-time log configuration does not exist.
- InvalidResponseCode:
A response code is not valid.
- InvalidGeoRestrictionParameter:
The specified geo restriction parameter is not valid.
- TooManyOrigins:
You cannot create more origins for the distribution.
- InvalidViewerCertificate:
A viewer certificate specified is not valid.
- InvalidFunctionAssociation:
A CloudFront function association is invalid.
- TooManyDistributionsWithLambdaAssociations:
Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.
- TooManyDistributionsAssociatedToKeyGroup:
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.
- DistributionAlreadyExists:
The caller reference you attempted to create the distribution with is associated with another distribution.
- NoSuchOrigin:
No origin exists with the specified
Origin Id
.- TooManyCacheBehaviors:
You cannot create more cache behaviors for the distribution.
CreateAnycastIpList
$result = $client->createAnycastIpList
([/* ... */]); $promise = $client->createAnycastIpListAsync
([/* ... */]);
Creates an Anycast static IP list.
Parameter Syntax
$result = $client->createAnycastIpList([ 'IpCount' => <integer>, // REQUIRED 'Name' => '<string>', // REQUIRED 'Tags' => [ 'Items' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], ], ]);
Parameter Details
Members
- IpCount
-
- Required: Yes
- Type: int
The number of static IP addresses that are allocated to the Anycast static IP list.
- Name
-
- Required: Yes
- Type: string
Name of the Anycast static IP list.
- Tags
-
- Type: Tags structure
A complex type that contains zero or more
Tag
elements.
Result Syntax
[ 'AnycastIpList' => [ 'AnycastIps' => ['<string>', ...], 'Arn' => '<string>', 'Id' => '<string>', 'IpCount' => <integer>, 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Status' => '<string>', ], 'ETag' => '<string>', ]
Result Details
Members
- AnycastIpList
-
- Type: AnycastIpList structure
A response structure that includes the version identifier (ETag) and the created AnycastIpList structure.
- ETag
-
- Type: string
The version identifier for the current version of the Anycast static IP list.
Errors
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- EntityAlreadyExists:
The entity already exists. You must provide a unique entity.
- InvalidTagging:
The tagging specified is not valid.
- InvalidArgument:
An argument is invalid.
- EntityLimitExceeded:
The entity limit has been exceeded.
CreateCachePolicy
$result = $client->createCachePolicy
([/* ... */]); $promise = $client->createCachePolicyAsync
([/* ... */]);
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 also 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.
Parameter Syntax
$result = $client->createCachePolicy([ 'CachePolicyConfig' => [ // REQUIRED 'Comment' => '<string>', 'DefaultTTL' => <integer>, 'MaxTTL' => <integer>, 'MinTTL' => <integer>, // REQUIRED 'Name' => '<string>', // REQUIRED 'ParametersInCacheKeyAndForwardedToOrigin' => [ 'CookiesConfig' => [ // REQUIRED 'CookieBehavior' => 'none|whitelist|allExcept|all', // REQUIRED 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'EnableAcceptEncodingBrotli' => true || false, 'EnableAcceptEncodingGzip' => true || false, // REQUIRED 'HeadersConfig' => [ // REQUIRED 'HeaderBehavior' => 'none|whitelist', // REQUIRED 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'QueryStringsConfig' => [ // REQUIRED 'QueryStringBehavior' => 'none|whitelist|allExcept|all', // REQUIRED 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], ], ], ]);
Parameter Details
Members
- CachePolicyConfig
-
- Required: Yes
- Type: CachePolicyConfig structure
A cache policy configuration.
Result Syntax
[ 'CachePolicy' => [ 'CachePolicyConfig' => [ 'Comment' => '<string>', 'DefaultTTL' => <integer>, 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'Name' => '<string>', 'ParametersInCacheKeyAndForwardedToOrigin' => [ 'CookiesConfig' => [ 'CookieBehavior' => 'none|whitelist|allExcept|all', 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'EnableAcceptEncodingBrotli' => true || false, 'EnableAcceptEncodingGzip' => true || false, 'HeadersConfig' => [ 'HeaderBehavior' => 'none|whitelist', 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'QueryStringsConfig' => [ 'QueryStringBehavior' => 'none|whitelist|allExcept|all', 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], 'ETag' => '<string>', 'Location' => '<string>', ]
Result Details
Members
- CachePolicy
-
- Type: CachePolicy structure
A cache policy.
- ETag
-
- Type: string
The current version of the cache policy.
- Location
-
- Type: string
The fully qualified URI of the cache policy just created.
Errors
- AccessDenied:
Access denied.
- TooManyHeadersInCachePolicy:
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.
- CachePolicyAlreadyExists:
A cache policy with this name already exists. You must provide a unique name. To modify an existing cache policy, use
UpdateCachePolicy
.- TooManyCookiesInCachePolicy:
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.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- TooManyCachePolicies:
You have reached the maximum number of cache policies for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- InvalidArgument:
An argument is invalid.
- TooManyQueryStringsInCachePolicy:
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.
CreateCloudFrontOriginAccessIdentity
$result = $client->createCloudFrontOriginAccessIdentity
([/* ... */]); $promise = $client->createCloudFrontOriginAccessIdentityAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createCloudFrontOriginAccessIdentity([ 'CloudFrontOriginAccessIdentityConfig' => [ // REQUIRED 'CallerReference' => '<string>', // REQUIRED 'Comment' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- CloudFrontOriginAccessIdentityConfig
-
- Required: Yes
- Type: CloudFrontOriginAccessIdentityConfig structure
The current configuration information for the identity.
Result Syntax
[ 'CloudFrontOriginAccessIdentity' => [ 'CloudFrontOriginAccessIdentityConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', ], 'Id' => '<string>', 'S3CanonicalUserId' => '<string>', ], 'ETag' => '<string>', 'Location' => '<string>', ]
Result Details
Members
- CloudFrontOriginAccessIdentity
-
- Type: CloudFrontOriginAccessIdentity structure
The origin access identity's information.
- ETag
-
- Type: string
The current version of the origin access identity created.
- Location
-
- Type: string
The fully qualified URI of the new origin access identity just created.
Errors
- MissingBody:
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.- TooManyCloudFrontOriginAccessIdentities:
Processing your request would cause you to exceed the maximum number of origin access identities allowed.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidArgument:
An argument is invalid.
- CloudFrontOriginAccessIdentityAlreadyExists:
If the
CallerReference
is a value you already sent in a previous request to create an identity but the content of theCloudFrontOriginAccessIdentityConfig
is different from the original request, CloudFront returns aCloudFrontOriginAccessIdentityAlreadyExists
error.
CreateContinuousDeploymentPolicy
$result = $client->createContinuousDeploymentPolicy
([/* ... */]); $promise = $client->createContinuousDeploymentPolicyAsync
([/* ... */]);
Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
To use a continuous deployment policy, first use CopyDistribution
to create a staging distribution, then use UpdateDistribution
to modify the staging distribution's configuration.
After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration.
Parameter Syntax
$result = $client->createContinuousDeploymentPolicy([ 'ContinuousDeploymentPolicyConfig' => [ // REQUIRED 'Enabled' => true || false, // REQUIRED 'StagingDistributionDnsNames' => [ // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'TrafficConfig' => [ 'SingleHeaderConfig' => [ 'Header' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], 'SingleWeightConfig' => [ 'SessionStickinessConfig' => [ 'IdleTTL' => <integer>, // REQUIRED 'MaximumTTL' => <integer>, // REQUIRED ], 'Weight' => <float>, // REQUIRED ], 'Type' => 'SingleWeight|SingleHeader', // REQUIRED ], ], ]);
Parameter Details
Members
- ContinuousDeploymentPolicyConfig
-
- Required: Yes
- Type: ContinuousDeploymentPolicyConfig structure
Contains the configuration for a continuous deployment policy.
Result Syntax
[ 'ContinuousDeploymentPolicy' => [ 'ContinuousDeploymentPolicyConfig' => [ 'Enabled' => true || false, 'StagingDistributionDnsNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrafficConfig' => [ 'SingleHeaderConfig' => [ 'Header' => '<string>', 'Value' => '<string>', ], 'SingleWeightConfig' => [ 'SessionStickinessConfig' => [ 'IdleTTL' => <integer>, 'MaximumTTL' => <integer>, ], 'Weight' => <float>, ], 'Type' => 'SingleWeight|SingleHeader', ], ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], 'ETag' => '<string>', 'Location' => '<string>', ]
Result Details
Members
- ContinuousDeploymentPolicy
-
- Type: ContinuousDeploymentPolicy structure
A continuous deployment policy.
- ETag
-
- Type: string
The version identifier for the current version of the continuous deployment policy.
- Location
-
- Type: string
The location of the continuous deployment policy.
Errors
- AccessDenied:
Access denied.
- TooManyContinuousDeploymentPolicies:
You have reached the maximum number of continuous deployment policies for this Amazon Web Services account.
- StagingDistributionInUse:
A continuous deployment policy for this staging distribution already exists.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- ContinuousDeploymentPolicyAlreadyExists:
A continuous deployment policy with this configuration already exists.
- InvalidArgument:
An argument is invalid.
CreateDistribution
$result = $client->createDistribution
([/* ... */]); $promise = $client->createDistributionAsync
([/* ... */]);
Creates a CloudFront distribution.
Parameter Syntax
$result = $client->createDistribution([ 'DistributionConfig' => [ // REQUIRED 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ // REQUIRED 'Forward' => 'none|whitelist|all', // REQUIRED 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'QueryString' => true || false, // REQUIRED 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'FunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'GrpcConfig' => [ 'Enabled' => true || false, // REQUIRED ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', // REQUIRED 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', // REQUIRED 'TrustedKeyGroups' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'TrustedSigners' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'CallerReference' => '<string>', // REQUIRED 'Comment' => '<string>', // REQUIRED 'ContinuousDeploymentPolicyId' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, // REQUIRED 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'DefaultCacheBehavior' => [ // REQUIRED 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ // REQUIRED 'Forward' => 'none|whitelist|all', // REQUIRED 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'QueryString' => true || false, // REQUIRED 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'FunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'GrpcConfig' => [ 'Enabled' => true || false, // REQUIRED ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', // REQUIRED 'TrustedKeyGroups' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'TrustedSigners' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED ], 'DefaultRootObject' => '<string>', 'Enabled' => true || false, // REQUIRED 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'IsIPV6Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'IncludeCookies' => true || false, 'Prefix' => '<string>', ], 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ // REQUIRED 'StatusCodes' => [ // REQUIRED 'Items' => [<integer>, ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], ], 'Id' => '<string>', // REQUIRED 'Members' => [ // REQUIRED 'Items' => [ // REQUIRED [ 'OriginId' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'Origins' => [ // REQUIRED 'Items' => [ // REQUIRED [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', // REQUIRED 'HeaderValue' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, // REQUIRED 'HTTPSPort' => <integer>, // REQUIRED 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', // REQUIRED 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], ], 'DomainName' => '<string>', // REQUIRED 'Id' => '<string>', // REQUIRED 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, // REQUIRED 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', // REQUIRED ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', // REQUIRED ], ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED 'RestrictionType' => 'blacklist|whitelist|none', // REQUIRED ], ], 'Staging' => true || false, 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], ]);
Parameter Details
Members
- DistributionConfig
-
- Required: Yes
- Type: DistributionConfig structure
The distribution's configuration information.
Result Syntax
[ 'Distribution' => [ 'ARN' => '<string>', 'ActiveTrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => [ [ 'KeyGroupId' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'ActiveTrustedSigners' => [ 'Enabled' => true || false, 'Items' => [ [ 'AwsAccountNumber' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'AliasICPRecordals' => [ [ 'CNAME' => '<string>', 'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING', ], // ... ], 'DistributionConfig' => [ 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], // ... ], 'Quantity' => <integer>, ], 'CallerReference' => '<string>', 'Comment' => '<string>', 'ContinuousDeploymentPolicyId' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'DefaultCacheBehavior' => [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], 'DefaultRootObject' => '<string>', 'Enabled' => true || false, 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'IsIPV6Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'IncludeCookies' => true || false, 'Prefix' => '<string>', ], 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ 'StatusCodes' => [ 'Items' => [<integer>, ...], 'Quantity' => <integer>, ], ], 'Id' => '<string>', 'Members' => [ 'Items' => [ [ 'OriginId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, ], 'Origins' => [ 'Items' => [ [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', 'HeaderValue' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'DomainName' => '<string>', 'Id' => '<string>', 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', ], ], // ... ], 'Quantity' => <integer>, ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, 'RestrictionType' => 'blacklist|whitelist|none', ], ], 'Staging' => true || false, 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], 'DomainName' => '<string>', 'Id' => '<string>', 'InProgressInvalidationBatches' => <integer>, 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', ], 'ETag' => '<string>', 'Location' => '<string>', ]
Result Details
Members
- Distribution
-
- Type: Distribution structure
The distribution's information.
- ETag
-
- Type: string
The current version of the distribution created.
- Location
-
- Type: string
The fully qualified URI of the new distribution resource just created.
Errors
- AccessDenied:
Access denied.
- TooManyDistributionsAssociatedToOriginAccessControl:
The maximum number of distributions have been associated with the specified origin access control.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- InvalidDefaultRootObject:
The default root object file name is too big or contains an invalid character.
- InvalidDomainNameForOriginAccessControl:
An origin access control is associated with an origin whose domain name is not supported.
- InvalidQueryStringParameters:
The query string parameters specified are not valid.
- TooManyTrustedSigners:
Your request contains more trusted signers than are allowed per distribution.
- TooManyCookieNamesInWhiteList:
Your request contains more cookie names in the whitelist than are allowed per cache behavior.
- NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
- InvalidErrorCode:
An invalid error code was specified.
- IllegalOriginAccessConfiguration:
An origin cannot contain both an origin access control (OAC) and an origin access identity (OAI).
- InvalidProtocolSettings:
You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).
- TooManyFunctionAssociations:
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.
- TooManyOriginCustomHeaders:
Your request contains too many origin custom headers.
- InvalidOrigin:
The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
- InvalidForwardCookies:
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.- InvalidMinimumProtocolVersion:
The minimum protocol version specified is not valid.
- NoSuchCachePolicy:
The cache policy does not exist.
- TooManyKeyGroupsAssociatedToDistribution:
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.
- TooManyDistributionsAssociatedToCachePolicy:
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.
- InvalidRequiredProtocol:
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.- TooManyDistributionsWithFunctionAssociations:
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.
- TooManyOriginGroupsPerDistribution:
Processing your request would cause you to exceed the maximum number of origin groups allowed.
- TooManyDistributions:
Processing your request would cause you to exceed the maximum number of distributions allowed.
- InvalidTTLOrder:
The TTL order specified is not valid.
- IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior:
The specified configuration for field-level encryption can't be associated with the specified cache behavior.
- InvalidOriginKeepaliveTimeout:
The keep alive timeout specified for the origin is not valid.
- InvalidArgument:
An argument is invalid.
- InvalidOriginReadTimeout:
The read timeout specified for the origin is not valid.
- InvalidOriginAccessControl:
The origin access control is not valid.
- EntityNotFound:
The entity was not found.
- InvalidHeadersForS3Origin:
The headers specified are not valid for an Amazon S3 origin.
- TrustedSignerDoesNotExist:
One or more of your trusted signers don't exist.
- InvalidWebACLId:
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 example473e64fd-f30b-4765-81a0-62ad96dd167a
.- TooManyDistributionsWithSingleFunctionARN:
The maximum number of distributions have been associated with the specified Lambda@Edge function.
- InvalidRelativePath:
The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
- TooManyLambdaFunctionAssociations:
Your request contains more Lambda@Edge function associations than are allowed per distribution.
- NoSuchOriginRequestPolicy:
The origin request policy does not exist.
- TooManyDistributionsAssociatedToFieldLevelEncryptionConfig:
The maximum number of distributions have been associated with the specified configuration for field-level encryption.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidLocationCode:
The location code specified is not valid.
- InvalidOriginAccessIdentity:
The origin access identity is not valid or doesn't exist.
- TooManyDistributionCNAMEs:
Your request contains more CNAMEs than are allowed per distribution.
- NoSuchContinuousDeploymentPolicy:
The continuous deployment policy doesn't exist.
- TooManyDistributionsAssociatedToOriginRequestPolicy:
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.
- TooManyQueryStringParameters:
Your request contains too many query string parameters.
- RealtimeLogConfigOwnerMismatch:
The specified real-time log configuration belongs to a different Amazon Web Services account.
- ContinuousDeploymentPolicyInUse:
You cannot delete a continuous deployment policy that is associated with a primary distribution.
- MissingBody:
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.- TooManyHeadersInForwardedValues:
Your request contains too many headers in forwarded values.
- InvalidLambdaFunctionAssociation:
The specified Lambda@Edge function association is invalid.
- CNAMEAlreadyExists:
The CNAME specified is already defined for CloudFront.
- TooManyCertificates:
You cannot create anymore custom SSL/TLS certificates.
- TrustedKeyGroupDoesNotExist:
The specified key group does not exist.
- TooManyDistributionsAssociatedToResponseHeadersPolicy:
The maximum number of distributions have been associated with the specified response headers policy.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- NoSuchResponseHeadersPolicy:
The response headers policy does not exist.
- NoSuchRealtimeLogConfig:
The real-time log configuration does not exist.
- InvalidResponseCode:
A response code is not valid.
- InvalidGeoRestrictionParameter:
The specified geo restriction parameter is not valid.
- TooManyOrigins:
You cannot create more origins for the distribution.
- InvalidViewerCertificate:
A viewer certificate specified is not valid.
- InvalidFunctionAssociation:
A CloudFront function association is invalid.
- TooManyDistributionsWithLambdaAssociations:
Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.
- TooManyDistributionsAssociatedToKeyGroup:
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.
- DistributionAlreadyExists:
The caller reference you attempted to create the distribution with is associated with another distribution.
- NoSuchOrigin:
No origin exists with the specified
Origin Id
.- TooManyCacheBehaviors:
You cannot create more cache behaviors for the distribution.
CreateDistributionWithTags
$result = $client->createDistributionWithTags
([/* ... */]); $promise = $client->createDistributionWithTagsAsync
([/* ... */]);
Create a new distribution with tags. This API operation requires the following IAM permissions:
Parameter Syntax
$result = $client->createDistributionWithTags([ 'DistributionConfigWithTags' => [ // REQUIRED 'DistributionConfig' => [ // REQUIRED 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ // REQUIRED 'Forward' => 'none|whitelist|all', // REQUIRED 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'QueryString' => true || false, // REQUIRED 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'FunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'GrpcConfig' => [ 'Enabled' => true || false, // REQUIRED ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', // REQUIRED 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', // REQUIRED 'TrustedKeyGroups' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'TrustedSigners' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'CallerReference' => '<string>', // REQUIRED 'Comment' => '<string>', // REQUIRED 'ContinuousDeploymentPolicyId' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, // REQUIRED 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'DefaultCacheBehavior' => [ // REQUIRED 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ // REQUIRED 'Forward' => 'none|whitelist|all', // REQUIRED 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'QueryString' => true || false, // REQUIRED 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'FunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'GrpcConfig' => [ 'Enabled' => true || false, // REQUIRED ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', // REQUIRED 'TrustedKeyGroups' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'TrustedSigners' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED ], 'DefaultRootObject' => '<string>', 'Enabled' => true || false, // REQUIRED 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'IsIPV6Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'IncludeCookies' => true || false, 'Prefix' => '<string>', ], 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ // REQUIRED 'StatusCodes' => [ // REQUIRED 'Items' => [<integer>, ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], ], 'Id' => '<string>', // REQUIRED 'Members' => [ // REQUIRED 'Items' => [ // REQUIRED [ 'OriginId' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'Origins' => [ // REQUIRED 'Items' => [ // REQUIRED [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', // REQUIRED 'HeaderValue' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, // REQUIRED 'HTTPSPort' => <integer>, // REQUIRED 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', // REQUIRED 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], ], 'DomainName' => '<string>', // REQUIRED 'Id' => '<string>', // REQUIRED 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, // REQUIRED 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', // REQUIRED ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', // REQUIRED ], ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED 'RestrictionType' => 'blacklist|whitelist|none', // REQUIRED ], ], 'Staging' => true || false, 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], 'Tags' => [ // REQUIRED 'Items' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], ], ], ]);
Parameter Details
Members
- DistributionConfigWithTags
-
- Required: Yes
- Type: DistributionConfigWithTags structure
The distribution's configuration information.
Result Syntax
[ 'Distribution' => [ 'ARN' => '<string>', 'ActiveTrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => [ [ 'KeyGroupId' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'ActiveTrustedSigners' => [ 'Enabled' => true || false, 'Items' => [ [ 'AwsAccountNumber' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'AliasICPRecordals' => [ [ 'CNAME' => '<string>', 'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING', ], // ... ], 'DistributionConfig' => [ 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], // ... ], 'Quantity' => <integer>, ], 'CallerReference' => '<string>', 'Comment' => '<string>', 'ContinuousDeploymentPolicyId' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'DefaultCacheBehavior' => [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], 'DefaultRootObject' => '<string>', 'Enabled' => true || false, 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'IsIPV6Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'IncludeCookies' => true || false, 'Prefix' => '<string>', ], 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ 'StatusCodes' => [ 'Items' => [<integer>, ...], 'Quantity' => <integer>, ], ], 'Id' => '<string>', 'Members' => [ 'Items' => [ [ 'OriginId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, ], 'Origins' => [ 'Items' => [ [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', 'HeaderValue' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'DomainName' => '<string>', 'Id' => '<string>', 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', ], ], // ... ], 'Quantity' => <integer>, ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, 'RestrictionType' => 'blacklist|whitelist|none', ], ], 'Staging' => true || false, 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], 'DomainName' => '<string>', 'Id' => '<string>', 'InProgressInvalidationBatches' => <integer>, 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', ], 'ETag' => '<string>', 'Location' => '<string>', ]
Result Details
Members
- Distribution
-
- Type: Distribution structure
The distribution's information.
- ETag
-
- Type: string
The current version of the distribution created.
- Location
-
- Type: string
The fully qualified URI of the new distribution resource just created.
Errors
- AccessDenied:
Access denied.
- TooManyDistributionsAssociatedToOriginAccessControl:
The maximum number of distributions have been associated with the specified origin access control.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- InvalidDefaultRootObject:
The default root object file name is too big or contains an invalid character.
- InvalidDomainNameForOriginAccessControl:
An origin access control is associated with an origin whose domain name is not supported.
- InvalidQueryStringParameters:
The query string parameters specified are not valid.
- TooManyTrustedSigners:
Your request contains more trusted signers than are allowed per distribution.
- TooManyCookieNamesInWhiteList:
Your request contains more cookie names in the whitelist than are allowed per cache behavior.
- NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
- InvalidErrorCode:
An invalid error code was specified.
- IllegalOriginAccessConfiguration:
An origin cannot contain both an origin access control (OAC) and an origin access identity (OAI).
- InvalidProtocolSettings:
You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).
- TooManyFunctionAssociations:
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.
- TooManyOriginCustomHeaders:
Your request contains too many origin custom headers.
- InvalidOrigin:
The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
- InvalidForwardCookies:
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.- InvalidMinimumProtocolVersion:
The minimum protocol version specified is not valid.
- NoSuchCachePolicy:
The cache policy does not exist.
- TooManyKeyGroupsAssociatedToDistribution:
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.
- TooManyDistributionsAssociatedToCachePolicy:
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.
- InvalidRequiredProtocol:
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.- TooManyDistributionsWithFunctionAssociations:
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.
- TooManyOriginGroupsPerDistribution:
Processing your request would cause you to exceed the maximum number of origin groups allowed.
- TooManyDistributions:
Processing your request would cause you to exceed the maximum number of distributions allowed.
- InvalidTTLOrder:
The TTL order specified is not valid.
- IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior:
The specified configuration for field-level encryption can't be associated with the specified cache behavior.
- InvalidOriginKeepaliveTimeout:
The keep alive timeout specified for the origin is not valid.
- InvalidArgument:
An argument is invalid.
- InvalidOriginReadTimeout:
The read timeout specified for the origin is not valid.
- InvalidOriginAccessControl:
The origin access control is not valid.
- EntityNotFound:
The entity was not found.
- InvalidHeadersForS3Origin:
The headers specified are not valid for an Amazon S3 origin.
- TrustedSignerDoesNotExist:
One or more of your trusted signers don't exist.
- InvalidWebACLId:
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 example473e64fd-f30b-4765-81a0-62ad96dd167a
.- TooManyDistributionsWithSingleFunctionARN:
The maximum number of distributions have been associated with the specified Lambda@Edge function.
- InvalidRelativePath:
The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
- TooManyLambdaFunctionAssociations:
Your request contains more Lambda@Edge function associations than are allowed per distribution.
- NoSuchOriginRequestPolicy:
The origin request policy does not exist.
- TooManyDistributionsAssociatedToFieldLevelEncryptionConfig:
The maximum number of distributions have been associated with the specified configuration for field-level encryption.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidLocationCode:
The location code specified is not valid.
- InvalidOriginAccessIdentity:
The origin access identity is not valid or doesn't exist.
- InvalidTagging:
The tagging specified is not valid.
- TooManyDistributionCNAMEs:
Your request contains more CNAMEs than are allowed per distribution.
- NoSuchContinuousDeploymentPolicy:
The continuous deployment policy doesn't exist.
- TooManyDistributionsAssociatedToOriginRequestPolicy:
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.
- TooManyQueryStringParameters:
Your request contains too many query string parameters.
- RealtimeLogConfigOwnerMismatch:
The specified real-time log configuration belongs to a different Amazon Web Services account.
- ContinuousDeploymentPolicyInUse:
You cannot delete a continuous deployment policy that is associated with a primary distribution.
- MissingBody:
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.- TooManyHeadersInForwardedValues:
Your request contains too many headers in forwarded values.
- InvalidLambdaFunctionAssociation:
The specified Lambda@Edge function association is invalid.
- CNAMEAlreadyExists:
The CNAME specified is already defined for CloudFront.
- TooManyCertificates:
You cannot create anymore custom SSL/TLS certificates.
- TrustedKeyGroupDoesNotExist:
The specified key group does not exist.
- TooManyDistributionsAssociatedToResponseHeadersPolicy:
The maximum number of distributions have been associated with the specified response headers policy.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- NoSuchResponseHeadersPolicy:
The response headers policy does not exist.
- NoSuchRealtimeLogConfig:
The real-time log configuration does not exist.
- InvalidResponseCode:
A response code is not valid.
- InvalidGeoRestrictionParameter:
The specified geo restriction parameter is not valid.
- TooManyOrigins:
You cannot create more origins for the distribution.
- InvalidViewerCertificate:
A viewer certificate specified is not valid.
- InvalidFunctionAssociation:
A CloudFront function association is invalid.
- TooManyDistributionsWithLambdaAssociations:
Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.
- TooManyDistributionsAssociatedToKeyGroup:
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.
- DistributionAlreadyExists:
The caller reference you attempted to create the distribution with is associated with another distribution.
- NoSuchOrigin:
No origin exists with the specified
Origin Id
.- TooManyCacheBehaviors:
You cannot create more cache behaviors for the distribution.
CreateFieldLevelEncryptionConfig
$result = $client->createFieldLevelEncryptionConfig
([/* ... */]); $promise = $client->createFieldLevelEncryptionConfigAsync
([/* ... */]);
Create a new field-level encryption configuration.
Parameter Syntax
$result = $client->createFieldLevelEncryptionConfig([ 'FieldLevelEncryptionConfig' => [ // REQUIRED 'CallerReference' => '<string>', // REQUIRED 'Comment' => '<string>', 'ContentTypeProfileConfig' => [ 'ContentTypeProfiles' => [ 'Items' => [ [ 'ContentType' => '<string>', // REQUIRED 'Format' => 'URLEncoded', // REQUIRED 'ProfileId' => '<string>', ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'ForwardWhenContentTypeIsUnknown' => true || false, // REQUIRED ], 'QueryArgProfileConfig' => [ 'ForwardWhenQueryArgProfileIsUnknown' => true || false, // REQUIRED 'QueryArgProfiles' => [ 'Items' => [ [ 'ProfileId' => '<string>', // REQUIRED 'QueryArg' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], ], ], ]);
Parameter Details
Members
- FieldLevelEncryptionConfig
-
- Required: Yes
- Type: FieldLevelEncryptionConfig structure
The request to create a new field-level encryption configuration.
Result Syntax
[ 'ETag' => '<string>', 'FieldLevelEncryption' => [ 'FieldLevelEncryptionConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', 'ContentTypeProfileConfig' => [ 'ContentTypeProfiles' => [ 'Items' => [ [ 'ContentType' => '<string>', 'Format' => 'URLEncoded', 'ProfileId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'ForwardWhenContentTypeIsUnknown' => true || false, ], 'QueryArgProfileConfig' => [ 'ForwardWhenQueryArgProfileIsUnknown' => true || false, 'QueryArgProfiles' => [ 'Items' => [ [ 'ProfileId' => '<string>', 'QueryArg' => '<string>', ], // ... ], 'Quantity' => <integer>, ], ], ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], 'Location' => '<string>', ]
Result Details
Members
- ETag
-
- Type: string
The current version of the field level encryption configuration. For example:
E2QWRUHAPOMQZL
. - FieldLevelEncryption
-
- Type: FieldLevelEncryption structure
Returned when you create a new field-level encryption configuration.
- Location
-
- Type: string
The fully qualified URI of the new configuration resource just created.
Errors
- QueryArgProfileEmpty:
No profile specified for the field-level encryption query argument.
- TooManyFieldLevelEncryptionQueryArgProfiles:
The maximum number of query arg profiles for field-level encryption have been created.
- TooManyFieldLevelEncryptionContentTypeProfiles:
The maximum number of content type profiles for field-level encryption have been created.
- FieldLevelEncryptionConfigAlreadyExists:
The specified configuration for field-level encryption already exists.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- TooManyFieldLevelEncryptionConfigs:
The maximum number of configurations for field-level encryption have been created.
- NoSuchFieldLevelEncryptionProfile:
The specified profile for field-level encryption doesn't exist.
- InvalidArgument:
An argument is invalid.
CreateFieldLevelEncryptionProfile
$result = $client->createFieldLevelEncryptionProfile
([/* ... */]); $promise = $client->createFieldLevelEncryptionProfileAsync
([/* ... */]);
Create a field-level encryption profile.
Parameter Syntax
$result = $client->createFieldLevelEncryptionProfile([ 'FieldLevelEncryptionProfileConfig' => [ // REQUIRED 'CallerReference' => '<string>', // REQUIRED 'Comment' => '<string>', 'EncryptionEntities' => [ // REQUIRED 'Items' => [ [ 'FieldPatterns' => [ // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'ProviderId' => '<string>', // REQUIRED 'PublicKeyId' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'Name' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- FieldLevelEncryptionProfileConfig
-
- Required: Yes
- Type: FieldLevelEncryptionProfileConfig structure
The request to create a field-level encryption profile.
Result Syntax
[ 'ETag' => '<string>', 'FieldLevelEncryptionProfile' => [ 'FieldLevelEncryptionProfileConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', 'EncryptionEntities' => [ 'Items' => [ [ 'FieldPatterns' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ProviderId' => '<string>', 'PublicKeyId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Name' => '<string>', ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], 'Location' => '<string>', ]
Result Details
Members
- ETag
-
- Type: string
The current version of the field level encryption profile. For example:
E2QWRUHAPOMQZL
. - FieldLevelEncryptionProfile
-
- Type: FieldLevelEncryptionProfile structure
Returned when you create a new field-level encryption profile.
- Location
-
- Type: string
The fully qualified URI of the new profile resource just created.
Errors
- TooManyFieldLevelEncryptionFieldPatterns:
The maximum number of field patterns for field-level encryption have been created.
- FieldLevelEncryptionProfileAlreadyExists:
The specified profile for field-level encryption already exists.
- NoSuchPublicKey:
The specified public key doesn't exist.
- FieldLevelEncryptionProfileSizeExceeded:
The maximum size of a profile for field-level encryption was exceeded.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- TooManyFieldLevelEncryptionProfiles:
The maximum number of profiles for field-level encryption have been created.
- TooManyFieldLevelEncryptionEncryptionEntities:
The maximum number of encryption entities for field-level encryption have been created.
- InvalidArgument:
An argument is invalid.
CreateFunction
$result = $client->createFunction
([/* ... */]); $promise = $client->createFunctionAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createFunction([ 'FunctionCode' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'FunctionConfig' => [ // REQUIRED 'Comment' => '<string>', // REQUIRED 'KeyValueStoreAssociations' => [ 'Items' => [ [ 'KeyValueStoreARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'Runtime' => 'cloudfront-js-1.0|cloudfront-js-2.0', // REQUIRED ], 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FunctionCode
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.
- FunctionConfig
-
- Required: Yes
- Type: FunctionConfig structure
Configuration information about the function, including an optional comment and the function's runtime.
- Name
-
- Required: Yes
- Type: string
A name to identify the function.
Result Syntax
[ 'ETag' => '<string>', 'FunctionSummary' => [ 'FunctionConfig' => [ 'Comment' => '<string>', 'KeyValueStoreAssociations' => [ 'Items' => [ [ 'KeyValueStoreARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Runtime' => 'cloudfront-js-1.0|cloudfront-js-2.0', ], 'FunctionMetadata' => [ 'CreatedTime' => <DateTime>, 'FunctionARN' => '<string>', 'LastModifiedTime' => <DateTime>, 'Stage' => 'DEVELOPMENT|LIVE', ], 'Name' => '<string>', 'Status' => '<string>', ], 'Location' => '<string>', ]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the CloudFront function.
- FunctionSummary
-
- Type: FunctionSummary structure
Contains configuration information and metadata about a CloudFront function.
- Location
-
- Type: string
The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.
Errors
- FunctionAlreadyExists:
A function with the same name already exists in this Amazon Web Services account. To create a function, you must provide a unique name. To update an existing function, use
UpdateFunction
.- UnsupportedOperation:
This operation is not supported in this region.
- FunctionSizeLimitExceeded:
The function is too large. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- InvalidArgument:
An argument is invalid.
- TooManyFunctions:
You have reached the maximum number of CloudFront functions for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
Examples
Example 1: To create a function
Use the following command to create a function.
$result = $client->createFunction([ 'FunctionCode' => <BLOB>, 'FunctionConfig' => [ 'Comment' => 'my-function-comment', 'KeyValueStoreAssociations' => [ 'Items' => [ [ 'KeyValueStoreARN' => 'arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889', ], ], 'Quantity' => 1, ], 'Runtime' => 'cloudfront-js-2.0', ], 'Name' => 'my-function-name', ]);
Result syntax:
[ 'ETag' => 'ETVPDKIKX0DER', 'FunctionSummary' => [ 'FunctionConfig' => [ 'Comment' => 'my-function-comment', 'KeyValueStoreAssociations' => [ 'Items' => [ [ 'KeyValueStoreARN' => 'arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889', ], ], 'Quantity' => 1, ], 'Runtime' => 'cloudfront-js-2.0', ], 'FunctionMetadata' => [ 'CreatedTime' =>, 'FunctionARN' => 'arn:aws:cloudfront::123456789012:function/my-function-name', 'LastModifiedTime' => , 'Stage' => 'DEVELOPMENT', ], 'Name' => 'my-function-name', 'Status' => 'UNPUBLISHED', ], 'Location' => 'https://cloudfront.amazonaws.com/2020-05-31/function/arn:aws:cloudfront::123456789012:function/my-function-name', ]
CreateInvalidation
$result = $client->createInvalidation
([/* ... */]); $promise = $client->createInvalidationAsync
([/* ... */]);
Create a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
Parameter Syntax
$result = $client->createInvalidation([ 'DistributionId' => '<string>', // REQUIRED 'InvalidationBatch' => [ // REQUIRED 'CallerReference' => '<string>', // REQUIRED 'Paths' => [ // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], ]);
Parameter Details
Members
- DistributionId
-
- Required: Yes
- Type: string
The distribution's id.
- InvalidationBatch
-
- Required: Yes
- Type: InvalidationBatch structure
The batch information for the invalidation.
Result Syntax
[ 'Invalidation' => [ 'CreateTime' => <DateTime>, 'Id' => '<string>', 'InvalidationBatch' => [ 'CallerReference' => '<string>', 'Paths' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Status' => '<string>', ], 'Location' => '<string>', ]
Result Details
Members
- Invalidation
-
- Type: Invalidation structure
The invalidation's information.
- Location
-
- Type: string
The fully qualified URI of the distribution and invalidation batch request, including the
Invalidation ID
.
Errors
- NoSuchDistribution:
The specified distribution does not exist.
- AccessDenied:
Access denied.
- TooManyInvalidationsInProgress:
You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.
- MissingBody:
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidArgument:
An argument is invalid.
- BatchTooLarge:
Invalidation batch specified is too large.
CreateKeyGroup
$result = $client->createKeyGroup
([/* ... */]); $promise = $client->createKeyGroupAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createKeyGroup([ 'KeyGroupConfig' => [ // REQUIRED 'Comment' => '<string>', 'Items' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- KeyGroupConfig
-
- Required: Yes
- Type: KeyGroupConfig structure
A key group configuration.
Result Syntax
[ 'ETag' => '<string>', 'KeyGroup' => [ 'Id' => '<string>', 'KeyGroupConfig' => [ 'Comment' => '<string>', 'Items' => ['<string>', ...], 'Name' => '<string>', ], 'LastModifiedTime' => <DateTime>, ], 'Location' => '<string>', ]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the key group.
- KeyGroup
-
- Type: KeyGroup structure
The key group that was just created.
- Location
-
- Type: string
The URL of the key group.
Errors
- TooManyPublicKeysInKeyGroup:
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.
- TooManyKeyGroups:
You have reached the maximum number of key groups for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- InvalidArgument:
An argument is invalid.
- KeyGroupAlreadyExists:
A key group with this name already exists. You must provide a unique name. To modify an existing key group, use
UpdateKeyGroup
.
CreateKeyValueStore
$result = $client->createKeyValueStore
([/* ... */]); $promise = $client->createKeyValueStoreAsync
([/* ... */]);
Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid ImportSource
that you own.
Parameter Syntax
$result = $client->createKeyValueStore([ 'Comment' => '<string>', 'ImportSource' => [ 'SourceARN' => '<string>', // REQUIRED 'SourceType' => 'S3', // REQUIRED ], 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Comment
-
- Type: string
The comment of the key value store.
- ImportSource
-
- Type: ImportSource structure
The S3 bucket that provides the source for the import. The source must be in a valid JSON format.
- Name
-
- Required: Yes
- Type: string
The name of the key value store. The minimum length is 1 character and the maximum length is 64 characters.
Result Syntax
[ 'ETag' => '<string>', 'KeyValueStore' => [ 'ARN' => '<string>', 'Comment' => '<string>', 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Status' => '<string>', ], 'Location' => '<string>', ]
Result Details
Members
- ETag
-
- Type: string
The
ETag
in the resulting key value store. - KeyValueStore
-
- Type: KeyValueStore structure
The resulting key value store.
- Location
-
- Type: string
The location of the resulting key value store.
Errors
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- EntityAlreadyExists:
The entity already exists. You must provide a unique entity.
- InvalidArgument:
An argument is invalid.
- EntityLimitExceeded:
The entity limit has been exceeded.
- EntitySizeLimitExceeded:
The entity size limit was exceeded.
Examples
Example 1: To create a KeyValueStore
Use the following command to create a KeyValueStore.
$result = $client->createKeyValueStore([ 'Comment' => 'my-key-valuestore-comment', 'ImportSource' => [ 'SourceARN' => 'arn:aws:s3:::amzn-s3-demo-bucket/validJSON.json', 'SourceType' => 'S3', ], 'Name' => 'my-keyvaluestore-name', ]);
Result syntax:
[ 'ETag' => 'ETVPDKIKX0DER', 'KeyValueStore' => [ 'ARN' => 'arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889', 'Comment' => 'my-key-valuestore-comment', 'Id' => '54947df8-0e9e-4471-a2f9-9af509fb5889', 'LastModifiedTime' =>, 'Name' => 'my-keyvaluestore-name', 'Status' => 'PROVISIONING', ], 'Location' => 'https://cloudfront.amazonaws.com/2020-05-31/key-value-store/arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889', ]
CreateMonitoringSubscription
$result = $client->createMonitoringSubscription
([/* ... */]); $promise = $client->createMonitoringSubscriptionAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createMonitoringSubscription([ 'DistributionId' => '<string>', // REQUIRED 'MonitoringSubscription' => [ // REQUIRED 'RealtimeMetricsSubscriptionConfig' => [ 'RealtimeMetricsSubscriptionStatus' => 'Enabled|Disabled', // REQUIRED ], ], ]);
Parameter Details
Members
- DistributionId
-
- Required: Yes
- Type: string
The ID of the distribution that you are enabling metrics for.
- MonitoringSubscription
-
- Required: Yes
- Type: MonitoringSubscription structure
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
Result Syntax
[ 'MonitoringSubscription' => [ 'RealtimeMetricsSubscriptionConfig' => [ 'RealtimeMetricsSubscriptionStatus' => 'Enabled|Disabled', ], ], ]
Result Details
Members
- MonitoringSubscription
-
- Type: MonitoringSubscription structure
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
Errors
- NoSuchDistribution:
The specified distribution does not exist.
- AccessDenied:
Access denied.
- MonitoringSubscriptionAlreadyExists:
A monitoring subscription already exists for the specified distribution.
- UnsupportedOperation:
This operation is not supported in this region.
CreateOriginAccessControl
$result = $client->createOriginAccessControl
([/* ... */]); $promise = $client->createOriginAccessControlAsync
([/* ... */]);
Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the Amazon CloudFront Developer Guide.
Parameter Syntax
$result = $client->createOriginAccessControl([ 'OriginAccessControlConfig' => [ // REQUIRED 'Description' => '<string>', 'Name' => '<string>', // REQUIRED 'OriginAccessControlOriginType' => 's3|mediastore|mediapackagev2|lambda', // REQUIRED 'SigningBehavior' => 'never|always|no-override', // REQUIRED 'SigningProtocol' => 'sigv4', // REQUIRED ], ]);
Parameter Details
Members
- OriginAccessControlConfig
-
- Required: Yes
- Type: OriginAccessControlConfig structure
Contains the origin access control.
Result Syntax
[ 'ETag' => '<string>', 'Location' => '<string>', 'OriginAccessControl' => [ 'Id' => '<string>', 'OriginAccessControlConfig' => [ 'Description' => '<string>', 'Name' => '<string>', 'OriginAccessControlOriginType' => 's3|mediastore|mediapackagev2|lambda', 'SigningBehavior' => 'never|always|no-override', 'SigningProtocol' => 'sigv4', ], ], ]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the origin access control.
- Location
-
- Type: string
The URL of the origin access control.
- OriginAccessControl
-
- Type: OriginAccessControl structure
Contains an origin access control.
Errors
- OriginAccessControlAlreadyExists:
An origin access control with the specified parameters already exists.
- TooManyOriginAccessControls:
The number of origin access controls in your Amazon Web Services account exceeds the maximum allowed.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- InvalidArgument:
An argument is invalid.
CreateOriginRequestPolicy
$result = $client->createOriginRequestPolicy
([/* ... */]); $promise = $client->createOriginRequestPolicyAsync
([/* ... */]);
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
, andX-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.
Parameter Syntax
$result = $client->createOriginRequestPolicy([ 'OriginRequestPolicyConfig' => [ // REQUIRED 'Comment' => '<string>', 'CookiesConfig' => [ // REQUIRED 'CookieBehavior' => 'none|whitelist|all|allExcept', // REQUIRED 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'HeadersConfig' => [ // REQUIRED 'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept', // REQUIRED 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'Name' => '<string>', // REQUIRED 'QueryStringsConfig' => [ // REQUIRED 'QueryStringBehavior' => 'none|whitelist|all|allExcept', // REQUIRED 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], ], ]);
Parameter Details
Members
- OriginRequestPolicyConfig
-
- Required: Yes
- Type: OriginRequestPolicyConfig structure
An origin request policy configuration.
Result Syntax
[ 'ETag' => '<string>', 'Location' => '<string>', 'OriginRequestPolicy' => [ 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'OriginRequestPolicyConfig' => [ 'Comment' => '<string>', 'CookiesConfig' => [ 'CookieBehavior' => 'none|whitelist|all|allExcept', 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'HeadersConfig' => [ 'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept', 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Name' => '<string>', 'QueryStringsConfig' => [ 'QueryStringBehavior' => 'none|whitelist|all|allExcept', 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The current version of the origin request policy.
- Location
-
- Type: string
The fully qualified URI of the origin request policy just created.
- OriginRequestPolicy
-
- Type: OriginRequestPolicy structure
An origin request policy.
Errors
- AccessDenied:
Access denied.
- TooManyHeadersInOriginRequestPolicy:
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.
- TooManyCookiesInOriginRequestPolicy:
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.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- OriginRequestPolicyAlreadyExists:
An origin request policy with this name already exists. You must provide a unique name. To modify an existing origin request policy, use
UpdateOriginRequestPolicy
.- TooManyQueryStringsInOriginRequestPolicy:
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.
- InvalidArgument:
An argument is invalid.
- TooManyOriginRequestPolicies:
You have reached the maximum number of origin request policies for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
CreatePublicKey
$result = $client->createPublicKey
([/* ... */]); $promise = $client->createPublicKeyAsync
([/* ... */]);
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
Parameter Syntax
$result = $client->createPublicKey([ 'PublicKeyConfig' => [ // REQUIRED 'CallerReference' => '<string>', // REQUIRED 'Comment' => '<string>', 'EncodedKey' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- PublicKeyConfig
-
- Required: Yes
- Type: PublicKeyConfig structure
A CloudFront public key configuration.
Result Syntax
[ 'ETag' => '<string>', 'Location' => '<string>', 'PublicKey' => [ 'CreatedTime' => <DateTime>, 'Id' => '<string>', 'PublicKeyConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', 'EncodedKey' => '<string>', 'Name' => '<string>', ], ], ]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the public key.
- Location
-
- Type: string
The URL of the public key.
- PublicKey
-
- Type: PublicKey structure
The public key.
Errors
- TooManyPublicKeys:
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.
- PublicKeyAlreadyExists:
The specified public key already exists.
- InvalidArgument:
An argument is invalid.
CreateRealtimeLogConfig
$result = $client->createRealtimeLogConfig
([/* ... */]); $promise = $client->createRealtimeLogConfigAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createRealtimeLogConfig([ 'EndPoints' => [ // REQUIRED [ 'KinesisStreamConfig' => [ 'RoleARN' => '<string>', // REQUIRED 'StreamARN' => '<string>', // REQUIRED ], 'StreamType' => '<string>', // REQUIRED ], // ... ], 'Fields' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED 'SamplingRate' => <integer>, // REQUIRED ]);
Parameter Details
Members
- EndPoints
-
- Required: Yes
- Type: Array of EndPoint structures
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
- Fields
-
- Required: Yes
- Type: Array of strings
A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
- Name
-
- Required: Yes
- Type: string
A unique name to identify this real-time log configuration.
- SamplingRate
-
- Required: Yes
- Type: long (int|float)
The sampling rate for this real-time log configuration. You can specify a whole number between 1 and 100 (inclusive) to determine the percentage of viewer requests that are represented in the real-time log data.
Result Syntax
[ 'RealtimeLogConfig' => [ 'ARN' => '<string>', 'EndPoints' => [ [ 'KinesisStreamConfig' => [ 'RoleARN' => '<string>', 'StreamARN' => '<string>', ], 'StreamType' => '<string>', ], // ... ], 'Fields' => ['<string>', ...], 'Name' => '<string>', 'SamplingRate' => <integer>, ], ]
Result Details
Members
- RealtimeLogConfig
-
- Type: RealtimeLogConfig structure
A real-time log configuration.
Errors
- AccessDenied:
Access denied.
- RealtimeLogConfigAlreadyExists:
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
.- TooManyRealtimeLogConfigs:
You have reached the maximum number of real-time log configurations for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- InvalidArgument:
An argument is invalid.
CreateResponseHeadersPolicy
$result = $client->createResponseHeadersPolicy
([/* ... */]); $promise = $client->createResponseHeadersPolicyAsync
([/* ... */]);
Creates a response headers policy.
A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.
Parameter Syntax
$result = $client->createResponseHeadersPolicy([ 'ResponseHeadersPolicyConfig' => [ // REQUIRED 'Comment' => '<string>', 'CorsConfig' => [ 'AccessControlAllowCredentials' => true || false, // REQUIRED 'AccessControlAllowHeaders' => [ // REQUIRED 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'AccessControlAllowMethods' => [ // REQUIRED 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'AccessControlAllowOrigins' => [ // REQUIRED 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'AccessControlExposeHeaders' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'AccessControlMaxAgeSec' => <integer>, 'OriginOverride' => true || false, // REQUIRED ], 'CustomHeadersConfig' => [ 'Items' => [ [ 'Header' => '<string>', // REQUIRED 'Override' => true || false, // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'Name' => '<string>', // REQUIRED 'RemoveHeadersConfig' => [ 'Items' => [ [ 'Header' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'SecurityHeadersConfig' => [ 'ContentSecurityPolicy' => [ 'ContentSecurityPolicy' => '<string>', // REQUIRED 'Override' => true || false, // REQUIRED ], 'ContentTypeOptions' => [ 'Override' => true || false, // REQUIRED ], 'FrameOptions' => [ 'FrameOption' => 'DENY|SAMEORIGIN', // REQUIRED 'Override' => true || false, // REQUIRED ], 'ReferrerPolicy' => [ 'Override' => true || false, // REQUIRED 'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url', // REQUIRED ], 'StrictTransportSecurity' => [ 'AccessControlMaxAgeSec' => <integer>, // REQUIRED 'IncludeSubdomains' => true || false, 'Override' => true || false, // REQUIRED 'Preload' => true || false, ], 'XSSProtection' => [ 'ModeBlock' => true || false, 'Override' => true || false, // REQUIRED 'Protection' => true || false, // REQUIRED 'ReportUri' => '<string>', ], ], 'ServerTimingHeadersConfig' => [ 'Enabled' => true || false, // REQUIRED 'SamplingRate' => <float>, ], ], ]);
Parameter Details
Members
- ResponseHeadersPolicyConfig
-
- Required: Yes
- Type: ResponseHeadersPolicyConfig structure
Contains metadata about the response headers policy, and a set of configurations that specify the HTTP headers.
Result Syntax
[ 'ETag' => '<string>', 'Location' => '<string>', 'ResponseHeadersPolicy' => [ 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'ResponseHeadersPolicyConfig' => [ 'Comment' => '<string>', 'CorsConfig' => [ 'AccessControlAllowCredentials' => true || false, 'AccessControlAllowHeaders' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlAllowMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlAllowOrigins' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlExposeHeaders' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlMaxAgeSec' => <integer>, 'OriginOverride' => true || false, ], 'CustomHeadersConfig' => [ 'Items' => [ [ 'Header' => '<string>', 'Override' => true || false, 'Value' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Name' => '<string>', 'RemoveHeadersConfig' => [ 'Items' => [ [ 'Header' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SecurityHeadersConfig' => [ 'ContentSecurityPolicy' => [ 'ContentSecurityPolicy' => '<string>', 'Override' => true || false, ], 'ContentTypeOptions' => [ 'Override' => true || false, ], 'FrameOptions' => [ 'FrameOption' => 'DENY|SAMEORIGIN', 'Override' => true || false, ], 'ReferrerPolicy' => [ 'Override' => true || false, 'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url', ], 'StrictTransportSecurity' => [ 'AccessControlMaxAgeSec' => <integer>, 'IncludeSubdomains' => true || false, 'Override' => true || false, 'Preload' => true || false, ], 'XSSProtection' => [ 'ModeBlock' => true || false, 'Override' => true || false, 'Protection' => true || false, 'ReportUri' => '<string>', ], ], 'ServerTimingHeadersConfig' => [ 'Enabled' => true || false, 'SamplingRate' => <float>, ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the response headers policy.
- Location
-
- Type: string
The URL of the response headers policy.
- ResponseHeadersPolicy
-
- Type: ResponseHeadersPolicy structure
Contains a response headers policy.
Errors
- AccessDenied:
Access denied.
- TooManyCustomHeadersInResponseHeadersPolicy:
The number of custom headers in the response headers policy exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- ResponseHeadersPolicyAlreadyExists:
A response headers policy with this name already exists. You must provide a unique name. To modify an existing response headers policy, use
UpdateResponseHeadersPolicy
.- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- TooLongCSPInResponseHeadersPolicy:
The length of the
Content-Security-Policy
header value in the response headers policy exceeds the maximum.For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- InvalidArgument:
An argument is invalid.
- TooManyRemoveHeadersInResponseHeadersPolicy:
The number of headers in
RemoveHeadersConfig
in the response headers policy exceeds the maximum.For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- TooManyResponseHeadersPolicies:
You have reached the maximum number of response headers policies for this Amazon Web Services account.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
CreateStreamingDistribution
$result = $client->createStreamingDistribution
([/* ... */]); $promise = $client->createStreamingDistributionAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createStreamingDistribution([ 'StreamingDistributionConfig' => [ // REQUIRED 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'CallerReference' => '<string>', // REQUIRED 'Comment' => '<string>', // REQUIRED 'Enabled' => true || false, // REQUIRED 'Logging' => [ 'Bucket' => '<string>', // REQUIRED 'Enabled' => true || false, // REQUIRED 'Prefix' => '<string>', // REQUIRED ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'S3Origin' => [ // REQUIRED 'DomainName' => '<string>', // REQUIRED 'OriginAccessIdentity' => '<string>', // REQUIRED ], 'TrustedSigners' => [ // REQUIRED 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], ]);
Parameter Details
Members
- StreamingDistributionConfig
-
- Required: Yes
- Type: StreamingDistributionConfig structure
The streaming distribution's configuration information.
Result Syntax
[ 'ETag' => '<string>', 'Location' => '<string>', 'StreamingDistribution' => [ 'ARN' => '<string>', 'ActiveTrustedSigners' => [ 'Enabled' => true || false, 'Items' => [ [ 'AwsAccountNumber' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'DomainName' => '<string>', 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', 'StreamingDistributionConfig' => [ 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CallerReference' => '<string>', 'Comment' => '<string>', 'Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'Prefix' => '<string>', ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'S3Origin' => [ 'DomainName' => '<string>', 'OriginAccessIdentity' => '<string>', ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The current version of the streaming distribution created.
- Location
-
- Type: string
The fully qualified URI of the new streaming distribution resource just created.
- StreamingDistribution
-
- Type: StreamingDistribution structure
The streaming distribution's information.
Errors
- AccessDenied:
Access denied.
- StreamingDistributionAlreadyExists:
The caller reference you attempted to create the streaming distribution with is associated with another distribution
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidOriginAccessIdentity:
The origin access identity is not valid or doesn't exist.
- InvalidArgument:
An argument is invalid.
- TooManyTrustedSigners:
Your request contains more trusted signers than are allowed per distribution.
- InvalidOriginAccessControl:
The origin access control is not valid.
- TooManyStreamingDistributions:
Processing your request would cause you to exceed the maximum number of streaming distributions allowed.
- MissingBody:
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.- TooManyStreamingDistributionCNAMEs:
Your request contains more CNAMEs than are allowed per distribution.
- TrustedSignerDoesNotExist:
One or more of your trusted signers don't exist.
- CNAMEAlreadyExists:
The CNAME specified is already defined for CloudFront.
- InvalidOrigin:
The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
CreateStreamingDistributionWithTags
$result = $client->createStreamingDistributionWithTags
([/* ... */]); $promise = $client->createStreamingDistributionWithTagsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createStreamingDistributionWithTags([ 'StreamingDistributionConfigWithTags' => [ // REQUIRED 'StreamingDistributionConfig' => [ // REQUIRED 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'CallerReference' => '<string>', // REQUIRED 'Comment' => '<string>', // REQUIRED 'Enabled' => true || false, // REQUIRED 'Logging' => [ 'Bucket' => '<string>', // REQUIRED 'Enabled' => true || false, // REQUIRED 'Prefix' => '<string>', // REQUIRED ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'S3Origin' => [ // REQUIRED 'DomainName' => '<string>', // REQUIRED 'OriginAccessIdentity' => '<string>', // REQUIRED ], 'TrustedSigners' => [ // REQUIRED 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'Tags' => [ // REQUIRED 'Items' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], ], ], ]);
Parameter Details
Members
- StreamingDistributionConfigWithTags
-
- Required: Yes
- Type: StreamingDistributionConfigWithTags structure
The streaming distribution's configuration information.
Result Syntax
[ 'ETag' => '<string>', 'Location' => '<string>', 'StreamingDistribution' => [ 'ARN' => '<string>', 'ActiveTrustedSigners' => [ 'Enabled' => true || false, 'Items' => [ [ 'AwsAccountNumber' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'DomainName' => '<string>', 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', 'StreamingDistributionConfig' => [ 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CallerReference' => '<string>', 'Comment' => '<string>', 'Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'Prefix' => '<string>', ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'S3Origin' => [ 'DomainName' => '<string>', 'OriginAccessIdentity' => '<string>', ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The current version of the distribution created.
- Location
-
- Type: string
The fully qualified URI of the new streaming distribution resource just created.
- StreamingDistribution
-
- Type: StreamingDistribution structure
The streaming distribution's information.
Errors
- AccessDenied:
Access denied.
- StreamingDistributionAlreadyExists:
The caller reference you attempted to create the streaming distribution with is associated with another distribution
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidOriginAccessIdentity:
The origin access identity is not valid or doesn't exist.
- InvalidTagging:
The tagging specified is not valid.
- InvalidArgument:
An argument is invalid.
- TooManyTrustedSigners:
Your request contains more trusted signers than are allowed per distribution.
- InvalidOriginAccessControl:
The origin access control is not valid.
- TooManyStreamingDistributions:
Processing your request would cause you to exceed the maximum number of streaming distributions allowed.
- MissingBody:
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.- TooManyStreamingDistributionCNAMEs:
Your request contains more CNAMEs than are allowed per distribution.
- TrustedSignerDoesNotExist:
One or more of your trusted signers don't exist.
- CNAMEAlreadyExists:
The CNAME specified is already defined for CloudFront.
- InvalidOrigin:
The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
CreateVpcOrigin
$result = $client->createVpcOrigin
([/* ... */]); $promise = $client->createVpcOriginAsync
([/* ... */]);
Create an Amazon CloudFront VPC origin.
Parameter Syntax
$result = $client->createVpcOrigin([ 'Tags' => [ 'Items' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], ], 'VpcOriginEndpointConfig' => [ // REQUIRED 'Arn' => '<string>', // REQUIRED 'HTTPPort' => <integer>, // REQUIRED 'HTTPSPort' => <integer>, // REQUIRED 'Name' => '<string>', // REQUIRED 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', // REQUIRED 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], ], ]);
Parameter Details
Members
- Tags
-
- Type: Tags structure
A complex type that contains zero or more
Tag
elements. - VpcOriginEndpointConfig
-
- Required: Yes
- Type: VpcOriginEndpointConfig structure
The VPC origin endpoint configuration.
Result Syntax
[ 'ETag' => '<string>', 'Location' => '<string>', 'VpcOrigin' => [ 'Arn' => '<string>', 'CreatedTime' => <DateTime>, 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', 'VpcOriginEndpointConfig' => [ 'Arn' => '<string>', 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'Name' => '<string>', 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The VPC origin ETag.
- Location
-
- Type: string
The VPC origin location.
- VpcOrigin
-
- Type: VpcOrigin structure
The VPC origin.
Errors
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- EntityAlreadyExists:
The entity already exists. You must provide a unique entity.
- InvalidTagging:
The tagging specified is not valid.
- InvalidArgument:
An argument is invalid.
- EntityLimitExceeded:
The entity limit has been exceeded.
Examples
Example 1: To create a VPC origin
The following command creates a VPC origin:
$result = $client->createVpcOrigin([ 'VpcOriginEndpointConfig' => [ 'Arn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d', 'HTTPPort' => 80, 'HTTPSPort' => 443, 'Name' => 'my-vpcorigin-name', 'OriginProtocolPolicy' => 'match-viewer', 'OriginSslProtocols' => [ 'Items' => [ 'TLSv1.1', 'TLSv1.2', ], 'Quantity' => 2, ], ], ]);
Result syntax:
[ 'ETag' => 'E23ZP02F085DFQ', 'Location' => 'https://cloudfront.amazonaws.com/2020-05-31/vpc-origin/vo_BQwjxxQxjCaBcQLzJUFkDM', 'VpcOrigin' => [ 'Arn' => 'arn:aws:cloudfront::123456789012:vpcorigin/vo_BQwjxxQxjCaBcQLzJUFkDM', 'CreatedTime' =>, 'Id' => 'vo_BQwjxxQxjCaBcQLzJUFkDM', 'LastModifiedTime' => , 'Status' => 'Deploying', 'VpcOriginEndpointConfig' => [ 'Arn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d', 'HTTPPort' => 80, 'HTTPSPort' => 443, 'Name' => 'my-vpcorigin-name', 'OriginProtocolPolicy' => 'match-viewer', 'OriginSslProtocols' => [ 'Items' => [ 'TLSv1.1', 'TLSv1.2', ], 'Quantity' => 2, ], ], ], ]
DeleteAnycastIpList
$result = $client->deleteAnycastIpList
([/* ... */]); $promise = $client->deleteAnycastIpListAsync
([/* ... */]);
Deletes an Anycast static IP list.
Parameter Syntax
$result = $client->deleteAnycastIpList([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The ID of the Anycast static IP list.
- IfMatch
-
- Required: Yes
- Type: string
The current version (
ETag
value) of the Anycast static IP list that you are deleting.
Result Syntax
[]
Result Details
Errors
- CannotDeleteEntityWhileInUse:
The entity cannot be deleted while it is in use.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- EntityNotFound:
The entity was not found.
- AccessDenied:
Access denied.
- IllegalDelete:
Deletion is not allowed for this entity.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteCachePolicy
$result = $client->deleteCachePolicy
([/* ... */]); $promise = $client->deleteCachePolicyAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->deleteCachePolicy([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier for the cache policy that you are deleting. To get the identifier, you can use
ListCachePolicies
. - IfMatch
-
- Type: string
The version of the cache policy that you are deleting. The version is the cache policy's
ETag
value, which you can get usingListCachePolicies
,GetCachePolicy
, orGetCachePolicyConfig
.
Result Syntax
[]
Result Details
Errors
- NoSuchCachePolicy:
The cache policy does not exist.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- IllegalDelete:
Deletion is not allowed for this entity.
- CachePolicyInUse:
Cannot delete the cache policy because it is attached to one or more cache behaviors.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteCloudFrontOriginAccessIdentity
$result = $client->deleteCloudFrontOriginAccessIdentity
([/* ... */]); $promise = $client->deleteCloudFrontOriginAccessIdentityAsync
([/* ... */]);
Delete an origin access identity.
Parameter Syntax
$result = $client->deleteCloudFrontOriginAccessIdentity([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The origin access identity's ID.
- IfMatch
-
- Type: string
The value of the
ETag
header you received from a previousGET
orPUT
request. For example:E2QWRUHAPOMQZL
.
Result Syntax
[]
Result Details
Errors
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.- NoSuchCloudFrontOriginAccessIdentity:
The specified origin access identity does not exist.
- CloudFrontOriginAccessIdentityInUse:
The Origin Access Identity specified is already in use.
DeleteContinuousDeploymentPolicy
$result = $client->deleteContinuousDeploymentPolicy
([/* ... */]); $promise = $client->deleteContinuousDeploymentPolicyAsync
([/* ... */]);
Deletes a continuous deployment policy.
You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy.
Parameter Syntax
$result = $client->deleteContinuousDeploymentPolicy([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the continuous deployment policy that you are deleting.
- IfMatch
-
- Type: string
The current version (
ETag
value) of the continuous deployment policy that you are deleting.
Result Syntax
[]
Result Details
Errors
- ContinuousDeploymentPolicyInUse:
You cannot delete a continuous deployment policy that is associated with a primary distribution.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- InvalidArgument:
An argument is invalid.
- NoSuchContinuousDeploymentPolicy:
The continuous deployment policy doesn't exist.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteDistribution
$result = $client->deleteDistribution
([/* ... */]); $promise = $client->deleteDistributionAsync
([/* ... */]);
Delete a distribution.
Parameter Syntax
$result = $client->deleteDistribution([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The distribution ID.
- IfMatch
-
- Type: string
The value of the
ETag
header that you received when you disabled the distribution. For example:E2QWRUHAPOMQZL
.
Result Syntax
[]
Result Details
Errors
- NoSuchDistribution:
The specified distribution does not exist.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- DistributionNotDisabled:
The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteFieldLevelEncryptionConfig
$result = $client->deleteFieldLevelEncryptionConfig
([/* ... */]); $promise = $client->deleteFieldLevelEncryptionConfigAsync
([/* ... */]);
Remove a field-level encryption configuration.
Parameter Syntax
$result = $client->deleteFieldLevelEncryptionConfig([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The ID of the configuration you want to delete from CloudFront.
- IfMatch
-
- Type: string
The value of the
ETag
header that you received when retrieving the configuration identity to delete. For example:E2QWRUHAPOMQZL
.
Result Syntax
[]
Result Details
Errors
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- FieldLevelEncryptionConfigInUse:
The specified configuration for field-level encryption is in use.
- NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteFieldLevelEncryptionProfile
$result = $client->deleteFieldLevelEncryptionProfile
([/* ... */]); $promise = $client->deleteFieldLevelEncryptionProfileAsync
([/* ... */]);
Remove a field-level encryption profile.
Parameter Syntax
$result = $client->deleteFieldLevelEncryptionProfile([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
Request the ID of the profile you want to delete from CloudFront.
- IfMatch
-
- Type: string
The value of the
ETag
header that you received when retrieving the profile to delete. For example:E2QWRUHAPOMQZL
.
Result Syntax
[]
Result Details
Errors
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- NoSuchFieldLevelEncryptionProfile:
The specified profile for field-level encryption doesn't exist.
- FieldLevelEncryptionProfileInUse:
The specified profile for field-level encryption is in use.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteFunction
$result = $client->deleteFunction
([/* ... */]); $promise = $client->deleteFunctionAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->deleteFunction([ 'IfMatch' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- IfMatch
-
- Required: Yes
- Type: string
The current version (
ETag
value) of the function that you are deleting, which you can get usingDescribeFunction
. - Name
-
- Required: Yes
- Type: string
The name of the function that you are deleting.
Result Syntax
[]
Result Details
Errors
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- UnsupportedOperation:
This operation is not supported in this region.
- FunctionInUse:
Cannot delete the function because it's attached to one or more cache behaviors.
- NoSuchFunctionExists:
The function does not exist.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteKeyGroup
$result = $client->deleteKeyGroup
([/* ... */]); $promise = $client->deleteKeyGroupAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->deleteKeyGroup([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the key group that you are deleting. To get the identifier, use
ListKeyGroups
. - IfMatch
-
- Type: string
The version of the key group that you are deleting. The version is the key group's
ETag
value. To get theETag
, useGetKeyGroup
orGetKeyGroupConfig
.
Result Syntax
[]
Result Details
Errors
- ResourceInUse:
Cannot delete this resource because it is in use.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- NoSuchResource:
A resource that was specified is not valid.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteKeyValueStore
$result = $client->deleteKeyValueStore
([/* ... */]); $promise = $client->deleteKeyValueStoreAsync
([/* ... */]);
Specifies the key value store to delete.
Parameter Syntax
$result = $client->deleteKeyValueStore([ 'IfMatch' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- IfMatch
-
- Required: Yes
- Type: string
The key value store to delete, if a match occurs.
- Name
-
- Required: Yes
- Type: string
The name of the key value store.
Result Syntax
[]
Result Details
Errors
- CannotDeleteEntityWhileInUse:
The entity cannot be deleted while it is in use.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- EntityNotFound:
The entity was not found.
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
Examples
Example 1: To delete a KeyValueStore
Use the following command to delete a KeyValueStore.
$result = $client->deleteKeyValueStore([ 'IfMatch' => 'ETVPDKIKX0DER', 'Name' => 'my-keyvaluestore-name', ]);
DeleteMonitoringSubscription
$result = $client->deleteMonitoringSubscription
([/* ... */]); $promise = $client->deleteMonitoringSubscriptionAsync
([/* ... */]);
Disables additional CloudWatch metrics for the specified CloudFront distribution.
Parameter Syntax
$result = $client->deleteMonitoringSubscription([ 'DistributionId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DistributionId
-
- Required: Yes
- Type: string
The ID of the distribution that you are disabling metrics for.
Result Syntax
[]
Result Details
Errors
- NoSuchDistribution:
The specified distribution does not exist.
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- NoSuchMonitoringSubscription:
A monitoring subscription does not exist for the specified distribution.
DeleteOriginAccessControl
$result = $client->deleteOriginAccessControl
([/* ... */]); $promise = $client->deleteOriginAccessControlAsync
([/* ... */]);
Deletes a CloudFront origin access control.
You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control.
Parameter Syntax
$result = $client->deleteOriginAccessControl([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier of the origin access control that you are deleting.
- IfMatch
-
- Type: string
The current version (
ETag
value) of the origin access control that you are deleting.
Result Syntax
[]
Result Details
Errors
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- OriginAccessControlInUse:
Cannot delete the origin access control because it's in use by one or more distributions.
- NoSuchOriginAccessControl:
The origin access control does not exist.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteOriginRequestPolicy
$result = $client->deleteOriginRequestPolicy
([/* ... */]); $promise = $client->deleteOriginRequestPolicyAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->deleteOriginRequestPolicy([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use
ListOriginRequestPolicies
. - IfMatch
-
- Type: string
The version of the origin request policy that you are deleting. The version is the origin request policy's
ETag
value, which you can get usingListOriginRequestPolicies
,GetOriginRequestPolicy
, orGetOriginRequestPolicyConfig
.
Result Syntax
[]
Result Details
Errors
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- IllegalDelete:
Deletion is not allowed for this entity.
- NoSuchOriginRequestPolicy:
The origin request policy does not exist.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.- OriginRequestPolicyInUse:
Cannot delete the origin request policy because it is attached to one or more cache behaviors.
DeletePublicKey
$result = $client->deletePublicKey
([/* ... */]); $promise = $client->deletePublicKeyAsync
([/* ... */]);
Remove a public key you previously added to CloudFront.
Parameter Syntax
$result = $client->deletePublicKey([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The ID of the public key you want to remove from CloudFront.
- IfMatch
-
- Type: string
The value of the
ETag
header that you received when retrieving the public key identity to delete. For example:E2QWRUHAPOMQZL
.
Result Syntax
[]
Result Details
Errors
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- NoSuchPublicKey:
The specified public key doesn't exist.
- PublicKeyInUse:
The specified public key is in use.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteRealtimeLogConfig
$result = $client->deleteRealtimeLogConfig
([/* ... */]); $promise = $client->deleteRealtimeLogConfigAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteRealtimeLogConfig([ 'ARN' => '<string>', 'Name' => '<string>', ]);
Parameter Details
Members
- ARN
-
- Type: string
The Amazon Resource Name (ARN) of the real-time log configuration to delete.
- Name
-
- Type: string
The name of the real-time log configuration to delete.
Result Syntax
[]
Result Details
Errors
- AccessDenied:
Access denied.
- InvalidArgument:
An argument is invalid.
- RealtimeLogConfigInUse:
Cannot delete the real-time log configuration because it is attached to one or more cache behaviors.
- NoSuchRealtimeLogConfig:
The real-time log configuration does not exist.
DeleteResponseHeadersPolicy
$result = $client->deleteResponseHeadersPolicy
([/* ... */]); $promise = $client->deleteResponseHeadersPolicyAsync
([/* ... */]);
Deletes a response headers policy.
You cannot delete a response headers policy if it's attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy.
To delete a response headers policy, you must provide the policy's identifier and version. To get these values, you can use ListResponseHeadersPolicies
or GetResponseHeadersPolicy
.
Parameter Syntax
$result = $client->deleteResponseHeadersPolicy([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier for the response headers policy that you are deleting.
To get the identifier, you can use
ListResponseHeadersPolicies
. - IfMatch
-
- Type: string
The version of the response headers policy that you are deleting.
The version is the response headers policy's
ETag
value, which you can get usingListResponseHeadersPolicies
,GetResponseHeadersPolicy
, orGetResponseHeadersPolicyConfig
.
Result Syntax
[]
Result Details
Errors
- ResponseHeadersPolicyInUse:
Cannot delete the response headers policy because it is attached to one or more cache behaviors in a CloudFront distribution.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- IllegalDelete:
Deletion is not allowed for this entity.
- NoSuchResponseHeadersPolicy:
The response headers policy does not exist.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteStreamingDistribution
$result = $client->deleteStreamingDistribution
([/* ... */]); $promise = $client->deleteStreamingDistributionAsync
([/* ... */]);
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 theEtag
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 ofEnabled
tofalse
. -
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 HTTPIf-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET 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 ofStatus
isDeployed
. -
Submit a
DELETE Streaming Distribution
request. Set the value of the HTTPIf-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET 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.
Parameter Syntax
$result = $client->deleteStreamingDistribution([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The distribution ID.
- IfMatch
-
- Type: string
The value of the
ETag
header that you received when you disabled the streaming distribution. For example:E2QWRUHAPOMQZL
.
Result Syntax
[]
Result Details
Errors
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- StreamingDistributionNotDisabled:
The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.
- NoSuchStreamingDistribution:
The specified streaming distribution does not exist.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
DeleteVpcOrigin
$result = $client->deleteVpcOrigin
([/* ... */]); $promise = $client->deleteVpcOriginAsync
([/* ... */]);
Delete an Amazon CloudFront VPC origin.
Parameter Syntax
$result = $client->deleteVpcOrigin([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The VPC origin ID.
- IfMatch
-
- Required: Yes
- Type: string
The VPC origin to delete, if a match occurs.
Result Syntax
[ 'ETag' => '<string>', 'VpcOrigin' => [ 'Arn' => '<string>', 'CreatedTime' => <DateTime>, 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', 'VpcOriginEndpointConfig' => [ 'Arn' => '<string>', 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'Name' => '<string>', 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The VPC origin ETag.
- VpcOrigin
-
- Type: VpcOrigin structure
The VPC origin.
Errors
- CannotDeleteEntityWhileInUse:
The entity cannot be deleted while it is in use.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- EntityNotFound:
The entity was not found.
- AccessDenied:
Access denied.
- IllegalDelete:
Deletion is not allowed for this entity.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
Examples
Example 1: To delete a VPC origin
The following command deletes a VPC origin:
$result = $client->deleteVpcOrigin([ 'Id' => 'vo_BQwjxxQxjCaBcQLzJUFkDM', 'IfMatch' => 'E1F83G8C2ARO7P', ]);
Result syntax:
[ 'ETag' => 'E1PA6795UKMFR9', 'VpcOrigin' => [ 'Arn' => 'arn:aws:cloudfront::123456789012:vpcorigin/vo_BQwjxxQxjCaBcQLzJUFkDM', 'CreatedTime' =>, 'Id' => 'vo_BQwjxxQxjCaBcQLzJUFkDM', 'LastModifiedTime' => , 'Status' => 'Deploying', 'VpcOriginEndpointConfig' => [ 'Arn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d', 'HTTPPort' => 80, 'HTTPSPort' => 443, 'Name' => 'my-vpcorigin-name', 'OriginProtocolPolicy' => 'match-viewer', 'OriginSslProtocols' => [ 'Items' => [ 'TLSv1.1', 'TLSv1.2', ], 'Quantity' => 2, ], ], ], ]
DescribeFunction
$result = $client->describeFunction
([/* ... */]); $promise = $client->describeFunctionAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->describeFunction([ 'Name' => '<string>', // REQUIRED 'Stage' => 'DEVELOPMENT|LIVE', ]);
Parameter Details
Members
- Name
-
- Required: Yes
- Type: string
The name of the function that you are getting information about.
- Stage
-
- Type: string
The function's stage, either
DEVELOPMENT
orLIVE
.
Result Syntax
[ 'ETag' => '<string>', 'FunctionSummary' => [ 'FunctionConfig' => [ 'Comment' => '<string>', 'KeyValueStoreAssociations' => [ 'Items' => [ [ 'KeyValueStoreARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Runtime' => 'cloudfront-js-1.0|cloudfront-js-2.0', ], 'FunctionMetadata' => [ 'CreatedTime' => <DateTime>, 'FunctionARN' => '<string>', 'LastModifiedTime' => <DateTime>, 'Stage' => 'DEVELOPMENT|LIVE', ], 'Name' => '<string>', 'Status' => '<string>', ], ]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the CloudFront function.
- FunctionSummary
-
- Type: FunctionSummary structure
Contains configuration information and metadata about a CloudFront function.
Errors
- UnsupportedOperation:
This operation is not supported in this region.
- NoSuchFunctionExists:
The function does not exist.
DescribeKeyValueStore
$result = $client->describeKeyValueStore
([/* ... */]); $promise = $client->describeKeyValueStoreAsync
([/* ... */]);
Specifies the key value store and its configuration.
Parameter Syntax
$result = $client->describeKeyValueStore([ 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Name
-
- Required: Yes
- Type: string
The name of the key value store.
Result Syntax
[ 'ETag' => '<string>', 'KeyValueStore' => [ 'ARN' => '<string>', 'Comment' => '<string>', 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Status' => '<string>', ], ]
Result Details
Members
- ETag
-
- Type: string
The
ETag
of the resulting key value store. - KeyValueStore
-
- Type: KeyValueStore structure
The resulting key value store.
Errors
- EntityNotFound:
The entity was not found.
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
Examples
Example 1: To describe a KeyValueStore
Use the following command to describe a KeyValueStore.
$result = $client->describeKeyValueStore([ 'Name' => 'my-keyvaluestore-name', ]);
Result syntax:
[ 'ETag' => 'ETVPDKIKX0DER', 'KeyValueStore' => [ 'ARN' => 'arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889', 'Comment' => 'my-key-valuestore-comment', 'Id' => '54947df8-0e9e-4471-a2f9-9af509fb5889', 'LastModifiedTime' =>, 'Name' => 'my-keyvaluestore-name', 'Status' => 'READY', ], ]
GetAnycastIpList
$result = $client->getAnycastIpList
([/* ... */]); $promise = $client->getAnycastIpListAsync
([/* ... */]);
Gets an Anycast static IP list.
Parameter Syntax
$result = $client->getAnycastIpList([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The ID of the Anycast static IP list.
Result Syntax
[ 'AnycastIpList' => [ 'AnycastIps' => ['<string>', ...], 'Arn' => '<string>', 'Id' => '<string>', 'IpCount' => <integer>, 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Status' => '<string>', ], 'ETag' => '<string>', ]
Result Details
Members
- AnycastIpList
-
- Type: AnycastIpList structure
The Anycast static IP list details.
- ETag
-
- Type: string
The version identifier for the current version of the Anycast static IP list.
Errors
- EntityNotFound:
The entity was not found.
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
GetCachePolicy
$result = $client->getCachePolicy
([/* ... */]); $promise = $client->getCachePolicyAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->getCachePolicy([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier for the cache policy. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributions
orGetDistribution
. If the cache policy is not attached to a cache behavior, you can get the identifier usingListCachePolicies
.
Result Syntax
[ 'CachePolicy' => [ 'CachePolicyConfig' => [ 'Comment' => '<string>', 'DefaultTTL' => <integer>, 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'Name' => '<string>', 'ParametersInCacheKeyAndForwardedToOrigin' => [ 'CookiesConfig' => [ 'CookieBehavior' => 'none|whitelist|allExcept|all', 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'EnableAcceptEncodingBrotli' => true || false, 'EnableAcceptEncodingGzip' => true || false, 'HeadersConfig' => [ 'HeaderBehavior' => 'none|whitelist', 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'QueryStringsConfig' => [ 'QueryStringBehavior' => 'none|whitelist|allExcept|all', 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], 'ETag' => '<string>', ]
Result Details
Members
- CachePolicy
-
- Type: CachePolicy structure
The cache policy.
- ETag
-
- Type: string
The current version of the cache policy.
Errors
- NoSuchCachePolicy:
The cache policy does not exist.
- AccessDenied:
Access denied.
GetCachePolicyConfig
$result = $client->getCachePolicyConfig
([/* ... */]); $promise = $client->getCachePolicyConfigAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->getCachePolicyConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier for the cache policy. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributions
orGetDistribution
. If the cache policy is not attached to a cache behavior, you can get the identifier usingListCachePolicies
.
Result Syntax
[ 'CachePolicyConfig' => [ 'Comment' => '<string>', 'DefaultTTL' => <integer>, 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'Name' => '<string>', 'ParametersInCacheKeyAndForwardedToOrigin' => [ 'CookiesConfig' => [ 'CookieBehavior' => 'none|whitelist|allExcept|all', 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'EnableAcceptEncodingBrotli' => true || false, 'EnableAcceptEncodingGzip' => true || false, 'HeadersConfig' => [ 'HeaderBehavior' => 'none|whitelist', 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'QueryStringsConfig' => [ 'QueryStringBehavior' => 'none|whitelist|allExcept|all', 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ], 'ETag' => '<string>', ]
Result Details
Members
- CachePolicyConfig
-
- Type: CachePolicyConfig structure
The cache policy configuration.
- ETag
-
- Type: string
The current version of the cache policy.
Errors
- NoSuchCachePolicy:
The cache policy does not exist.
- AccessDenied:
Access denied.
GetCloudFrontOriginAccessIdentity
$result = $client->getCloudFrontOriginAccessIdentity
([/* ... */]); $promise = $client->getCloudFrontOriginAccessIdentityAsync
([/* ... */]);
Get the information about an origin access identity.
Parameter Syntax
$result = $client->getCloudFrontOriginAccessIdentity([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identity's ID.
Result Syntax
[ 'CloudFrontOriginAccessIdentity' => [ 'CloudFrontOriginAccessIdentityConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', ], 'Id' => '<string>', 'S3CanonicalUserId' => '<string>', ], 'ETag' => '<string>', ]
Result Details
Members
- CloudFrontOriginAccessIdentity
-
- Type: CloudFrontOriginAccessIdentity structure
The origin access identity's information.
- ETag
-
- Type: string
The current version of the origin access identity's information. For example:
E2QWRUHAPOMQZL
.
Errors
- AccessDenied:
Access denied.
- NoSuchCloudFrontOriginAccessIdentity:
The specified origin access identity does not exist.
GetCloudFrontOriginAccessIdentityConfig
$result = $client->getCloudFrontOriginAccessIdentityConfig
([/* ... */]); $promise = $client->getCloudFrontOriginAccessIdentityConfigAsync
([/* ... */]);
Get the configuration information about an origin access identity.
Parameter Syntax
$result = $client->getCloudFrontOriginAccessIdentityConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identity's ID.
Result Syntax
[ 'CloudFrontOriginAccessIdentityConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', ], 'ETag' => '<string>', ]
Result Details
Members
- CloudFrontOriginAccessIdentityConfig
-
- Type: CloudFrontOriginAccessIdentityConfig structure
The origin access identity's configuration information.
- ETag
-
- Type: string
The current version of the configuration. For example:
E2QWRUHAPOMQZL
.
Errors
- AccessDenied:
Access denied.
- NoSuchCloudFrontOriginAccessIdentity:
The specified origin access identity does not exist.
GetContinuousDeploymentPolicy
$result = $client->getContinuousDeploymentPolicy
([/* ... */]); $promise = $client->getContinuousDeploymentPolicyAsync
([/* ... */]);
Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
Parameter Syntax
$result = $client->getContinuousDeploymentPolicy([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the continuous deployment policy that you are getting.
Result Syntax
[ 'ContinuousDeploymentPolicy' => [ 'ContinuousDeploymentPolicyConfig' => [ 'Enabled' => true || false, 'StagingDistributionDnsNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrafficConfig' => [ 'SingleHeaderConfig' => [ 'Header' => '<string>', 'Value' => '<string>', ], 'SingleWeightConfig' => [ 'SessionStickinessConfig' => [ 'IdleTTL' => <integer>, 'MaximumTTL' => <integer>, ], 'Weight' => <float>, ], 'Type' => 'SingleWeight|SingleHeader', ], ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], 'ETag' => '<string>', ]
Result Details
Members
- ContinuousDeploymentPolicy
-
- Type: ContinuousDeploymentPolicy structure
A continuous deployment policy.
- ETag
-
- Type: string
The version identifier for the current version of the continuous deployment policy.
Errors
- AccessDenied:
Access denied.
- NoSuchContinuousDeploymentPolicy:
The continuous deployment policy doesn't exist.
GetContinuousDeploymentPolicyConfig
$result = $client->getContinuousDeploymentPolicyConfig
([/* ... */]); $promise = $client->getContinuousDeploymentPolicyConfigAsync
([/* ... */]);
Gets configuration information about a continuous deployment policy.
Parameter Syntax
$result = $client->getContinuousDeploymentPolicyConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the continuous deployment policy whose configuration you are getting.
Result Syntax
[ 'ContinuousDeploymentPolicyConfig' => [ 'Enabled' => true || false, 'StagingDistributionDnsNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrafficConfig' => [ 'SingleHeaderConfig' => [ 'Header' => '<string>', 'Value' => '<string>', ], 'SingleWeightConfig' => [ 'SessionStickinessConfig' => [ 'IdleTTL' => <integer>, 'MaximumTTL' => <integer>, ], 'Weight' => <float>, ], 'Type' => 'SingleWeight|SingleHeader', ], ], 'ETag' => '<string>', ]
Result Details
Members
- ContinuousDeploymentPolicyConfig
-
- Type: ContinuousDeploymentPolicyConfig structure
Contains the configuration for a continuous deployment policy.
- ETag
-
- Type: string
The version identifier for the current version of the continuous deployment policy.
Errors
- AccessDenied:
Access denied.
- NoSuchContinuousDeploymentPolicy:
The continuous deployment policy doesn't exist.
GetDistribution
$result = $client->getDistribution
([/* ... */]); $promise = $client->getDistributionAsync
([/* ... */]);
Get the information about a distribution.
Parameter Syntax
$result = $client->getDistribution([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
Result Syntax
[ 'Distribution' => [ 'ARN' => '<string>', 'ActiveTrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => [ [ 'KeyGroupId' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'ActiveTrustedSigners' => [ 'Enabled' => true || false, 'Items' => [ [ 'AwsAccountNumber' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'AliasICPRecordals' => [ [ 'CNAME' => '<string>', 'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING', ], // ... ], 'DistributionConfig' => [ 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], // ... ], 'Quantity' => <integer>, ], 'CallerReference' => '<string>', 'Comment' => '<string>', 'ContinuousDeploymentPolicyId' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'DefaultCacheBehavior' => [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], 'DefaultRootObject' => '<string>', 'Enabled' => true || false, 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'IsIPV6Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'IncludeCookies' => true || false, 'Prefix' => '<string>', ], 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ 'StatusCodes' => [ 'Items' => [<integer>, ...], 'Quantity' => <integer>, ], ], 'Id' => '<string>', 'Members' => [ 'Items' => [ [ 'OriginId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, ], 'Origins' => [ 'Items' => [ [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', 'HeaderValue' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'DomainName' => '<string>', 'Id' => '<string>', 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', ], ], // ... ], 'Quantity' => <integer>, ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, 'RestrictionType' => 'blacklist|whitelist|none', ], ], 'Staging' => true || false, 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], 'DomainName' => '<string>', 'Id' => '<string>', 'InProgressInvalidationBatches' => <integer>, 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', ], 'ETag' => '<string>', ]
Result Details
Members
- Distribution
-
- Type: Distribution structure
The distribution's information.
- ETag
-
- Type: string
The current version of the distribution's information. For example:
E2QWRUHAPOMQZL
.
Errors
- NoSuchDistribution:
The specified distribution does not exist.
- AccessDenied:
Access denied.
GetDistributionConfig
$result = $client->getDistributionConfig
([/* ... */]); $promise = $client->getDistributionConfigAsync
([/* ... */]);
Get the configuration information about a distribution.
Parameter Syntax
$result = $client->getDistributionConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
Result Syntax
[ 'DistributionConfig' => [ 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], // ... ], 'Quantity' => <integer>, ], 'CallerReference' => '<string>', 'Comment' => '<string>', 'ContinuousDeploymentPolicyId' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'DefaultCacheBehavior' => [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], 'DefaultRootObject' => '<string>', 'Enabled' => true || false, 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'IsIPV6Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'IncludeCookies' => true || false, 'Prefix' => '<string>', ], 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ 'StatusCodes' => [ 'Items' => [<integer>, ...], 'Quantity' => <integer>, ], ], 'Id' => '<string>', 'Members' => [ 'Items' => [ [ 'OriginId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, ], 'Origins' => [ 'Items' => [ [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', 'HeaderValue' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'DomainName' => '<string>', 'Id' => '<string>', 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', ], ], // ... ], 'Quantity' => <integer>, ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, 'RestrictionType' => 'blacklist|whitelist|none', ], ], 'Staging' => true || false, 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], 'ETag' => '<string>', ]
Result Details
Members
- DistributionConfig
-
- Type: DistributionConfig structure
The distribution's configuration information.
- ETag
-
- Type: string
The current version of the configuration. For example:
E2QWRUHAPOMQZL
.
Errors
- NoSuchDistribution:
The specified distribution does not exist.
- AccessDenied:
Access denied.
GetFieldLevelEncryption
$result = $client->getFieldLevelEncryption
([/* ... */]); $promise = $client->getFieldLevelEncryptionAsync
([/* ... */]);
Get the field-level encryption configuration information.
Parameter Syntax
$result = $client->getFieldLevelEncryption([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
Request the ID for the field-level encryption configuration information.
Result Syntax
[ 'ETag' => '<string>', 'FieldLevelEncryption' => [ 'FieldLevelEncryptionConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', 'ContentTypeProfileConfig' => [ 'ContentTypeProfiles' => [ 'Items' => [ [ 'ContentType' => '<string>', 'Format' => 'URLEncoded', 'ProfileId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'ForwardWhenContentTypeIsUnknown' => true || false, ], 'QueryArgProfileConfig' => [ 'ForwardWhenQueryArgProfileIsUnknown' => true || false, 'QueryArgProfiles' => [ 'Items' => [ [ 'ProfileId' => '<string>', 'QueryArg' => '<string>', ], // ... ], 'Quantity' => <integer>, ], ], ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], ]
Result Details
Members
- ETag
-
- Type: string
The current version of the field level encryption configuration. For example:
E2QWRUHAPOMQZL
. - FieldLevelEncryption
-
- Type: FieldLevelEncryption structure
Return the field-level encryption configuration information.
Errors
- AccessDenied:
Access denied.
- NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
GetFieldLevelEncryptionConfig
$result = $client->getFieldLevelEncryptionConfig
([/* ... */]); $promise = $client->getFieldLevelEncryptionConfigAsync
([/* ... */]);
Get the field-level encryption configuration information.
Parameter Syntax
$result = $client->getFieldLevelEncryptionConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
Request the ID for the field-level encryption configuration information.
Result Syntax
[ 'ETag' => '<string>', 'FieldLevelEncryptionConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', 'ContentTypeProfileConfig' => [ 'ContentTypeProfiles' => [ 'Items' => [ [ 'ContentType' => '<string>', 'Format' => 'URLEncoded', 'ProfileId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'ForwardWhenContentTypeIsUnknown' => true || false, ], 'QueryArgProfileConfig' => [ 'ForwardWhenQueryArgProfileIsUnknown' => true || false, 'QueryArgProfiles' => [ 'Items' => [ [ 'ProfileId' => '<string>', 'QueryArg' => '<string>', ], // ... ], 'Quantity' => <integer>, ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The current version of the field level encryption configuration. For example:
E2QWRUHAPOMQZL
. - FieldLevelEncryptionConfig
-
- Type: FieldLevelEncryptionConfig structure
Return the field-level encryption configuration information.
Errors
- AccessDenied:
Access denied.
- NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
GetFieldLevelEncryptionProfile
$result = $client->getFieldLevelEncryptionProfile
([/* ... */]); $promise = $client->getFieldLevelEncryptionProfileAsync
([/* ... */]);
Get the field-level encryption profile information.
Parameter Syntax
$result = $client->getFieldLevelEncryptionProfile([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
Get the ID for the field-level encryption profile information.
Result Syntax
[ 'ETag' => '<string>', 'FieldLevelEncryptionProfile' => [ 'FieldLevelEncryptionProfileConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', 'EncryptionEntities' => [ 'Items' => [ [ 'FieldPatterns' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ProviderId' => '<string>', 'PublicKeyId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Name' => '<string>', ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], ]
Result Details
Members
- ETag
-
- Type: string
The current version of the field level encryption profile. For example:
E2QWRUHAPOMQZL
. - FieldLevelEncryptionProfile
-
- Type: FieldLevelEncryptionProfile structure
Return the field-level encryption profile information.
Errors
- AccessDenied:
Access denied.
- NoSuchFieldLevelEncryptionProfile:
The specified profile for field-level encryption doesn't exist.
GetFieldLevelEncryptionProfileConfig
$result = $client->getFieldLevelEncryptionProfileConfig
([/* ... */]); $promise = $client->getFieldLevelEncryptionProfileConfigAsync
([/* ... */]);
Get the field-level encryption profile configuration information.
Parameter Syntax
$result = $client->getFieldLevelEncryptionProfileConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
Get the ID for the field-level encryption profile configuration information.
Result Syntax
[ 'ETag' => '<string>', 'FieldLevelEncryptionProfileConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', 'EncryptionEntities' => [ 'Items' => [ [ 'FieldPatterns' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ProviderId' => '<string>', 'PublicKeyId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Name' => '<string>', ], ]
Result Details
Members
- ETag
-
- Type: string
The current version of the field-level encryption profile configuration result. For example:
E2QWRUHAPOMQZL
. - FieldLevelEncryptionProfileConfig
-
- Type: FieldLevelEncryptionProfileConfig structure
Return the field-level encryption profile configuration information.
Errors
- AccessDenied:
Access denied.
- NoSuchFieldLevelEncryptionProfile:
The specified profile for field-level encryption doesn't exist.
GetFunction
$result = $client->getFunction
([/* ... */]); $promise = $client->getFunctionAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->getFunction([ 'Name' => '<string>', // REQUIRED 'Stage' => 'DEVELOPMENT|LIVE', ]);
Parameter Details
Members
- Name
-
- Required: Yes
- Type: string
The name of the function whose code you are getting.
- Stage
-
- Type: string
The function's stage, either
DEVELOPMENT
orLIVE
.
Result Syntax
[ 'ContentType' => '<string>', 'ETag' => '<string>', 'FunctionCode' => <string || resource || Psr\Http\Message\StreamInterface>, ]
Result Details
Members
- ContentType
-
- Type: string
The content type (media type) of the response.
- ETag
-
- Type: string
The version identifier for the current version of the CloudFront function.
- FunctionCode
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The function code of a CloudFront function.
Errors
- UnsupportedOperation:
This operation is not supported in this region.
- NoSuchFunctionExists:
The function does not exist.
GetInvalidation
$result = $client->getInvalidation
([/* ... */]); $promise = $client->getInvalidationAsync
([/* ... */]);
Get the information about an invalidation.
Parameter Syntax
$result = $client->getInvalidation([ 'DistributionId' => '<string>', // REQUIRED 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DistributionId
-
- Required: Yes
- Type: string
The distribution's ID.
- Id
-
- Required: Yes
- Type: string
The identifier for the invalidation request, for example,
IDFDVBD632BHDS5
.
Result Syntax
[ 'Invalidation' => [ 'CreateTime' => <DateTime>, 'Id' => '<string>', 'InvalidationBatch' => [ 'CallerReference' => '<string>', 'Paths' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Status' => '<string>', ], ]
Result Details
Members
- Invalidation
-
- Type: Invalidation structure
The invalidation's information. For more information, see Invalidation Complex Type.
Errors
- NoSuchDistribution:
The specified distribution does not exist.
- AccessDenied:
Access denied.
- NoSuchInvalidation:
The specified invalidation does not exist.
GetKeyGroup
$result = $client->getKeyGroup
([/* ... */]); $promise = $client->getKeyGroupAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->getKeyGroup([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the key group that you are getting. To get the identifier, use
ListKeyGroups
.
Result Syntax
[ 'ETag' => '<string>', 'KeyGroup' => [ 'Id' => '<string>', 'KeyGroupConfig' => [ 'Comment' => '<string>', 'Items' => ['<string>', ...], 'Name' => '<string>', ], 'LastModifiedTime' => <DateTime>, ], ]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the key group.
- KeyGroup
-
- Type: KeyGroup structure
The key group.
Errors
- NoSuchResource:
A resource that was specified is not valid.
GetKeyGroupConfig
$result = $client->getKeyGroupConfig
([/* ... */]); $promise = $client->getKeyGroupConfigAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->getKeyGroupConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the key group whose configuration you are getting. To get the identifier, use
ListKeyGroups
.
Result Syntax
[ 'ETag' => '<string>', 'KeyGroupConfig' => [ 'Comment' => '<string>', 'Items' => ['<string>', ...], 'Name' => '<string>', ], ]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the key group.
- KeyGroupConfig
-
- Type: KeyGroupConfig structure
The key group configuration.
Errors
- NoSuchResource:
A resource that was specified is not valid.
GetMonitoringSubscription
$result = $client->getMonitoringSubscription
([/* ... */]); $promise = $client->getMonitoringSubscriptionAsync
([/* ... */]);
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
Parameter Syntax
$result = $client->getMonitoringSubscription([ 'DistributionId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DistributionId
-
- Required: Yes
- Type: string
The ID of the distribution that you are getting metrics information for.
Result Syntax
[ 'MonitoringSubscription' => [ 'RealtimeMetricsSubscriptionConfig' => [ 'RealtimeMetricsSubscriptionStatus' => 'Enabled|Disabled', ], ], ]
Result Details
Members
- MonitoringSubscription
-
- Type: MonitoringSubscription structure
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
Errors
- NoSuchDistribution:
The specified distribution does not exist.
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- NoSuchMonitoringSubscription:
A monitoring subscription does not exist for the specified distribution.
GetOriginAccessControl
$result = $client->getOriginAccessControl
([/* ... */]); $promise = $client->getOriginAccessControlAsync
([/* ... */]);
Gets a CloudFront origin access control, including its unique identifier.
Parameter Syntax
$result = $client->getOriginAccessControl([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier of the origin access control.
Result Syntax
[ 'ETag' => '<string>', 'OriginAccessControl' => [ 'Id' => '<string>', 'OriginAccessControlConfig' => [ 'Description' => '<string>', 'Name' => '<string>', 'OriginAccessControlOriginType' => 's3|mediastore|mediapackagev2|lambda', 'SigningBehavior' => 'never|always|no-override', 'SigningProtocol' => 'sigv4', ], ], ]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the origin access control.
- OriginAccessControl
-
- Type: OriginAccessControl structure
Contains an origin access control, including its unique identifier.
Errors
- AccessDenied:
Access denied.
- NoSuchOriginAccessControl:
The origin access control does not exist.
GetOriginAccessControlConfig
$result = $client->getOriginAccessControlConfig
([/* ... */]); $promise = $client->getOriginAccessControlConfigAsync
([/* ... */]);
Gets a CloudFront origin access control configuration.
Parameter Syntax
$result = $client->getOriginAccessControlConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier of the origin access control.
Result Syntax
[ 'ETag' => '<string>', 'OriginAccessControlConfig' => [ 'Description' => '<string>', 'Name' => '<string>', 'OriginAccessControlOriginType' => 's3|mediastore|mediapackagev2|lambda', 'SigningBehavior' => 'never|always|no-override', 'SigningProtocol' => 'sigv4', ], ]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the origin access control.
- OriginAccessControlConfig
-
- Type: OriginAccessControlConfig structure
Contains an origin access control configuration.
Errors
- AccessDenied:
Access denied.
- NoSuchOriginAccessControl:
The origin access control does not exist.
GetOriginRequestPolicy
$result = $client->getOriginRequestPolicy
([/* ... */]); $promise = $client->getOriginRequestPolicyAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->getOriginRequestPolicy([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier for the origin request policy. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributions
orGetDistribution
. If the origin request policy is not attached to a cache behavior, you can get the identifier usingListOriginRequestPolicies
.
Result Syntax
[ 'ETag' => '<string>', 'OriginRequestPolicy' => [ 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'OriginRequestPolicyConfig' => [ 'Comment' => '<string>', 'CookiesConfig' => [ 'CookieBehavior' => 'none|whitelist|all|allExcept', 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'HeadersConfig' => [ 'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept', 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Name' => '<string>', 'QueryStringsConfig' => [ 'QueryStringBehavior' => 'none|whitelist|all|allExcept', 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The current version of the origin request policy.
- OriginRequestPolicy
-
- Type: OriginRequestPolicy structure
The origin request policy.
Errors
- AccessDenied:
Access denied.
- NoSuchOriginRequestPolicy:
The origin request policy does not exist.
GetOriginRequestPolicyConfig
$result = $client->getOriginRequestPolicyConfig
([/* ... */]); $promise = $client->getOriginRequestPolicyConfigAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->getOriginRequestPolicyConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier for the origin request policy. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributions
orGetDistribution
. If the origin request policy is not attached to a cache behavior, you can get the identifier usingListOriginRequestPolicies
.
Result Syntax
[ 'ETag' => '<string>', 'OriginRequestPolicyConfig' => [ 'Comment' => '<string>', 'CookiesConfig' => [ 'CookieBehavior' => 'none|whitelist|all|allExcept', 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'HeadersConfig' => [ 'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept', 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Name' => '<string>', 'QueryStringsConfig' => [ 'QueryStringBehavior' => 'none|whitelist|all|allExcept', 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The current version of the origin request policy.
- OriginRequestPolicyConfig
-
- Type: OriginRequestPolicyConfig structure
The origin request policy configuration.
Errors
- AccessDenied:
Access denied.
- NoSuchOriginRequestPolicy:
The origin request policy does not exist.
GetPublicKey
$result = $client->getPublicKey
([/* ... */]); $promise = $client->getPublicKeyAsync
([/* ... */]);
Gets a public key.
Parameter Syntax
$result = $client->getPublicKey([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the public key you are getting.
Result Syntax
[ 'ETag' => '<string>', 'PublicKey' => [ 'CreatedTime' => <DateTime>, 'Id' => '<string>', 'PublicKeyConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', 'EncodedKey' => '<string>', 'Name' => '<string>', ], ], ]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the public key.
- PublicKey
-
- Type: PublicKey structure
The public key.
Errors
- AccessDenied:
Access denied.
- NoSuchPublicKey:
The specified public key doesn't exist.
GetPublicKeyConfig
$result = $client->getPublicKeyConfig
([/* ... */]); $promise = $client->getPublicKeyConfigAsync
([/* ... */]);
Gets a public key configuration.
Parameter Syntax
$result = $client->getPublicKeyConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the public key whose configuration you are getting.
Result Syntax
[ 'ETag' => '<string>', 'PublicKeyConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', 'EncodedKey' => '<string>', 'Name' => '<string>', ], ]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the public key configuration.
- PublicKeyConfig
-
- Type: PublicKeyConfig structure
A public key configuration.
Errors
- AccessDenied:
Access denied.
- NoSuchPublicKey:
The specified public key doesn't exist.
GetRealtimeLogConfig
$result = $client->getRealtimeLogConfig
([/* ... */]); $promise = $client->getRealtimeLogConfigAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getRealtimeLogConfig([ 'ARN' => '<string>', 'Name' => '<string>', ]);
Parameter Details
Members
- ARN
-
- Type: string
The Amazon Resource Name (ARN) of the real-time log configuration to get.
- Name
-
- Type: string
The name of the real-time log configuration to get.
Result Syntax
[ 'RealtimeLogConfig' => [ 'ARN' => '<string>', 'EndPoints' => [ [ 'KinesisStreamConfig' => [ 'RoleARN' => '<string>', 'StreamARN' => '<string>', ], 'StreamType' => '<string>', ], // ... ], 'Fields' => ['<string>', ...], 'Name' => '<string>', 'SamplingRate' => <integer>, ], ]
Result Details
Members
- RealtimeLogConfig
-
- Type: RealtimeLogConfig structure
A real-time log configuration.
Errors
- AccessDenied:
Access denied.
- InvalidArgument:
An argument is invalid.
- NoSuchRealtimeLogConfig:
The real-time log configuration does not exist.
GetResponseHeadersPolicy
$result = $client->getResponseHeadersPolicy
([/* ... */]); $promise = $client->getResponseHeadersPolicyAsync
([/* ... */]);
Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
To get a response headers policy, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions
or GetDistribution
. If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies
.
Parameter Syntax
$result = $client->getResponseHeadersPolicy([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier for the response headers policy.
If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributions
orGetDistribution
. If the response headers policy is not attached to a cache behavior, you can get the identifier usingListResponseHeadersPolicies
.
Result Syntax
[ 'ETag' => '<string>', 'ResponseHeadersPolicy' => [ 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'ResponseHeadersPolicyConfig' => [ 'Comment' => '<string>', 'CorsConfig' => [ 'AccessControlAllowCredentials' => true || false, 'AccessControlAllowHeaders' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlAllowMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlAllowOrigins' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlExposeHeaders' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlMaxAgeSec' => <integer>, 'OriginOverride' => true || false, ], 'CustomHeadersConfig' => [ 'Items' => [ [ 'Header' => '<string>', 'Override' => true || false, 'Value' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Name' => '<string>', 'RemoveHeadersConfig' => [ 'Items' => [ [ 'Header' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SecurityHeadersConfig' => [ 'ContentSecurityPolicy' => [ 'ContentSecurityPolicy' => '<string>', 'Override' => true || false, ], 'ContentTypeOptions' => [ 'Override' => true || false, ], 'FrameOptions' => [ 'FrameOption' => 'DENY|SAMEORIGIN', 'Override' => true || false, ], 'ReferrerPolicy' => [ 'Override' => true || false, 'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url', ], 'StrictTransportSecurity' => [ 'AccessControlMaxAgeSec' => <integer>, 'IncludeSubdomains' => true || false, 'Override' => true || false, 'Preload' => true || false, ], 'XSSProtection' => [ 'ModeBlock' => true || false, 'Override' => true || false, 'Protection' => true || false, 'ReportUri' => '<string>', ], ], 'ServerTimingHeadersConfig' => [ 'Enabled' => true || false, 'SamplingRate' => <float>, ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the response headers policy.
- ResponseHeadersPolicy
-
- Type: ResponseHeadersPolicy structure
Contains a response headers policy.
Errors
- AccessDenied:
Access denied.
- NoSuchResponseHeadersPolicy:
The response headers policy does not exist.
GetResponseHeadersPolicyConfig
$result = $client->getResponseHeadersPolicyConfig
([/* ... */]); $promise = $client->getResponseHeadersPolicyConfigAsync
([/* ... */]);
Gets a response headers policy configuration.
To get a response headers policy configuration, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions
or GetDistribution
. If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies
.
Parameter Syntax
$result = $client->getResponseHeadersPolicyConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier for the response headers policy.
If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributions
orGetDistribution
. If the response headers policy is not attached to a cache behavior, you can get the identifier usingListResponseHeadersPolicies
.
Result Syntax
[ 'ETag' => '<string>', 'ResponseHeadersPolicyConfig' => [ 'Comment' => '<string>', 'CorsConfig' => [ 'AccessControlAllowCredentials' => true || false, 'AccessControlAllowHeaders' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlAllowMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlAllowOrigins' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlExposeHeaders' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlMaxAgeSec' => <integer>, 'OriginOverride' => true || false, ], 'CustomHeadersConfig' => [ 'Items' => [ [ 'Header' => '<string>', 'Override' => true || false, 'Value' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Name' => '<string>', 'RemoveHeadersConfig' => [ 'Items' => [ [ 'Header' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SecurityHeadersConfig' => [ 'ContentSecurityPolicy' => [ 'ContentSecurityPolicy' => '<string>', 'Override' => true || false, ], 'ContentTypeOptions' => [ 'Override' => true || false, ], 'FrameOptions' => [ 'FrameOption' => 'DENY|SAMEORIGIN', 'Override' => true || false, ], 'ReferrerPolicy' => [ 'Override' => true || false, 'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url', ], 'StrictTransportSecurity' => [ 'AccessControlMaxAgeSec' => <integer>, 'IncludeSubdomains' => true || false, 'Override' => true || false, 'Preload' => true || false, ], 'XSSProtection' => [ 'ModeBlock' => true || false, 'Override' => true || false, 'Protection' => true || false, 'ReportUri' => '<string>', ], ], 'ServerTimingHeadersConfig' => [ 'Enabled' => true || false, 'SamplingRate' => <float>, ], ], ]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the response headers policy.
- ResponseHeadersPolicyConfig
-
- Type: ResponseHeadersPolicyConfig structure
Contains a response headers policy.
Errors
- AccessDenied:
Access denied.
- NoSuchResponseHeadersPolicy:
The response headers policy does not exist.
GetStreamingDistribution
$result = $client->getStreamingDistribution
([/* ... */]); $promise = $client->getStreamingDistributionAsync
([/* ... */]);
Gets information about a specified RTMP distribution, including the distribution configuration.
Parameter Syntax
$result = $client->getStreamingDistribution([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The streaming distribution's ID.
Result Syntax
[ 'ETag' => '<string>', 'StreamingDistribution' => [ 'ARN' => '<string>', 'ActiveTrustedSigners' => [ 'Enabled' => true || false, 'Items' => [ [ 'AwsAccountNumber' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'DomainName' => '<string>', 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', 'StreamingDistributionConfig' => [ 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CallerReference' => '<string>', 'Comment' => '<string>', 'Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'Prefix' => '<string>', ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'S3Origin' => [ 'DomainName' => '<string>', 'OriginAccessIdentity' => '<string>', ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The current version of the streaming distribution's information. For example:
E2QWRUHAPOMQZL
. - StreamingDistribution
-
- Type: StreamingDistribution structure
The streaming distribution's information.
Errors
- AccessDenied:
Access denied.
- NoSuchStreamingDistribution:
The specified streaming distribution does not exist.
GetStreamingDistributionConfig
$result = $client->getStreamingDistributionConfig
([/* ... */]); $promise = $client->getStreamingDistributionConfigAsync
([/* ... */]);
Get the configuration information about a streaming distribution.
Parameter Syntax
$result = $client->getStreamingDistributionConfig([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The streaming distribution's ID.
Result Syntax
[ 'ETag' => '<string>', 'StreamingDistributionConfig' => [ 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CallerReference' => '<string>', 'Comment' => '<string>', 'Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'Prefix' => '<string>', ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'S3Origin' => [ 'DomainName' => '<string>', 'OriginAccessIdentity' => '<string>', ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ]
Result Details
Members
- ETag
-
- Type: string
The current version of the configuration. For example:
E2QWRUHAPOMQZL
. - StreamingDistributionConfig
-
- Type: StreamingDistributionConfig structure
The streaming distribution's configuration information.
Errors
- AccessDenied:
Access denied.
- NoSuchStreamingDistribution:
The specified streaming distribution does not exist.
GetVpcOrigin
$result = $client->getVpcOrigin
([/* ... */]); $promise = $client->getVpcOriginAsync
([/* ... */]);
Get the details of an Amazon CloudFront VPC origin.
Parameter Syntax
$result = $client->getVpcOrigin([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The VPC origin ID.
Result Syntax
[ 'ETag' => '<string>', 'VpcOrigin' => [ 'Arn' => '<string>', 'CreatedTime' => <DateTime>, 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', 'VpcOriginEndpointConfig' => [ 'Arn' => '<string>', 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'Name' => '<string>', 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ]
Result Details
Members
- ETag
-
- Type: string
The VPC origin ETag.
- VpcOrigin
-
- Type: VpcOrigin structure
The VPC origin.
Errors
- EntityNotFound:
The entity was not found.
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
Examples
Example 1: To get a VPC origin
The following command gets a VPC origin:
$result = $client->getVpcOrigin([ 'Id' => 'vo_BQwjxxQxjCaBcQLzJUFkDM', ]);
Result syntax:
[ 'ETag' => 'ETVPDKIKX0DER', 'VpcOrigin' => [ 'Arn' => 'arn:aws:cloudfront::123456789012:vpcorigin/vo_BQwjxxQxjCaBcQLzJUFkDM', 'CreatedTime' =>, 'Id' => 'vo_BQwjxxQxjCaBcQLzJUFkDM', 'LastModifiedTime' => , 'Status' => 'Deployed', 'VpcOriginEndpointConfig' => [ 'Arn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d', 'HTTPPort' => 80, 'HTTPSPort' => 443, 'Name' => 'my-vpcorigin-name', 'OriginProtocolPolicy' => 'match-viewer', 'OriginSslProtocols' => [ 'Items' => [ 'TLSv1.1', 'TLSv1.2', ], 'Quantity' => 2, ], ], ], ]
ListAnycastIpLists
$result = $client->listAnycastIpLists
([/* ... */]); $promise = $client->listAnycastIpListsAsync
([/* ... */]);
Lists your Anycast static IP lists.
Parameter Syntax
$result = $client->listAnycastIpLists([ 'Marker' => '<string>', 'MaxItems' => <integer>, ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: int
The maximum number of Anycast static IP lists that you want returned in the response.
Result Syntax
[ 'AnycastIpLists' => [ 'IsTruncated' => true || false, 'Items' => [ [ 'Arn' => '<string>', 'Id' => '<string>', 'IpCount' => <integer>, 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Status' => '<string>', ], // ... ], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- AnycastIpLists
-
- Type: AnycastIpListCollection structure
Root level tag for the
AnycastIpLists
parameters.
Errors
- EntityNotFound:
The entity was not found.
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
ListCachePolicies
$result = $client->listCachePolicies
([/* ... */]); $promise = $client->listCachePoliciesAsync
([/* ... */]);
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 Amazon Web Services 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.
Parameter Syntax
$result = $client->listCachePolicies([ 'Marker' => '<string>', 'MaxItems' => '<string>', 'Type' => 'managed|custom', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of cache policies. The response includes cache policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of cache policies that you want in the response.
- Type
-
- Type: string
A filter to return only the specified kinds of cache policies. Valid values are:
-
managed
– Returns only the managed policies created by Amazon Web Services. -
custom
– Returns only the custom policies created in your Amazon Web Services account.
Result Syntax
[ 'CachePolicyList' => [ 'Items' => [ [ 'CachePolicy' => [ 'CachePolicyConfig' => [ 'Comment' => '<string>', 'DefaultTTL' => <integer>, 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'Name' => '<string>', 'ParametersInCacheKeyAndForwardedToOrigin' => [ 'CookiesConfig' => [ 'CookieBehavior' => 'none|whitelist|allExcept|all', 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'EnableAcceptEncodingBrotli' => true || false, 'EnableAcceptEncodingGzip' => true || false, 'HeadersConfig' => [ 'HeaderBehavior' => 'none|whitelist', 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'QueryStringsConfig' => [ 'QueryStringBehavior' => 'none|whitelist|allExcept|all', 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], 'Type' => 'managed|custom', ], // ... ], 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- CachePolicyList
-
- Type: CachePolicyList structure
A list of cache policies.
Errors
- NoSuchCachePolicy:
The cache policy does not exist.
- AccessDenied:
Access denied.
- InvalidArgument:
An argument is invalid.
ListCloudFrontOriginAccessIdentities
$result = $client->listCloudFrontOriginAccessIdentities
([/* ... */]); $promise = $client->listCloudFrontOriginAccessIdentitiesAsync
([/* ... */]);
Lists origin access identities.
Parameter Syntax
$result = $client->listCloudFrontOriginAccessIdentities([ 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the
Marker
to the value of theNextMarker
from the current page's response (which is also the ID of the last identity on that page). - MaxItems
-
- Type: string
The maximum number of origin access identities you want in the response body.
Result Syntax
[ 'CloudFrontOriginAccessIdentityList' => [ 'IsTruncated' => true || false, 'Items' => [ [ 'Comment' => '<string>', 'Id' => '<string>', 'S3CanonicalUserId' => '<string>', ], // ... ], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- CloudFrontOriginAccessIdentityList
-
- Type: CloudFrontOriginAccessIdentityList structure
The
CloudFrontOriginAccessIdentityList
type.
Errors
- InvalidArgument:
An argument is invalid.
ListConflictingAliases
$result = $client->listConflictingAliases
([/* ... */]); $promise = $client->listConflictingAliasesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listConflictingAliases([ 'Alias' => '<string>', // REQUIRED 'DistributionId' => '<string>', // REQUIRED 'Marker' => '<string>', 'MaxItems' => <integer>, ]);
Parameter Details
Members
- Alias
-
- Required: Yes
- Type: string
The alias (also called a CNAME) to search for conflicting aliases.
- DistributionId
-
- Required: Yes
- Type: string
The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: int
The maximum number of conflicting aliases that you want in the response.
Result Syntax
[ 'ConflictingAliasesList' => [ 'Items' => [ [ 'AccountId' => '<string>', 'Alias' => '<string>', 'DistributionId' => '<string>', ], // ... ], 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- ConflictingAliasesList
-
- Type: ConflictingAliasesList structure
A list of conflicting aliases.
Errors
- NoSuchDistribution:
The specified distribution does not exist.
- InvalidArgument:
An argument is invalid.
ListContinuousDeploymentPolicies
$result = $client->listContinuousDeploymentPolicies
([/* ... */]); $promise = $client->listContinuousDeploymentPoliciesAsync
([/* ... */]);
Gets a list of the continuous deployment policies in your Amazon Web Services 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.
Parameter Syntax
$result = $client->listContinuousDeploymentPolicies([ 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of continuous deployment policies. The response includes policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of continuous deployment policies that you want returned in the response.
Result Syntax
[ 'ContinuousDeploymentPolicyList' => [ 'Items' => [ [ 'ContinuousDeploymentPolicy' => [ 'ContinuousDeploymentPolicyConfig' => [ 'Enabled' => true || false, 'StagingDistributionDnsNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrafficConfig' => [ 'SingleHeaderConfig' => [ 'Header' => '<string>', 'Value' => '<string>', ], 'SingleWeightConfig' => [ 'SessionStickinessConfig' => [ 'IdleTTL' => <integer>, 'MaximumTTL' => <integer>, ], 'Weight' => <float>, ], 'Type' => 'SingleWeight|SingleHeader', ], ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], ], // ... ], 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- ContinuousDeploymentPolicyList
-
- Type: ContinuousDeploymentPolicyList structure
A list of continuous deployment policies.
Errors
- AccessDenied:
Access denied.
- InvalidArgument:
An argument is invalid.
- NoSuchContinuousDeploymentPolicy:
The continuous deployment policy doesn't exist.
ListDistributions
$result = $client->listDistributions
([/* ... */]); $promise = $client->listDistributionsAsync
([/* ... */]);
List CloudFront distributions.
Parameter Syntax
$result = $client->listDistributions([ 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the
Marker
to the value of theNextMarker
from the current page's response (which is also the ID of the last distribution on that page). - MaxItems
-
- Type: string
The maximum number of distributions you want in the response body.
Result Syntax
[ 'DistributionList' => [ 'IsTruncated' => true || false, 'Items' => [ [ 'ARN' => '<string>', 'AliasICPRecordals' => [ [ 'CNAME' => '<string>', 'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING', ], // ... ], 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], // ... ], 'Quantity' => <integer>, ], 'Comment' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'DefaultCacheBehavior' => [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], 'DomainName' => '<string>', 'Enabled' => true || false, 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'Id' => '<string>', 'IsIPV6Enabled' => true || false, 'LastModifiedTime' => <DateTime>, 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ 'StatusCodes' => [ 'Items' => [<integer>, ...], 'Quantity' => <integer>, ], ], 'Id' => '<string>', 'Members' => [ 'Items' => [ [ 'OriginId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, ], 'Origins' => [ 'Items' => [ [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', 'HeaderValue' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'DomainName' => '<string>', 'Id' => '<string>', 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', ], ], // ... ], 'Quantity' => <integer>, ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, 'RestrictionType' => 'blacklist|whitelist|none', ], ], 'Staging' => true || false, 'Status' => '<string>', 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], // ... ], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- DistributionList
-
- Type: DistributionList structure
The
DistributionList
type.
Errors
- InvalidArgument:
An argument is invalid.
ListDistributionsByAnycastIpListId
$result = $client->listDistributionsByAnycastIpListId
([/* ... */]); $promise = $client->listDistributionsByAnycastIpListIdAsync
([/* ... */]);
Lists the distributions in your account that are associated with the specified AnycastIpListId
.
Parameter Syntax
$result = $client->listDistributionsByAnycastIpListId([ 'AnycastIpListId' => '<string>', // REQUIRED 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- AnycastIpListId
-
- Required: Yes
- Type: string
The ID of the Anycast static IP list.
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of distributions that you want returned in the response.
Result Syntax
[ 'DistributionList' => [ 'IsTruncated' => true || false, 'Items' => [ [ 'ARN' => '<string>', 'AliasICPRecordals' => [ [ 'CNAME' => '<string>', 'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING', ], // ... ], 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], // ... ], 'Quantity' => <integer>, ], 'Comment' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'DefaultCacheBehavior' => [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], 'DomainName' => '<string>', 'Enabled' => true || false, 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'Id' => '<string>', 'IsIPV6Enabled' => true || false, 'LastModifiedTime' => <DateTime>, 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ 'StatusCodes' => [ 'Items' => [<integer>, ...], 'Quantity' => <integer>, ], ], 'Id' => '<string>', 'Members' => [ 'Items' => [ [ 'OriginId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, ], 'Origins' => [ 'Items' => [ [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', 'HeaderValue' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'DomainName' => '<string>', 'Id' => '<string>', 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', ], ], // ... ], 'Quantity' => <integer>, ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, 'RestrictionType' => 'blacklist|whitelist|none', ], ], 'Staging' => true || false, 'Status' => '<string>', 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], // ... ], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- DistributionList
-
- Type: DistributionList structure
A distribution list.
Errors
- EntityNotFound:
The entity was not found.
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
ListDistributionsByCachePolicyId
$result = $client->listDistributionsByCachePolicyId
([/* ... */]); $promise = $client->listDistributionsByCachePolicyIdAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listDistributionsByCachePolicyId([ 'CachePolicyId' => '<string>', // REQUIRED 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- CachePolicyId
-
- Required: Yes
- Type: string
The ID of the cache policy whose associated distribution IDs you want to list.
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of distribution IDs that you want in the response.
Result Syntax
[ 'DistributionIdList' => [ 'IsTruncated' => true || false, 'Items' => ['<string>', ...], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- DistributionIdList
-
- Type: DistributionIdList structure
A list of distribution IDs.
Errors
- NoSuchCachePolicy:
The cache policy does not exist.
- AccessDenied:
Access denied.
- InvalidArgument:
An argument is invalid.
ListDistributionsByKeyGroup
$result = $client->listDistributionsByKeyGroup
([/* ... */]); $promise = $client->listDistributionsByKeyGroupAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listDistributionsByKeyGroup([ 'KeyGroupId' => '<string>', // REQUIRED 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- KeyGroupId
-
- Required: Yes
- Type: string
The ID of the key group whose associated distribution IDs you are listing.
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of distribution IDs that you want in the response.
Result Syntax
[ 'DistributionIdList' => [ 'IsTruncated' => true || false, 'Items' => ['<string>', ...], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- DistributionIdList
-
- Type: DistributionIdList structure
A list of distribution IDs.
Errors
- InvalidArgument:
An argument is invalid.
- NoSuchResource:
A resource that was specified is not valid.
ListDistributionsByOriginRequestPolicyId
$result = $client->listDistributionsByOriginRequestPolicyId
([/* ... */]); $promise = $client->listDistributionsByOriginRequestPolicyIdAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listDistributionsByOriginRequestPolicyId([ 'Marker' => '<string>', 'MaxItems' => '<string>', 'OriginRequestPolicyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of distribution IDs that you want in the response.
- OriginRequestPolicyId
-
- Required: Yes
- Type: string
The ID of the origin request policy whose associated distribution IDs you want to list.
Result Syntax
[ 'DistributionIdList' => [ 'IsTruncated' => true || false, 'Items' => ['<string>', ...], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- DistributionIdList
-
- Type: DistributionIdList structure
A list of distribution IDs.
Errors
- AccessDenied:
Access denied.
- NoSuchOriginRequestPolicy:
The origin request policy does not exist.
- InvalidArgument:
An argument is invalid.
ListDistributionsByRealtimeLogConfig
$result = $client->listDistributionsByRealtimeLogConfig
([/* ... */]); $promise = $client->listDistributionsByRealtimeLogConfigAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listDistributionsByRealtimeLogConfig([ 'Marker' => '<string>', 'MaxItems' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'RealtimeLogConfigName' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of distributions. The response includes distributions in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of distributions that you want in the response.
- RealtimeLogConfigArn
-
- Type: string
The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list.
- RealtimeLogConfigName
-
- Type: string
The name of the real-time log configuration whose associated distributions you want to list.
Result Syntax
[ 'DistributionList' => [ 'IsTruncated' => true || false, 'Items' => [ [ 'ARN' => '<string>', 'AliasICPRecordals' => [ [ 'CNAME' => '<string>', 'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING', ], // ... ], 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], // ... ], 'Quantity' => <integer>, ], 'Comment' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'DefaultCacheBehavior' => [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], 'DomainName' => '<string>', 'Enabled' => true || false, 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'Id' => '<string>', 'IsIPV6Enabled' => true || false, 'LastModifiedTime' => <DateTime>, 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ 'StatusCodes' => [ 'Items' => [<integer>, ...], 'Quantity' => <integer>, ], ], 'Id' => '<string>', 'Members' => [ 'Items' => [ [ 'OriginId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, ], 'Origins' => [ 'Items' => [ [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', 'HeaderValue' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'DomainName' => '<string>', 'Id' => '<string>', 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', ], ], // ... ], 'Quantity' => <integer>, ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, 'RestrictionType' => 'blacklist|whitelist|none', ], ], 'Staging' => true || false, 'Status' => '<string>', 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], // ... ], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- DistributionList
-
- Type: DistributionList structure
A distribution list.
Errors
- InvalidArgument:
An argument is invalid.
ListDistributionsByResponseHeadersPolicyId
$result = $client->listDistributionsByResponseHeadersPolicyId
([/* ... */]); $promise = $client->listDistributionsByResponseHeadersPolicyIdAsync
([/* ... */]);
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers 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.
Parameter Syntax
$result = $client->listDistributionsByResponseHeadersPolicyId([ 'Marker' => '<string>', 'MaxItems' => '<string>', 'ResponseHeadersPolicyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of distribution IDs that you want to get in the response.
- ResponseHeadersPolicyId
-
- Required: Yes
- Type: string
The ID of the response headers policy whose associated distribution IDs you want to list.
Result Syntax
[ 'DistributionIdList' => [ 'IsTruncated' => true || false, 'Items' => ['<string>', ...], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- DistributionIdList
-
- Type: DistributionIdList structure
A list of distribution IDs.
Errors
- AccessDenied:
Access denied.
- NoSuchResponseHeadersPolicy:
The response headers policy does not exist.
- InvalidArgument:
An argument is invalid.
ListDistributionsByVpcOriginId
$result = $client->listDistributionsByVpcOriginId
([/* ... */]); $promise = $client->listDistributionsByVpcOriginIdAsync
([/* ... */]);
List CloudFront distributions by their VPC origin ID.
Parameter Syntax
$result = $client->listDistributionsByVpcOriginId([ 'Marker' => '<string>', 'MaxItems' => '<string>', 'VpcOriginId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Marker
-
- Type: string
The marker associated with the VPC origin distributions list.
- MaxItems
-
- Type: string
The maximum number of items included in the list.
- VpcOriginId
-
- Required: Yes
- Type: string
The VPC origin ID.
Result Syntax
[ 'DistributionIdList' => [ 'IsTruncated' => true || false, 'Items' => ['<string>', ...], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- DistributionIdList
-
- Type: DistributionIdList structure
A list of distribution IDs.
Errors
- EntityNotFound:
The entity was not found.
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
Examples
Example 1: To list distributions by VPC origin ID
The following command lists distributions by VPC origin ID:
$result = $client->listDistributionsByVpcOriginId([ 'VpcOriginId' => 'vo_BQwjxxQxjCaBcQLzJUFkDM', ]);
Result syntax:
[ 'DistributionIdList' => [ 'IsTruncated' => , 'Items' => [ ], 'Marker' => 'a', 'MaxItems' => 100, 'Quantity' => 0, ], ]
ListDistributionsByWebACLId
$result = $client->listDistributionsByWebACLId
([/* ... */]); $promise = $client->listDistributionsByWebACLIdAsync
([/* ... */]);
List the distributions that are associated with a specified WAF web ACL.
Parameter Syntax
$result = $client->listDistributionsByWebACLId([ 'Marker' => '<string>', 'MaxItems' => '<string>', 'WebACLId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Marker
-
- Type: string
Use
Marker
andMaxItems
to control pagination of results. If you have more thanMaxItems
distributions that satisfy the request, the response includes aNextMarker
element. To get the next page of results, submit another request. For the value ofMarker
, specify the value ofNextMarker
from the last response. (For the first request, omitMarker
.) - MaxItems
-
- Type: string
The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
- WebACLId
-
- Required: Yes
- Type: string
The ID of the WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.
For WAFV2, this is the ARN of the web ACL, such as
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
.For WAF Classic, this is the ID of the web ACL, such as
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
.
Result Syntax
[ 'DistributionList' => [ 'IsTruncated' => true || false, 'Items' => [ [ 'ARN' => '<string>', 'AliasICPRecordals' => [ [ 'CNAME' => '<string>', 'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING', ], // ... ], 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], // ... ], 'Quantity' => <integer>, ], 'Comment' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'DefaultCacheBehavior' => [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], 'DomainName' => '<string>', 'Enabled' => true || false, 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'Id' => '<string>', 'IsIPV6Enabled' => true || false, 'LastModifiedTime' => <DateTime>, 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ 'StatusCodes' => [ 'Items' => [<integer>, ...], 'Quantity' => <integer>, ], ], 'Id' => '<string>', 'Members' => [ 'Items' => [ [ 'OriginId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, ], 'Origins' => [ 'Items' => [ [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', 'HeaderValue' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'DomainName' => '<string>', 'Id' => '<string>', 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', ], ], // ... ], 'Quantity' => <integer>, ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, 'RestrictionType' => 'blacklist|whitelist|none', ], ], 'Staging' => true || false, 'Status' => '<string>', 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], // ... ], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- DistributionList
-
- Type: DistributionList structure
The
DistributionList
type.
Errors
- InvalidWebACLId:
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 example473e64fd-f30b-4765-81a0-62ad96dd167a
.- InvalidArgument:
An argument is invalid.
ListFieldLevelEncryptionConfigs
$result = $client->listFieldLevelEncryptionConfigs
([/* ... */]); $promise = $client->listFieldLevelEncryptionConfigsAsync
([/* ... */]);
List all field-level encryption configurations that have been created in CloudFront for this account.
Parameter Syntax
$result = $client->listFieldLevelEncryptionConfigs([ 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the
Marker
to the value of theNextMarker
from the current page's response (which is also the ID of the last configuration on that page). - MaxItems
-
- Type: string
The maximum number of field-level encryption configurations you want in the response body.
Result Syntax
[ 'FieldLevelEncryptionList' => [ 'Items' => [ [ 'Comment' => '<string>', 'ContentTypeProfileConfig' => [ 'ContentTypeProfiles' => [ 'Items' => [ [ 'ContentType' => '<string>', 'Format' => 'URLEncoded', 'ProfileId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'ForwardWhenContentTypeIsUnknown' => true || false, ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'QueryArgProfileConfig' => [ 'ForwardWhenQueryArgProfileIsUnknown' => true || false, 'QueryArgProfiles' => [ 'Items' => [ [ 'ProfileId' => '<string>', 'QueryArg' => '<string>', ], // ... ], 'Quantity' => <integer>, ], ], ], // ... ], 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- FieldLevelEncryptionList
-
- Type: FieldLevelEncryptionList structure
Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.
Errors
- InvalidArgument:
An argument is invalid.
ListFieldLevelEncryptionProfiles
$result = $client->listFieldLevelEncryptionProfiles
([/* ... */]); $promise = $client->listFieldLevelEncryptionProfilesAsync
([/* ... */]);
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
Parameter Syntax
$result = $client->listFieldLevelEncryptionProfiles([ 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the
Marker
to the value of theNextMarker
from the current page's response (which is also the ID of the last profile on that page). - MaxItems
-
- Type: string
The maximum number of field-level encryption profiles you want in the response body.
Result Syntax
[ 'FieldLevelEncryptionProfileList' => [ 'Items' => [ [ 'Comment' => '<string>', 'EncryptionEntities' => [ 'Items' => [ [ 'FieldPatterns' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ProviderId' => '<string>', 'PublicKeyId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', ], // ... ], 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- FieldLevelEncryptionProfileList
-
- Type: FieldLevelEncryptionProfileList structure
Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.
Errors
- InvalidArgument:
An argument is invalid.
ListFunctions
$result = $client->listFunctions
([/* ... */]); $promise = $client->listFunctionsAsync
([/* ... */]);
Gets a list of all CloudFront functions in your Amazon Web Services 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.
Parameter Syntax
$result = $client->listFunctions([ 'Marker' => '<string>', 'MaxItems' => '<string>', 'Stage' => 'DEVELOPMENT|LIVE', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of functions. The response includes functions in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of functions that you want in the response.
- Stage
-
- Type: string
An optional filter to return only the functions that are in the specified stage, either
DEVELOPMENT
orLIVE
.
Result Syntax
[ 'FunctionList' => [ 'Items' => [ [ 'FunctionConfig' => [ 'Comment' => '<string>', 'KeyValueStoreAssociations' => [ 'Items' => [ [ 'KeyValueStoreARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Runtime' => 'cloudfront-js-1.0|cloudfront-js-2.0', ], 'FunctionMetadata' => [ 'CreatedTime' => <DateTime>, 'FunctionARN' => '<string>', 'LastModifiedTime' => <DateTime>, 'Stage' => 'DEVELOPMENT|LIVE', ], 'Name' => '<string>', 'Status' => '<string>', ], // ... ], 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- FunctionList
-
- Type: FunctionList structure
A list of CloudFront functions.
Errors
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
ListInvalidations
$result = $client->listInvalidations
([/* ... */]); $promise = $client->listInvalidationsAsync
([/* ... */]);
Lists invalidation batches.
Parameter Syntax
$result = $client->listInvalidations([ 'DistributionId' => '<string>', // REQUIRED 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- DistributionId
-
- Required: Yes
- Type: string
The distribution's ID.
- Marker
-
- Type: string
Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set
Marker
to the value of theNextMarker
from the current page's response. This value is the same as the ID of the last invalidation batch on that page. - MaxItems
-
- Type: string
The maximum number of invalidation batches that you want in the response body.
Result Syntax
[ 'InvalidationList' => [ 'IsTruncated' => true || false, 'Items' => [ [ 'CreateTime' => <DateTime>, 'Id' => '<string>', 'Status' => '<string>', ], // ... ], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- InvalidationList
-
- Type: InvalidationList structure
Information about invalidation batches.
Errors
- NoSuchDistribution:
The specified distribution does not exist.
- AccessDenied:
Access denied.
- InvalidArgument:
An argument is invalid.
ListKeyGroups
$result = $client->listKeyGroups
([/* ... */]); $promise = $client->listKeyGroupsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listKeyGroups([ 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of key groups. The response includes key groups in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of key groups that you want in the response.
Result Syntax
[ 'KeyGroupList' => [ 'Items' => [ [ 'KeyGroup' => [ 'Id' => '<string>', 'KeyGroupConfig' => [ 'Comment' => '<string>', 'Items' => ['<string>', ...], 'Name' => '<string>', ], 'LastModifiedTime' => <DateTime>, ], ], // ... ], 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- KeyGroupList
-
- Type: KeyGroupList structure
A list of key groups.
Errors
- InvalidArgument:
An argument is invalid.
ListKeyValueStores
$result = $client->listKeyValueStores
([/* ... */]); $promise = $client->listKeyValueStoresAsync
([/* ... */]);
Specifies the key value stores to list.
Parameter Syntax
$result = $client->listKeyValueStores([ 'Marker' => '<string>', 'MaxItems' => '<string>', 'Status' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
The marker associated with the key value stores list.
- MaxItems
-
- Type: string
The maximum number of items in the key value stores list.
- Status
-
- Type: string
The status of the request for the key value stores list.
Result Syntax
[ 'KeyValueStoreList' => [ 'Items' => [ [ 'ARN' => '<string>', 'Comment' => '<string>', 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Status' => '<string>', ], // ... ], 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- KeyValueStoreList
-
- Type: KeyValueStoreList structure
The resulting key value stores list.
Errors
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
Examples
Example 1: To get a list of KeyValueStores
The following command retrieves a list of KeyValueStores with READY status.
$result = $client->listKeyValueStores([ 'Status' => 'READY', ]);
Result syntax:
[ 'KeyValueStoreList' => [ 'Items' => [ [ 'ARN' => 'arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889', 'Comment' => '', 'Id' => '54947df8-0e9e-4471-a2f9-9af509fb5889', 'LastModifiedTime' =>, 'Name' => 'my-keyvaluestore-name', 'Status' => 'READY', ], ], 'MaxItems' => 100, 'NextMarker' => '', 'Quantity' => 1, ], ]
ListOriginAccessControls
$result = $client->listOriginAccessControls
([/* ... */]); $promise = $client->listOriginAccessControlsAsync
([/* ... */]);
Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services 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 another request that specifies the NextMarker
value from the current response as the Marker
value in the next request.
If you're not using origin access controls for your Amazon Web Services account, the ListOriginAccessControls
operation doesn't return the Items
element in the response.
Parameter Syntax
$result = $client->listOriginAccessControls([ 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of origin access controls. The response includes the items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of origin access controls that you want in the response.
Result Syntax
[ 'OriginAccessControlList' => [ 'IsTruncated' => true || false, 'Items' => [ [ 'Description' => '<string>', 'Id' => '<string>', 'Name' => '<string>', 'OriginAccessControlOriginType' => 's3|mediastore|mediapackagev2|lambda', 'SigningBehavior' => 'never|always|no-override', 'SigningProtocol' => 'sigv4', ], // ... ], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- OriginAccessControlList
-
- Type: OriginAccessControlList structure
A list of origin access controls.
Errors
- InvalidArgument:
An argument is invalid.
ListOriginRequestPolicies
$result = $client->listOriginRequestPolicies
([/* ... */]); $promise = $client->listOriginRequestPoliciesAsync
([/* ... */]);
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 Amazon Web Services 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.
Parameter Syntax
$result = $client->listOriginRequestPolicies([ 'Marker' => '<string>', 'MaxItems' => '<string>', 'Type' => 'managed|custom', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of origin request policies. The response includes origin request policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of origin request policies that you want in the response.
- Type
-
- Type: string
A filter to return only the specified kinds of origin request policies. Valid values are:
-
managed
– Returns only the managed policies created by Amazon Web Services. -
custom
– Returns only the custom policies created in your Amazon Web Services account.
Result Syntax
[ 'OriginRequestPolicyList' => [ 'Items' => [ [ 'OriginRequestPolicy' => [ 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'OriginRequestPolicyConfig' => [ 'Comment' => '<string>', 'CookiesConfig' => [ 'CookieBehavior' => 'none|whitelist|all|allExcept', 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'HeadersConfig' => [ 'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept', 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Name' => '<string>', 'QueryStringsConfig' => [ 'QueryStringBehavior' => 'none|whitelist|all|allExcept', 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ], 'Type' => 'managed|custom', ], // ... ], 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- OriginRequestPolicyList
-
- Type: OriginRequestPolicyList structure
A list of origin request policies.
Errors
- AccessDenied:
Access denied.
- NoSuchOriginRequestPolicy:
The origin request policy does not exist.
- InvalidArgument:
An argument is invalid.
ListPublicKeys
$result = $client->listPublicKeys
([/* ... */]); $promise = $client->listPublicKeysAsync
([/* ... */]);
List all public keys that have been added to CloudFront for this account.
Parameter Syntax
$result = $client->listPublicKeys([ 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the
Marker
to the value of theNextMarker
from the current page's response (which is also the ID of the last public key on that page). - MaxItems
-
- Type: string
The maximum number of public keys you want in the response body.
Result Syntax
[ 'PublicKeyList' => [ 'Items' => [ [ 'Comment' => '<string>', 'CreatedTime' => <DateTime>, 'EncodedKey' => '<string>', 'Id' => '<string>', 'Name' => '<string>', ], // ... ], 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- PublicKeyList
-
- Type: PublicKeyList structure
Returns a list of all public keys that have been added to CloudFront for this account.
Errors
- InvalidArgument:
An argument is invalid.
ListRealtimeLogConfigs
$result = $client->listRealtimeLogConfigs
([/* ... */]); $promise = $client->listRealtimeLogConfigsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listRealtimeLogConfigs([ 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of real-time log configurations. The response includes real-time log configurations in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of real-time log configurations that you want in the response.
Result Syntax
[ 'RealtimeLogConfigs' => [ 'IsTruncated' => true || false, 'Items' => [ [ 'ARN' => '<string>', 'EndPoints' => [ [ 'KinesisStreamConfig' => [ 'RoleARN' => '<string>', 'StreamARN' => '<string>', ], 'StreamType' => '<string>', ], // ... ], 'Fields' => ['<string>', ...], 'Name' => '<string>', 'SamplingRate' => <integer>, ], // ... ], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', ], ]
Result Details
Members
- RealtimeLogConfigs
-
- Type: RealtimeLogConfigs structure
A list of real-time log configurations.
Errors
- AccessDenied:
Access denied.
- InvalidArgument:
An argument is invalid.
- NoSuchRealtimeLogConfig:
The real-time log configuration does not exist.
ListResponseHeadersPolicies
$result = $client->listResponseHeadersPolicies
([/* ... */]); $promise = $client->listResponseHeadersPoliciesAsync
([/* ... */]);
Gets a list of response headers policies.
You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services 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.
Parameter Syntax
$result = $client->listResponseHeadersPolicies([ 'Marker' => '<string>', 'MaxItems' => '<string>', 'Type' => 'managed|custom', ]);
Parameter Details
Members
- Marker
-
- Type: string
Use this field when paginating results to indicate where to begin in your list of response headers policies. The response includes response headers policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
- Type: string
The maximum number of response headers policies that you want to get in the response.
- Type
-
- Type: string
A filter to get only the specified kind of response headers policies. Valid values are:
-
managed
– Gets only the managed policies created by Amazon Web Services. -
custom
– Gets only the custom policies created in your Amazon Web Services account.
Result Syntax
[ 'ResponseHeadersPolicyList' => [ 'Items' => [ [ 'ResponseHeadersPolicy' => [ 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'ResponseHeadersPolicyConfig' => [ 'Comment' => '<string>', 'CorsConfig' => [ 'AccessControlAllowCredentials' => true || false, 'AccessControlAllowHeaders' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlAllowMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlAllowOrigins' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlExposeHeaders' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AccessControlMaxAgeSec' => <integer>, 'OriginOverride' => true || false, ], 'CustomHeadersConfig' => [ 'Items' => [ [ 'Header' => '<string>', 'Override' => true || false, 'Value' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Name' => '<string>', 'RemoveHeadersConfig' => [ 'Items' => [ [ 'Header' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SecurityHeadersConfig' => [ 'ContentSecurityPolicy' => [ 'ContentSecurityPolicy' => '<string>', 'Override' => true || false, ], 'ContentTypeOptions' => [ 'Override' => true || false, ], 'FrameOptions' => [ 'FrameOption' => 'DENY|SAMEORIGIN', 'Override' => true || false, ], 'ReferrerPolicy' => [ 'Override' => true || false, 'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url', ], 'StrictTransportSecurity' => [ 'AccessControlMaxAgeSec' => <integer>, 'IncludeSubdomains' => true || false, 'Override' => true || false, 'Preload' => true || false, ], 'XSSProtection' => [ 'ModeBlock' => true || false, 'Override' => true || false, 'Protection' => true || false, 'ReportUri' => '<string>', ], ], 'ServerTimingHeadersConfig' => [ 'Enabled' => true || false, 'SamplingRate' => <float>, ], ], ], 'Type' => 'managed|custom', ], // ... ], 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- ResponseHeadersPolicyList
-
- Type: ResponseHeadersPolicyList structure
A list of response headers policies.
Errors
- AccessDenied:
Access denied.
- NoSuchResponseHeadersPolicy:
The response headers policy does not exist.
- InvalidArgument:
An argument is invalid.
ListStreamingDistributions
$result = $client->listStreamingDistributions
([/* ... */]); $promise = $client->listStreamingDistributionsAsync
([/* ... */]);
List streaming distributions.
Parameter Syntax
$result = $client->listStreamingDistributions([ 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
The value that you provided for the
Marker
request parameter. - MaxItems
-
- Type: string
The value that you provided for the
MaxItems
request parameter.
Result Syntax
[ 'StreamingDistributionList' => [ 'IsTruncated' => true || false, 'Items' => [ [ 'ARN' => '<string>', 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Comment' => '<string>', 'DomainName' => '<string>', 'Enabled' => true || false, 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'S3Origin' => [ 'DomainName' => '<string>', 'OriginAccessIdentity' => '<string>', ], 'Status' => '<string>', 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- StreamingDistributionList
-
- Type: StreamingDistributionList structure
The
StreamingDistributionList
type.
Errors
- InvalidArgument:
An argument is invalid.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
List tags for a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
Parameter Syntax
$result = $client->listTagsForResource([ 'Resource' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Resource
-
- Required: Yes
- Type: string
An ARN of a CloudFront resource.
Result Syntax
[ 'Tags' => [ 'Items' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], ]
Result Details
Members
- Tags
-
- Required: Yes
- Type: Tags structure
A complex type that contains zero or more
Tag
elements.
Errors
- AccessDenied:
Access denied.
- InvalidTagging:
The tagging specified is not valid.
- InvalidArgument:
An argument is invalid.
- NoSuchResource:
A resource that was specified is not valid.
ListVpcOrigins
$result = $client->listVpcOrigins
([/* ... */]); $promise = $client->listVpcOriginsAsync
([/* ... */]);
List the CloudFront VPC origins in your account.
Parameter Syntax
$result = $client->listVpcOrigins([ 'Marker' => '<string>', 'MaxItems' => '<string>', ]);
Parameter Details
Members
- Marker
-
- Type: string
The marker associated with the VPC origins list.
- MaxItems
-
- Type: string
The maximum number of items included in the list.
Result Syntax
[ 'VpcOriginList' => [ 'IsTruncated' => true || false, 'Items' => [ [ 'Arn' => '<string>', 'CreatedTime' => <DateTime>, 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'OriginEndpointArn' => '<string>', 'Status' => '<string>', ], // ... ], 'Marker' => '<string>', 'MaxItems' => <integer>, 'NextMarker' => '<string>', 'Quantity' => <integer>, ], ]
Result Details
Members
- VpcOriginList
-
- Type: VpcOriginList structure
List of VPC origins.
Errors
- EntityNotFound:
The entity was not found.
- AccessDenied:
Access denied.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
Examples
Example 1: To list VPC origins
The following command lists VPC origins:
$result = $client->listVpcOrigins([ ]);
Result syntax:
[ 'VpcOriginList' => [ 'IsTruncated' => 1, 'Items' => [ [ 'Arn' => 'arn:aws:cloudfront::123456789012:vpcorigin/vo_BQwjxxQxjCaBcQLzJUFkDM', 'CreatedTime' =>, 'Id' => 'vo_BQwjxxQxjCaBcQLzJUFkDM', 'LastModifiedTime' => , 'Name' => 'my-vpcorigin-name', 'OriginEndpointArn' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d', 'Status' => 'Deployed', ], ], 'Marker' => 'a', 'MaxItems' => 100, 'Quantity' => 1, ], ]
PublishFunction
$result = $client->publishFunction
([/* ... */]); $promise = $client->publishFunctionAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->publishFunction([ 'IfMatch' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- IfMatch
-
- Required: Yes
- Type: string
The current version (
ETag
value) of the function that you are publishing, which you can get usingDescribeFunction
. - Name
-
- Required: Yes
- Type: string
The name of the function that you are publishing.
Result Syntax
[ 'FunctionSummary' => [ 'FunctionConfig' => [ 'Comment' => '<string>', 'KeyValueStoreAssociations' => [ 'Items' => [ [ 'KeyValueStoreARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Runtime' => 'cloudfront-js-1.0|cloudfront-js-2.0', ], 'FunctionMetadata' => [ 'CreatedTime' => <DateTime>, 'FunctionARN' => '<string>', 'LastModifiedTime' => <DateTime>, 'Stage' => 'DEVELOPMENT|LIVE', ], 'Name' => '<string>', 'Status' => '<string>', ], ]
Result Details
Members
- FunctionSummary
-
- Type: FunctionSummary structure
Contains configuration information and metadata about a CloudFront function.
Errors
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
- NoSuchFunctionExists:
The function does not exist.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Add tags to a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
Parameter Syntax
$result = $client->tagResource([ 'Resource' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED 'Items' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], ], ]);
Parameter Details
Members
- Resource
-
- Required: Yes
- Type: string
An ARN of a CloudFront resource.
- Tags
-
- Required: Yes
- Type: Tags structure
A complex type that contains zero or more
Tag
elements.
Result Syntax
[]
Result Details
Errors
- AccessDenied:
Access denied.
- InvalidTagging:
The tagging specified is not valid.
- InvalidArgument:
An argument is invalid.
- NoSuchResource:
A resource that was specified is not valid.
TestFunction
$result = $client->testFunction
([/* ... */]); $promise = $client->testFunctionAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->testFunction([ 'EventObject' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'IfMatch' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Stage' => 'DEVELOPMENT|LIVE', ]);
Parameter Details
Members
- EventObject
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The event object to test the function with. For more information about the structure of the event object, see Testing functions in the Amazon CloudFront Developer Guide.
- IfMatch
-
- Required: Yes
- Type: string
The current version (
ETag
value) of the function that you are testing, which you can get usingDescribeFunction
. - Name
-
- Required: Yes
- Type: string
The name of the function that you are testing.
- Stage
-
- Type: string
The stage of the function that you are testing, either
DEVELOPMENT
orLIVE
.
Result Syntax
[ 'TestResult' => [ 'ComputeUtilization' => '<string>', 'FunctionErrorMessage' => '<string>', 'FunctionExecutionLogs' => ['<string>', ...], 'FunctionOutput' => '<string>', 'FunctionSummary' => [ 'FunctionConfig' => [ 'Comment' => '<string>', 'KeyValueStoreAssociations' => [ 'Items' => [ [ 'KeyValueStoreARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'Runtime' => 'cloudfront-js-1.0|cloudfront-js-2.0', ], 'FunctionMetadata' => [ 'CreatedTime' => <DateTime>, 'FunctionARN' => '<string>', 'LastModifiedTime' => <DateTime>, 'Stage' => 'DEVELOPMENT|LIVE', ], 'Name' => '<string>', 'Status' => '<string>', ], ], ]
Result Details
Members
- TestResult
-
- Type: TestResult structure
An object that represents the result of running the function with the provided event object.
Errors
- TestFunctionFailed:
The CloudFront function failed.
- UnsupportedOperation:
This operation is not supported in this region.
- InvalidArgument:
An argument is invalid.
- NoSuchFunctionExists:
The function does not exist.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Remove tags from a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
Parameter Syntax
$result = $client->untagResource([ 'Resource' => '<string>', // REQUIRED 'TagKeys' => [ // REQUIRED 'Items' => ['<string>', ...], ], ]);
Parameter Details
Members
- Resource
-
- Required: Yes
- Type: string
An ARN of a CloudFront resource.
- TagKeys
-
- Required: Yes
- Type: TagKeys structure
A complex type that contains zero or more
Tag
key elements.
Result Syntax
[]
Result Details
Errors
- AccessDenied:
Access denied.
- InvalidTagging:
The tagging specified is not valid.
- InvalidArgument:
An argument is invalid.
- NoSuchResource:
A resource that was specified is not valid.
UpdateCachePolicy
$result = $client->updateCachePolicy
([/* ... */]); $promise = $client->updateCachePolicyAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateCachePolicy([ 'CachePolicyConfig' => [ // REQUIRED 'Comment' => '<string>', 'DefaultTTL' => <integer>, 'MaxTTL' => <integer>, 'MinTTL' => <integer>, // REQUIRED 'Name' => '<string>', // REQUIRED 'ParametersInCacheKeyAndForwardedToOrigin' => [ 'CookiesConfig' => [ // REQUIRED 'CookieBehavior' => 'none|whitelist|allExcept|all', // REQUIRED 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'EnableAcceptEncodingBrotli' => true || false, 'EnableAcceptEncodingGzip' => true || false, // REQUIRED 'HeadersConfig' => [ // REQUIRED 'HeaderBehavior' => 'none|whitelist', // REQUIRED 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'QueryStringsConfig' => [ // REQUIRED 'QueryStringBehavior' => 'none|whitelist|allExcept|all', // REQUIRED 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], ], ], 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- CachePolicyConfig
-
- Required: Yes
- Type: CachePolicyConfig structure
A cache policy configuration.
- Id
-
- Required: Yes
- Type: string
The unique identifier for the cache policy that you are updating. The identifier is returned in a cache behavior's
CachePolicyId
field in the response toGetDistributionConfig
. - IfMatch
-
- Type: string
The version of the cache policy that you are updating. The version is returned in the cache policy's
ETag
field in the response toGetCachePolicyConfig
.
Result Syntax
[ 'CachePolicy' => [ 'CachePolicyConfig' => [ 'Comment' => '<string>', 'DefaultTTL' => <integer>, 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'Name' => '<string>', 'ParametersInCacheKeyAndForwardedToOrigin' => [ 'CookiesConfig' => [ 'CookieBehavior' => 'none|whitelist|allExcept|all', 'Cookies' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'EnableAcceptEncodingBrotli' => true || false, 'EnableAcceptEncodingGzip' => true || false, 'HeadersConfig' => [ 'HeaderBehavior' => 'none|whitelist', 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'QueryStringsConfig' => [ 'QueryStringBehavior' => 'none|whitelist|allExcept|all', 'QueryStrings' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], ], ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], 'ETag' => '<string>', ]
Result Details
Members
- CachePolicy
-
- Type: CachePolicy structure
A cache policy.
- ETag
-
- Type: string
The current version of the cache policy.
Errors
- NoSuchCachePolicy:
The cache policy does not exist.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- TooManyHeadersInCachePolicy:
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.
- CachePolicyAlreadyExists:
A cache policy with this name already exists. You must provide a unique name. To modify an existing cache policy, use
UpdateCachePolicy
.- TooManyCookiesInCachePolicy:
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.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidArgument:
An argument is invalid.
- IllegalUpdate:
The update contains modifications that are not allowed.
- TooManyQueryStringsInCachePolicy:
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.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
UpdateCloudFrontOriginAccessIdentity
$result = $client->updateCloudFrontOriginAccessIdentity
([/* ... */]); $promise = $client->updateCloudFrontOriginAccessIdentityAsync
([/* ... */]);
Update an origin access identity.
Parameter Syntax
$result = $client->updateCloudFrontOriginAccessIdentity([ 'CloudFrontOriginAccessIdentityConfig' => [ // REQUIRED 'CallerReference' => '<string>', // REQUIRED 'Comment' => '<string>', // REQUIRED ], 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- CloudFrontOriginAccessIdentityConfig
-
- Required: Yes
- Type: CloudFrontOriginAccessIdentityConfig structure
The identity's configuration information.
- Id
-
- Required: Yes
- Type: string
The identity's id.
- IfMatch
-
- Type: string
The value of the
ETag
header that you received when retrieving the identity's configuration. For example:E2QWRUHAPOMQZL
.
Result Syntax
[ 'CloudFrontOriginAccessIdentity' => [ 'CloudFrontOriginAccessIdentityConfig' => [ 'CallerReference' => '<string>', 'Comment' => '<string>', ], 'Id' => '<string>', 'S3CanonicalUserId' => '<string>', ], 'ETag' => '<string>', ]
Result Details
Members
- CloudFrontOriginAccessIdentity
-
- Type: CloudFrontOriginAccessIdentity structure
The origin access identity's information.
- ETag
-
- Type: string
The current version of the configuration. For example:
E2QWRUHAPOMQZL
.
Errors
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- MissingBody:
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidArgument:
An argument is invalid.
- IllegalUpdate:
The update contains modifications that are not allowed.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.- NoSuchCloudFrontOriginAccessIdentity:
The specified origin access identity does not exist.
UpdateContinuousDeploymentPolicy
$result = $client->updateContinuousDeploymentPolicy
([/* ... */]); $promise = $client->updateContinuousDeploymentPolicyAsync
([/* ... */]);
Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to.
When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration:
-
Use
GetContinuousDeploymentPolicyConfig
to get the current configuration. -
Locally modify the fields in the continuous deployment policy configuration that you want to update.
-
Use
UpdateContinuousDeploymentPolicy
, providing the entire continuous deployment policy configuration, including the fields that you modified and those that you didn't.
Parameter Syntax
$result = $client->updateContinuousDeploymentPolicy([ 'ContinuousDeploymentPolicyConfig' => [ // REQUIRED 'Enabled' => true || false, // REQUIRED 'StagingDistributionDnsNames' => [ // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'TrafficConfig' => [ 'SingleHeaderConfig' => [ 'Header' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], 'SingleWeightConfig' => [ 'SessionStickinessConfig' => [ 'IdleTTL' => <integer>, // REQUIRED 'MaximumTTL' => <integer>, // REQUIRED ], 'Weight' => <float>, // REQUIRED ], 'Type' => 'SingleWeight|SingleHeader', // REQUIRED ], ], 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- ContinuousDeploymentPolicyConfig
-
- Required: Yes
- Type: ContinuousDeploymentPolicyConfig structure
The continuous deployment policy configuration.
- Id
-
- Required: Yes
- Type: string
The identifier of the continuous deployment policy that you are updating.
- IfMatch
-
- Type: string
The current version (
ETag
value) of the continuous deployment policy that you are updating.
Result Syntax
[ 'ContinuousDeploymentPolicy' => [ 'ContinuousDeploymentPolicyConfig' => [ 'Enabled' => true || false, 'StagingDistributionDnsNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrafficConfig' => [ 'SingleHeaderConfig' => [ 'Header' => '<string>', 'Value' => '<string>', ], 'SingleWeightConfig' => [ 'SessionStickinessConfig' => [ 'IdleTTL' => <integer>, 'MaximumTTL' => <integer>, ], 'Weight' => <float>, ], 'Type' => 'SingleWeight|SingleHeader', ], ], 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, ], 'ETag' => '<string>', ]
Result Details
Members
- ContinuousDeploymentPolicy
-
- Type: ContinuousDeploymentPolicy structure
A continuous deployment policy.
- ETag
-
- Type: string
The version identifier for the current version of the continuous deployment policy.
Errors
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- AccessDenied:
Access denied.
- StagingDistributionInUse:
A continuous deployment policy for this staging distribution already exists.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidArgument:
An argument is invalid.
- NoSuchContinuousDeploymentPolicy:
The continuous deployment policy doesn't exist.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.
UpdateDistribution
$result = $client->updateDistribution
([/* ... */]); $promise = $client->updateDistributionAsync
([/* ... */]);
Updates the configuration for a CloudFront distribution.
The update process includes getting the current distribution configuration, updating it to make your changes, and then submitting an UpdateDistribution
request to make the updates.
To update a web distribution using the CloudFront API
-
Use
GetDistributionConfig
to get the current configuration, including the version identifier (ETag
). -
Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:
-
You must copy the
ETag
field value from the response. (You'll use it for theIfMatch
parameter in your request.) Then, remove theETag
field from the distribution configuration. -
You can't change the value of
CallerReference
.
-
-
Submit an
UpdateDistribution
request, providing the updated distribution configuration. The new configuration replaces the existing configuration. The values that you specify in anUpdateDistribution
request are not merged into your existing configuration. Make sure to include all fields: the ones that you modified and also the ones that you didn't.
Parameter Syntax
$result = $client->updateDistribution([ 'DistributionConfig' => [ // REQUIRED 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ // REQUIRED 'Forward' => 'none|whitelist|all', // REQUIRED 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'QueryString' => true || false, // REQUIRED 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'FunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'GrpcConfig' => [ 'Enabled' => true || false, // REQUIRED ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', // REQUIRED 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', // REQUIRED 'TrustedKeyGroups' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'TrustedSigners' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'CallerReference' => '<string>', // REQUIRED 'Comment' => '<string>', // REQUIRED 'ContinuousDeploymentPolicyId' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, // REQUIRED 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'DefaultCacheBehavior' => [ // REQUIRED 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ // REQUIRED 'Forward' => 'none|whitelist|all', // REQUIRED 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'QueryString' => true || false, // REQUIRED 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'FunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'GrpcConfig' => [ 'Enabled' => true || false, // REQUIRED ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', // REQUIRED 'TrustedKeyGroups' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'TrustedSigners' => [ 'Enabled' => true || false, // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED ], 'DefaultRootObject' => '<string>', 'Enabled' => true || false, // REQUIRED 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'IsIPV6Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'IncludeCookies' => true || false, 'Prefix' => '<string>', ], 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ // REQUIRED 'StatusCodes' => [ // REQUIRED 'Items' => [<integer>, ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], ], 'Id' => '<string>', // REQUIRED 'Members' => [ // REQUIRED 'Items' => [ // REQUIRED [ 'OriginId' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'Origins' => [ // REQUIRED 'Items' => [ // REQUIRED [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', // REQUIRED 'HeaderValue' => '<string>', // REQUIRED ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, // REQUIRED 'HTTPSPort' => <integer>, // REQUIRED 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', // REQUIRED 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], // REQUIRED 'Quantity' => <integer>, // REQUIRED ], ], 'DomainName' => '<string>', // REQUIRED 'Id' => '<string>', // REQUIRED 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, // REQUIRED 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', // REQUIRED ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', // REQUIRED ], ], // ... ], 'Quantity' => <integer>, // REQUIRED ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ // REQUIRED 'Items' => ['<string>', ...], 'Quantity' => <integer>, // REQUIRED 'RestrictionType' => 'blacklist|whitelist|none', // REQUIRED ], ], 'Staging' => true || false, 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', ]);
Parameter Details
Members
- DistributionConfig
-
- Required: Yes
- Type: DistributionConfig structure
The distribution's configuration information.
- Id
-
- Required: Yes
- Type: string
The distribution's id.
- IfMatch
-
- Type: string
The value of the
ETag
header that you received when retrieving the distribution's configuration. For example:E2QWRUHAPOMQZL
.
Result Syntax
[ 'Distribution' => [ 'ARN' => '<string>', 'ActiveTrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => [ [ 'KeyGroupId' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'ActiveTrustedSigners' => [ 'Enabled' => true || false, 'Items' => [ [ 'AwsAccountNumber' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'AliasICPRecordals' => [ [ 'CNAME' => '<string>', 'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING', ], // ... ], 'DistributionConfig' => [ 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], // ... ], 'Quantity' => <integer>, ], 'CallerReference' => '<string>', 'Comment' => '<string>', 'ContinuousDeploymentPolicyId' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'DefaultCacheBehavior' => [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], 'DefaultRootObject' => '<string>', 'Enabled' => true || false, 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'IsIPV6Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'IncludeCookies' => true || false, 'Prefix' => '<string>', ], 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ 'StatusCodes' => [ 'Items' => [<integer>, ...], 'Quantity' => <integer>, ], ], 'Id' => '<string>', 'Members' => [ 'Items' => [ [ 'OriginId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, ], 'Origins' => [ 'Items' => [ [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', 'HeaderValue' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'DomainName' => '<string>', 'Id' => '<string>', 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', ], ], // ... ], 'Quantity' => <integer>, ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, 'RestrictionType' => 'blacklist|whitelist|none', ], ], 'Staging' => true || false, 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], 'DomainName' => '<string>', 'Id' => '<string>', 'InProgressInvalidationBatches' => <integer>, 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', ], 'ETag' => '<string>', ]
Result Details
Members
- Distribution
-
- Type: Distribution structure
The distribution's information.
- ETag
-
- Type: string
The current version of the configuration. For example:
E2QWRUHAPOMQZL
.
Errors
- AccessDenied:
Access denied.
- TooManyDistributionsAssociatedToOriginAccessControl:
The maximum number of distributions have been associated with the specified origin access control.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- InvalidDefaultRootObject:
The default root object file name is too big or contains an invalid character.
- InvalidDomainNameForOriginAccessControl:
An origin access control is associated with an origin whose domain name is not supported.
- InvalidQueryStringParameters:
The query string parameters specified are not valid.
- TooManyTrustedSigners:
Your request contains more trusted signers than are allowed per distribution.
- TooManyCookieNamesInWhiteList:
Your request contains more cookie names in the whitelist than are allowed per cache behavior.
- NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
- InvalidErrorCode:
An invalid error code was specified.
- IllegalOriginAccessConfiguration:
An origin cannot contain both an origin access control (OAC) and an origin access identity (OAI).
- TooManyFunctionAssociations:
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.
- TooManyOriginCustomHeaders:
Your request contains too many origin custom headers.
- InvalidForwardCookies:
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.- InvalidMinimumProtocolVersion:
The minimum protocol version specified is not valid.
- NoSuchCachePolicy:
The cache policy does not exist.
- TooManyKeyGroupsAssociatedToDistribution:
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.
- TooManyDistributionsAssociatedToCachePolicy:
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.
- InvalidRequiredProtocol:
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.- TooManyDistributionsWithFunctionAssociations:
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.
- TooManyOriginGroupsPerDistribution:
Processing your request would cause you to exceed the maximum number of origin groups allowed.
- InvalidTTLOrder:
The TTL order specified is not valid.
- IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior:
The specified configuration for field-level encryption can't be associated with the specified cache behavior.
- InvalidOriginKeepaliveTimeout:
The keep alive timeout specified for the origin is not valid.
- InvalidArgument:
An argument is invalid.
- InvalidOriginReadTimeout:
The read timeout specified for the origin is not valid.
- IllegalUpdate:
The update contains modifications that are not allowed.
- InvalidOriginAccessControl:
The origin access control is not valid.
- EntityNotFound:
The entity was not found.
- StagingDistributionInUse:
A continuous deployment policy for this staging distribution already exists.
- InvalidHeadersForS3Origin:
The headers specified are not valid for an Amazon S3 origin.
- TrustedSignerDoesNotExist:
One or more of your trusted signers don't exist.
- InvalidWebACLId:
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 example473e64fd-f30b-4765-81a0-62ad96dd167a
.- TooManyDistributionsWithSingleFunctionARN:
The maximum number of distributions have been associated with the specified Lambda@Edge function.
- InvalidRelativePath:
The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
- TooManyLambdaFunctionAssociations:
Your request contains more Lambda@Edge function associations than are allowed per distribution.
- NoSuchDistribution:
The specified distribution does not exist.
- NoSuchOriginRequestPolicy:
The origin request policy does not exist.
- TooManyDistributionsAssociatedToFieldLevelEncryptionConfig:
The maximum number of distributions have been associated with the specified configuration for field-level encryption.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidLocationCode:
The location code specified is not valid.
- InvalidOriginAccessIdentity:
The origin access identity is not valid or doesn't exist.
- TooManyDistributionCNAMEs:
Your request contains more CNAMEs than are allowed per distribution.
- NoSuchContinuousDeploymentPolicy:
The continuous deployment policy doesn't exist.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.- TooManyDistributionsAssociatedToOriginRequestPolicy:
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.
- TooManyQueryStringParameters:
Your request contains too many query string parameters.
- RealtimeLogConfigOwnerMismatch:
The specified real-time log configuration belongs to a different Amazon Web Services account.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- ContinuousDeploymentPolicyInUse:
You cannot delete a continuous deployment policy that is associated with a primary distribution.
- MissingBody:
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.- TooManyHeadersInForwardedValues:
Your request contains too many headers in forwarded values.
- InvalidLambdaFunctionAssociation:
The specified Lambda@Edge function association is invalid.
- CNAMEAlreadyExists:
The CNAME specified is already defined for CloudFront.
- TooManyCertificates:
You cannot create anymore custom SSL/TLS certificates.
- TrustedKeyGroupDoesNotExist:
The specified key group does not exist.
- TooManyDistributionsAssociatedToResponseHeadersPolicy:
The maximum number of distributions have been associated with the specified response headers policy.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- NoSuchResponseHeadersPolicy:
The response headers policy does not exist.
- NoSuchRealtimeLogConfig:
The real-time log configuration does not exist.
- InvalidResponseCode:
A response code is not valid.
- InvalidGeoRestrictionParameter:
The specified geo restriction parameter is not valid.
- TooManyOrigins:
You cannot create more origins for the distribution.
- InvalidViewerCertificate:
A viewer certificate specified is not valid.
- InvalidFunctionAssociation:
A CloudFront function association is invalid.
- TooManyDistributionsWithLambdaAssociations:
Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.
- TooManyDistributionsAssociatedToKeyGroup:
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.
- NoSuchOrigin:
No origin exists with the specified
Origin Id
.- TooManyCacheBehaviors:
You cannot create more cache behaviors for the distribution.
UpdateDistributionWithStagingConfig
$result = $client->updateDistributionWithStagingConfig
([/* ... */]); $promise = $client->updateDistributionWithStagingConfigAsync
([/* ... */]);
Copies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its Aliases
(also known as alternate domain names or CNAMEs) and ContinuousDeploymentPolicyId
value, but otherwise its configuration is overwritten to match the staging distribution.
You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution.
This API operation requires the following IAM permissions:
Parameter Syntax
$result = $client->updateDistributionWithStagingConfig([ 'Id' => '<string>', // REQUIRED 'IfMatch' => '<string>', 'StagingDistributionId' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the primary distribution to which you are copying a staging distribution's configuration.
- IfMatch
-
- Type: string
The current versions (
ETag
values) of both primary and staging distributions. Provide these in the following format:<primary ETag>, <staging ETag>
- StagingDistributionId
-
- Type: string
The identifier of the staging distribution whose configuration you are copying to the primary distribution.
Result Syntax
[ 'Distribution' => [ 'ARN' => '<string>', 'ActiveTrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => [ [ 'KeyGroupId' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'ActiveTrustedSigners' => [ 'Enabled' => true || false, 'Items' => [ [ 'AwsAccountNumber' => '<string>', 'KeyPairIds' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], // ... ], 'Quantity' => <integer>, ], 'AliasICPRecordals' => [ [ 'CNAME' => '<string>', 'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING', ], // ... ], 'DistributionConfig' => [ 'Aliases' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'AnycastIpListId' => '<string>', 'CacheBehaviors' => [ 'Items' => [ [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'PathPattern' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], // ... ], 'Quantity' => <integer>, ], 'CallerReference' => '<string>', 'Comment' => '<string>', 'ContinuousDeploymentPolicyId' => '<string>', 'CustomErrorResponses' => [ 'Items' => [ [ 'ErrorCachingMinTTL' => <integer>, 'ErrorCode' => <integer>, 'ResponseCode' => '<string>', 'ResponsePagePath' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'DefaultCacheBehavior' => [ 'AllowedMethods' => [ 'CachedMethods' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'CachePolicyId' => '<string>', 'Compress' => true || false, 'DefaultTTL' => <integer>, 'FieldLevelEncryptionId' => '<string>', 'ForwardedValues' => [ 'Cookies' => [ 'Forward' => 'none|whitelist|all', 'WhitelistedNames' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'Headers' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'QueryString' => true || false, 'QueryStringCacheKeys' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'FunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'FunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'GrpcConfig' => [ 'Enabled' => true || false, ], 'LambdaFunctionAssociations' => [ 'Items' => [ [ 'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', 'IncludeBody' => true || false, 'LambdaFunctionARN' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'MaxTTL' => <integer>, 'MinTTL' => <integer>, 'OriginRequestPolicyId' => '<string>', 'RealtimeLogConfigArn' => '<string>', 'ResponseHeadersPolicyId' => '<string>', 'SmoothStreaming' => true || false, 'TargetOriginId' => '<string>', 'TrustedKeyGroups' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'TrustedSigners' => [ 'Enabled' => true || false, 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], 'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', ], 'DefaultRootObject' => '<string>', 'Enabled' => true || false, 'HttpVersion' => 'http1.1|http2|http3|http2and3', 'IsIPV6Enabled' => true || false, 'Logging' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'IncludeCookies' => true || false, 'Prefix' => '<string>', ], 'OriginGroups' => [ 'Items' => [ [ 'FailoverCriteria' => [ 'StatusCodes' => [ 'Items' => [<integer>, ...], 'Quantity' => <integer>, ], ], 'Id' => '<string>', 'Members' => [ 'Items' => [ [ 'OriginId' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'SelectionCriteria' => 'default|media-quality-based', ], // ... ], 'Quantity' => <integer>, ], 'Origins' => [ 'Items' => [ [ 'ConnectionAttempts' => <integer>, 'ConnectionTimeout' => <integer>, 'CustomHeaders' => [ 'Items' => [ [ 'HeaderName' => '<string>', 'HeaderValue' => '<string>', ], // ... ], 'Quantity' => <integer>, ], 'CustomOriginConfig' => [ 'HTTPPort' => <integer>, 'HTTPSPort' => <integer>, 'OriginKeepaliveTimeout' => <integer>, 'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', 'OriginReadTimeout' => <integer>, 'OriginSslProtocols' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, ], ], 'DomainName' => '<string>', 'Id' => '<string>', 'OriginAccessControlId' => '<string>', 'OriginPath' => '<string>', 'OriginShield' => [ 'Enabled' => true || false, 'OriginShieldRegion' => '<string>', ], 'S3OriginConfig' => [ 'OriginAccessIdentity' => '<string>', ], 'VpcOriginConfig' => [ 'VpcOriginId' => '<string>', ], ], // ... ], 'Quantity' => <integer>, ], 'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All', 'Restrictions' => [ 'GeoRestriction' => [ 'Items' => ['<string>', ...], 'Quantity' => <integer>, 'RestrictionType' => 'blacklist|whitelist|none', ], ], 'Staging' => true || false, 'ViewerCertificate' => [ 'ACMCertificateArn' => '<string>', 'Certificate' => '<string>', 'CertificateSource' => 'cloudfront|iam|acm', 'CloudFrontDefaultCertificate' => true || false, 'IAMCertificateId' => '<string>', 'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021', 'SSLSupportMethod' => 'sni-only|vip|static-ip', ], 'WebACLId' => '<string>', ], 'DomainName' => '<string>', 'Id' => '<string>', 'InProgressInvalidationBatches' => <integer>, 'LastModifiedTime' => <DateTime>, 'Status' => '<string>', ], 'ETag' => '<string>', ]
Result Details
Members
- Distribution
-
- Type: Distribution structure
A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
- ETag
-
- Type: string
The current version of the primary distribution (after it's updated).
Errors
- AccessDenied:
Access denied.
- TooManyDistributionsAssociatedToOriginAccessControl:
The maximum number of distributions have been associated with the specified origin access control.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- InvalidDefaultRootObject:
The default root object file name is too big or contains an invalid character.
- InvalidQueryStringParameters:
The query string parameters specified are not valid.
- TooManyTrustedSigners:
Your request contains more trusted signers than are allowed per distribution.
- TooManyCookieNamesInWhiteList:
Your request contains more cookie names in the whitelist than are allowed per cache behavior.
- NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
- InvalidErrorCode:
An invalid error code was specified.
- TooManyFunctionAssociations:
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.
- TooManyOriginCustomHeaders:
Your request contains too many origin custom headers.
- InvalidForwardCookies:
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.- InvalidMinimumProtocolVersion:
The minimum protocol version specified is not valid.
- NoSuchCachePolicy:
The cache policy does not exist.
- TooManyKeyGroupsAssociatedToDistribution:
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.
- TooManyDistributionsAssociatedToCachePolicy:
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.
- InvalidRequiredProtocol:
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.- TooManyDistributionsWithFunctionAssociations:
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.
- TooManyOriginGroupsPerDistribution:
Processing your request would cause you to exceed the maximum number of origin groups allowed.
- InvalidTTLOrder:
The TTL order specified is not valid.
- IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior:
The specified configuration for field-level encryption can't be associated with the specified cache behavior.
- InvalidOriginKeepaliveTimeout:
The keep alive timeout specified for the origin is not valid.
- InvalidArgument:
An argument is invalid.
- InvalidOriginReadTimeout:
The read timeout specified for the origin is not valid.
- IllegalUpdate:
The update contains modifications that are not allowed.
- InvalidOriginAccessControl:
The origin access control is not valid.
- EntityNotFound:
The entity was not found.
- InvalidHeadersForS3Origin:
The headers specified are not valid for an Amazon S3 origin.
- TrustedSignerDoesNotExist:
One or more of your trusted signers don't exist.
- InvalidWebACLId:
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 example473e64fd-f30b-4765-81a0-62ad96dd167a
.- TooManyDistributionsWithSingleFunctionARN:
The maximum number of distributions have been associated with the specified Lambda@Edge function.
- InvalidRelativePath:
The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
- TooManyLambdaFunctionAssociations:
Your request contains more Lambda@Edge function associations than are allowed per distribution.
- NoSuchDistribution:
The specified distribution does not exist.
- NoSuchOriginRequestPolicy:
The origin request policy does not exist.
- TooManyDistributionsAssociatedToFieldLevelEncryptionConfig:
The maximum number of distributions have been associated with the specified configuration for field-level encryption.
- InconsistentQuantities:
The value of
Quantity
and the size ofItems
don't match.- InvalidLocationCode:
The location code specified is not valid.
- InvalidOriginAccessIdentity:
The origin access identity is not valid or doesn't exist.
- TooManyDistributionCNAMEs:
Your request contains more CNAMEs than are allowed per distribution.
- InvalidIfMatchVersion:
The
If-Match
version is missing or not valid.- TooManyDistributionsAssociatedToOriginRequestPolicy:
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.
- TooManyQueryStringParameters:
Your request contains too many query string parameters.
- RealtimeLogConfigOwnerMismatch:
The specified real-time log configuration belongs to a different Amazon Web Services account.
- PreconditionFailed:
The precondition in one or more of the request fields evaluated to
false
.- MissingBody:
This operation requires a body. Ensure that the body is present and the
Content-Type
header is set.- TooManyHeadersInForwardedValues:
Your request contains too many headers in forwarded values.
- InvalidLambdaFunctionAssociation:
The specified Lambda@Edge function association is invalid.
- CNAMEAlreadyExists:
The CNAME specified is already defined for CloudFront.
- TooManyCertificates:
You cannot create anymore custom SSL/TLS certificates.
- TrustedKeyGroupDoesNotExist:
The specified key group does not exist.
- TooManyDistributionsAssociatedToResponseHeadersPolicy:
The maximum number of distributions have been associated with the specified response headers policy.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
- NoSuchResponseHeadersPolicy:
The response headers policy does not exist.
- NoSuchRealtimeLogConfig:
The real-time log configuration does not exist.
- InvalidResponseCode:
A response code is not valid.
- InvalidGeoRestrictionParameter:
The specified geo restriction parameter is not valid.
- TooManyOrigins:
You cannot create more origins for the distribution.
- InvalidViewerCertificate:
A viewer certificate specified is not valid.
- InvalidFunctionAssociation:
A CloudFront function association is invalid.
- TooManyDistributionsWithLambdaAssociations:
Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.
- TooManyDistributionsAssociatedToKeyGroup:
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.
- NoSuchOrigin:
No origin exists with the specified
Origin Id
.- TooManyCacheBehaviors:
You cannot create more cache behaviors for the distribution.
UpdateFieldLevelEncryptionConfig
$result = $client->updateFieldLevelEncryptionConfig
([/* ... */]); $promise = $client->updateFieldLevelEncryptionConfigAsync
([/* ... */]);
Update a field-level encryption configuration.
Parameter Syntax
$result = $client->updateFieldLevelEncryptionConfig([ 'FieldLevelEncryptionConfig' => [ // REQUIRED 'CallerReference' => '<string>', // REQUIRED 'Comment' => '<string>', 'ContentTypeProfileConfig' => [ 'ContentTypeProfiles' => [ 'Items' => [ [ 'ContentType' => '<string>', // REQUIRED 'Format' => 'URLEncoded', // REQUIRED