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

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.

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.

InvalidArgument:

An argument is invalid.

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

CreateDistribution

$result = $client->createDistribution([/* ... */]);
$promise = $client->createDistributionAsync([/* ... */]);

Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.

Parameter Syntax

$result = $client->createDistribution([
    'DistributionConfig' => [ // REQUIRED
        'Aliases' => [
            'Items' => ['<string>', ...],
            'Quantity' => <integer>, // REQUIRED
        ],
        'CacheBehaviors' => [
            'Items' => [
                [
                    'AllowedMethods' => [
                        'CachedMethods' => [
                            'Items' => ['<string>', ...], // REQUIRED
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'Items' => ['<string>', ...], // REQUIRED
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'Compress' => true || false,
                    'DefaultTTL' => <integer>,
                    'FieldLevelEncryptionId' => '<string>',
                    'ForwardedValues' => [ // REQUIRED
                        '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
                        ],
                    ],
                    '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>, // REQUIRED
                    'PathPattern' => '<string>', // REQUIRED
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>', // REQUIRED
                    'TrustedSigners' => [ // REQUIRED
                        '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
        '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
            ],
            'Compress' => true || false,
            'DefaultTTL' => <integer>,
            'FieldLevelEncryptionId' => '<string>',
            'ForwardedValues' => [ // REQUIRED
                '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
                ],
            ],
            '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>, // REQUIRED
            'SmoothStreaming' => true || false,
            'TargetOriginId' => '<string>', // REQUIRED
            'TrustedSigners' => [ // REQUIRED
                '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',
        'IsIPV6Enabled' => true || false,
        'Logging' => [
            'Bucket' => '<string>', // REQUIRED
            'Enabled' => true || false, // REQUIRED
            'IncludeCookies' => true || false, // REQUIRED
            'Prefix' => '<string>', // REQUIRED
        ],
        '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
                    ],
                ],
                // ...
            ],
            '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
                    'OriginPath' => '<string>',
                    'S3OriginConfig' => [
                        'OriginAccessIdentity' => '<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
            ],
        ],
        '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',
            'SSLSupportMethod' => 'sni-only|vip',
        ],
        'WebACLId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'Distribution' => [
        'ARN' => '<string>',
        '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>,
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        '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>,
                            ],
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'IncludeBody' => true || false,
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'PathPattern' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>',
                        'TrustedSigners' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>,
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'DefaultCacheBehavior' => [
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                '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>,
                    ],
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'IncludeBody' => true || false,
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>',
                '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',
            '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>,
                        ],
                    ],
                    // ...
                ],
                '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>',
                        'OriginPath' => '<string>',
                        'S3OriginConfig' => [
                            'OriginAccessIdentity' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
            'Restrictions' => [
                'GeoRestriction' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                    'RestrictionType' => 'blacklist|whitelist|none',
                ],
            ],
            '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',
                'SSLSupportMethod' => 'sni-only|vip',
            ],
            'WebACLId' => '<string>',
        ],
        'DomainName' => '<string>',
        'Id' => '<string>',
        'InProgressInvalidationBatches' => <integer>,
        'LastModifiedTime' => <DateTime>,
        'Status' => '<string>',
    ],
    'ETag' => '<string>',
    'Location' => '<string>',
]

Result Details

Errors

CNAMEAlreadyExists:

The CNAME specified is already defined for CloudFront.

DistributionAlreadyExists:

The caller reference you attempted to create the distribution with is associated with another distribution.

InvalidOrigin:

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

InvalidOriginAccessIdentity:

The origin access identity is not valid or doesn't exist.

AccessDenied:

Access denied.

TooManyTrustedSigners:

Your request contains more trusted signers than are allowed per distribution.

TrustedSignerDoesNotExist:

One or more of your trusted signers don't exist.

InvalidViewerCertificate:

A viewer certificate specified is not valid.

InvalidMinimumProtocolVersion:

The minimum protocol version specified is not valid.

MissingBody:

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

TooManyDistributionCNAMEs:

Your request contains more CNAMEs than are allowed per distribution.

TooManyDistributions:

Processing your request would cause you to exceed the maximum number of distributions allowed.

InvalidDefaultRootObject:

The default root object file name is too big or contains an invalid character.

InvalidRelativePath:

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

InvalidErrorCode:

An invalid error code was specified.

InvalidResponseCode:

A response code is not valid.

InvalidArgument:

An argument is invalid.

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.

NoSuchOrigin:

No origin exists with the specified Origin Id.

TooManyOrigins:

You cannot create more origins for the distribution.

TooManyOriginGroupsPerDistribution:

Processing your request would cause you to exceed the maximum number of origin groups allowed.

TooManyCacheBehaviors:

You cannot create more cache behaviors for the distribution.

TooManyCookieNamesInWhiteList:

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

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.

TooManyHeadersInForwardedValues:

Your request contains too many headers in forwarded values.

InvalidHeadersForS3Origin:

The headers specified are not valid for an Amazon S3 origin.

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

TooManyCertificates:

You cannot create anymore custom SSL/TLS certificates.

InvalidLocationCode:

The location code specified is not valid.

InvalidGeoRestrictionParameter:

The specified geo restriction parameter is not valid.

InvalidProtocolSettings:

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).

InvalidTTLOrder:

The TTL order specified is not valid.

InvalidWebACLId:

A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

TooManyOriginCustomHeaders:

Your request contains too many origin custom headers.

TooManyQueryStringParameters:

Your request contains too many query string parameters.

InvalidQueryStringParameters:

The query string parameters specified are not valid.

TooManyDistributionsWithLambdaAssociations:

Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.

TooManyLambdaFunctionAssociations:

Your request contains more Lambda function associations than are allowed per distribution.

InvalidLambdaFunctionAssociation:

The specified Lambda function association is invalid.

InvalidOriginReadTimeout:

The read timeout specified for the origin is not valid.

InvalidOriginKeepaliveTimeout:

The keep alive timeout specified for the origin is not valid.

NoSuchFieldLevelEncryptionConfig:

The specified configuration for field-level encryption doesn't exist.

IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior:

The specified configuration for field-level encryption can't be associated with the specified cache behavior.

TooManyDistributionsAssociatedToFieldLevelEncryptionConfig:

