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

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:

• GetDistribution

• CreateDistribution

• CopyDistribution

Parameter Syntax

$result = $client->copyDistribution([
    'CallerReference' => '<string>', // REQUIRED
    'Enabled' => true || false,
    'IfMatch' => '<string>',
    'PrimaryDistributionId' => '<string>', // REQUIRED
    'Staging' => true || false,
]);

Parameter Details

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' => [
                            'OriginKeepaliveTimeout' => <integer>,
                            'OriginReadTimeout' => <integer>,
                            '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

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 example 473e64fd-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 of Items 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

Result Syntax

[
    'AnycastIpList' => [
        'AnycastIps' => ['<string>', ...],
        'Arn' => '<string>',
        'Id' => '<string>',
        'IpCount' => <integer>,
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => '<string>',
    ],
    'ETag' => '<string>',
]

Result Details

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

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

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 of Items 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

Result Syntax

[
    'CloudFrontOriginAccessIdentity' => [
        'CloudFrontOriginAccessIdentityConfig' => [
            'CallerReference' => '<string>',
            'Comment' => '<string>',
        ],
        'Id' => '<string>',
        'S3CanonicalUserId' => '<string>',
    ],
    'ETag' => '<string>',
    'Location' => '<string>',
]

Result Details

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 of Items 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 the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists 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

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

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 of Items 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' => [
                        'OriginKeepaliveTimeout' => <integer>,
                        'OriginReadTimeout' => <integer>,
                        '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

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' => [
                            'OriginKeepaliveTimeout' => <integer>,
                            'OriginReadTimeout' => <integer>,
                            '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

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 example 473e64fd-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 of Items 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:

• CreateDistribution

• TagResource

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' => [
                            'OriginKeepaliveTimeout' => <integer>,
                            'OriginReadTimeout' => <integer>,
                            '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

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' => [
                            'OriginKeepaliveTimeout' => <integer>,
                            'OriginReadTimeout' => <integer>,
                            '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

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 example 473e64fd-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 of Items 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

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

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 of Items 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

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

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 of Items 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

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

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

Result Syntax

[
    'Invalidation' => [
        'CreateTime' => <DateTime>,
        'Id' => '<string>',
        'InvalidationBatch' => [
            'CallerReference' => '<string>',
            'Paths' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
        ],
        'Status' => '<string>',
    ],
    'Location' => '<string>',
]

Result Details

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 of Items 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

Result Syntax

[
    'ETag' => '<string>',
    'KeyGroup' => [
        'Id' => '<string>',
        'KeyGroupConfig' => [
            'Comment' => '<string>',
            'Items' => ['<string>', ...],
            'Name' => '<string>',
        ],
        'LastModifiedTime' => <DateTime>,
    ],
    'Location' => '<string>',
]

Result Details

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

Result Syntax

[
    'ETag' => '<string>',
    'KeyValueStore' => [
        'ARN' => '<string>',
        'Comment' => '<string>',
        'Id' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => '<string>',
    ],
    'Location' => '<string>',
]

Result Details

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

Result Syntax

[
    'MonitoringSubscription' => [
        'RealtimeMetricsSubscriptionConfig' => [
            'RealtimeMetricsSubscriptionStatus' => 'Enabled|Disabled',
        ],
    ],
]

Result Details

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

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

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, and X-Amz-Cf-Id.

• All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.

CloudFront sends a request when it can't find a valid object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.

For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.

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

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

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 of Items 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

Result Syntax

[
    'ETag' => '<string>',
    'Location' => '<string>',
    'PublicKey' => [
        'CreatedTime' => <DateTime>,
        'Id' => '<string>',
        'PublicKeyConfig' => [
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'EncodedKey' => '<string>',
            'Name' => '<string>',
        ],
    ],
]

Result Details

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

Result Syntax

[
    'RealtimeLogConfig' => [
        'ARN' => '<string>',
        'EndPoints' => [
            [
                'KinesisStreamConfig' => [
                    'RoleARN' => '<string>',
                    'StreamARN' => '<string>',
                ],
                'StreamType' => '<string>',
            ],
            // ...
        ],
        'Fields' => ['<string>', ...],
        'Name' => '<string>',
        'SamplingRate' => <integer>,
    ],
]

Result Details

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

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

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 of Items 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

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

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 of Items 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

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

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 of Items 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

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

