Amazon CloudFront 2020-05-31

CreateCachePolicy

$result = $client->createCachePolicy([/* ... */]);
$promise = $client->createCachePolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->createCachePolicy([
    'CachePolicyConfig' => [ // REQUIRED
        'Comment' => '<string>',
        'DefaultTTL' => <integer>,
        'MaxTTL' => <integer>,
        'MinTTL' => <integer>, // REQUIRED
        'Name' => '<string>', // REQUIRED
        'ParametersInCacheKeyAndForwardedToOrigin' => [
            'CookiesConfig' => [ // REQUIRED
                'CookieBehavior' => 'none|whitelist|allExcept|all', // REQUIRED
                'Cookies' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
            ],
            'EnableAcceptEncodingBrotli' => true || false,
            'EnableAcceptEncodingGzip' => true || false, // REQUIRED
            'HeadersConfig' => [ // REQUIRED
                'HeaderBehavior' => 'none|whitelist', // REQUIRED
                'Headers' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
            ],
            'QueryStringsConfig' => [ // REQUIRED
                'QueryStringBehavior' => 'none|whitelist|allExcept|all', // REQUIRED
                'QueryStrings' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'CachePolicy' => [
        'CachePolicyConfig' => [
            'Comment' => '<string>',
            'DefaultTTL' => <integer>,
            'MaxTTL' => <integer>,
            'MinTTL' => <integer>,
            'Name' => '<string>',
            'ParametersInCacheKeyAndForwardedToOrigin' => [
                'CookiesConfig' => [
                    'CookieBehavior' => 'none|whitelist|allExcept|all',
                    'Cookies' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'EnableAcceptEncodingBrotli' => true || false,
                'EnableAcceptEncodingGzip' => true || false,
                'HeadersConfig' => [
                    'HeaderBehavior' => 'none|whitelist',
                    'Headers' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'QueryStringsConfig' => [
                    'QueryStringBehavior' => 'none|whitelist|allExcept|all',
                    'QueryStrings' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
            ],
        ],
        'Id' => '<string>',
        'LastModifiedTime' => <DateTime>,
    ],
    'ETag' => '<string>',
    'Location' => '<string>',
]

Result Details

Errors

• AccessDenied:

  Access denied.

• InconsistentQuantities:

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

• InvalidArgument:

  An argument is invalid.

• CachePolicyAlreadyExists:

  A cache policy with this name already exists. You must provide a unique name. To modify an existing cache policy, use UpdateCachePolicy.

• TooManyCachePolicies:

  You have reached the maximum number of cache policies for this AWS account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyHeadersInCachePolicy:

  The number of headers in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyCookiesInCachePolicy:

  The number of cookies in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyQueryStringsInCachePolicy:

  The number of query strings in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

CreateCloudFrontOriginAccessIdentity

$result = $client->createCloudFrontOriginAccessIdentity([/* ... */]);
$promise = $client->createCloudFrontOriginAccessIdentityAsync([/* ... */]);

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

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
                    ],
                    'CachePolicyId' => '<string>',
                    'Compress' => true || false,
                    'DefaultTTL' => <integer>,
                    'FieldLevelEncryptionId' => '<string>',
                    'ForwardedValues' => [
                        'Cookies' => [ // REQUIRED
                            'Forward' => 'none|whitelist|all', // REQUIRED
                            'WhitelistedNames' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>, // REQUIRED
                            ],
                        ],
                        'Headers' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'QueryString' => true || false, // REQUIRED
                        'QueryStringCacheKeys' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                    ],
                    'FunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
                                'FunctionARN' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'LambdaFunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
                                'IncludeBody' => true || false,
                                'LambdaFunctionARN' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'MaxTTL' => <integer>,
                    'MinTTL' => <integer>,
                    'OriginRequestPolicyId' => '<string>',
                    'PathPattern' => '<string>', // REQUIRED
                    'RealtimeLogConfigArn' => '<string>',
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>', // REQUIRED
                    'TrustedKeyGroups' => [
                        'Enabled' => true || false, // REQUIRED
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'TrustedSigners' => [
                        'Enabled' => true || false, // REQUIRED
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
                ],
                // ...
            ],
            'Quantity' => <integer>, // REQUIRED
        ],
        'CallerReference' => '<string>', // REQUIRED
        'Comment' => '<string>', // REQUIRED
        'CustomErrorResponses' => [
            'Items' => [
                [
                    'ErrorCachingMinTTL' => <integer>,
                    'ErrorCode' => <integer>, // REQUIRED
                    'ResponseCode' => '<string>',
                    'ResponsePagePath' => '<string>',
                ],
                // ...
            ],
            'Quantity' => <integer>, // REQUIRED
        ],
        'DefaultCacheBehavior' => [ // REQUIRED
            'AllowedMethods' => [
                'CachedMethods' => [
                    'Items' => ['<string>', ...], // REQUIRED
                    'Quantity' => <integer>, // REQUIRED
                ],
                'Items' => ['<string>', ...], // REQUIRED
                'Quantity' => <integer>, // REQUIRED
            ],
            'CachePolicyId' => '<string>',
            'Compress' => true || false,
            'DefaultTTL' => <integer>,
            'FieldLevelEncryptionId' => '<string>',
            'ForwardedValues' => [
                'Cookies' => [ // REQUIRED
                    'Forward' => 'none|whitelist|all', // REQUIRED
                    'WhitelistedNames' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                ],
                'Headers' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
                'QueryString' => true || false, // REQUIRED
                'QueryStringCacheKeys' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
            ],
            'FunctionAssociations' => [
                'Items' => [
                    [
                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
                        'FunctionARN' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'Quantity' => <integer>, // REQUIRED
            ],
            'LambdaFunctionAssociations' => [
                'Items' => [
                    [
                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
                        'IncludeBody' => true || false,
                        'LambdaFunctionARN' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'Quantity' => <integer>, // REQUIRED
            ],
            'MaxTTL' => <integer>,
            'MinTTL' => <integer>,
            'OriginRequestPolicyId' => '<string>',
            'RealtimeLogConfigArn' => '<string>',
            'SmoothStreaming' => true || false,
            'TargetOriginId' => '<string>', // REQUIRED
            'TrustedKeyGroups' => [
                'Enabled' => true || false, // REQUIRED
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
            ],
            'TrustedSigners' => [
                'Enabled' => true || false, // REQUIRED
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
            ],
            'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
        ],
        'DefaultRootObject' => '<string>',
        'Enabled' => true || false, // REQUIRED
        'HttpVersion' => 'http1.1|http2',
        '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>',
                    'OriginShield' => [
                        'Enabled' => true || false, // REQUIRED
                        'OriginShieldRegion' => '<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|static-ip',
        ],
        'WebACLId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'Distribution' => [
        'ARN' => '<string>',
        'ActiveTrustedKeyGroups' => [
            'Enabled' => true || false,
            'Items' => [
                [
                    'KeyGroupId' => '<string>',
                    'KeyPairIds' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'ActiveTrustedSigners' => [
            'Enabled' => true || false,
            'Items' => [
                [
                    'AwsAccountNumber' => '<string>',
                    'KeyPairIds' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'AliasICPRecordals' => [
            [
                'CNAME' => '<string>',
                'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
            ],
            // ...
        ],
        'DistributionConfig' => [
            'Aliases' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'CachePolicyId' => '<string>',
                        'Compress' => true || false,
                        'DefaultTTL' => <integer>,
                        'FieldLevelEncryptionId' => '<string>',
                        'ForwardedValues' => [
                            'Cookies' => [
                                'Forward' => 'none|whitelist|all',
                                'WhitelistedNames' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'Headers' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'QueryString' => true || false,
                            'QueryStringCacheKeys' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'FunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'FunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'IncludeBody' => true || false,
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'OriginRequestPolicyId' => '<string>',
                        'PathPattern' => '<string>',
                        'RealtimeLogConfigArn' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>',
                        'TrustedKeyGroups' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'TrustedSigners' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>,
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'DefaultCacheBehavior' => [
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'CachePolicyId' => '<string>',
                'Compress' => true || false,
                'DefaultTTL' => <integer>,
                'FieldLevelEncryptionId' => '<string>',
                'ForwardedValues' => [
                    'Cookies' => [
                        'Forward' => 'none|whitelist|all',
                        'WhitelistedNames' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'Headers' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'QueryString' => true || false,
                    'QueryStringCacheKeys' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'FunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'FunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'IncludeBody' => true || false,
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'OriginRequestPolicyId' => '<string>',
                'RealtimeLogConfigArn' => '<string>',
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>',
                'TrustedKeyGroups' => [
                    'Enabled' => true || false,
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'TrustedSigners' => [
                    'Enabled' => true || false,
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
            ],
            'DefaultRootObject' => '<string>',
            'Enabled' => true || false,
            'HttpVersion' => 'http1.1|http2',
            '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>',
                        'OriginShield' => [
                            'Enabled' => true || false,
                            'OriginShieldRegion' => '<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|static-ip',
            ],
            '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.

• TooManyDistributionsWithSingleFunctionARN:

  The maximum number of distributions have been associated with the specified Lambda function.

• TooManyLambdaFunctionAssociations:

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

• InvalidLambdaFunctionAssociation:

  The specified Lambda function association is invalid.

• TooManyDistributionsWithFunctionAssociations:

  You have reached the maximum number of distributions that are associated with a CloudFront function. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyFunctionAssociations:

  You have reached the maximum number of CloudFront function associations for this distribution. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• InvalidFunctionAssociation:

  A CloudFront 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.

• NoSuchCachePolicy:

  The cache policy does not exist.

• TooManyDistributionsAssociatedToCachePolicy:

  The maximum number of distributions have been associated with the specified cache policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• NoSuchOriginRequestPolicy:

  The origin request policy does not exist.

• TooManyDistributionsAssociatedToOriginRequestPolicy:

  The maximum number of distributions have been associated with the specified origin request policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyDistributionsAssociatedToKeyGroup:

  The number of distributions that reference this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyKeyGroupsAssociatedToDistribution:

  The number of key groups referenced by this distribution is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TrustedKeyGroupDoesNotExist:

  The specified key group does not exist.

• NoSuchRealtimeLogConfig:

  The real-time log configuration does not exist.

• RealtimeLogConfigOwnerMismatch:

  The specified real-time log configuration belongs to a different AWS account.

CreateDistributionWithTags

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

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
                        ],
                        'CachePolicyId' => '<string>',
                        'Compress' => true || false,
                        'DefaultTTL' => <integer>,
                        'FieldLevelEncryptionId' => '<string>',
                        'ForwardedValues' => [
                            'Cookies' => [ // REQUIRED
                                'Forward' => 'none|whitelist|all', // REQUIRED
                                'WhitelistedNames' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>, // REQUIRED
                                ],
                            ],
                            'Headers' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>, // REQUIRED
                            ],
                            'QueryString' => true || false, // REQUIRED
                            'QueryStringCacheKeys' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>, // REQUIRED
                            ],
                        ],
                        'FunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
                                    'FunctionARN' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
                                    'IncludeBody' => true || false,
                                    'LambdaFunctionARN' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'OriginRequestPolicyId' => '<string>',
                        'PathPattern' => '<string>', // REQUIRED
                        'RealtimeLogConfigArn' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>', // REQUIRED
                        'TrustedKeyGroups' => [
                            'Enabled' => true || false, // REQUIRED
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'TrustedSigners' => [
                            'Enabled' => true || false, // REQUIRED
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
                    ],
                    // ...
                ],
                'Quantity' => <integer>, // REQUIRED
            ],
            'CallerReference' => '<string>', // REQUIRED
            'Comment' => '<string>', // REQUIRED
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>, // REQUIRED
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>, // REQUIRED
            ],
            'DefaultCacheBehavior' => [ // REQUIRED
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...], // REQUIRED
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'Items' => ['<string>', ...], // REQUIRED
                    'Quantity' => <integer>, // REQUIRED
                ],
                'CachePolicyId' => '<string>',
                'Compress' => true || false,
                'DefaultTTL' => <integer>,
                'FieldLevelEncryptionId' => '<string>',
                'ForwardedValues' => [
                    'Cookies' => [ // REQUIRED
                        'Forward' => 'none|whitelist|all', // REQUIRED
                        'WhitelistedNames' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                    ],
                    'Headers' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'QueryString' => true || false, // REQUIRED
                    'QueryStringCacheKeys' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                ],
                'FunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
                            'FunctionARN' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>, // REQUIRED
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
                            'IncludeBody' => true || false,
                            'LambdaFunctionARN' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>, // REQUIRED
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'OriginRequestPolicyId' => '<string>',
                'RealtimeLogConfigArn' => '<string>',
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>', // REQUIRED
                'TrustedKeyGroups' => [
                    'Enabled' => true || false, // REQUIRED
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
                'TrustedSigners' => [
                    'Enabled' => true || false, // REQUIRED
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
                'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
            ],
            'DefaultRootObject' => '<string>',
            'Enabled' => true || false, // REQUIRED
            'HttpVersion' => 'http1.1|http2',
            '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>',
                        'OriginShield' => [
                            'Enabled' => true || false, // REQUIRED
                            'OriginShieldRegion' => '<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|static-ip',
            ],
            'WebACLId' => '<string>',
        ],
        'Tags' => [ // REQUIRED
            'Items' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'Distribution' => [
        'ARN' => '<string>',
        'ActiveTrustedKeyGroups' => [
            'Enabled' => true || false,
            'Items' => [
                [
                    'KeyGroupId' => '<string>',
                    'KeyPairIds' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'ActiveTrustedSigners' => [
            'Enabled' => true || false,
            'Items' => [
                [
                    'AwsAccountNumber' => '<string>',
                    'KeyPairIds' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'AliasICPRecordals' => [
            [
                'CNAME' => '<string>',
                'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
            ],
            // ...
        ],
        'DistributionConfig' => [
            'Aliases' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'CachePolicyId' => '<string>',
                        'Compress' => true || false,
                        'DefaultTTL' => <integer>,
                        'FieldLevelEncryptionId' => '<string>',
                        'ForwardedValues' => [
                            'Cookies' => [
                                'Forward' => 'none|whitelist|all',
                                'WhitelistedNames' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'Headers' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'QueryString' => true || false,
                            'QueryStringCacheKeys' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'FunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'FunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'IncludeBody' => true || false,
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'OriginRequestPolicyId' => '<string>',
                        'PathPattern' => '<string>',
                        'RealtimeLogConfigArn' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>',
                        'TrustedKeyGroups' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'TrustedSigners' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>,
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'DefaultCacheBehavior' => [
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'CachePolicyId' => '<string>',
                'Compress' => true || false,
                'DefaultTTL' => <integer>,
                'FieldLevelEncryptionId' => '<string>',
                'ForwardedValues' => [
                    'Cookies' => [
                        'Forward' => 'none|whitelist|all',
                        'WhitelistedNames' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'Headers' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'QueryString' => true || false,
                    'QueryStringCacheKeys' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'FunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'FunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'IncludeBody' => true || false,
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'OriginRequestPolicyId' => '<string>',
                'RealtimeLogConfigArn' => '<string>',
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>',
                'TrustedKeyGroups' => [
                    'Enabled' => true || false,
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'TrustedSigners' => [
                    'Enabled' => true || false,
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
            ],
            'DefaultRootObject' => '<string>',
            'Enabled' => true || false,
            'HttpVersion' => 'http1.1|http2',
            '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>',
                        'OriginShield' => [
                            'Enabled' => true || false,
                            'OriginShieldRegion' => '<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|static-ip',
            ],
            '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.

• TooManyDistributionsWithSingleFunctionARN:

  The maximum number of distributions have been associated with the specified Lambda function.

• TooManyLambdaFunctionAssociations:

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

• InvalidLambdaFunctionAssociation:

  The specified Lambda function association is invalid.

• TooManyDistributionsWithFunctionAssociations:

  You have reached the maximum number of distributions that are associated with a CloudFront function. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyFunctionAssociations:

  You have reached the maximum number of CloudFront function associations for this distribution. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• InvalidFunctionAssociation:

  A CloudFront 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.

• NoSuchCachePolicy:

  The cache policy does not exist.

• TooManyDistributionsAssociatedToCachePolicy:

  The maximum number of distributions have been associated with the specified cache policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• NoSuchOriginRequestPolicy:

  The origin request policy does not exist.

• TooManyDistributionsAssociatedToOriginRequestPolicy:

  The maximum number of distributions have been associated with the specified origin request policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyDistributionsAssociatedToKeyGroup:

  The number of distributions that reference this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyKeyGroupsAssociatedToDistribution:

  The number of key groups referenced by this distribution is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TrustedKeyGroupDoesNotExist:

  The specified key group does not exist.

• NoSuchRealtimeLogConfig:

  The real-time log configuration does not exist.

• RealtimeLogConfigOwnerMismatch:

  The specified real-time log configuration belongs to a different AWS account.

CreateFieldLevelEncryptionConfig

$result = $client->createFieldLevelEncryptionConfig([/* ... */]);
$promise = $client->createFieldLevelEncryptionConfigAsync([/* ... */]);

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

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.

CreateFunction

$result = $client->createFunction([/* ... */]);
$promise = $client->createFunctionAsync([/* ... */]);

Parameter Syntax

$result = $client->createFunction([
    'FunctionCode' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'FunctionConfig' => [ // REQUIRED
        'Comment' => '<string>', // REQUIRED
        'Runtime' => 'cloudfront-js-1.0', // REQUIRED
    ],
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ETag' => '<string>',
    'FunctionSummary' => [
        'FunctionConfig' => [
            'Comment' => '<string>',
            'Runtime' => 'cloudfront-js-1.0',
        ],
        'FunctionMetadata' => [
            'CreatedTime' => <DateTime>,
            'FunctionARN' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'Stage' => 'DEVELOPMENT|LIVE',
        ],
        'Name' => '<string>',
        'Status' => '<string>',
    ],
    'Location' => '<string>',
]

Result Details

Errors

• TooManyFunctions:

  You have reached the maximum number of CloudFront functions for this AWS account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• FunctionAlreadyExists:

  A function with the same name already exists in this AWS account. To create a function, you must provide a unique name. To update an existing function, use UpdateFunction.

• FunctionSizeLimitExceeded:

  The function is too large. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• InvalidArgument:

  An argument is invalid.

CreateInvalidation

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

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.

CreateKeyGroup

$result = $client->createKeyGroup([/* ... */]);
$promise = $client->createKeyGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createKeyGroup([
    'KeyGroupConfig' => [ // REQUIRED
        'Comment' => '<string>',
        'Items' => ['<string>', ...], // REQUIRED
        'Name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidArgument:

  An argument is invalid.

• KeyGroupAlreadyExists:

  A key group with this name already exists. You must provide a unique name. To modify an existing key group, use UpdateKeyGroup.

• TooManyKeyGroups:

  You have reached the maximum number of key groups for this AWS account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyPublicKeysInKeyGroup:

  The number of public keys in this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

CreateMonitoringSubscription

$result = $client->createMonitoringSubscription([/* ... */]);
$promise = $client->createMonitoringSubscriptionAsync([/* ... */]);

Parameter Syntax

$result = $client->createMonitoringSubscription([
    'DistributionId' => '<string>', // REQUIRED
    'MonitoringSubscription' => [ // REQUIRED
        'RealtimeMetricsSubscriptionConfig' => [
            'RealtimeMetricsSubscriptionStatus' => 'Enabled|Disabled', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• AccessDenied:

  Access denied.

• NoSuchDistribution:

  The specified distribution does not exist.

• UnsupportedOperation:

  This operation is not supported in this region.

CreateOriginRequestPolicy

$result = $client->createOriginRequestPolicy([/* ... */]);
$promise = $client->createOriginRequestPolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->createOriginRequestPolicy([
    'OriginRequestPolicyConfig' => [ // REQUIRED
        'Comment' => '<string>',
        'CookiesConfig' => [ // REQUIRED
            'CookieBehavior' => 'none|whitelist|all', // REQUIRED
            'Cookies' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
            ],
        ],
        'HeadersConfig' => [ // REQUIRED
            'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront', // REQUIRED
            'Headers' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
            ],
        ],
        'Name' => '<string>', // REQUIRED
        'QueryStringsConfig' => [ // REQUIRED
            'QueryStringBehavior' => 'none|whitelist|all', // REQUIRED
            'QueryStrings' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'ETag' => '<string>',
    'Location' => '<string>',
    'OriginRequestPolicy' => [
        'Id' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'OriginRequestPolicyConfig' => [
            'Comment' => '<string>',
            'CookiesConfig' => [
                'CookieBehavior' => 'none|whitelist|all',
                'Cookies' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
            ],
            'HeadersConfig' => [
                'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront',
                'Headers' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
            ],
            'Name' => '<string>',
            'QueryStringsConfig' => [
                'QueryStringBehavior' => 'none|whitelist|all',
                'QueryStrings' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
            ],
        ],
    ],
]

Result Details

Errors

• AccessDenied:

  Access denied.

• InconsistentQuantities:

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

• InvalidArgument:

  An argument is invalid.

• OriginRequestPolicyAlreadyExists:

  An origin request policy with this name already exists. You must provide a unique name. To modify an existing origin request policy, use UpdateOriginRequestPolicy.

• TooManyOriginRequestPolicies:

  You have reached the maximum number of origin request policies for this AWS account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyHeadersInOriginRequestPolicy:

  The number of headers in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyCookiesInOriginRequestPolicy:

  The number of cookies in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• TooManyQueryStringsInOriginRequestPolicy:

  The number of query strings in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

CreatePublicKey

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

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.

CreateRealtimeLogConfig

$result = $client->createRealtimeLogConfig([/* ... */]);
$promise = $client->createRealtimeLogConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->createRealtimeLogConfig([
    'EndPoints' => [ // REQUIRED
        [
            'KinesisStreamConfig' => [
                'RoleARN' => '<string>', // REQUIRED
                'StreamARN' => '<string>', // REQUIRED
            ],
            'StreamType' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Fields' => ['<string>', ...], // REQUIRED
    'Name' => '<string>', // REQUIRED
    'SamplingRate' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• RealtimeLogConfigAlreadyExists:

  A real-time log configuration with this name already exists. You must provide a unique name. To modify an existing real-time log configuration, use UpdateRealtimeLogConfig.

• TooManyRealtimeLogConfigs:

  You have reached the maximum number of real-time log configurations for this AWS account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.

• InvalidArgument:

  An argument is invalid.

• AccessDenied:

  Access denied.

CreateStreamingDistribution

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

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

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.

DeleteCachePolicy

$result = $client->deleteCachePolicy([/* ... */]);
$promise = $client->deleteCachePolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteCachePolicy([
    '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.

• NoSuchCachePolicy:

  The cache policy does not exist.

• PreconditionFailed:

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

• IllegalDelete:

  You cannot delete a managed policy.

• CachePolicyInUse:

  Cannot delete the cache policy because it is attached to one or more cache behaviors.

DeleteCloudFrontOriginAccessIdentity

$result = $client->deleteCloudFrontOriginAccessIdentity([/* ... */]);
$promise = $client->deleteCloudFrontOriginAccessIdentityAsync([/* ... */]);

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.

• NoSuchCloudFrontOriginAccessIdentity:

  The specified origin access identity does not exist.

• PreconditionFailed:

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

• CloudFrontOriginAccessIdentityInUse:

  The Origin Access Identity specified is already in use.

DeleteDistribution

$result = $client->deleteDistribution([/* ... */]);
$promise = $client->deleteDistributionAsync([/* ... */]);

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.

• NoSuchDistribution:

  The specified distribution does not exist.

• PreconditionFailed:

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

DeleteFieldLevelEncryptionConfig

$result = $client->deleteFieldLevelEncryptionConfig([/* ... */]);
$promise = $client->deleteFieldLevelEncryptionConfigAsync([/* ... */]);

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.

• NoSuchFieldLevelEncryptionConfig:

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

• PreconditionFailed:

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

• FieldLevelEncryptionConfigInUse:

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

DeleteFieldLevelEncryptionProfile

$result = $client->deleteFieldLevelEncryptionProfile([/* ... */]);
$promise = $client->deleteFieldLevelEncryptionProfileAsync([/* ... */]);

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.

• NoSuchFieldLevelEncryptionProfile:

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

• PreconditionFailed:

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

• FieldLevelEncryptionProfileInUse:

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

DeleteFunction

$result = $client->deleteFunction([/* ... */]);
$promise = $client->deleteFunctionAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteFunction([
    'IfMatch' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• InvalidIfMatchVersion:

  The If-Match version is missing or not valid.

• NoSuchFunctionExists:

  The function does not exist.

• FunctionInUse:

  Cannot delete the function because it’s attached to one or more cache behaviors.

• PreconditionFailed:

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

DeleteKeyGroup

$result = $client->deleteKeyGroup([/* ... */]);
$promise = $client->deleteKeyGroupAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• InvalidIfMatchVersion:

  The If-Match version is missing or not valid.

• NoSuchResource:

  A resource that was specified is not valid.

• PreconditionFailed:

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

• ResourceInUse:

  Cannot delete this resource because it is in use.

DeleteMonitoringSubscription

$result = $client->deleteMonitoringSubscription([/* ... */]);
$promise = $client->deleteMonitoringSubscriptionAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• AccessDenied:

  Access denied.

• NoSuchDistribution:

  The specified distribution does not exist.

• UnsupportedOperation:

  This operation is not supported in this region.

DeleteOriginRequestPolicy

$result = $client->deleteOriginRequestPolicy([/* ... */]);
$promise = $client->deleteOriginRequestPolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteOriginRequestPolicy([
    '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.

• NoSuchOriginRequestPolicy:

  The origin request policy does not exist.

• PreconditionFailed:

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

• IllegalDelete:

  You cannot delete a managed policy.

• OriginRequestPolicyInUse:

  Cannot delete the origin request policy because it is attached to one or more cache behaviors.

DeletePublicKey

$result = $client->deletePublicKey([/* ... */]);
$promise = $client->deletePublicKeyAsync([/* ... */]);

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.

• NoSuchPublicKey:

  The specified public key doesn't exist.

• PreconditionFailed:

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

DeleteRealtimeLogConfig

$result = $client->deleteRealtimeLogConfig([/* ... */]);
$promise = $client->deleteRealtimeLogConfigAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteRealtimeLogConfig([
    'ARN' => '<string>',
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• NoSuchRealtimeLogConfig:

  The real-time log configuration does not exist.

• RealtimeLogConfigInUse:

  Cannot delete the real-time log configuration because it is attached to one or more cache behaviors.

• InvalidArgument:

  An argument is invalid.

• AccessDenied:

  Access denied.

DeleteStreamingDistribution

$result = $client->deleteStreamingDistribution([/* ... */]);
$promise = $client->deleteStreamingDistributionAsync([/* ... */]);

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.

• NoSuchStreamingDistribution:

  The specified streaming distribution does not exist.

• PreconditionFailed:

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

DescribeFunction

$result = $client->describeFunction([/* ... */]);
$promise = $client->describeFunctionAsync([/* ... */]);

Parameter Syntax

$result = $client->describeFunction([
    'Name' => '<string>', // REQUIRED
    'Stage' => 'DEVELOPMENT|LIVE',
]);

Parameter Details

Result Syntax

[
    'ETag' => '<string>',
    'FunctionSummary' => [
        'FunctionConfig' => [
            'Comment' => '<string>',
            'Runtime' => 'cloudfront-js-1.0',
        ],
        'FunctionMetadata' => [
            'CreatedTime' => <DateTime>,
            'FunctionARN' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'Stage' => 'DEVELOPMENT|LIVE',
        ],
        'Name' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

• NoSuchFunctionExists:

  The function does not exist.

GetCachePolicy

$result = $client->getCachePolicy([/* ... */]);
$promise = $client->getCachePolicyAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CachePolicy' => [
        'CachePolicyConfig' => [
            'Comment' => '<string>',
            'DefaultTTL' => <integer>,
            'MaxTTL' => <integer>,
            'MinTTL' => <integer>,
            'Name' => '<string>',
            'ParametersInCacheKeyAndForwardedToOrigin' => [
                'CookiesConfig' => [
                    'CookieBehavior' => 'none|whitelist|allExcept|all',
                    'Cookies' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'EnableAcceptEncodingBrotli' => true || false,
                'EnableAcceptEncodingGzip' => true || false,
                'HeadersConfig' => [
                    'HeaderBehavior' => 'none|whitelist',
                    'Headers' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'QueryStringsConfig' => [
                    'QueryStringBehavior' => 'none|whitelist|allExcept|all',
                    'QueryStrings' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
            ],
        ],
        'Id' => '<string>',
        'LastModifiedTime' => <DateTime>,
    ],
    'ETag' => '<string>',
]

Result Details

Errors

• AccessDenied:

  Access denied.

• NoSuchCachePolicy:

  The cache policy does not exist.

GetCachePolicyConfig

$result = $client->getCachePolicyConfig([/* ... */]);
$promise = $client->getCachePolicyConfigAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CachePolicyConfig' => [
        'Comment' => '<string>',
        'DefaultTTL' => <integer>,
        'MaxTTL' => <integer>,
        'MinTTL' => <integer>,
        'Name' => '<string>',
        'ParametersInCacheKeyAndForwardedToOrigin' => [
            'CookiesConfig' => [
                'CookieBehavior' => 'none|whitelist|allExcept|all',
                'Cookies' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
            ],
            'EnableAcceptEncodingBrotli' => true || false,
            'EnableAcceptEncodingGzip' => true || false,
            'HeadersConfig' => [
                'HeaderBehavior' => 'none|whitelist',
                'Headers' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
            ],
            'QueryStringsConfig' => [
                'QueryStringBehavior' => 'none|whitelist|allExcept|all',
                'QueryStrings' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
            ],
        ],
    ],
    'ETag' => '<string>',
]

Result Details

Errors

• AccessDenied:

  Access denied.

• NoSuchCachePolicy:

  The cache policy does not exist.

GetCloudFrontOriginAccessIdentity

$result = $client->getCloudFrontOriginAccessIdentity([/* ... */]);
$promise = $client->getCloudFrontOriginAccessIdentityAsync([/* ... */]);

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Distribution' => [
        'ARN' => '<string>',
        'ActiveTrustedKeyGroups' => [
            'Enabled' => true || false,
            'Items' => [
                [
                    'KeyGroupId' => '<string>',
                    'KeyPairIds' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'ActiveTrustedSigners' => [
            'Enabled' => true || false,
            'Items' => [
                [
                    'AwsAccountNumber' => '<string>',
                    'KeyPairIds' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'AliasICPRecordals' => [
            [
                'CNAME' => '<string>',
                'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
            ],
            // ...
        ],
        'DistributionConfig' => [
            'Aliases' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'CachePolicyId' => '<string>',
                        'Compress' => true || false,
                        'DefaultTTL' => <integer>,
                        'FieldLevelEncryptionId' => '<string>',
                        'ForwardedValues' => [
                            'Cookies' => [
                                'Forward' => 'none|whitelist|all',
                                'WhitelistedNames' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'Headers' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'QueryString' => true || false,
                            'QueryStringCacheKeys' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'FunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'FunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'IncludeBody' => true || false,
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'OriginRequestPolicyId' => '<string>',
                        'PathPattern' => '<string>',
                        'RealtimeLogConfigArn' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>',
                        'TrustedKeyGroups' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'TrustedSigners' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>,
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'DefaultCacheBehavior' => [
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'CachePolicyId' => '<string>',
                'Compress' => true || false,
                'DefaultTTL' => <integer>,
                'FieldLevelEncryptionId' => '<string>',
                'ForwardedValues' => [
                    'Cookies' => [
                        'Forward' => 'none|whitelist|all',
                        'WhitelistedNames' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'Headers' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'QueryString' => true || false,
                    'QueryStringCacheKeys' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'FunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'FunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'IncludeBody' => true || false,
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'OriginRequestPolicyId' => '<string>',
                'RealtimeLogConfigArn' => '<string>',
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>',
                'TrustedKeyGroups' => [
                    'Enabled' => true || false,
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'TrustedSigners' => [
                    'Enabled' => true || false,
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
            ],
            'DefaultRootObject' => '<string>',
            'Enabled' => true || false,
            'HttpVersion' => 'http1.1|http2',
            '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>',
                        'OriginShield' => [
                            'Enabled' => true || false,
                            'OriginShieldRegion' => '<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|static-ip',
            ],
            'WebACLId' => '<string>',
        ],
        'DomainName' => '<string>',
        'Id' => '<string>',
        'InProgressInvalidationBatches' => <integer>,
        'LastModifiedTime' => <DateTime>,
        'Status' => '<string>',
    ],
    'ETag' => '<string>',
]

Result Details

Errors

• NoSuchDistribution:

  The specified distribution does not exist.

• AccessDenied:

  Access denied.

GetDistributionConfig

$result = $client->getDistributionConfig([/* ... */]);
$promise = $client->getDistributionConfigAsync([/* ... */]);

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>,
                    ],
                    'CachePolicyId' => '<string>',
                    'Compress' => true || false,
                    'DefaultTTL' => <integer>,
                    'FieldLevelEncryptionId' => '<string>',
                    'ForwardedValues' => [
                        'Cookies' => [
                            'Forward' => 'none|whitelist|all',
                            'WhitelistedNames' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'Headers' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'QueryString' => true || false,
                        'QueryStringCacheKeys' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'FunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                'FunctionARN' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>,
                    ],
                    'LambdaFunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                'IncludeBody' => true || false,
                                'LambdaFunctionARN' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>,
                    ],
                    'MaxTTL' => <integer>,
                    'MinTTL' => <integer>,
                    'OriginRequestPolicyId' => '<string>',
                    'PathPattern' => '<string>',
                    'RealtimeLogConfigArn' => '<string>',
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>',
                    'TrustedKeyGroups' => [
                        'Enabled' => true || false,
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'TrustedSigners' => [
                        'Enabled' => true || false,
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'CallerReference' => '<string>',
        'Comment' => '<string>',
        'CustomErrorResponses' => [
            'Items' => [
                [
                    'ErrorCachingMinTTL' => <integer>,
                    'ErrorCode' => <integer>,
                    'ResponseCode' => '<string>',
                    'ResponsePagePath' => '<string>',
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'DefaultCacheBehavior' => [
            'AllowedMethods' => [
                'CachedMethods' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'CachePolicyId' => '<string>',
            'Compress' => true || false,
            'DefaultTTL' => <integer>,
            'FieldLevelEncryptionId' => '<string>',
            'ForwardedValues' => [
                'Cookies' => [
                    'Forward' => 'none|whitelist|all',
                    'WhitelistedNames' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'Headers' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'QueryString' => true || false,
                'QueryStringCacheKeys' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
            ],
            'FunctionAssociations' => [
                'Items' => [
                    [
                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                        'FunctionARN' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'LambdaFunctionAssociations' => [
                'Items' => [
                    [
                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                        'IncludeBody' => true || false,
                        'LambdaFunctionARN' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'MaxTTL' => <integer>,
            'MinTTL' => <integer>,
            'OriginRequestPolicyId' => '<string>',
            'RealtimeLogConfigArn' => '<string>',
            'SmoothStreaming' => true || false,
            'TargetOriginId' => '<string>',
            'TrustedKeyGroups' => [
                'Enabled' => true || false,
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'TrustedSigners' => [
                'Enabled' => true || false,
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
        ],
        'DefaultRootObject' => '<string>',
        'Enabled' => true || false,
        'HttpVersion' => 'http1.1|http2',
        '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>',
                    'OriginShield' => [
                        'Enabled' => true || false,
                        'OriginShieldRegion' => '<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|static-ip',
        ],
        'WebACLId' => '<string>',
    ],
    'ETag' => '<string>',
]

Result Details

Errors

• NoSuchDistribution:

  The specified distribution does not exist.

• AccessDenied:

  Access denied.

GetFieldLevelEncryption

$result = $client->getFieldLevelEncryption([/* ... */]);
$promise = $client->getFieldLevelEncryptionAsync([/* ... */]);

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

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

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

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