The maximum number of distributions have been associated with the specified configuration for field-level encryption.

CreateDistributionWithTags

$result = $client->createDistributionWithTags([/* ... */]);
$promise = $client->createDistributionWithTagsAsync([/* ... */]);

Create a new distribution with tags.

Parameter Syntax

$result = $client->createDistributionWithTags([
    'DistributionConfigWithTags' => [ // REQUIRED
        'DistributionConfig' => [ // REQUIRED
            'Aliases' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...], // REQUIRED
                                'Quantity' => <integer>, // REQUIRED
                            ],
                            'Items' => ['<string>', ...], // REQUIRED
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'Compress' => true || false,
                        'DefaultTTL' => <integer>,
                        'FieldLevelEncryptionId' => '<string>',
                        'ForwardedValues' => [ // REQUIRED
                            '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
                            ],
                        ],
                        '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>, // REQUIRED
                        'PathPattern' => '<string>', // REQUIRED
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>', // REQUIRED
                        'TrustedSigners' => [ // REQUIRED
                            '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
            '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
                ],
                'Compress' => true || false,
                'DefaultTTL' => <integer>,
                'FieldLevelEncryptionId' => '<string>',
                'ForwardedValues' => [ // REQUIRED
                    '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
                    ],
                ],
                '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>, // REQUIRED
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>', // REQUIRED
                'TrustedSigners' => [ // REQUIRED
                    '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',
            'IsIPV6Enabled' => true || false,
            'Logging' => [
                'Bucket' => '<string>', // REQUIRED
                'Enabled' => true || false, // REQUIRED
                'IncludeCookies' => true || false, // REQUIRED
                'Prefix' => '<string>', // REQUIRED
            ],
            '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
                        ],
                    ],
                    // ...
                ],
                '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
                        'OriginPath' => '<string>',
                        'S3OriginConfig' => [
                            'OriginAccessIdentity' => '<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
                ],
            ],
            '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',
                'SSLSupportMethod' => 'sni-only|vip',
            ],
            'WebACLId' => '<string>',
        ],
        'Tags' => [ // REQUIRED
            'Items' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'Distribution' => [
        'ARN' => '<string>',
        '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>,
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        '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>,
                            ],
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'IncludeBody' => true || false,
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'PathPattern' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>',
                        'TrustedSigners' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>,
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'DefaultCacheBehavior' => [
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                '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>,
                    ],
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'IncludeBody' => true || false,
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>',
                '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',
            '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>,
                        ],
                    ],
                    // ...
                ],
                '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>',
                        'OriginPath' => '<string>',
                        'S3OriginConfig' => [
                            'OriginAccessIdentity' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
            'Restrictions' => [
                'GeoRestriction' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                    'RestrictionType' => 'blacklist|whitelist|none',
                ],
            ],
            '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',
                'SSLSupportMethod' => 'sni-only|vip',
            ],
            'WebACLId' => '<string>',
        ],
        'DomainName' => '<string>',
        'Id' => '<string>',
        'InProgressInvalidationBatches' => <integer>,
        'LastModifiedTime' => <DateTime>,
        'Status' => '<string>',
    ],
    'ETag' => '<string>',
    'Location' => '<string>',
]

Result Details

Errors

CNAMEAlreadyExists:

The CNAME specified is already defined for CloudFront.

DistributionAlreadyExists:

The caller reference you attempted to create the distribution with is associated with another distribution.

InvalidOrigin:

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

InvalidOriginAccessIdentity:

The origin access identity is not valid or doesn't exist.

AccessDenied:

Access denied.

TooManyTrustedSigners:

Your request contains more trusted signers than are allowed per distribution.

TrustedSignerDoesNotExist:

One or more of your trusted signers don't exist.

InvalidViewerCertificate:

A viewer certificate specified is not valid.

InvalidMinimumProtocolVersion:

The minimum protocol version specified is not valid.

MissingBody:

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

TooManyDistributionCNAMEs:

Your request contains more CNAMEs than are allowed per distribution.

TooManyDistributions:

Processing your request would cause you to exceed the maximum number of distributions allowed.

InvalidDefaultRootObject:

The default root object file name is too big or contains an invalid character.

InvalidRelativePath:

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

InvalidErrorCode:

An invalid error code was specified.

InvalidResponseCode:

A response code is not valid.

InvalidArgument:

An argument is invalid.

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.

NoSuchOrigin:

No origin exists with the specified Origin Id.

TooManyOrigins:

You cannot create more origins for the distribution.

TooManyOriginGroupsPerDistribution:

Processing your request would cause you to exceed the maximum number of origin groups allowed.

TooManyCacheBehaviors:

You cannot create more cache behaviors for the distribution.

TooManyCookieNamesInWhiteList:

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

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.

TooManyHeadersInForwardedValues:

Your request contains too many headers in forwarded values.

InvalidHeadersForS3Origin:

The headers specified are not valid for an Amazon S3 origin.

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

TooManyCertificates:

You cannot create anymore custom SSL/TLS certificates.

InvalidLocationCode:

The location code specified is not valid.

InvalidGeoRestrictionParameter:

The specified geo restriction parameter is not valid.

InvalidProtocolSettings:

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).

InvalidTTLOrder:

The TTL order specified is not valid.

InvalidWebACLId:

A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

TooManyOriginCustomHeaders:

Your request contains too many origin custom headers.

InvalidTagging:

The tagging specified is not valid.

TooManyQueryStringParameters:

Your request contains too many query string parameters.

InvalidQueryStringParameters:

The query string parameters specified are not valid.

TooManyDistributionsWithLambdaAssociations:

Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.

TooManyLambdaFunctionAssociations:

Your request contains more Lambda function associations than are allowed per distribution.

InvalidLambdaFunctionAssociation:

The specified Lambda function association is invalid.

InvalidOriginReadTimeout:

The read timeout specified for the origin is not valid.

InvalidOriginKeepaliveTimeout:

The keep alive timeout specified for the origin is not valid.

NoSuchFieldLevelEncryptionConfig:

The specified configuration for field-level encryption doesn't exist.

IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior:

The specified configuration for field-level encryption can't be associated with the specified cache behavior.