Errors

AccessDenied:

Access denied.

UnsupportedOperation:

This operation is not supported in this region.

InconsistentQuantities:

The value of Quantity and the size of Items 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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:

1. Disable the RTMP distribution.

2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

8. 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

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

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

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

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

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

Result Syntax

[
    'ETag' => '<string>',
    'KeyValueStore' => [
        'ARN' => '<string>',
        'Comment' => '<string>',
        'Id' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

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

Result Syntax

[
    'AnycastIpList' => [
        'AnycastIps' => ['<string>', ...],
        'Arn' => '<string>',
        'Id' => '<string>',
        'IpCount' => <integer>,
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => '<string>',
    ],
    'ETag' => '<string>',
]

Result Details

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

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

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

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

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

Result Syntax

[
    'CloudFrontOriginAccessIdentity' => [
        'CloudFrontOriginAccessIdentityConfig' => [
            'CallerReference' => '<string>',
            'Comment' => '<string>',
        ],
        'Id' => '<string>',
        'S3CanonicalUserId' => '<string>',
    ],
    'ETag' => '<string>',
]

Result Details

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

Result Syntax

[
    'CloudFrontOriginAccessIdentityConfig' => [
        'CallerReference' => '<string>',
        'Comment' => '<string>',
    ],
    'ETag' => '<string>',
]

Result Details

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

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

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

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

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

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' => [
                            'OriginKeepaliveTimeout' => <integer>,
                            'OriginReadTimeout' => <integer>,
                            '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

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

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' => [
                        'OriginKeepaliveTimeout' => <integer>,
                        'OriginReadTimeout' => <integer>,
                        '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

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

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

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

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

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

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

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

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

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

Result Syntax

[
    'ContentType' => '<string>',
    'ETag' => '<string>',
    'FunctionCode' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

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

Result Syntax

[
    'Invalidation' => [
        'CreateTime' => <DateTime>,
        'Id' => '<string>',
        'InvalidationBatch' => [
            'CallerReference' => '<string>',
            'Paths' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
        ],
        'Status' => '<string>',
    ],
]

Result Details

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

Result Syntax

[
    'ETag' => '<string>',
    'KeyGroup' => [
        'Id' => '<string>',
        'KeyGroupConfig' => [
            'Comment' => '<string>',
            'Items' => ['<string>', ...],
            'Name' => '<string>',
        ],
        'LastModifiedTime' => <DateTime>,
    ],
]

Result Details

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

Result Syntax

[
    'ETag' => '<string>',
    'KeyGroupConfig' => [
        'Comment' => '<string>',
        'Items' => ['<string>', ...],
        'Name' => '<string>',
    ],
]

Result Details

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

Result Syntax

[
    'MonitoringSubscription' => [
        'RealtimeMetricsSubscriptionConfig' => [
            'RealtimeMetricsSubscriptionStatus' => 'Enabled|Disabled',
        ],
    ],
]

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.

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

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

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

Result Syntax

[
    'ETag' => '<string>',
    'OriginAccessControlConfig' => [
        'Description' => '<string>',
        'Name' => '<string>',
        'OriginAccessControlOriginType' => 's3|mediastore|mediapackagev2|lambda',
        'SigningBehavior' => 'never|always|no-override',
        'SigningProtocol' => 'sigv4',
    ],
]

Result Details

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

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

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

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

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

Result Syntax

[
    'ETag' => '<string>',
    'PublicKey' => [
        'CreatedTime' => <DateTime>,
        'Id' => '<string>',
        'PublicKeyConfig' => [
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'EncodedKey' => '<string>',
            'Name' => '<string>',
        ],
    ],
]

Result Details

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

Result Syntax

[
    'ETag' => '<string>',
    'PublicKeyConfig' => [
        'CallerReference' => '<string>',
        'Comment' => '<string>',
        'EncodedKey' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

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

Result Syntax

[
    'RealtimeLogConfig' => [
        'ARN' => '<string>',
        'EndPoints' => [
            [
                'KinesisStreamConfig' => [
                    'RoleARN' => '<string>',
                    'StreamARN' => '<string>',
                ],
                'StreamType' => '<string>',
            ],
            // ...
        ],
        'Fields' => ['<string>', ...],
        'Name' => '<string>',
        'SamplingRate' => <integer>,
    ],
]

Result Details