CreateCloudFrontOriginAccessIdentity

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

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

CloudFrontOriginAccessIdentityAlreadyExists:

If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

MissingBody:

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

TooManyCloudFrontOriginAccessIdentities:

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

InvalidArgument:

The argument is invalid.

InconsistentQuantities:

The value of Quantity and the size of Items do not match.

CreateDistribution

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

Creates a new web distribution. Send a GET request to the /CloudFront API version/distribution/distribution ID resource.

Parameter Syntax

$result = $client->createDistribution([
    'DistributionConfig' => [ // REQUIRED
        'Aliases' => [
            'Items' => ['<string>', ...],
            'Quantity' => <integer>, // REQUIRED
        ],
        'CacheBehaviors' => [
            'Items' => [
                [
                    'AllowedMethods' => [
                        'CachedMethods' => [
                            'Items' => ['<string>', ...], // REQUIRED
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'Items' => ['<string>', ...], // REQUIRED
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'Compress' => true || false,
                    'DefaultTTL' => <integer>,
                    'ForwardedValues' => [ // REQUIRED
                        'Cookies' => [ // REQUIRED
                            'Forward' => 'none|whitelist|all', // REQUIRED
                            'WhitelistedNames' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>, // REQUIRED
                            ],
                        ],
                        'Headers' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'QueryString' => true || false, // REQUIRED
                        'QueryStringCacheKeys' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                    ],
                    'LambdaFunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                'LambdaFunctionARN' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'MaxTTL' => <integer>,
                    'MinTTL' => <integer>, // REQUIRED
                    'PathPattern' => '<string>', // REQUIRED
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>', // REQUIRED
                    'TrustedSigners' => [ // REQUIRED
                        'Enabled' => true || false, // REQUIRED
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
                ],
                // ...
            ],
            'Quantity' => <integer>, // REQUIRED
        ],
        'CallerReference' => '<string>', // REQUIRED
        'Comment' => '<string>', // REQUIRED
        'CustomErrorResponses' => [
            'Items' => [
                [
                    'ErrorCachingMinTTL' => <integer>,
                    'ErrorCode' => <integer>, // REQUIRED
                    'ResponseCode' => '<string>',
                    'ResponsePagePath' => '<string>',
                ],
                // ...
            ],
            'Quantity' => <integer>, // REQUIRED
        ],
        'DefaultCacheBehavior' => [ // REQUIRED
            'AllowedMethods' => [
                'CachedMethods' => [
                    'Items' => ['<string>', ...], // REQUIRED
                    'Quantity' => <integer>, // REQUIRED
                ],
                'Items' => ['<string>', ...], // REQUIRED
                'Quantity' => <integer>, // REQUIRED
            ],
            'Compress' => true || false,
            'DefaultTTL' => <integer>,
            'ForwardedValues' => [ // REQUIRED
                'Cookies' => [ // REQUIRED
                    'Forward' => 'none|whitelist|all', // REQUIRED
                    'WhitelistedNames' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                ],
                'Headers' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
                'QueryString' => true || false, // REQUIRED
                'QueryStringCacheKeys' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
            ],
            'LambdaFunctionAssociations' => [
                'Items' => [
                    [
                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                        'LambdaFunctionARN' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>, // REQUIRED
            ],
            'MaxTTL' => <integer>,
            'MinTTL' => <integer>, // REQUIRED
            'SmoothStreaming' => true || false,
            'TargetOriginId' => '<string>', // REQUIRED
            'TrustedSigners' => [ // REQUIRED
                'Enabled' => true || false, // REQUIRED
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
            ],
            'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
        ],
        'DefaultRootObject' => '<string>',
        'Enabled' => true || false, // REQUIRED
        'HttpVersion' => 'http1.1|http2',
        'IsIPV6Enabled' => true || false,
        'Logging' => [
            'Bucket' => '<string>', // REQUIRED
            'Enabled' => true || false, // REQUIRED
            'IncludeCookies' => true || false, // REQUIRED
            'Prefix' => '<string>', // REQUIRED
        ],
        'Origins' => [ // REQUIRED
            'Items' => [
                [
                    'CustomHeaders' => [
                        'Items' => [
                            [
                                'HeaderName' => '<string>', // REQUIRED
                                'HeaderValue' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'CustomOriginConfig' => [
                        'HTTPPort' => <integer>, // REQUIRED
                        'HTTPSPort' => <integer>, // REQUIRED
                        'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', // REQUIRED
                        'OriginSslProtocols' => [
                            'Items' => ['<string>', ...], // REQUIRED
                            'Quantity' => <integer>, // REQUIRED
                        ],
                    ],
                    'DomainName' => '<string>', // REQUIRED
                    'Id' => '<string>', // REQUIRED
                    'OriginPath' => '<string>',
                    'S3OriginConfig' => [
                        'OriginAccessIdentity' => '<string>', // REQUIRED
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>, // REQUIRED
        ],
        'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
        'Restrictions' => [
            'GeoRestriction' => [ // REQUIRED
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
                'RestrictionType' => 'blacklist|whitelist|none', // REQUIRED
            ],
        ],
        'ViewerCertificate' => [
            'ACMCertificateArn' => '<string>',
            'Certificate' => '<string>',
            'CertificateSource' => 'cloudfront|iam|acm',
            'CloudFrontDefaultCertificate' => true || false,
            'IAMCertificateId' => '<string>',
            'MinimumProtocolVersion' => 'SSLv3|TLSv1',
            'SSLSupportMethod' => 'sni-only|vip',
        ],
        'WebACLId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'Distribution' => [
        'ARN' => '<string>',
        'ActiveTrustedSigners' => [
            'Enabled' => true || false,
            'Items' => [
                [
                    'AwsAccountNumber' => '<string>',
                    'KeyPairIds' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'DistributionConfig' => [
            'Aliases' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'Compress' => true || false,
                        'DefaultTTL' => <integer>,
                        'ForwardedValues' => [
                            'Cookies' => [
                                'Forward' => 'none|whitelist|all',
                                'WhitelistedNames' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'Headers' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'QueryString' => true || false,
                            'QueryStringCacheKeys' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'PathPattern' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>',
                        'TrustedSigners' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>,
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'DefaultCacheBehavior' => [
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'Compress' => true || false,
                'DefaultTTL' => <integer>,
                'ForwardedValues' => [
                    'Cookies' => [
                        'Forward' => 'none|whitelist|all',
                        'WhitelistedNames' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'Headers' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'QueryString' => true || false,
                    'QueryStringCacheKeys' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>',
                'TrustedSigners' => [
                    'Enabled' => true || false,
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
            ],
            'DefaultRootObject' => '<string>',
            'Enabled' => true || false,
            'HttpVersion' => 'http1.1|http2',
            'IsIPV6Enabled' => true || false,
            'Logging' => [
                'Bucket' => '<string>',
                'Enabled' => true || false,
                'IncludeCookies' => true || false,
                'Prefix' => '<string>',
            ],
            'Origins' => [
                'Items' => [
                    [
                        'CustomHeaders' => [
                            'Items' => [
                                [
                                    'HeaderName' => '<string>',
                                    'HeaderValue' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'CustomOriginConfig' => [
                            'HTTPPort' => <integer>,
                            'HTTPSPort' => <integer>,
                            'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
                            'OriginSslProtocols' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'DomainName' => '<string>',
                        'Id' => '<string>',
                        'OriginPath' => '<string>',
                        'S3OriginConfig' => [
                            'OriginAccessIdentity' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
            'Restrictions' => [
                'GeoRestriction' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                    'RestrictionType' => 'blacklist|whitelist|none',
                ],
            ],
            'ViewerCertificate' => [
                'ACMCertificateArn' => '<string>',
                'Certificate' => '<string>',
                'CertificateSource' => 'cloudfront|iam|acm',
                'CloudFrontDefaultCertificate' => true || false,
                'IAMCertificateId' => '<string>',
                'MinimumProtocolVersion' => 'SSLv3|TLSv1',
                'SSLSupportMethod' => 'sni-only|vip',
            ],
            'WebACLId' => '<string>',
        ],
        'DomainName' => '<string>',
        'Id' => '<string>',
        'InProgressInvalidationBatches' => <integer>,
        'LastModifiedTime' => <DateTime>,
        'Status' => '<string>',
    ],
    'ETag' => '<string>',
    'Location' => '<string>',
]

Result Details

Errors

CNAMEAlreadyExists:

This error does not currently have a description.

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 do not exist.

InvalidViewerCertificate:

This error does not currently have a description.

InvalidMinimumProtocolVersion:

This error does not currently have a description.

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:

This error does not currently have a description.

InvalidResponseCode:

This error does not currently have a description.

InvalidArgument:

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

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:

This error does not currently have a description.

InvalidHeadersForS3Origin:

This error does not currently have a description.

InconsistentQuantities:

The value of Quantity and the size of Items do not match.

TooManyCertificates:

You cannot create anymore custom SSL/TLS certificates.

InvalidLocationCode:

This error does not currently have a description.

InvalidGeoRestrictionParameter:

This error does not currently have a description.

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:

This error does not currently have a description.

InvalidWebACLId:

This error does not currently have a description.

TooManyOriginCustomHeaders:

This error does not currently have a description.

TooManyQueryStringParameters:

This error does not currently have a description.

InvalidQueryStringParameters:

This error does not currently have a description.

TooManyDistributionsWithLambdaAssociations:

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

TooManyLambdaFunctionAssociations:

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

InvalidLambdaFunctionAssociation:

The specified Lambda function association is invalid.

CreateDistributionWithTags

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

Create a new distribution with tags.

Parameter Syntax

$result = $client->createDistributionWithTags([
    'DistributionConfigWithTags' => [ // REQUIRED
        'DistributionConfig' => [ // REQUIRED
            'Aliases' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...], // REQUIRED
                                'Quantity' => <integer>, // REQUIRED
                            ],
                            'Items' => ['<string>', ...], // REQUIRED
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'Compress' => true || false,
                        'DefaultTTL' => <integer>,
                        'ForwardedValues' => [ // REQUIRED
                            'Cookies' => [ // REQUIRED
                                'Forward' => 'none|whitelist|all', // REQUIRED
                                'WhitelistedNames' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>, // REQUIRED
                                ],
                            ],
                            'Headers' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>, // REQUIRED
                            ],
                            'QueryString' => true || false, // REQUIRED
                            'QueryStringCacheKeys' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>, // REQUIRED
                            ],
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>, // REQUIRED
                        'PathPattern' => '<string>', // REQUIRED
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>', // REQUIRED
                        'TrustedSigners' => [ // REQUIRED
                            'Enabled' => true || false, // REQUIRED
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
                    ],
                    // ...
                ],
                'Quantity' => <integer>, // REQUIRED
            ],
            'CallerReference' => '<string>', // REQUIRED
            'Comment' => '<string>', // REQUIRED
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>, // REQUIRED
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>, // REQUIRED
            ],
            'DefaultCacheBehavior' => [ // REQUIRED
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...], // REQUIRED
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'Items' => ['<string>', ...], // REQUIRED
                    'Quantity' => <integer>, // REQUIRED
                ],
                'Compress' => true || false,
                'DefaultTTL' => <integer>,
                'ForwardedValues' => [ // REQUIRED
                    'Cookies' => [ // REQUIRED
                        'Forward' => 'none|whitelist|all', // REQUIRED
                        'WhitelistedNames' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                    ],
                    'Headers' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'QueryString' => true || false, // REQUIRED
                    'QueryStringCacheKeys' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>, // REQUIRED
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>, // REQUIRED
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>', // REQUIRED
                'TrustedSigners' => [ // REQUIRED
                    'Enabled' => true || false, // REQUIRED
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
                'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
            ],
            'DefaultRootObject' => '<string>',
            'Enabled' => true || false, // REQUIRED
            'HttpVersion' => 'http1.1|http2',
            'IsIPV6Enabled' => true || false,
            'Logging' => [
                'Bucket' => '<string>', // REQUIRED
                'Enabled' => true || false, // REQUIRED
                'IncludeCookies' => true || false, // REQUIRED
                'Prefix' => '<string>', // REQUIRED
            ],
            'Origins' => [ // REQUIRED
                'Items' => [
                    [
                        'CustomHeaders' => [
                            'Items' => [
                                [
                                    'HeaderName' => '<string>', // REQUIRED
                                    'HeaderValue' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'CustomOriginConfig' => [
                            'HTTPPort' => <integer>, // REQUIRED
                            'HTTPSPort' => <integer>, // REQUIRED
                            'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', // REQUIRED
                            'OriginSslProtocols' => [
                                'Items' => ['<string>', ...], // REQUIRED
                                'Quantity' => <integer>, // REQUIRED
                            ],
                        ],
                        'DomainName' => '<string>', // REQUIRED
                        'Id' => '<string>', // REQUIRED
                        'OriginPath' => '<string>',
                        'S3OriginConfig' => [
                            'OriginAccessIdentity' => '<string>', // REQUIRED
                        ],
                    ],
                    // ...
                ],
                'Quantity' => <integer>, // REQUIRED
            ],
            'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
            'Restrictions' => [
                'GeoRestriction' => [ // REQUIRED
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                    'RestrictionType' => 'blacklist|whitelist|none', // REQUIRED
                ],
            ],
            'ViewerCertificate' => [
                'ACMCertificateArn' => '<string>',
                'Certificate' => '<string>',
                'CertificateSource' => 'cloudfront|iam|acm',
                'CloudFrontDefaultCertificate' => true || false,
                'IAMCertificateId' => '<string>',
                'MinimumProtocolVersion' => 'SSLv3|TLSv1',
                'SSLSupportMethod' => 'sni-only|vip',
            ],
            'WebACLId' => '<string>',
        ],
        'Tags' => [ // REQUIRED
            'Items' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'Distribution' => [
        'ARN' => '<string>',
        'ActiveTrustedSigners' => [
            'Enabled' => true || false,
            'Items' => [
                [
                    'AwsAccountNumber' => '<string>',
                    'KeyPairIds' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'DistributionConfig' => [
            'Aliases' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'Compress' => true || false,
                        'DefaultTTL' => <integer>,
                        'ForwardedValues' => [
                            'Cookies' => [
                                'Forward' => 'none|whitelist|all',
                                'WhitelistedNames' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'Headers' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'QueryString' => true || false,
                            'QueryStringCacheKeys' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'PathPattern' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>',
                        'TrustedSigners' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>,
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'DefaultCacheBehavior' => [
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'Compress' => true || false,
                'DefaultTTL' => <integer>,
                'ForwardedValues' => [
                    'Cookies' => [
                        'Forward' => 'none|whitelist|all',
                        'WhitelistedNames' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'Headers' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'QueryString' => true || false,
                    'QueryStringCacheKeys' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>',
                'TrustedSigners' => [
                    'Enabled' => true || false,
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
            ],
            'DefaultRootObject' => '<string>',
            'Enabled' => true || false,
            'HttpVersion' => 'http1.1|http2',
            'IsIPV6Enabled' => true || false,
            'Logging' => [
                'Bucket' => '<string>',
                'Enabled' => true || false,
                'IncludeCookies' => true || false,
                'Prefix' => '<string>',
            ],
            'Origins' => [
                'Items' => [
                    [
                        'CustomHeaders' => [
                            'Items' => [
                                [
                                    'HeaderName' => '<string>',
                                    'HeaderValue' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'CustomOriginConfig' => [
                            'HTTPPort' => <integer>,
                            'HTTPSPort' => <integer>,
                            'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
                            'OriginSslProtocols' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'DomainName' => '<string>',
                        'Id' => '<string>',
                        'OriginPath' => '<string>',
                        'S3OriginConfig' => [
                            'OriginAccessIdentity' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
            'Restrictions' => [
                'GeoRestriction' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                    'RestrictionType' => 'blacklist|whitelist|none',
                ],
            ],
            'ViewerCertificate' => [
                'ACMCertificateArn' => '<string>',
                'Certificate' => '<string>',
                'CertificateSource' => 'cloudfront|iam|acm',
                'CloudFrontDefaultCertificate' => true || false,
                'IAMCertificateId' => '<string>',
                'MinimumProtocolVersion' => 'SSLv3|TLSv1',
                'SSLSupportMethod' => 'sni-only|vip',
            ],
            'WebACLId' => '<string>',
        ],
        'DomainName' => '<string>',
        'Id' => '<string>',
        'InProgressInvalidationBatches' => <integer>,
        'LastModifiedTime' => <DateTime>,
        'Status' => '<string>',
    ],
    'ETag' => '<string>',
    'Location' => '<string>',
]

Result Details

Errors

CNAMEAlreadyExists:

This error does not currently have a description.

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 do not exist.

InvalidViewerCertificate:

This error does not currently have a description.

InvalidMinimumProtocolVersion:

This error does not currently have a description.

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:

This error does not currently have a description.

InvalidResponseCode:

This error does not currently have a description.

InvalidArgument:

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

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:

This error does not currently have a description.

InvalidHeadersForS3Origin:

This error does not currently have a description.

InconsistentQuantities:

The value of Quantity and the size of Items do not match.

TooManyCertificates:

You cannot create anymore custom SSL/TLS certificates.

InvalidLocationCode:

This error does not currently have a description.

InvalidGeoRestrictionParameter:

This error does not currently have a description.

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:

This error does not currently have a description.

InvalidWebACLId:

This error does not currently have a description.

TooManyOriginCustomHeaders:

This error does not currently have a description.

InvalidTagging:

This error does not currently have a description.

TooManyQueryStringParameters:

This error does not currently have a description.

InvalidQueryStringParameters:

This error does not currently have a description.

TooManyDistributionsWithLambdaAssociations:

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

TooManyLambdaFunctionAssociations:

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

InvalidLambdaFunctionAssociation:

The specified Lambda function association is invalid.

CreateInvalidation

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

Create a new invalidation.

Parameter Syntax

$result = $client->createInvalidation([
    'DistributionId' => '<string>', // REQUIRED
    'InvalidationBatch' => [ // REQUIRED
        'CallerReference' => '<string>', // REQUIRED
        'Paths' => [ // REQUIRED
            'Items' => ['<string>', ...],
            'Quantity' => <integer>, // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDenied:

Access denied.

MissingBody:

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

InvalidArgument:

The argument is invalid.

NoSuchDistribution:

The specified distribution does not exist.

BatchTooLarge:

This error does not currently have a description.

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 do not match.

CreateStreamingDistribution

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

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

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

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

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

Parameter Syntax

$result = $client->createStreamingDistribution([
    'StreamingDistributionConfig' => [ // REQUIRED
        'Aliases' => [
            'Items' => ['<string>', ...],
            'Quantity' => <integer>, // REQUIRED
        ],
        'CallerReference' => '<string>', // REQUIRED
        'Comment' => '<string>', // REQUIRED
        'Enabled' => true || false, // REQUIRED
        'Logging' => [
            'Bucket' => '<string>', // REQUIRED
            'Enabled' => true || false, // REQUIRED
            'Prefix' => '<string>', // REQUIRED
        ],
        'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
        'S3Origin' => [ // REQUIRED
            'DomainName' => '<string>', // REQUIRED
            'OriginAccessIdentity' => '<string>', // REQUIRED
        ],
        'TrustedSigners' => [ // REQUIRED
            'Enabled' => true || false, // REQUIRED
            'Items' => ['<string>', ...],
            'Quantity' => <integer>, // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

CNAMEAlreadyExists:

This error does not currently have a description.

StreamingDistributionAlreadyExists:

This error does not currently have a description.

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 do not exist.

MissingBody:

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

TooManyStreamingDistributionCNAMEs:

This error does not currently have a description.

TooManyStreamingDistributions:

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

InvalidArgument:

The argument is invalid.

InconsistentQuantities:

The value of Quantity and the size of Items do not match.

CreateStreamingDistributionWithTags

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

Create a new streaming distribution with tags.

Parameter Syntax

$result = $client->createStreamingDistributionWithTags([
    'StreamingDistributionConfigWithTags' => [ // REQUIRED
        'StreamingDistributionConfig' => [ // REQUIRED
            'Aliases' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
            ],
            'CallerReference' => '<string>', // REQUIRED
            'Comment' => '<string>', // REQUIRED
            'Enabled' => true || false, // REQUIRED
            'Logging' => [
                'Bucket' => '<string>', // REQUIRED
                'Enabled' => true || false, // REQUIRED
                'Prefix' => '<string>', // REQUIRED
            ],
            'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
            'S3Origin' => [ // REQUIRED
                'DomainName' => '<string>', // REQUIRED
                'OriginAccessIdentity' => '<string>', // REQUIRED
            ],
            'TrustedSigners' => [ // REQUIRED
                'Enabled' => true || false, // REQUIRED
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
            ],
        ],
        'Tags' => [ // REQUIRED
            'Items' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

CNAMEAlreadyExists:

This error does not currently have a description.

StreamingDistributionAlreadyExists:

This error does not currently have a description.

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 do not exist.

MissingBody:

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

TooManyStreamingDistributionCNAMEs:

This error does not currently have a description.

TooManyStreamingDistributions:

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

InvalidArgument:

The argument is invalid.

InconsistentQuantities:

The value of Quantity and the size of Items do not match.

InvalidTagging:

This error does not currently have a description.

DeleteCloudFrontOriginAccessIdentity

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

Delete an origin access identity.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDenied:

Access denied.

InvalidIfMatchVersion:

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

NoSuchCloudFrontOriginAccessIdentity:

The specified origin access identity does not exist.

PreconditionFailed:

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

CloudFrontOriginAccessIdentityInUse:

This error does not currently have a description.

DeleteDistribution

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

Delete a distribution.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDenied:

Access denied.

DistributionNotDisabled:

This error does not currently have a description.

InvalidIfMatchVersion:

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

NoSuchDistribution:

The specified distribution does not exist.

PreconditionFailed:

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

DeleteStreamingDistribution

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

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

To delete an RTMP distribution using the CloudFront API:

1. Disable the RTMP distribution.

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

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

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

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

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

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

8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDenied:

Access denied.

StreamingDistributionNotDisabled:

This error does not currently have a description.

InvalidIfMatchVersion:

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

NoSuchStreamingDistribution:

The specified streaming distribution does not exist.

PreconditionFailed:

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

GetCloudFrontOriginAccessIdentity

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

Get the information about an origin access identity.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

NoSuchCloudFrontOriginAccessIdentity:

The specified origin access identity does not exist.

AccessDenied:

Access denied.

GetCloudFrontOriginAccessIdentityConfig

$result = $client->getCloudFrontOriginAccessIdentityConfig([/* ... */]);
$promise = $client->getCloudFrontOriginAccessIdentityConfigAsync([/* ... */]);

Get the configuration information about an origin access identity.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

NoSuchCloudFrontOriginAccessIdentity:

The specified origin access identity does not exist.

AccessDenied:

Access denied.

GetDistribution

$result = $client->getDistribution([/* ... */]);
$promise = $client->getDistributionAsync([/* ... */]);

Get the information about a distribution.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Distribution' => [
        'ARN' => '<string>',
        'ActiveTrustedSigners' => [
            'Enabled' => true || false,
            'Items' => [
                [
                    'AwsAccountNumber' => '<string>',
                    'KeyPairIds' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'DistributionConfig' => [
            'Aliases' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'Compress' => true || false,
                        'DefaultTTL' => <integer>,
                        'ForwardedValues' => [
                            'Cookies' => [
                                'Forward' => 'none|whitelist|all',
                                'WhitelistedNames' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'Headers' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'QueryString' => true || false,
                            'QueryStringCacheKeys' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'PathPattern' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>',
                        'TrustedSigners' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>,
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'DefaultCacheBehavior' => [
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'Compress' => true || false,
                'DefaultTTL' => <integer>,
                'ForwardedValues' => [
                    'Cookies' => [
                        'Forward' => 'none|whitelist|all',
                        'WhitelistedNames' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'Headers' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'QueryString' => true || false,
                    'QueryStringCacheKeys' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>',
                'TrustedSigners' => [
                    'Enabled' => true || false,
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
            ],
            'DefaultRootObject' => '<string>',
            'Enabled' => true || false,
            'HttpVersion' => 'http1.1|http2',
            'IsIPV6Enabled' => true || false,
            'Logging' => [
                'Bucket' => '<string>',
                'Enabled' => true || false,
                'IncludeCookies' => true || false,
                'Prefix' => '<string>',
            ],
            'Origins' => [
                'Items' => [
                    [
                        'CustomHeaders' => [
                            'Items' => [
                                [
                                    'HeaderName' => '<string>',
                                    'HeaderValue' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'CustomOriginConfig' => [
                            'HTTPPort' => <integer>,
                            'HTTPSPort' => <integer>,
                            'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
                            'OriginSslProtocols' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'DomainName' => '<string>',
                        'Id' => '<string>',
                        'OriginPath' => '<string>',
                        'S3OriginConfig' => [
                            'OriginAccessIdentity' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
            'Restrictions' => [
                'GeoRestriction' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                    'RestrictionType' => 'blacklist|whitelist|none',
                ],
            ],
            'ViewerCertificate' => [
                'ACMCertificateArn' => '<string>',
                'Certificate' => '<string>',
                'CertificateSource' => 'cloudfront|iam|acm',
                'CloudFrontDefaultCertificate' => true || false,
                'IAMCertificateId' => '<string>',
                'MinimumProtocolVersion' => 'SSLv3|TLSv1',
                'SSLSupportMethod' => 'sni-only|vip',
            ],
            'WebACLId' => '<string>',
        ],
        'DomainName' => '<string>',
        'Id' => '<string>',
        'InProgressInvalidationBatches' => <integer>,
        'LastModifiedTime' => <DateTime>,
        'Status' => '<string>',
    ],
    'ETag' => '<string>',
]

Result Details

Errors

NoSuchDistribution:

The specified distribution does not exist.

AccessDenied:

Access denied.

GetDistributionConfig

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

Get the configuration information about a distribution.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DistributionConfig' => [
        'Aliases' => [
            'Items' => ['<string>', ...],
            'Quantity' => <integer>,
        ],
        'CacheBehaviors' => [
            'Items' => [
                [
                    'AllowedMethods' => [
                        'CachedMethods' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Compress' => true || false,
                    'DefaultTTL' => <integer>,
                    'ForwardedValues' => [
                        'Cookies' => [
                            'Forward' => 'none|whitelist|all',
                            'WhitelistedNames' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'Headers' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'QueryString' => true || false,
                        'QueryStringCacheKeys' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'LambdaFunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                'LambdaFunctionARN' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>,
                    ],
                    'MaxTTL' => <integer>,
                    'MinTTL' => <integer>,
                    'PathPattern' => '<string>',
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>',
                    'TrustedSigners' => [
                        'Enabled' => true || false,
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'CallerReference' => '<string>',
        'Comment' => '<string>',
        'CustomErrorResponses' => [
            'Items' => [
                [
                    'ErrorCachingMinTTL' => <integer>,
                    'ErrorCode' => <integer>,
                    'ResponseCode' => '<string>',
                    'ResponsePagePath' => '<string>',
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'DefaultCacheBehavior' => [
            'AllowedMethods' => [
                'CachedMethods' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'Compress' => true || false,
            'DefaultTTL' => <integer>,
            'ForwardedValues' => [
                'Cookies' => [
                    'Forward' => 'none|whitelist|all',
                    'WhitelistedNames' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'Headers' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'QueryString' => true || false,
                'QueryStringCacheKeys' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
            ],
            'LambdaFunctionAssociations' => [
                'Items' => [
                    [
                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                        'LambdaFunctionARN' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'MaxTTL' => <integer>,
            'MinTTL' => <integer>,
            'SmoothStreaming' => true || false,
            'TargetOriginId' => '<string>',
            'TrustedSigners' => [
                'Enabled' => true || false,
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
        ],
        'DefaultRootObject' => '<string>',
        'Enabled' => true || false,
        'HttpVersion' => 'http1.1|http2',
        'IsIPV6Enabled' => true || false,
        'Logging' => [
            'Bucket' => '<string>',
            'Enabled' => true || false,
            'IncludeCookies' => true || false,
            'Prefix' => '<string>',
        ],
        'Origins' => [
            'Items' => [
                [
                    'CustomHeaders' => [
                        'Items' => [
                            [
                                'HeaderName' => '<string>',
                                'HeaderValue' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>,
                    ],
                    'CustomOriginConfig' => [
                        'HTTPPort' => <integer>,
                        'HTTPSPort' => <integer>,
                        'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
                        'OriginSslProtocols' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'DomainName' => '<string>',
                    'Id' => '<string>',
                    'OriginPath' => '<string>',
                    'S3OriginConfig' => [
                        'OriginAccessIdentity' => '<string>',
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
        'Restrictions' => [
            'GeoRestriction' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
                'RestrictionType' => 'blacklist|whitelist|none',
            ],
        ],
        'ViewerCertificate' => [
            'ACMCertificateArn' => '<string>',
            'Certificate' => '<string>',
            'CertificateSource' => 'cloudfront|iam|acm',
            'CloudFrontDefaultCertificate' => true || false,
            'IAMCertificateId' => '<string>',
            'MinimumProtocolVersion' => 'SSLv3|TLSv1',
            'SSLSupportMethod' => 'sni-only|vip',
        ],
        'WebACLId' => '<string>',
    ],
    'ETag' => '<string>',
]

Result Details

Errors

NoSuchDistribution:

The specified distribution does not exist.

AccessDenied:

Access denied.

GetInvalidation

$result = $client->getInvalidation([/* ... */]);
$promise = $client->getInvalidationAsync([/* ... */]);

Get the information about an invalidation.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

NoSuchInvalidation:

The specified invalidation does not exist.

NoSuchDistribution:

The specified distribution does not exist.

AccessDenied:

Access denied.

GetStreamingDistribution

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

NoSuchStreamingDistribution:

The specified streaming distribution does not exist.

AccessDenied:

Access denied.

GetStreamingDistributionConfig

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

Get the configuration information about a streaming distribution.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

NoSuchStreamingDistribution:

The specified streaming distribution does not exist.

AccessDenied:

Access denied.

ListCloudFrontOriginAccessIdentities

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

Lists origin access identities.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidArgument:

The argument is invalid.

ListDistributions

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

List distributions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DistributionList' => [
        'IsTruncated' => true || false,
        'Items' => [
            [
                'ARN' => '<string>',
                'Aliases' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'CacheBehaviors' => [
                    'Items' => [
                        [
                            'AllowedMethods' => [
                                'CachedMethods' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Compress' => true || false,
                            'DefaultTTL' => <integer>,
                            'ForwardedValues' => [
                                'Cookies' => [
                                    'Forward' => 'none|whitelist|all',
                                    'WhitelistedNames' => [
                                        'Items' => ['<string>', ...],
                                        'Quantity' => <integer>,
                                    ],
                                ],
                                'Headers' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                                'QueryString' => true || false,
                                'QueryStringCacheKeys' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'LambdaFunctionAssociations' => [
                                'Items' => [
                                    [
                                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                        'LambdaFunctionARN' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Quantity' => <integer>,
                            ],
                            'MaxTTL' => <integer>,
                            'MinTTL' => <integer>,
                            'PathPattern' => '<string>',
                            'SmoothStreaming' => true || false,
                            'TargetOriginId' => '<string>',
                            'TrustedSigners' => [
                                'Enabled' => true || false,
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'Comment' => '<string>',
                'CustomErrorResponses' => [
                    'Items' => [
                        [
                            'ErrorCachingMinTTL' => <integer>,
                            'ErrorCode' => <integer>,
                            'ResponseCode' => '<string>',
                            'ResponsePagePath' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'DefaultCacheBehavior' => [
                    'AllowedMethods' => [
                        'CachedMethods' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Compress' => true || false,
                    'DefaultTTL' => <integer>,
                    'ForwardedValues' => [
                        'Cookies' => [
                            'Forward' => 'none|whitelist|all',
                            'WhitelistedNames' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'Headers' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'QueryString' => true || false,
                        'QueryStringCacheKeys' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'LambdaFunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                'LambdaFunctionARN' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>,
                    ],
                    'MaxTTL' => <integer>,
                    'MinTTL' => <integer>,
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>',
                    'TrustedSigners' => [
                        'Enabled' => true || false,
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                ],
                'DomainName' => '<string>',
                'Enabled' => true || false,
                'HttpVersion' => 'http1.1|http2',
                'Id' => '<string>',
                'IsIPV6Enabled' => true || false,
                'LastModifiedTime' => <DateTime>,
                'Origins' => [
                    'Items' => [
                        [
                            'CustomHeaders' => [
                                'Items' => [
                                    [
                                        'HeaderName' => '<string>',
                                        'HeaderValue' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Quantity' => <integer>,
                            ],
                            'CustomOriginConfig' => [
                                'HTTPPort' => <integer>,
                                'HTTPSPort' => <integer>,
                                'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
                                'OriginSslProtocols' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'DomainName' => '<string>',
                            'Id' => '<string>',
                            'OriginPath' => '<string>',
                            'S3OriginConfig' => [
                                'OriginAccessIdentity' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
                'Restrictions' => [
                    'GeoRestriction' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                        'RestrictionType' => 'blacklist|whitelist|none',
                    ],
                ],
                'Status' => '<string>',
                'ViewerCertificate' => [
                    'ACMCertificateArn' => '<string>',
                    'Certificate' => '<string>',
                    'CertificateSource' => 'cloudfront|iam|acm',
                    'CloudFrontDefaultCertificate' => true || false,
                    'IAMCertificateId' => '<string>',
                    'MinimumProtocolVersion' => 'SSLv3|TLSv1',
                    'SSLSupportMethod' => 'sni-only|vip',
                ],
                'WebACLId' => '<string>',
            ],
            // ...
        ],
        'Marker' => '<string>',
        'MaxItems' => <integer>,
        'NextMarker' => '<string>',
        'Quantity' => <integer>,
    ],
]

Result Details

Errors

InvalidArgument:

The argument is invalid.

ListDistributionsByWebACLId

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DistributionList' => [
        'IsTruncated' => true || false,
        'Items' => [
            [
                'ARN' => '<string>',
                'Aliases' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'CacheBehaviors' => [
                    'Items' => [
                        [
                            'AllowedMethods' => [
                                'CachedMethods' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Compress' => true || false,
                            'DefaultTTL' => <integer>,
                            'ForwardedValues' => [
                                'Cookies' => [
                                    'Forward' => 'none|whitelist|all',
                                    'WhitelistedNames' => [
                                        'Items' => ['<string>', ...],
                                        'Quantity' => <integer>,
                                    ],
                                ],
                                'Headers' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                                'QueryString' => true || false,
                                'QueryStringCacheKeys' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'LambdaFunctionAssociations' => [
                                'Items' => [
                                    [
                                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                        'LambdaFunctionARN' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Quantity' => <integer>,
                            ],
                            'MaxTTL' => <integer>,
                            'MinTTL' => <integer>,
                            'PathPattern' => '<string>',
                            'SmoothStreaming' => true || false,
                            'TargetOriginId' => '<string>',
                            'TrustedSigners' => [
                                'Enabled' => true || false,
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'Comment' => '<string>',
                'CustomErrorResponses' => [
                    'Items' => [
                        [
                            'ErrorCachingMinTTL' => <integer>,
                            'ErrorCode' => <integer>,
                            'ResponseCode' => '<string>',
                            'ResponsePagePath' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'DefaultCacheBehavior' => [
                    'AllowedMethods' => [
                        'CachedMethods' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Compress' => true || false,
                    'DefaultTTL' => <integer>,
                    'ForwardedValues' => [
                        'Cookies' => [
                            'Forward' => 'none|whitelist|all',
                            'WhitelistedNames' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'Headers' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'QueryString' => true || false,
                        'QueryStringCacheKeys' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'LambdaFunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                'LambdaFunctionARN' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>,
                    ],
                    'MaxTTL' => <integer>,
                    'MinTTL' => <integer>,
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>',
                    'TrustedSigners' => [
                        'Enabled' => true || false,
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                ],
                'DomainName' => '<string>',
                'Enabled' => true || false,
                'HttpVersion' => 'http1.1|http2',
                'Id' => '<string>',
                'IsIPV6Enabled' => true || false,
                'LastModifiedTime' => <DateTime>,
                'Origins' => [
                    'Items' => [
                        [
                            'CustomHeaders' => [
                                'Items' => [
                                    [
                                        'HeaderName' => '<string>',
                                        'HeaderValue' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Quantity' => <integer>,
                            ],
                            'CustomOriginConfig' => [
                                'HTTPPort' => <integer>,
                                'HTTPSPort' => <integer>,
                                'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
                                'OriginSslProtocols' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'DomainName' => '<string>',
                            'Id' => '<string>',
                            'OriginPath' => '<string>',
                            'S3OriginConfig' => [
                                'OriginAccessIdentity' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
                'Restrictions' => [
                    'GeoRestriction' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                        'RestrictionType' => 'blacklist|whitelist|none',
                    ],
                ],
                'Status' => '<string>',
                'ViewerCertificate' => [
                    'ACMCertificateArn' => '<string>',
                    'Certificate' => '<string>',
                    'CertificateSource' => 'cloudfront|iam|acm',
                    'CloudFrontDefaultCertificate' => true || false,
                    'IAMCertificateId' => '<string>',
                    'MinimumProtocolVersion' => 'SSLv3|TLSv1',
                    'SSLSupportMethod' => 'sni-only|vip',
                ],
                'WebACLId' => '<string>',
            ],
            // ...
        ],
        'Marker' => '<string>',
        'MaxItems' => <integer>,
        'NextMarker' => '<string>',
        'Quantity' => <integer>,
    ],
]

Result Details

Errors

InvalidArgument:

The argument is invalid.

InvalidWebACLId:

This error does not currently have a description.

ListInvalidations

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

Lists invalidation batches.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidArgument:

The argument is invalid.

NoSuchDistribution:

The specified distribution does not exist.

AccessDenied:

Access denied.

ListStreamingDistributions

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

List streaming distributions.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidArgument:

The argument is invalid.

ListTagsForResource

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

List tags for a CloudFront resource.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDenied:

Access denied.

InvalidArgument:

The argument is invalid.

InvalidTagging:

This error does not currently have a description.

NoSuchResource:

This error does not currently have a description.

TagResource

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

Add tags to a CloudFront resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDenied:

Access denied.

InvalidArgument:

The argument is invalid.

InvalidTagging:

This error does not currently have a description.

NoSuchResource:

This error does not currently have a description.

UntagResource

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

Remove tags from a CloudFront resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDenied:

Access denied.

InvalidArgument:

The argument is invalid.

InvalidTagging:

This error does not currently have a description.

NoSuchResource:

This error does not currently have a description.

UpdateCloudFrontOriginAccessIdentity

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

Update an origin access identity.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDenied:

Access denied.

IllegalUpdate:

Origin and CallerReference cannot be updated.

InvalidIfMatchVersion:

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

MissingBody:

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

NoSuchCloudFrontOriginAccessIdentity:

The specified origin access identity does not exist.

PreconditionFailed:

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

InvalidArgument:

The argument is invalid.

InconsistentQuantities:

The value of Quantity and the size of Items do not match.

UpdateDistribution

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

Update a distribution.

Parameter Syntax

$result = $client->updateDistribution([
    'DistributionConfig' => [ // REQUIRED
        'Aliases' => [
            'Items' => ['<string>', ...],
            'Quantity' => <integer>, // REQUIRED
        ],
        'CacheBehaviors' => [
            'Items' => [
                [
                    'AllowedMethods' => [
                        'CachedMethods' => [
                            'Items' => ['<string>', ...], // REQUIRED
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'Items' => ['<string>', ...], // REQUIRED
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'Compress' => true || false,
                    'DefaultTTL' => <integer>,
                    'ForwardedValues' => [ // REQUIRED
                        'Cookies' => [ // REQUIRED
                            'Forward' => 'none|whitelist|all', // REQUIRED
                            'WhitelistedNames' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>, // REQUIRED
                            ],
                        ],
                        'Headers' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                        'QueryString' => true || false, // REQUIRED
                        'QueryStringCacheKeys' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>, // REQUIRED
                        ],
                    ],
                    'LambdaFunctionAssociations' => [
                        'Items' => [
                            [
                                'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                'LambdaFunctionARN' => '<string>',
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'MaxTTL' => <integer>,
                    'MinTTL' => <integer>, // REQUIRED
                    'PathPattern' => '<string>', // REQUIRED
                    'SmoothStreaming' => true || false,
                    'TargetOriginId' => '<string>', // REQUIRED
                    'TrustedSigners' => [ // REQUIRED
                        'Enabled' => true || false, // REQUIRED
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
                ],
                // ...
            ],
            'Quantity' => <integer>, // REQUIRED
        ],
        'CallerReference' => '<string>', // REQUIRED
        'Comment' => '<string>', // REQUIRED
        'CustomErrorResponses' => [
            'Items' => [
                [
                    'ErrorCachingMinTTL' => <integer>,
                    'ErrorCode' => <integer>, // REQUIRED
                    'ResponseCode' => '<string>',
                    'ResponsePagePath' => '<string>',
                ],
                // ...
            ],
            'Quantity' => <integer>, // REQUIRED
        ],
        'DefaultCacheBehavior' => [ // REQUIRED
            'AllowedMethods' => [
                'CachedMethods' => [
                    'Items' => ['<string>', ...], // REQUIRED
                    'Quantity' => <integer>, // REQUIRED
                ],
                'Items' => ['<string>', ...], // REQUIRED
                'Quantity' => <integer>, // REQUIRED
            ],
            'Compress' => true || false,
            'DefaultTTL' => <integer>,
            'ForwardedValues' => [ // REQUIRED
                'Cookies' => [ // REQUIRED
                    'Forward' => 'none|whitelist|all', // REQUIRED
                    'WhitelistedNames' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                ],
                'Headers' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
                'QueryString' => true || false, // REQUIRED
                'QueryStringCacheKeys' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>, // REQUIRED
                ],
            ],
            'LambdaFunctionAssociations' => [
                'Items' => [
                    [
                        'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                        'LambdaFunctionARN' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>, // REQUIRED
            ],
            'MaxTTL' => <integer>,
            'MinTTL' => <integer>, // REQUIRED
            'SmoothStreaming' => true || false,
            'TargetOriginId' => '<string>', // REQUIRED
            'TrustedSigners' => [ // REQUIRED
                'Enabled' => true || false, // REQUIRED
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
            ],
            'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
        ],
        'DefaultRootObject' => '<string>',
        'Enabled' => true || false, // REQUIRED
        'HttpVersion' => 'http1.1|http2',
        'IsIPV6Enabled' => true || false,
        'Logging' => [
            'Bucket' => '<string>', // REQUIRED
            'Enabled' => true || false, // REQUIRED
            'IncludeCookies' => true || false, // REQUIRED
            'Prefix' => '<string>', // REQUIRED
        ],
        'Origins' => [ // REQUIRED
            'Items' => [
                [
                    'CustomHeaders' => [
                        'Items' => [
                            [
                                'HeaderName' => '<string>', // REQUIRED
                                'HeaderValue' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'Quantity' => <integer>, // REQUIRED
                    ],
                    'CustomOriginConfig' => [
                        'HTTPPort' => <integer>, // REQUIRED
                        'HTTPSPort' => <integer>, // REQUIRED
                        'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', // REQUIRED
                        'OriginSslProtocols' => [
                            'Items' => ['<string>', ...], // REQUIRED
                            'Quantity' => <integer>, // REQUIRED
                        ],
                    ],
                    'DomainName' => '<string>', // REQUIRED
                    'Id' => '<string>', // REQUIRED
                    'OriginPath' => '<string>',
                    'S3OriginConfig' => [
                        'OriginAccessIdentity' => '<string>', // REQUIRED
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>, // REQUIRED
        ],
        'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
        'Restrictions' => [
            'GeoRestriction' => [ // REQUIRED
                'Items' => ['<string>', ...],
                'Quantity' => <integer>, // REQUIRED
                'RestrictionType' => 'blacklist|whitelist|none', // REQUIRED
            ],
        ],
        'ViewerCertificate' => [
            'ACMCertificateArn' => '<string>',
            'Certificate' => '<string>',
            'CertificateSource' => 'cloudfront|iam|acm',
            'CloudFrontDefaultCertificate' => true || false,
            'IAMCertificateId' => '<string>',
            'MinimumProtocolVersion' => 'SSLv3|TLSv1',
            'SSLSupportMethod' => 'sni-only|vip',
        ],
        'WebACLId' => '<string>',
    ],
    'Id' => '<string>', // REQUIRED
    'IfMatch' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Distribution' => [
        'ARN' => '<string>',
        'ActiveTrustedSigners' => [
            'Enabled' => true || false,
            'Items' => [
                [
                    'AwsAccountNumber' => '<string>',
                    'KeyPairIds' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                // ...
            ],
            'Quantity' => <integer>,
        ],
        'DistributionConfig' => [
            'Aliases' => [
                'Items' => ['<string>', ...],
                'Quantity' => <integer>,
            ],
            'CacheBehaviors' => [
                'Items' => [
                    [
                        'AllowedMethods' => [
                            'CachedMethods' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'Compress' => true || false,
                        'DefaultTTL' => <integer>,
                        'ForwardedValues' => [
                            'Cookies' => [
                                'Forward' => 'none|whitelist|all',
                                'WhitelistedNames' => [
                                    'Items' => ['<string>', ...],
                                    'Quantity' => <integer>,
                                ],
                            ],
                            'Headers' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                            'QueryString' => true || false,
                            'QueryStringCacheKeys' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'LambdaFunctionAssociations' => [
                            'Items' => [
                                [
                                    'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                                    'LambdaFunctionARN' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'MaxTTL' => <integer>,
                        'MinTTL' => <integer>,
                        'PathPattern' => '<string>',
                        'SmoothStreaming' => true || false,
                        'TargetOriginId' => '<string>',
                        'TrustedSigners' => [
                            'Enabled' => true || false,
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                        'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'CallerReference' => '<string>',
            'Comment' => '<string>',
            'CustomErrorResponses' => [
                'Items' => [
                    [
                        'ErrorCachingMinTTL' => <integer>,
                        'ErrorCode' => <integer>,
                        'ResponseCode' => '<string>',
                        'ResponsePagePath' => '<string>',
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'DefaultCacheBehavior' => [
                'AllowedMethods' => [
                    'CachedMethods' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'Compress' => true || false,
                'DefaultTTL' => <integer>,
                'ForwardedValues' => [
                    'Cookies' => [
                        'Forward' => 'none|whitelist|all',
                        'WhitelistedNames' => [
                            'Items' => ['<string>', ...],
                            'Quantity' => <integer>,
                        ],
                    ],
                    'Headers' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                    'QueryString' => true || false,
                    'QueryStringCacheKeys' => [
                        'Items' => ['<string>', ...],
                        'Quantity' => <integer>,
                    ],
                ],
                'LambdaFunctionAssociations' => [
                    'Items' => [
                        [
                            'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
                            'LambdaFunctionARN' => '<string>',
                        ],
                        // ...
                    ],
                    'Quantity' => <integer>,
                ],
                'MaxTTL' => <integer>,
                'MinTTL' => <integer>,
                'SmoothStreaming' => true || false,
                'TargetOriginId' => '<string>',
                'TrustedSigners' => [
                    'Enabled' => true || false,
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                ],
                'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
            ],
            'DefaultRootObject' => '<string>',
            'Enabled' => true || false,
            'HttpVersion' => 'http1.1|http2',
            'IsIPV6Enabled' => true || false,
            'Logging' => [
                'Bucket' => '<string>',
                'Enabled' => true || false,
                'IncludeCookies' => true || false,
                'Prefix' => '<string>',
            ],
            'Origins' => [
                'Items' => [
                    [
                        'CustomHeaders' => [
                            'Items' => [
                                [
                                    'HeaderName' => '<string>',
                                    'HeaderValue' => '<string>',
                                ],
                                // ...
                            ],
                            'Quantity' => <integer>,
                        ],
                        'CustomOriginConfig' => [
                            'HTTPPort' => <integer>,
                            'HTTPSPort' => <integer>,
                            'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
                            'OriginSslProtocols' => [
                                'Items' => ['<string>', ...],
                                'Quantity' => <integer>,
                            ],
                        ],
                        'DomainName' => '<string>',
                        'Id' => '<string>',
                        'OriginPath' => '<string>',
                        'S3OriginConfig' => [
                            'OriginAccessIdentity' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'Quantity' => <integer>,
            ],
            'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
            'Restrictions' => [
                'GeoRestriction' => [
                    'Items' => ['<string>', ...],
                    'Quantity' => <integer>,
                    'RestrictionType' => 'blacklist|whitelist|none',
                ],
            ],
            'ViewerCertificate' => [
                'ACMCertificateArn' => '<string>',
                'Certificate' => '<string>',
                'CertificateSource' => 'cloudfront|iam|acm',
                'CloudFrontDefaultCertificate' => true || false,
                'IAMCertificateId' => '<string>',
                'MinimumProtocolVersion' => 'SSLv3|TLSv1',
                'SSLSupportMethod' => 'sni-only|vip',
            ],
            'WebACLId' => '<string>',
        ],
        'DomainName' => '<string>',
        'Id' => '<string>',
        'InProgressInvalidationBatches' => <integer>,
        'LastModifiedTime' => <DateTime>,
        'Status' => '<string>',
    ],
    'ETag' => '<string>',
]

Result Details

Errors

AccessDenied:

Access denied.

CNAMEAlreadyExists:

This error does not currently have a description.

IllegalUpdate:

Origin and CallerReference cannot be updated.

InvalidIfMatchVersion:

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

MissingBody:

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

NoSuchDistribution:

The specified distribution does not exist.

PreconditionFailed:

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

TooManyDistributionCNAMEs:

Your request contains more CNAMEs than are allowed per distribution.

InvalidDefaultRootObject:

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

InvalidRelativePath:

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

InvalidErrorCode:

This error does not currently have a description.

InvalidResponseCode:

This error does not currently have a description.

InvalidArgument:

The argument is invalid.

InvalidOriginAccessIdentity:

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

TooManyTrustedSigners:

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

TrustedSignerDoesNotExist:

One or more of your trusted signers do not exist.

InvalidViewerCertificate:

This error does not currently have a description.

InvalidMinimumProtocolVersion:

This error does not currently have a description.

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.

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:

This error does not currently have a description.

InvalidHeadersForS3Origin:

This error does not currently have a description.

InconsistentQuantities:

The value of Quantity and the size of Items do not match.

TooManyCertificates:

You cannot create anymore custom SSL/TLS certificates.

InvalidLocationCode:

This error does not currently have a description.

InvalidGeoRestrictionParameter:

This error does not currently have a description.

InvalidTTLOrder:

This error does not currently have a description.

InvalidWebACLId:

This error does not currently have a description.

TooManyOriginCustomHeaders:

This error does not currently have a description.

TooManyQueryStringParameters:

This error does not currently have a description.

InvalidQueryStringParameters:

This error does not currently have a description.

TooManyDistributionsWithLambdaAssociations:

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

TooManyLambdaFunctionAssociations:

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

InvalidLambdaFunctionAssociation:

The specified Lambda function association is invalid.

UpdateStreamingDistribution

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

Update a streaming distribution.

Parameter Syntax

$result = $client->updateStreamingDistribution([
    'Id' => '<string>', // REQUIRED
    'IfMatch' => '<string>',
    'StreamingDistributionConfig' => [ // REQUIRED
        'Aliases' => [
            'Items' => ['<string>', ...],
            'Quantity' => <integer>, // REQUIRED
        ],
        'CallerReference' => '<string>', // REQUIRED
        'Comment' => '<string>', // REQUIRED
        'Enabled' => true || false, // REQUIRED
        'Logging' => [
            'Bucket' => '<string>', // REQUIRED
            'Enabled' => true || false, // REQUIRED
            'Prefix' => '<string>', // REQUIRED
        ],
        'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
        'S3Origin' => [ // REQUIRED
            'DomainName' => '<string>', // REQUIRED
            'OriginAccessIdentity' => '<string>', // REQUIRED
        ],
        'TrustedSigners' => [ // REQUIRED
            'Enabled' => true || false, // REQUIRED
            'Items' => ['<string>', ...],
            'Quantity' => <integer>, // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDenied:

Access denied.

CNAMEAlreadyExists:

This error does not currently have a description.

IllegalUpdate:

Origin and CallerReference cannot be updated.

InvalidIfMatchVersion:

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

MissingBody:

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

NoSuchStreamingDistribution:

The specified streaming distribution does not exist.

PreconditionFailed:

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

TooManyStreamingDistributionCNAMEs:

This error does not currently have a description.

InvalidArgument:

The argument is invalid.

InvalidOriginAccessIdentity:

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

TooManyTrustedSigners:

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

TrustedSignerDoesNotExist:

One or more of your trusted signers do not exist.

InconsistentQuantities:

The value of Quantity and the size of Items do not match.