TooManyDistributionsAssociatedToFieldLevelEncryptionConfig:

The maximum number of distributions have been associated with the specified configuration for field-level encryption.

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

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

InvalidArgument:

An argument is invalid.

NoSuchFieldLevelEncryptionProfile:

The specified profile for field-level encryption doesn't exist.

FieldLevelEncryptionConfigAlreadyExists:

The specified configuration for field-level encryption already exists.

TooManyFieldLevelEncryptionConfigs:

The maximum number of configurations for field-level encryption have been created.

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.

QueryArgProfileEmpty:

No profile specified for the field-level encryption query argument.

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

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

InvalidArgument:

An argument is invalid.

NoSuchPublicKey:

The specified public key doesn't exist.

FieldLevelEncryptionProfileAlreadyExists:

The specified profile for field-level encryption already exists.

FieldLevelEncryptionProfileSizeExceeded:

The maximum size of a profile for field-level encryption was exceeded.

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.

TooManyFieldLevelEncryptionFieldPatterns:

The maximum number of field patterns for field-level encryption have been created.

CreateInvalidation

$result = $client->createInvalidation([/* ... */]);
$promise = $client->createInvalidationAsync([/* ... */]);

Create a new invalidation.

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

AccessDenied:

Access denied.

MissingBody:

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

InvalidArgument:

An argument is invalid.

NoSuchDistribution:

The specified distribution does not exist.

BatchTooLarge:

Invalidation batch specified is too large.

TooManyInvalidationsInProgress:

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

CreatePublicKey

$result = $client->createPublicKey([/* ... */]);
$promise = $client->createPublicKeyAsync([/* ... */]);

Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.

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

PublicKeyAlreadyExists:

The specified public key already exists.

InvalidArgument:

An argument is invalid.

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.

CreateStreamingDistribution

$result = $client->createStreamingDistribution([/* ... */]);
$promise = $client->createStreamingDistributionAsync([/* ... */]);

Creates a new RTMP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

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

CNAMEAlreadyExists:

The CNAME specified is already defined for CloudFront.

StreamingDistributionAlreadyExists:

The caller reference you attempted to create the streaming distribution with is associated with another distribution

InvalidOrigin:

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

InvalidOriginAccessIdentity:

The origin access identity is not valid or doesn't exist.

AccessDenied:

Access denied.

TooManyTrustedSigners:

Your request contains more trusted signers than are allowed per distribution.

TrustedSignerDoesNotExist:

One or more of your trusted signers don't exist.

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.

TooManyStreamingDistributions:

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

InvalidArgument:

An argument is invalid.

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

CreateStreamingDistributionWithTags

$result = $client->createStreamingDistributionWithTags([/* ... */]);
$promise = $client->createStreamingDistributionWithTagsAsync([/* ... */]);

Create a new streaming distribution with tags.

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

CNAMEAlreadyExists:

The CNAME specified is already defined for CloudFront.

StreamingDistributionAlreadyExists:

The caller reference you attempted to create the streaming distribution with is associated with another distribution

InvalidOrigin:

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

InvalidOriginAccessIdentity:

The origin access identity is not valid or doesn't exist.

AccessDenied:

Access denied.

TooManyTrustedSigners:

Your request contains more trusted signers than are allowed per distribution.

TrustedSignerDoesNotExist:

One or more of your trusted signers don't exist.

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.

TooManyStreamingDistributions:

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

InvalidArgument:

An argument is invalid.

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

InvalidTagging:

The tagging specified is 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

AccessDenied:

Access denied.

InvalidIfMatchVersion:

The If-Match version is missing or not valid for the distribution.

NoSuchCloudFrontOriginAccessIdentity:

The specified origin access identity does not exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

CloudFrontOriginAccessIdentityInUse:

The Origin Access Identity specified is already in use.

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

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 for the distribution.

NoSuchDistribution:

The specified distribution does not exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

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

AccessDenied:

Access denied.

InvalidIfMatchVersion:

The If-Match version is missing or not valid for the distribution.

NoSuchFieldLevelEncryptionConfig:

The specified configuration for field-level encryption doesn't exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

FieldLevelEncryptionConfigInUse:

The specified configuration for field-level encryption is in use.

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

AccessDenied:

Access denied.

InvalidIfMatchVersion:

The If-Match version is missing or not valid for the distribution.

NoSuchFieldLevelEncryptionProfile:

The specified profile for field-level encryption doesn't exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

FieldLevelEncryptionProfileInUse:

The specified profile for field-level encryption is in use.

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

AccessDenied:

Access denied.

PublicKeyInUse:

The specified public key is in use.

InvalidIfMatchVersion:

The If-Match version is missing or not valid for the distribution.

NoSuchPublicKey:

The specified public key doesn't exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

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

AccessDenied:

Access denied.

StreamingDistributionNotDisabled:

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 for the distribution.

NoSuchStreamingDistribution:

The specified streaming distribution does not exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

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

NoSuchCloudFrontOriginAccessIdentity:

The specified origin access identity does not exist.

AccessDenied:

Access denied.

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

NoSuchCloudFrontOriginAccessIdentity:

The specified origin access identity does not exist.

AccessDenied:

Access denied.

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>',
        '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>,
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        '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>,
                            ],
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'IncludeBody' => true || false,
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'PathPattern' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>',
                        'TrustedSigners' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>,
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'DefaultCacheBehavior' => [
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                '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>,
                    ],
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'IncludeBody' => true || false,
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>',
                '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',
            '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>,
                        ],
                    ],
                    // ...
                ],
                '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>',
                        'OriginPath' => '<string>',
                        'S3OriginConfig' => [
                            'OriginAccessIdentity' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
            'Restrictions' => [
                'GeoRestriction' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                    'RestrictionType' => 'blacklist|whitelist|none',
                ],
            ],
            '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',
                'SSLSupportMethod' => 'sni-only|vip',
            ],
            '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>,
        ],
        'CacheBehaviors' => [
            'Items' => [
                [
                    'AllowedMethods' => [
                        'CachedMethods' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    '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>,
                        ],
                    ],
                    'LambdaFunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                'IncludeBody' => true || false,
                                'LambdaFunctionARN' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>,
                    ],
                    'MaxTTL' => <integer>,
                    'MinTTL' => <integer>,
                    'PathPattern' => '<string>',
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>',
                    'TrustedSigners' => [
                        'Enabled' => true || false,
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'CallerReference' => '<string>',
        'Comment' => '<string>',
        'CustomErrorResponses' => [
            'Items' => [
                [
                    'ErrorCachingMinTTL' => <integer>,
                    'ErrorCode' => <integer>,
                    'ResponseCode' => '<string>',
                    'ResponsePagePath' => '<string>',
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'DefaultCacheBehavior' => [
            'AllowedMethods' => [
                'CachedMethods' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            '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>,
                ],
            ],
            'LambdaFunctionAssociations' => [
                'Items' => [
                    [
                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                        'IncludeBody' => true || false,
                        'LambdaFunctionARN' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'MaxTTL' => <integer>,
            'MinTTL' => <integer>,
            'SmoothStreaming' => true || false,
            'TargetOriginId' => '<string>',
            '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',
        '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>,
                    ],
                ],
                // ...
            ],
            '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>',
                    'OriginPath' => '<string>',
                    'S3OriginConfig' => [
                        'OriginAccessIdentity' => '<string>',
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
        'Restrictions' => [
            'GeoRestriction' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
                'RestrictionType' => 'blacklist|whitelist|none',
            ],
        ],
        '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',
            'SSLSupportMethod' => 'sni-only|vip',
        ],
        '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.

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

NoSuchInvalidation:

The specified invalidation does not exist.

NoSuchDistribution:

The specified distribution does not exist.

AccessDenied:

Access denied.

GetPublicKey

$result = $client->getPublicKey([/* ... */]);
$promise = $client->getPublicKeyAsync([/* ... */]);

Get the public key information.

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([/* ... */]);

Return public key configuration informaation

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.

GetStreamingDistribution

$result = $client->getStreamingDistribution([/* ... */]);
$promise = $client->getStreamingDistributionAsync([/* ... */]);

Gets information about a specified RTMP distribution, including the distribution configuration.

Parameter Syntax

$result = $client->getStreamingDistribution([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ETag' => '<string>',
    'StreamingDistribution' => [
        'ARN' => '<string>',
        'ActiveTrustedSigners' => [
            'Enabled' => true || false,
            'Items' => [
                [
                    'AwsAccountNumber' => '<string>',
                    'KeyPairIds' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'DomainName' => '<string>',
        'Id' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'Status' => '<string>',
        'StreamingDistributionConfig' => [
            'Aliases' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'Enabled' => true || false,
            'Logging' => [
                'Bucket' => '<string>',
                'Enabled' => true || false,
                'Prefix' => '<string>',
            ],
            'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
            'S3Origin' => [
                'DomainName' => '<string>',
                'OriginAccessIdentity' => '<string>',
            ],
            'TrustedSigners' => [
                'Enabled' => true || false,
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
        ],
    ],
]

Result Details

Errors

NoSuchStreamingDistribution:

The specified streaming distribution does not exist.

AccessDenied:

Access denied.

GetStreamingDistributionConfig

$result = $client->getStreamingDistributionConfig([/* ... */]);
$promise = $client->getStreamingDistributionConfigAsync([/* ... */]);

Get the configuration information about a streaming distribution.

Parameter Syntax

$result = $client->getStreamingDistributionConfig([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ETag' => '<string>',
    'StreamingDistributionConfig' => [
        'Aliases' => [
            'Items' => ['<string>', ...],
            'Quantity' => <integer>,
        ],
        'CallerReference' => '<string>',
        'Comment' => '<string>',
        'Enabled' => true || false,
        'Logging' => [
            'Bucket' => '<string>',
            'Enabled' => true || false,
            'Prefix' => '<string>',
        ],
        'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
        'S3Origin' => [
            'DomainName' => '<string>',
            'OriginAccessIdentity' => '<string>',
        ],
        'TrustedSigners' => [
            'Enabled' => true || false,
            'Items' => ['<string>', ...],
            'Quantity' => <integer>,
        ],
    ],
]

Result Details

Errors

NoSuchStreamingDistribution:

The specified streaming distribution does not exist.

AccessDenied:

Access denied.

ListCloudFrontOriginAccessIdentities

$result = $client->listCloudFrontOriginAccessIdentities([/* ... */]);
$promise = $client->listCloudFrontOriginAccessIdentitiesAsync([/* ... */]);

Lists origin access identities.

Parameter Syntax

$result = $client->listCloudFrontOriginAccessIdentities([
    'Marker' => '<string>',
    'MaxItems' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CloudFrontOriginAccessIdentityList' => [
        'IsTruncated' => true || false,
        'Items' => [
            [
                'Comment' => '<string>',
                'Id' => '<string>',
                'S3CanonicalUserId' => '<string>',
            ],
            // ...
        ],
        'Marker' => '<string>',
        'MaxItems' => <integer>,
        'NextMarker' => '<string>',
        'Quantity' => <integer>,
    ],
]

Result Details

Errors

InvalidArgument:

An argument is invalid.

ListDistributions

$result = $client->listDistributions([/* ... */]);
$promise = $client->listDistributionsAsync([/* ... */]);

List CloudFront distributions.

Parameter Syntax

$result = $client->listDistributions([
    'Marker' => '<string>',
    'MaxItems' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DistributionList' => [
        'IsTruncated' => true || false,
        'Items' => [
            [
                'ARN' => '<string>',
                'AliasICPRecordals' => [
                    [
                        'CNAME' => '<string>',
                        'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
                    ],
                    // ...
                ],
                'Aliases' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'CacheBehaviors' => [
                    'Items' => [
                        [
                            'AllowedMethods' => [
                                'CachedMethods' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            '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>,
                                ],
                            ],
                            'LambdaFunctionAssociations' => [
                                'Items' => [
                                    [
                                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                        'IncludeBody' => true || false,
                                        'LambdaFunctionARN' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Quantity' => <integer>,
                            ],
                            'MaxTTL' => <integer>,
                            'MinTTL' => <integer>,
                            'PathPattern' => '<string>',
                            'SmoothStreaming' => true || false,
                            'TargetOriginId' => '<string>',
                            'TrustedSigners' => [
                                'Enabled' => true || false,
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'Comment' => '<string>',
                'CustomErrorResponses' => [
                    'Items' => [
                        [
                            'ErrorCachingMinTTL' => <integer>,
                            'ErrorCode' => <integer>,
                            'ResponseCode' => '<string>',
                            'ResponsePagePath' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'DefaultCacheBehavior' => [
                    'AllowedMethods' => [
                        'CachedMethods' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    '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>,
                        ],
                    ],
                    'LambdaFunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                'IncludeBody' => true || false,
                                'LambdaFunctionARN' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>,
                    ],
                    'MaxTTL' => <integer>,
                    'MinTTL' => <integer>,
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>',
                    'TrustedSigners' => [
                        'Enabled' => true || false,
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                ],
                'DomainName' => '<string>',
                'Enabled' => true || false,
                'HttpVersion' => 'http1.1|http2',
                'Id' => '<string>',
                'IsIPV6Enabled' => true || false,
                'LastModifiedTime' => <DateTime>,
                'OriginGroups' => [
                    'Items' => [
                        [
                            'FailoverCriteria' => [
                                'StatusCodes' => [
                                    'Items' => [<integer>, ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'Id' => '<string>',
                            'Members' => [
                                'Items' => [
                                    [
                                        'OriginId' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Quantity' => <integer>,
                            ],
                        ],
                        // ...
                    ],
                    '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>',
                            'OriginPath' => '<string>',
                            'S3OriginConfig' => [
                                'OriginAccessIdentity' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
                'Restrictions' => [
                    'GeoRestriction' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                        'RestrictionType' => 'blacklist|whitelist|none',
                    ],
                ],
                'Status' => '<string>',
                'ViewerCertificate' => [
                    'ACMCertificateArn' => '<string>',
                    'Certificate' => '<string>',
                    'CertificateSource' => 'cloudfront|iam|acm',
                    'CloudFrontDefaultCertificate' => true || false,
                    'IAMCertificateId' => '<string>',
                    'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019',
                    'SSLSupportMethod' => 'sni-only|vip',
                ],
                'WebACLId' => '<string>',
            ],
            // ...
        ],
        'Marker' => '<string>',
        'MaxItems' => <integer>,
        'NextMarker' => '<string>',
        'Quantity' => <integer>,
    ],
]

Result Details

Errors

InvalidArgument:

An argument is invalid.

ListDistributionsByWebACLId

$result = $client->listDistributionsByWebACLId([/* ... */]);
$promise = $client->listDistributionsByWebACLIdAsync([/* ... */]);

List the distributions that are associated with a specified AWS WAF web ACL.

Parameter Syntax

$result = $client->listDistributionsByWebACLId([
    'Marker' => '<string>',
    'MaxItems' => '<string>',
    'WebACLId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DistributionList' => [
        'IsTruncated' => true || false,
        'Items' => [
            [
                'ARN' => '<string>',
                'AliasICPRecordals' => [
                    [
                        'CNAME' => '<string>',
                        'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
                    ],
                    // ...
                ],
                'Aliases' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'CacheBehaviors' => [
                    'Items' => [
                        [
                            'AllowedMethods' => [
                                'CachedMethods' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            '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>,
                                ],
                            ],
                            'LambdaFunctionAssociations' => [
                                'Items' => [
                                    [
                                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                        'IncludeBody' => true || false,
                                        'LambdaFunctionARN' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Quantity' => <integer>,
                            ],
                            'MaxTTL' => <integer>,
                            'MinTTL' => <integer>,
                            'PathPattern' => '<string>',
                            'SmoothStreaming' => true || false,
                            'TargetOriginId' => '<string>',
                            'TrustedSigners' => [
                                'Enabled' => true || false,
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'Comment' => '<string>',
                'CustomErrorResponses' => [
                    'Items' => [
                        [
                            'ErrorCachingMinTTL' => <integer>,
                            'ErrorCode' => <integer>,
                            'ResponseCode' => '<string>',
                            'ResponsePagePath' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'DefaultCacheBehavior' => [
                    'AllowedMethods' => [
                        'CachedMethods' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    '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>,
                        ],
                    ],
                    'LambdaFunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                'IncludeBody' => true || false,
                                'LambdaFunctionARN' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>,
                    ],
                    'MaxTTL' => <integer>,
                    'MinTTL' => <integer>,
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>',
                    'TrustedSigners' => [
                        'Enabled' => true || false,
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                ],
                'DomainName' => '<string>',
                'Enabled' => true || false,
                'HttpVersion' => 'http1.1|http2',
                'Id' => '<string>',
                'IsIPV6Enabled' => true || false,
                'LastModifiedTime' => <DateTime>,
                'OriginGroups' => [
                    'Items' => [
                        [
                            'FailoverCriteria' => [
                                'StatusCodes' => [
                                    'Items' => [<integer>, ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'Id' => '<string>',
                            'Members' => [
                                'Items' => [
                                    [
                                        'OriginId' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Quantity' => <integer>,
                            ],
                        ],
                        // ...
                    ],
                    '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>',
                            'OriginPath' => '<string>',
                            'S3OriginConfig' => [
                                'OriginAccessIdentity' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
                'Restrictions' => [
                    'GeoRestriction' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                        'RestrictionType' => 'blacklist|whitelist|none',
                    ],
                ],
                'Status' => '<string>',
                'ViewerCertificate' => [
                    'ACMCertificateArn' => '<string>',
                    'Certificate' => '<string>',
                    'CertificateSource' => 'cloudfront|iam|acm',
                    'CloudFrontDefaultCertificate' => true || false,
                    'IAMCertificateId' => '<string>',
                    'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019',
                    'SSLSupportMethod' => 'sni-only|vip',
                ],
                'WebACLId' => '<string>',
            ],
            // ...
        ],
        'Marker' => '<string>',
        'MaxItems' => <integer>,
        'NextMarker' => '<string>',
        'Quantity' => <integer>,
    ],
]

Result Details

Errors

InvalidArgument:

An argument is invalid.

InvalidWebACLId:

A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

ListFieldLevelEncryptionConfigs

$result = $client->listFieldLevelEncryptionConfigs([/* ... */]);
$promise = $client->listFieldLevelEncryptionConfigsAsync([/* ... */]);

List all field-level encryption configurations that have been created in CloudFront for this account.

Parameter Syntax

$result = $client->listFieldLevelEncryptionConfigs([
    'Marker' => '<string>',
    'MaxItems' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FieldLevelEncryptionList' => [
        'Items' => [
            [
                'Comment' => '<string>',
                'ContentTypeProfileConfig' => [
                    'ContentTypeProfiles' => [
                        'Items' => [
                            [
                                'ContentType' => '<string>',
                                'Format' => 'URLEncoded',
                                'ProfileId' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>,
                    ],
                    'ForwardWhenContentTypeIsUnknown' => true || false,
                ],
                'Id' => '<string>',
                'LastModifiedTime' => <DateTime>,
                'QueryArgProfileConfig' => [
                    'ForwardWhenQueryArgProfileIsUnknown' => true || false,
                    'QueryArgProfiles' => [
                        'Items' => [
                            [
                                'ProfileId' => '<string>',
                                'QueryArg' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>,
                    ],
                ],
            ],
            // ...
        ],
        'MaxItems' => <integer>,
        'NextMarker' => '<string>',
        'Quantity' => <integer>,
    ],
]

Result Details

Errors

InvalidArgument:

An argument is invalid.

ListFieldLevelEncryptionProfiles

$result = $client->listFieldLevelEncryptionProfiles([/* ... */]);
$promise = $client->listFieldLevelEncryptionProfilesAsync([/* ... */]);

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

Parameter Syntax

$result = $client->listFieldLevelEncryptionProfiles([
    'Marker' => '<string>',
    'MaxItems' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FieldLevelEncryptionProfileList' => [
        'Items' => [
            [
                'Comment' => '<string>',
                'EncryptionEntities' => [
                    'Items' => [
                        [
                            'FieldPatterns' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'ProviderId' => '<string>',
                            'PublicKeyId' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'Id' => '<string>',
                'LastModifiedTime' => <DateTime>,
                'Name' => '<string>',
            ],
            // ...
        ],
        'MaxItems' => <integer>,
        'NextMarker' => '<string>',
        'Quantity' => <integer>,
    ],
]

Result Details

Errors

InvalidArgument:

An argument is invalid.

ListInvalidations

$result = $client->listInvalidations([/* ... */]);
$promise = $client->listInvalidationsAsync([/* ... */]);

Lists invalidation batches.

Parameter Syntax

$result = $client->listInvalidations([
    'DistributionId' => '<string>', // REQUIRED
    'Marker' => '<string>',
    'MaxItems' => '<string>',
]);

Parameter Details

Result Syntax

[
    'InvalidationList' => [
        'IsTruncated' => true || false,
        'Items' => [
            [
                'CreateTime' => <DateTime>,
                'Id' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Marker' => '<string>',
        'MaxItems' => <integer>,
        'NextMarker' => '<string>',
        'Quantity' => <integer>,
    ],
]

Result Details

Errors

InvalidArgument:

An argument is invalid.

NoSuchDistribution:

The specified distribution does not exist.

AccessDenied:

Access denied.

ListPublicKeys

$result = $client->listPublicKeys([/* ... */]);
$promise = $client->listPublicKeysAsync([/* ... */]);

List all public keys that have been added to CloudFront for this account.

Parameter Syntax

$result = $client->listPublicKeys([
    'Marker' => '<string>',
    'MaxItems' => '<string>',
]);

Parameter Details

Result Syntax

[
    'PublicKeyList' => [
        'Items' => [
            [
                'Comment' => '<string>',
                'CreatedTime' => <DateTime>,
                'EncodedKey' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            // ...
        ],
        'MaxItems' => <integer>,
        'NextMarker' => '<string>',
        'Quantity' => <integer>,
    ],
]

Result Details

Errors

InvalidArgument:

An argument is invalid.

ListStreamingDistributions

$result = $client->listStreamingDistributions([/* ... */]);
$promise = $client->listStreamingDistributionsAsync([/* ... */]);

List streaming distributions.

Parameter Syntax

$result = $client->listStreamingDistributions([
    'Marker' => '<string>',
    'MaxItems' => '<string>',
]);

Parameter Details

Result Syntax

[
    'StreamingDistributionList' => [
        'IsTruncated' => true || false,
        'Items' => [
            [
                'ARN' => '<string>',
                'Aliases' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'Comment' => '<string>',
                'DomainName' => '<string>',
                'Enabled' => true || false,
                'Id' => '<string>',
                'LastModifiedTime' => <DateTime>,
                'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
                'S3Origin' => [
                    'DomainName' => '<string>',
                    'OriginAccessIdentity' => '<string>',
                ],
                'Status' => '<string>',
                'TrustedSigners' => [
                    'Enabled' => true || false,
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
            ],
            // ...
        ],
        'Marker' => '<string>',
        'MaxItems' => <integer>,
        'NextMarker' => '<string>',
        'Quantity' => <integer>,
    ],
]

Result Details

Errors

InvalidArgument:

An argument is invalid.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List tags for a CloudFront resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'Resource' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => [
        'Items' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

AccessDenied:

Access denied.

InvalidArgument:

An argument is invalid.

InvalidTagging:

The tagging specified is not valid.

NoSuchResource:

A resource that was specified is not valid.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Add tags to a CloudFront resource.

Parameter Syntax

$result = $client->tagResource([
    'Resource' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        'Items' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDenied:

Access denied.

InvalidArgument:

An argument is invalid.

InvalidTagging:

The tagging specified is not valid.

NoSuchResource:

A resource that was specified is not valid.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Remove tags from a CloudFront resource.

Parameter Syntax

$result = $client->untagResource([
    'Resource' => '<string>', // REQUIRED
    'TagKeys' => [ // REQUIRED
        'Items' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDenied:

Access denied.

InvalidArgument:

An argument is invalid.

InvalidTagging:

The tagging specified is not valid.

NoSuchResource:

A resource that was specified is not valid.

UpdateCloudFrontOriginAccessIdentity

$result = $client->updateCloudFrontOriginAccessIdentity([/* ... */]);
$promise = $client->updateCloudFrontOriginAccessIdentityAsync([/* ... */]);

Update an origin access identity.

Parameter Syntax

$result = $client->updateCloudFrontOriginAccessIdentity([
    'CloudFrontOriginAccessIdentityConfig' => [ // REQUIRED
        'CallerReference' => '<string>', // REQUIRED
        'Comment' => '<string>', // REQUIRED
    ],
    'Id' => '<string>', // REQUIRED
    'IfMatch' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDenied:

Access denied.

IllegalUpdate:

Origin and CallerReference cannot be updated.

InvalidIfMatchVersion:

The If-Match version is missing or not valid for the distribution.

MissingBody:

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

NoSuchCloudFrontOriginAccessIdentity:

The specified origin access identity does not exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

InvalidArgument:

An argument is invalid.

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

UpdateDistribution

$result = $client->updateDistribution([/* ... */]);
$promise = $client->updateDistributionAsync([/* ... */]);

Updates the configuration for a web distribution.

The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates.

For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.

To update a web distribution using the CloudFront API

1. Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution.

   If you update the distribution again, you must get a new Etag header.

2. Update the XML document that was returned in the response to your GetDistributionConfig request to include your changes.

   When you edit the XML file, be aware of the following:

   • You must strip out the ETag parameter that is returned.

   • Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.

   • You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error.

   • The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element.

3. Submit an UpdateDistribution request to update the configuration for your distribution:

   • In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element.

   • Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1.

4. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated.

5. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

Parameter Syntax

$result = $client->updateDistribution([
    'DistributionConfig' => [ // REQUIRED
        'Aliases' => [
            'Items' => ['<string>', ...],
            'Quantity' => <integer>, // REQUIRED
        ],
        'CacheBehaviors' => [
            'Items' => [
                [
                    'AllowedMethods' => [
                        'CachedMethods' => [
                            'Items' => ['<string>', ...], // REQUIRED
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'Items' => ['<string>', ...], // REQUIRED
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'Compress' => true || false,
                    'DefaultTTL' => <integer>,
                    'FieldLevelEncryptionId' => '<string>',
                    'ForwardedValues' => [ // REQUIRED
                        '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
                        ],
                    ],
                    '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>, // REQUIRED
                    'PathPattern' => '<string>', // REQUIRED
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>', // REQUIRED
                    'TrustedSigners' => [ // REQUIRED
                        '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
        '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
            ],
            'Compress' => true || false,
            'DefaultTTL' => <integer>,
            'FieldLevelEncryptionId' => '<string>',
            'ForwardedValues' => [ // REQUIRED
                '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
                ],
            ],
            '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>, // REQUIRED
            'SmoothStreaming' => true || false,
            'TargetOriginId' => '<string>', // REQUIRED
            'TrustedSigners' => [ // REQUIRED
                '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',
        'IsIPV6Enabled' => true || false,
        'Logging' => [
            'Bucket' => '<string>', // REQUIRED
            'Enabled' => true || false, // REQUIRED
            'IncludeCookies' => true || false, // REQUIRED
            'Prefix' => '<string>', // REQUIRED
        ],
        '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
                    ],
                ],
                // ...
            ],
            '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
                    'OriginPath' => '<string>',
                    'S3OriginConfig' => [
                        'OriginAccessIdentity' => '<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
            ],
        ],
        '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',
            'SSLSupportMethod' => 'sni-only|vip',
        ],
        'WebACLId' => '<string>',
    ],
    'Id' => '<string>', // REQUIRED
    'IfMatch' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Distribution' => [
        'ARN' => '<string>',
        '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>,
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        '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>,
                            ],
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'IncludeBody' => true || false,
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'PathPattern' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>',
                        'TrustedSigners' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>,
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'DefaultCacheBehavior' => [
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                '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>,
                    ],
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'IncludeBody' => true || false,
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>',
                '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',
            '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>,
                        ],
                    ],
                    // ...
                ],
                '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>',
                        'OriginPath' => '<string>',
                        'S3OriginConfig' => [
                            'OriginAccessIdentity' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
            'Restrictions' => [
                'GeoRestriction' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                    'RestrictionType' => 'blacklist|whitelist|none',
                ],
            ],
            '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',
                'SSLSupportMethod' => 'sni-only|vip',
            ],
            'WebACLId' => '<string>',
        ],
        'DomainName' => '<string>',
        'Id' => '<string>',
        'InProgressInvalidationBatches' => <integer>,
        'LastModifiedTime' => <DateTime>,
        'Status' => '<string>',
    ],
    'ETag' => '<string>',
]

Result Details

Errors

AccessDenied:

Access denied.

CNAMEAlreadyExists:

The CNAME specified is already defined for CloudFront.

IllegalUpdate:

Origin and CallerReference cannot be updated.

InvalidIfMatchVersion:

The If-Match version is missing or not valid for the distribution.

MissingBody:

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

NoSuchDistribution:

The specified distribution does not exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

TooManyDistributionCNAMEs:

Your request contains more CNAMEs than are allowed per distribution.

InvalidDefaultRootObject:

The default root object file name is too big or contains an invalid character.

InvalidRelativePath:

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

InvalidErrorCode:

An invalid error code was specified.

InvalidResponseCode:

A response code is not valid.

InvalidArgument:

An argument is invalid.

InvalidOriginAccessIdentity:

The origin access identity is not valid or doesn't exist.

TooManyTrustedSigners:

Your request contains more trusted signers than are allowed per distribution.

TrustedSignerDoesNotExist:

One or more of your trusted signers don't exist.

InvalidViewerCertificate:

A viewer certificate specified is not valid.

InvalidMinimumProtocolVersion:

The minimum protocol version specified is not valid.

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.

NoSuchOrigin:

No origin exists with the specified Origin Id.

TooManyOrigins:

You cannot create more origins for the distribution.

TooManyOriginGroupsPerDistribution:

Processing your request would cause you to exceed the maximum number of origin groups allowed.

TooManyCacheBehaviors:

You cannot create more cache behaviors for the distribution.

TooManyCookieNamesInWhiteList:

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

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.

TooManyHeadersInForwardedValues:

Your request contains too many headers in forwarded values.

InvalidHeadersForS3Origin:

The headers specified are not valid for an Amazon S3 origin.

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

TooManyCertificates:

You cannot create anymore custom SSL/TLS certificates.

InvalidLocationCode:

The location code specified is not valid.

InvalidGeoRestrictionParameter:

The specified geo restriction parameter is not valid.

InvalidTTLOrder:

The TTL order specified is not valid.

InvalidWebACLId:

A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

TooManyOriginCustomHeaders:

Your request contains too many origin custom headers.

TooManyQueryStringParameters:

Your request contains too many query string parameters.

InvalidQueryStringParameters:

The query string parameters specified are not valid.

TooManyDistributionsWithLambdaAssociations:

Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.

TooManyLambdaFunctionAssociations:

Your request contains more Lambda function associations than are allowed per distribution.

InvalidLambdaFunctionAssociation:

The specified Lambda function association is invalid.

InvalidOriginReadTimeout:

The read timeout specified for the origin is not valid.

InvalidOriginKeepaliveTimeout:

The keep alive timeout specified for the origin is not valid.

NoSuchFieldLevelEncryptionConfig:

The specified configuration for field-level encryption doesn't exist.

IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior:

The specified configuration for field-level encryption can't be associated with the specified cache behavior.

TooManyDistributionsAssociatedToFieldLevelEncryptionConfig:

The maximum number of distributions have been associated with the specified configuration for field-level encryption.

UpdateFieldLevelEncryptionConfig

$result = $client->updateFieldLevelEncryptionConfig([/* ... */]);
$promise = $client->updateFieldLevelEncryptionConfigAsync([/* ... */]);

Update a field-level encryption configuration.

Parameter Syntax

$result = $client->updateFieldLevelEncryptionConfig([
    'FieldLevelEncryptionConfig' => [ // REQUIRED
        'CallerReference' => '<string>', // REQUIRED
        'Comment' => '<string>',
        'ContentTypeProfileConfig' => [
            'ContentTypeProfiles' => [
                'Items' => [
                    [
                        'ContentType' => '<string>', // REQUIRED
                        'Format' => 'URLEncoded', // REQUIRED
                        '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
            ],
        ],
    ],
    'Id' => '<string>', // REQUIRED
    'IfMatch' => '<string>',
]);

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.

IllegalUpdate:

Origin and CallerReference cannot be updated.

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

InvalidArgument:

An argument is invalid.

InvalidIfMatchVersion:

The If-Match version is missing or not valid for the distribution.

NoSuchFieldLevelEncryptionProfile:

The specified profile for field-level encryption doesn't exist.

NoSuchFieldLevelEncryptionConfig:

The specified configuration for field-level encryption doesn't exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

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.

QueryArgProfileEmpty:

No profile specified for the field-level encryption query argument.

UpdateFieldLevelEncryptionProfile

$result = $client->updateFieldLevelEncryptionProfile([/* ... */]);
$promise = $client->updateFieldLevelEncryptionProfileAsync([/* ... */]);

Update a field-level encryption profile.

Parameter Syntax

$result = $client->updateFieldLevelEncryptionProfile([
    '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
    ],
    'Id' => '<string>', // REQUIRED
    'IfMatch' => '<string>',
]);

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.

FieldLevelEncryptionProfileAlreadyExists:

The specified profile for field-level encryption already exists.

IllegalUpdate:

Origin and CallerReference cannot be updated.

InconsistentQuantities:

The value of Quantity and the size of Items don't match.

InvalidArgument:

An argument is invalid.

InvalidIfMatchVersion:

The If-Match version is missing or not valid for the distribution.

NoSuchPublicKey:

The specified public key doesn't exist.

NoSuchFieldLevelEncryptionProfile:

The specified profile for field-level encryption doesn't exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

FieldLevelEncryptionProfileSizeExceeded:

The maximum size of a profile for field-level encryption was exceeded.

TooManyFieldLevelEncryptionEncryptionEntities:

The maximum number of encryption entities for field-level encryption have been created.

TooManyFieldLevelEncryptionFieldPatterns:

The maximum number of field patterns for field-level encryption have been created.

UpdatePublicKey

$result = $client->updatePublicKey([/* ... */]);
$promise = $client->updatePublicKeyAsync([/* ... */]);

Update public key information. Note that the only value you can change is the comment.

Parameter Syntax

$result = $client->updatePublicKey([
    'Id' => '<string>', // REQUIRED
    'IfMatch' => '<string>',
    'PublicKeyConfig' => [ // REQUIRED
        'CallerReference' => '<string>', // REQUIRED
        'Comment' => '<string>',
        'EncodedKey' => '<string>', // REQUIRED
        'Name' => '<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.

CannotChangeImmutablePublicKeyFields:

You can't change the value of a public key.

InvalidArgument:

An argument is invalid.

InvalidIfMatchVersion:

The If-Match version is missing or not valid for the distribution.

IllegalUpdate:

Origin and CallerReference cannot be updated.

NoSuchPublicKey:

The specified public key doesn't exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

UpdateStreamingDistribution

$result = $client->updateStreamingDistribution([/* ... */]);
$promise = $client->updateStreamingDistributionAsync([/* ... */]);

Update a streaming distribution.

Parameter Syntax

$result = $client->updateStreamingDistribution([
    'Id' => '<string>', // REQUIRED
    'IfMatch' => '<string>',
    '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>',
    '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.

CNAMEAlreadyExists:

The CNAME specified is already defined for CloudFront.

IllegalUpdate:

Origin and CallerReference cannot be updated.

InvalidIfMatchVersion:

The If-Match version is missing or not valid for the distribution.

MissingBody:

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

NoSuchStreamingDistribution:

The specified streaming distribution does not exist.

PreconditionFailed:

The precondition given in one or more of the request header fields evaluated to false.

TooManyStreamingDistributionCNAMEs:

Your request contains more CNAMEs than are allowed per distribution.

InvalidArgument:

An argument is invalid.

InvalidOriginAccessIdentity:

The origin access identity is not valid or doesn't exist.

TooManyTrustedSigners:

Your request contains more trusted signers than are allowed per distribution.

TrustedSignerDoesNotExist:

One or more of your trusted signers don't exist.

InconsistentQuantities:

The value of Quantity and the size of Items don't match.