SDK for PHP 3.x

Client: Aws\CloudFront\CloudFrontClient
Service ID: cloudfront
Version: 2016-08-01

This page describes the parameters and results for the operations of the Amazon CloudFront (2016-08-01), and shows how to use the Aws\CloudFront\CloudFrontClient object to call the described operations. This documentation is specific to the 2016-08-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateCloudFrontOriginAccessIdentity ( array $params = [] )
Create a new origin access identity.
CreateDistribution ( array $params = [] )
Create a new distribution.
CreateDistributionWithTags ( array $params = [] )
Create a new distribution with tags.
CreateInvalidation ( array $params = [] )
Create a new invalidation.
CreateStreamingDistribution ( array $params = [] )
Create a new streaming distribution.
CreateStreamingDistributionWithTags ( array $params = [] )
Create a new streaming distribution with tags.
DeleteCloudFrontOriginAccessIdentity ( array $params = [] )
Delete an origin access identity.
DeleteDistribution ( array $params = [] )
Delete a distribution.
DeleteStreamingDistribution ( array $params = [] )
Delete a streaming distribution.
GetCloudFrontOriginAccessIdentity ( array $params = [] )
Get the information about an origin access identity.
GetCloudFrontOriginAccessIdentityConfig ( array $params = [] )
Get the configuration information about an origin access identity.
GetDistribution ( array $params = [] )
Get the information about a distribution.
GetDistributionConfig ( array $params = [] )
Get the configuration information about a distribution.
GetInvalidation ( array $params = [] )
Get the information about an invalidation.
GetStreamingDistribution ( array $params = [] )
Get the information about a streaming distribution.
GetStreamingDistributionConfig ( array $params = [] )
Get the configuration information about a streaming distribution.
ListCloudFrontOriginAccessIdentities ( array $params = [] )
List origin access identities.
ListDistributions ( array $params = [] )
List distributions.
ListDistributionsByWebACLId ( array $params = [] )
List the distributions that are associated with a specified AWS WAF web ACL.
ListInvalidations ( array $params = [] )
List invalidation batches.
ListStreamingDistributions ( array $params = [] )
List streaming distributions.
ListTagsForResource ( array $params = [] )
List tags for a CloudFront resource.
TagResource ( array $params = [] )
Add tags to a CloudFront resource.
UntagResource ( array $params = [] )
Remove tags from a CloudFront resource.
UpdateCloudFrontOriginAccessIdentity ( array $params = [] )
Update an origin access identity.
UpdateDistribution ( array $params = [] )
Update a distribution.
UpdateStreamingDistribution ( array $params = [] )
Update a streaming distribution.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListCloudFrontOriginAccessIdentities
ListDistributions
ListInvalidations
ListStreamingDistributions

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
DistributionDeployed GetDistribution 60 25
InvalidationCompleted GetInvalidation 20 30
StreamingDistributionDeployed GetStreamingDistribution 60 25

Operations

CreateCloudFrontOriginAccessIdentity

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

Create a new origin access identity.

Parameter Syntax

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

Parameter Details

Members
CloudFrontOriginAccessIdentityConfig
Required: Yes
Type: CloudFrontOriginAccessIdentityConfig structure
The origin access identity's configuration information.

Result Syntax

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

Result Details

Members
CloudFrontOriginAccessIdentity
The origin access identity's information.
ETag
Type: string
The current version of the origin access identity created.
Location
Type: string
The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

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

Create a new distribution.

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
                    ],
                    '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
            ],
            '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
        '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

Members
DistributionConfig
Required: Yes
Type: DistributionConfig structure
The distribution's configuration information.

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,
                        ],
                        '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,
                ],
                '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,
            '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

Members
Distribution
Type: Distribution structure
The distribution's information.
ETag
Type: string
The current version of the distribution created.
Location
Type: string
The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

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 anymore origins for the distribution.
TooManyCacheBehaviors:
You cannot create anymore 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 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.

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
                        ],
                        '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
                ],
                '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
            '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

Members
DistributionConfigWithTags
Required: Yes
Type: DistributionConfigWithTags structure
The distribution's configuration information.

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,
                        ],
                        '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,
                ],
                '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,
            '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

Members
Distribution
Type: Distribution structure
The distribution's information.
ETag
Type: string
The current version of the distribution created.
Location
Type: string
The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

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 anymore origins for the distribution.
TooManyCacheBehaviors:
You cannot create anymore 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 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:
The specified tagging for a CloudFront resource is invalid. For more information, see the error text.

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

Members
DistributionId
Required: Yes
Type: string
The distribution's id.
InvalidationBatch
Required: Yes
Type: InvalidationBatch structure
The batch information for the invalidation.

Result Syntax

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

Result Details

Members
Invalidation
Type: Invalidation structure
The invalidation's information.
Location
Type: string
The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

Errors

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

Create a new streaming distribution.

Parameter Syntax

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

Parameter Details

Members
StreamingDistributionConfig
Required: Yes
Type: StreamingDistributionConfig structure
The streaming distribution's configuration information.

Result Syntax

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

Result Details

Members
ETag
Type: string
The current version of the streaming distribution created.
Location
Type: string
The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.
StreamingDistribution
Type: StreamingDistribution structure
The streaming distribution's information.

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

Members
StreamingDistributionConfigWithTags
Required: Yes
Type: StreamingDistributionConfigWithTags structure
The streaming distribution's configuration information.

Result Syntax

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

Result Details

Members
ETag
Type: string
The current version of the streaming distribution created.
Location
Type: string
The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.
StreamingDistribution
Type: StreamingDistribution structure
The streaming distribution's information.

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:
The specified tagging for a CloudFront resource is invalid. For more information, see the error text.

DeleteCloudFrontOriginAccessIdentity

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

Delete an origin access identity.

Parameter Syntax

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

Parameter Details

Members
Id
Required: Yes
Type: string
The origin access identity's id.
IfMatch
Type: string
The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
Id
Required: Yes
Type: string
The distribution id.
IfMatch
Type: string
The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

Parameter Syntax

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

Parameter Details

Members
Id
Required: Yes
Type: string
The distribution id.
IfMatch
Type: string
The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
Id
Required: Yes
Type: string
The identity's id.

Result Syntax

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

Result Details

Members
CloudFrontOriginAccessIdentity
The origin access identity's information.
ETag
Type: string
The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

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

Members
Id
Required: Yes
Type: string
The identity's id.

Result Syntax

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

Result Details

Members
CloudFrontOriginAccessIdentityConfig
The origin access identity's configuration information.
ETag
Type: string
The current version of the configuration. For example: E2QWRUHAPOMQZL.

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

Members
Id
Required: Yes
Type: string
The distribution's id.

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,
                        ],
                        '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,
                ],
                '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,
            '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

Members
Distribution
Type: Distribution structure
The distribution's information.
ETag
Type: string
The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

Errors

NoSuchDistribution:
The specified distribution does not exist.
AccessDenied:
Access denied.

GetDistributionConfig

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

Get the configuration information about a distribution.

Parameter Syntax

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

Parameter Details

Members
Id
Required: Yes
Type: string
The distribution's id.

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,
                    ],
                    '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,
            ],
            '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,
        '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

Members
DistributionConfig
Type: DistributionConfig structure
The distribution's configuration information.
ETag
Type: string
The current version of the configuration. For example: E2QWRUHAPOMQZL.

Errors

NoSuchDistribution:
The specified distribution does not exist.
AccessDenied:
Access denied.

GetInvalidation

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

Get the information about an invalidation.

Parameter Syntax

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

Parameter Details

Members
DistributionId
Required: Yes
Type: string
The distribution's id.
Id
Required: Yes
Type: string
The invalidation's id.

Result Syntax

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

Result Details

Members
Invalidation
Type: Invalidation structure
The invalidation's information.

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

Get the information about a streaming distribution.

Parameter Syntax

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

Parameter Details

Members
Id
Required: Yes
Type: string
The streaming distribution's id.

Result Syntax

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

Result Details

Members
ETag
Type: string
The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.
StreamingDistribution
Type: StreamingDistribution structure
The streaming distribution's information.

Errors

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

Members
Id
Required: Yes
Type: string
The streaming distribution's id.

Result Syntax

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

Result Details

Members
ETag
Type: string
The current version of the configuration. For example: E2QWRUHAPOMQZL.
StreamingDistributionConfig
Type: StreamingDistributionConfig structure
The streaming distribution's configuration information.

Errors

NoSuchStreamingDistribution:
The specified streaming distribution does not exist.
AccessDenied:
Access denied.

ListCloudFrontOriginAccessIdentities

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

List origin access identities.

Parameter Syntax

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

Parameter Details

Members
Marker
Type: string
Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).
MaxItems
Type: string
The maximum number of origin access identities you want in the response body.

Result Syntax

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

Result Details

Members
CloudFrontOriginAccessIdentityList
The CloudFrontOriginAccessIdentityList type.

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

Members
Marker
Type: string
Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)
MaxItems
Type: string
The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

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,
                            ],
                            '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,
                    ],
                    '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,
                'Id' => '<string>',
                '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

Members
DistributionList
Type: DistributionList structure
The DistributionList type.

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

Members
Marker
Type: string
Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)
MaxItems
Type: string
The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
WebACLId
Required: Yes
Type: string
The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify "null" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.

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,
                            ],
                            '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,
                    ],
                    '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,
                'Id' => '<string>',
                '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

Members
DistributionList
Type: DistributionList structure
The DistributionList type.

Errors

InvalidArgument:
The argument is invalid.
InvalidWebACLId:
This error does not currently have a description.

ListInvalidations

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

List invalidation batches.

Parameter Syntax

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

Parameter Details

Members
DistributionId
Required: Yes
Type: string
The distribution's id.
Marker
Type: string
Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.
MaxItems
Type: string
The maximum number of invalidation batches you want in the response body.

Result Syntax

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

Result Details

Members
InvalidationList
Type: InvalidationList structure
Information about invalidation batches.

Errors

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

Members
Marker
Type: string
Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).
MaxItems
Type: string
The maximum number of streaming distributions you want in the response body.

Result Syntax

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

Result Details

Members
StreamingDistributionList
Type: StreamingDistributionList structure
The StreamingDistributionList type.

Errors

InvalidArgument:
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

Members
Resource
Required: Yes
Type: string
An ARN of a CloudFront resource.

Result Syntax

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

Result Details

Members
Tags
Required: Yes
Type: Tags structure
A complex type that contains zero or more Tag elements.

Errors

AccessDenied:
Access denied.
InvalidArgument:
The argument is invalid.
InvalidTagging:
The specified tagging for a CloudFront resource is invalid. For more information, see the error text.
NoSuchResource:
The specified CloudFront resource does not exist.

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

Members
Resource
Required: Yes
Type: string
An ARN of a CloudFront resource.
Tags
Required: Yes
Type: Tags structure
A complex type that contains zero or more Tag elements.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDenied:
Access denied.
InvalidArgument:
The argument is invalid.
InvalidTagging:
The specified tagging for a CloudFront resource is invalid. For more information, see the error text.
NoSuchResource:
The specified CloudFront resource does not exist.

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

Members
Resource
Required: Yes
Type: string
An ARN of a CloudFront resource.
TagKeys
Required: Yes
Type: TagKeys structure
A complex type that contains zero or more Tag key elements.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDenied:
Access denied.
InvalidArgument:
The argument is invalid.
InvalidTagging:
The specified tagging for a CloudFront resource is invalid. For more information, see the error text.
NoSuchResource:
The specified CloudFront resource does not exist.

UpdateCloudFrontOriginAccessIdentity

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

Update an origin access identity.

Parameter Syntax

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

Parameter Details

Members
CloudFrontOriginAccessIdentityConfig
Required: Yes
Type: CloudFrontOriginAccessIdentityConfig structure
The identity's configuration information.
Id
Required: Yes
Type: string
The identity's id.
IfMatch
Type: string
The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

Result Syntax

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

Result Details

Members
CloudFrontOriginAccessIdentity
The origin access identity's information.
ETag
Type: string
The current version of the configuration. For example: E2QWRUHAPOMQZL.

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
                    ],
                    '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
            ],
            '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
        '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

Members
DistributionConfig
Required: Yes
Type: DistributionConfig structure
The distribution's configuration information.
Id
Required: Yes
Type: string
The distribution's id.
IfMatch
Type: string
The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

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,
                        ],
                        '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,
                ],
                '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,
            '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

Members
Distribution
Type: Distribution structure
The distribution's information.
ETag
Type: string
The current version of the configuration. For example: E2QWRUHAPOMQZL.

Errors

AccessDenied:
Access denied.
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 anymore origins for the distribution.
TooManyCacheBehaviors:
You cannot create anymore 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 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.

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

Members
Id
Required: Yes
Type: string
The streaming distribution's id.
IfMatch
Type: string
The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.
StreamingDistributionConfig
Required: Yes
Type: StreamingDistributionConfig structure
The streaming distribution's configuration information.

Result Syntax

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

Result Details

Members
ETag
Type: string
The current version of the configuration. For example: E2QWRUHAPOMQZL.
StreamingDistribution
Type: StreamingDistribution structure
The streaming distribution's information.

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.

Shapes

AccessDenied

Description
Access denied.
Members
Message
Type: string

ActiveTrustedSigners

Description
A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content.
Members
Enabled
Required: Yes
Type: boolean
Each active trusted signer.
Items
Type: Array of Signer structures
A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors.
Quantity
Required: Yes
Type: int
The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3.

Aliases

Description
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
Members
Items
Type: Array of strings
Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.
Quantity
Required: Yes
Type: int
The number of CNAMEs, if any, for this distribution.

AllowedMethods

Description
A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin.
Members
CachedMethods
Type: CachedMethods structure
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly.
Items
Required: Yes
Type: Array of strings
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
Quantity
Required: Yes
Type: int
The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

BatchTooLarge

Members
Message
Type: string

CNAMEAlreadyExists

Members
Message
Type: string

CacheBehavior

Description
A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.
Members
AllowedMethods
Type: AllowedMethods structure
A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin.
Compress
Type: boolean
Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version.
DefaultTTL
Type: long (int|float)
If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).
ForwardedValues
Required: Yes
Type: ForwardedValues structure
A complex type that specifies how CloudFront handles query strings, cookies and headers.
MaxTTL
Type: long (int|float)
The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).
MinTTL
Required: Yes
Type: long (int|float)
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years).
PathPattern
Required: Yes
Type: string
The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.
SmoothStreaming
Type: boolean
Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false.
TargetOriginId
Required: Yes
Type: string
The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.
TrustedSigners
Required: Yes
Type: TrustedSigners structure
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
ViewerProtocolPolicy
Required: Yes
Type: string
Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL.

CacheBehaviors

Description
A complex type that contains zero or more CacheBehavior elements.
Members
Items
Type: Array of CacheBehavior structures
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.
Quantity
Required: Yes
Type: int
The number of cache behaviors for this distribution.

CachedMethods

Description
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly.
Members
Items
Required: Yes
Type: Array of strings
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
Quantity
Required: Yes
Type: int
The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

CloudFrontOriginAccessIdentity

Description
CloudFront origin access identity.
Members
CloudFrontOriginAccessIdentityConfig
The current configuration information for the identity.
Id
Required: Yes
Type: string
The ID for the origin access identity. For example: E74FTE3AJFJ256A.
S3CanonicalUserId
Required: Yes
Type: string
The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

CloudFrontOriginAccessIdentityAlreadyExists

Description
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.
Members
Message
Type: string

CloudFrontOriginAccessIdentityConfig

Description
Origin access identity configuration.
Members
CallerReference
Required: Yes
Type: string
A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. 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.
Comment
Required: Yes
Type: string
Any comments you want to include about the origin access identity.

CloudFrontOriginAccessIdentityInUse

Members
Message
Type: string

CloudFrontOriginAccessIdentityList

Description
The CloudFrontOriginAccessIdentityList type.
Members
IsTruncated
Required: Yes
Type: boolean
A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.
Items
Type: Array of CloudFrontOriginAccessIdentitySummary structures
A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.
Marker
Required: Yes
Type: string
The value you provided for the Marker request parameter.
MaxItems
Required: Yes
Type: int
The value you provided for the MaxItems request parameter.
NextMarker
Type: string
If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.
Quantity
Required: Yes
Type: int
The number of CloudFront origin access identities that were created by the current AWS account.

CloudFrontOriginAccessIdentitySummary

Description
Summary of the information about a CloudFront origin access identity.
Members
Comment
Required: Yes
Type: string
The comment for this origin access identity, as originally specified when created.
Id
Required: Yes
Type: string
The ID for the origin access identity. For example: E74FTE3AJFJ256A.
S3CanonicalUserId
Required: Yes
Type: string
The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

CookieNames

Description
A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior.
Members
Items
Type: Array of strings
Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items.
Quantity
Required: Yes
Type: int
The number of whitelisted cookies for this cache behavior.

CookiePreference

Description
A complex type that specifies the cookie preferences associated with this cache behavior.
Members
Forward
Required: Yes
Type: string
Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses.
WhitelistedNames
Type: CookieNames structure
A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior.

CustomErrorResponse

Description
A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution.
Members
ErrorCachingMinTTL
Type: long (int|float)
The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000.
ErrorCode
Required: Yes
Type: int
The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation.
ResponseCode
Type: string
The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation.
ResponsePagePath
Type: string
The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer.

CustomErrorResponses

Description
A complex type that contains zero or more CustomErrorResponse elements.
Members
Items
Type: Array of CustomErrorResponse structures
Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items.
Quantity
Required: Yes
Type: int
The number of custom error responses for this distribution.

CustomHeaders

Description
A complex type that contains the list of Custom Headers for each origin.
Members
Items
Type: Array of OriginCustomHeader structures
A complex type that contains the custom headers for this Origin.
Quantity
Required: Yes
Type: int
The number of custom headers for this origin.

CustomOriginConfig

Description
A customer origin.
Members
HTTPPort
Required: Yes
Type: int
The HTTP port the custom origin listens on.
HTTPSPort
Required: Yes
Type: int
The HTTPS port the custom origin listens on.
OriginProtocolPolicy
Required: Yes
Type: string
The origin protocol policy to apply to your origin.
OriginSslProtocols
Type: OriginSslProtocols structure
The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

DefaultCacheBehavior

Description
A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior.
Members
AllowedMethods
Type: AllowedMethods structure
A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin.
Compress
Type: boolean
Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version.
DefaultTTL
Type: long (int|float)
If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).
ForwardedValues
Required: Yes
Type: ForwardedValues structure
A complex type that specifies how CloudFront handles query strings, cookies and headers.
MaxTTL
Type: long (int|float)
The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).
MinTTL
Required: Yes
Type: long (int|float)
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years).
SmoothStreaming
Type: boolean
Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false.
TargetOriginId
Required: Yes
Type: string
The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.
TrustedSigners
Required: Yes
Type: TrustedSigners structure
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
ViewerProtocolPolicy
Required: Yes
Type: string
Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL.

Distribution

Description
A distribution.
Members
ARN
Required: Yes
Type: string
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id.
ActiveTrustedSigners
Required: Yes
Type: ActiveTrustedSigners structure
CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.
DistributionConfig
Required: Yes
Type: DistributionConfig structure
The current configuration information for the distribution.
DomainName
Required: Yes
Type: string
The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.
Id
Required: Yes
Type: string
The identifier for the distribution. For example: EDFDVBD632BHDS5.
InProgressInvalidationBatches
Required: Yes
Type: int
The number of invalidation batches currently in progress.
LastModifiedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the distribution was last modified.
Status
Required: Yes
Type: string
This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

DistributionAlreadyExists

Description
The caller reference you attempted to create the distribution with is associated with another distribution.
Members
Message
Type: string

DistributionConfig

Description
A distribution Configuration.
Members
Aliases
Type: Aliases structure
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
CacheBehaviors
Type: CacheBehaviors structure
A complex type that contains zero or more CacheBehavior elements.
CallerReference
Required: Yes
Type: string
A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.
Comment
Required: Yes
Type: string
Any comments you want to include about the distribution.
CustomErrorResponses
Type: CustomErrorResponses structure
A complex type that contains zero or more CustomErrorResponse elements.
DefaultCacheBehavior
Required: Yes
Type: DefaultCacheBehavior structure
A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior.
DefaultRootObject
Type: string
The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object.
Enabled
Required: Yes
Type: boolean
Whether the distribution is enabled to accept end user requests for content.
Logging
Type: LoggingConfig structure
A complex type that controls whether access logs are written for the distribution.
Origins
Required: Yes
Type: Origins structure
A complex type that contains information about origins for this distribution.
PriceClass
Type: string
A complex type that contains information about price class for this distribution.
Restrictions
Type: Restrictions structure
A complex type that identifies ways in which you want to restrict distribution of your content.
ViewerCertificate
Type: ViewerCertificate structure
A complex type that contains information about viewer certificates for this distribution.
WebACLId
Type: string
(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution.

DistributionConfigWithTags

Description
A distribution Configuration and a list of tags to be associated with the distribution.
Members
DistributionConfig
Required: Yes
Type: DistributionConfig structure
A distribution Configuration.
Tags
Required: Yes
Type: Tags structure
A complex type that contains zero or more Tag elements.

DistributionList

Description
A distribution list.
Members
IsTruncated
Required: Yes
Type: boolean
A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.
Items
Type: Array of DistributionSummary structures
A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.
Marker
Required: Yes
Type: string
The value you provided for the Marker request parameter.
MaxItems
Required: Yes
Type: int
The value you provided for the MaxItems request parameter.
NextMarker
Type: string
If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.
Quantity
Required: Yes
Type: int
The number of distributions that were created by the current AWS account.

DistributionNotDisabled

Members
Message
Type: string

DistributionSummary

Description
A summary of the information for an Amazon CloudFront distribution.
Members
ARN
Required: Yes
Type: string
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id.
Aliases
Required: Yes
Type: Aliases structure
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
CacheBehaviors
Required: Yes
Type: CacheBehaviors structure
A complex type that contains zero or more CacheBehavior elements.
Comment
Required: Yes
Type: string
The comment originally specified when this distribution was created.
CustomErrorResponses
Required: Yes
Type: CustomErrorResponses structure
A complex type that contains zero or more CustomErrorResponses elements.
DefaultCacheBehavior
Required: Yes
Type: DefaultCacheBehavior structure
A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior.
DomainName
Required: Yes
Type: string
The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.
Enabled
Required: Yes
Type: boolean
Whether the distribution is enabled to accept end user requests for content.
Id
Required: Yes
Type: string
The identifier for the distribution. For example: EDFDVBD632BHDS5.
LastModifiedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the distribution was last modified.
Origins
Required: Yes
Type: Origins structure
A complex type that contains information about origins for this distribution.
PriceClass
Required: Yes
Type: string
Restrictions
Required: Yes
Type: Restrictions structure
A complex type that identifies ways in which you want to restrict distribution of your content.
Status
Required: Yes
Type: string
This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.
ViewerCertificate
Required: Yes
Type: ViewerCertificate structure
A complex type that contains information about viewer certificates for this distribution.
WebACLId
Required: Yes
Type: string
The Web ACL Id (if any) associated with the distribution.

ForwardedValues

Description
A complex type that specifies how CloudFront handles query strings, cookies and headers.
Members
Cookies
Required: Yes
Type: CookiePreference structure
A complex type that specifies how CloudFront handles cookies.
Headers
Type: Headers structure
A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior.
QueryString
Required: Yes
Type: boolean
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false.

GeoRestriction

Description
A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website.
Members
Items
Type: Array of strings
A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes.
Quantity
Required: Yes
Type: int
When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.
RestrictionType
Required: Yes
Type: string
The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

Headers

Description
A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value.
Members
Items
Type: Array of strings
Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items.
Quantity
Required: Yes
Type: int
The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items.

IllegalUpdate

Description
Origin and CallerReference cannot be updated.
Members
Message
Type: string

InconsistentQuantities

Description
The value of Quantity and the size of Items do not match.
Members
Message
Type: string

InvalidArgument

Description
The argument is invalid.
Members
Message
Type: string

InvalidDefaultRootObject

Description
The default root object file name is too big or contains an invalid character.
Members
Message
Type: string

InvalidErrorCode

Members
Message
Type: string

InvalidForwardCookies

Description
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.
Members
Message
Type: string

InvalidGeoRestrictionParameter

Members
Message
Type: string

InvalidHeadersForS3Origin

Members
Message
Type: string

InvalidIfMatchVersion

Description
The If-Match version is missing or not valid for the distribution.
Members
Message
Type: string

InvalidLocationCode

Members
Message
Type: string

InvalidMinimumProtocolVersion

Members
Message
Type: string

InvalidOrigin

Description
The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
Members
Message
Type: string

InvalidOriginAccessIdentity

Description
The origin access identity is not valid or doesn't exist.
Members
Message
Type: string

InvalidProtocolSettings

Description
You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).
Members
Message
Type: string

InvalidRelativePath

Description
The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
Members
Message
Type: string

InvalidRequiredProtocol

Description
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.
Members
Message
Type: string

InvalidResponseCode

Members
Message
Type: string

InvalidTTLOrder

Members
Message
Type: string

InvalidTagging

Description
The specified tagging for a CloudFront resource is invalid. For more information, see the error text.
Members
Message
Type: string

InvalidViewerCertificate

Members
Message
Type: string

InvalidWebACLId

Members
Message
Type: string

Invalidation

Description
An invalidation.
Members
CreateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the invalidation request was first made.
Id
Required: Yes
Type: string
The identifier for the invalidation request. For example: IDFDVBD632BHDS5.
InvalidationBatch
Required: Yes
Type: InvalidationBatch structure
The current invalidation information for the batch request.
Status
Required: Yes
Type: string
The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

InvalidationBatch

Description
An invalidation batch.
Members
CallerReference
Required: Yes
Type: string
A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.
Paths
Required: Yes
Type: Paths structure
The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object.

InvalidationList

Description
An invalidation list.
Members
IsTruncated
Required: Yes
Type: boolean
A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.
Items
Type: Array of InvalidationSummary structures
A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account.
Marker
Required: Yes
Type: string
The value you provided for the Marker request parameter.
MaxItems
Required: Yes
Type: int
The value you provided for the MaxItems request parameter.
NextMarker
Type: string
If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off.
Quantity
Required: Yes
Type: int
The number of invalidation batches that were created by the current AWS account.

InvalidationSummary

Description
Summary of an invalidation request.
Members
CreateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
Id
Required: Yes
Type: string
The unique ID for an invalidation request.
Status
Required: Yes
Type: string
The status of an invalidation request.

KeyPairIds

Description
A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.
Members
Items
Type: Array of strings
A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.
Quantity
Required: Yes
Type: int
The number of active CloudFront key pairs for AwsAccountNumber.

LoggingConfig

Description
A complex type that controls whether access logs are written for the distribution.
Members
Bucket
Required: Yes
Type: string
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
Enabled
Required: Yes
Type: boolean
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted.
IncludeCookies
Required: Yes
Type: boolean
Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.
Prefix
Required: Yes
Type: string
An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

MissingBody

Description
This operation requires a body. Ensure that the body is present and the Content-Type header is set.
Members
Message
Type: string

NoSuchCloudFrontOriginAccessIdentity

Description
The specified origin access identity does not exist.
Members
Message
Type: string

NoSuchDistribution

Description
The specified distribution does not exist.
Members
Message
Type: string

NoSuchInvalidation

Description
The specified invalidation does not exist.
Members
Message
Type: string

NoSuchOrigin

Description
No origin exists with the specified Origin Id.
Members
Message
Type: string

NoSuchResource

Description
The specified CloudFront resource does not exist.
Members
Message
Type: string

NoSuchStreamingDistribution

Description
The specified streaming distribution does not exist.
Members
Message
Type: string

Origin

Description
A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin.
Members
CustomHeaders
Type: CustomHeaders structure
A complex type that contains information about the custom headers associated with this Origin.
CustomOriginConfig
Type: CustomOriginConfig structure
A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.
DomainName
Required: Yes
Type: string
Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.
Id
Required: Yes
Type: string
A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior.
OriginPath
Type: string
An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName.
S3OriginConfig
Type: S3OriginConfig structure
A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

OriginCustomHeader

Description
A complex type that contains information related to a Header
Members
HeaderName
Required: Yes
Type: string
The header's name.
HeaderValue
Required: Yes
Type: string
The header's value.

OriginSslProtocols

Description
A complex type that contains the list of SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.
Members
Items
Required: Yes
Type: Array of strings
A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
Quantity
Required: Yes
Type: int
The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

Origins

Description
A complex type that contains information about origins for this distribution.
Members
Items
Type: Array of Origin structures
A complex type that contains origins for this distribution.
Quantity
Required: Yes
Type: int
The number of origins for this distribution.

Paths

Description
A complex type that contains information about the objects that you want to invalidate.
Members
Items
Type: Array of strings
A complex type that contains a list of the objects that you want to invalidate.
Quantity
Required: Yes
Type: int
The number of objects that you want to invalidate.

PreconditionFailed

Description
The precondition given in one or more of the request-header fields evaluated to false.
Members
Message
Type: string

Restrictions

Description
A complex type that identifies ways in which you want to restrict distribution of your content.
Members
GeoRestriction
Required: Yes
Type: GeoRestriction structure
A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website.

S3Origin

Description
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
Members
DomainName
Required: Yes
Type: string
The DNS name of the S3 origin.
OriginAccessIdentity
Required: Yes
Type: string
Your S3 origin's origin access identity.

S3OriginConfig

Description
A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.
Members
OriginAccessIdentity
Required: Yes
Type: string
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity.

Signer

Description
A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.
Members
AwsAccountNumber
Type: string
Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number.
KeyPairIds
Type: KeyPairIds structure
A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

StreamingDistribution

Description
A streaming distribution.
Members
ARN
Required: Yes
Type: string
The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id.
ActiveTrustedSigners
Required: Yes
Type: ActiveTrustedSigners structure
CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.
DomainName
Required: Yes
Type: string
The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.
Id
Required: Yes
Type: string
The identifier for the streaming distribution. For example: EGTXBD79H29TRA8.
LastModifiedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the distribution was last modified.
Status
Required: Yes
Type: string
The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.
StreamingDistributionConfig
Required: Yes
Type: StreamingDistributionConfig structure
The current configuration information for the streaming distribution.

StreamingDistributionAlreadyExists

Members
Message
Type: string

StreamingDistributionConfig

Description
The configuration for the streaming distribution.
Members
Aliases
Type: Aliases structure
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
CallerReference
Required: Yes
Type: string
A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.
Comment
Required: Yes
Type: string
Any comments you want to include about the streaming distribution.
Enabled
Required: Yes
Type: boolean
Whether the streaming distribution is enabled to accept end user requests for content.
Logging
Type: StreamingLoggingConfig structure
A complex type that controls whether access logs are written for the streaming distribution.
PriceClass
Type: string
A complex type that contains information about price class for this streaming distribution.
S3Origin
Required: Yes
Type: S3Origin structure
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
TrustedSigners
Required: Yes
Type: TrustedSigners structure
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

StreamingDistributionConfigWithTags

Description
A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.
Members
StreamingDistributionConfig
Required: Yes
Type: StreamingDistributionConfig structure
A streaming distribution Configuration.
Tags
Required: Yes
Type: Tags structure
A complex type that contains zero or more Tag elements.

StreamingDistributionList

Description
A streaming distribution list.
Members
IsTruncated
Required: Yes
Type: boolean
A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.
Items
Type: Array of StreamingDistributionSummary structures
A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.
Marker
Required: Yes
Type: string
The value you provided for the Marker request parameter.
MaxItems
Required: Yes
Type: int
The value you provided for the MaxItems request parameter.
NextMarker
Type: string
If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off.
Quantity
Required: Yes
Type: int
The number of streaming distributions that were created by the current AWS account.

StreamingDistributionNotDisabled

Members
Message
Type: string

StreamingDistributionSummary

Description
A summary of the information for an Amazon CloudFront streaming distribution.
Members
ARN
Required: Yes
Type: string
The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id.
Aliases
Required: Yes
Type: Aliases structure
A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
Comment
Required: Yes
Type: string
The comment originally specified when this distribution was created.
DomainName
Required: Yes
Type: string
The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.
Enabled
Required: Yes
Type: boolean
Whether the distribution is enabled to accept end user requests for content.
Id
Required: Yes
Type: string
The identifier for the distribution. For example: EDFDVBD632BHDS5.
LastModifiedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the distribution was last modified.
PriceClass
Required: Yes
Type: string
S3Origin
Required: Yes
Type: S3Origin structure
A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
Status
Required: Yes
Type: string
Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.
TrustedSigners
Required: Yes
Type: TrustedSigners structure
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

StreamingLoggingConfig

Description
A complex type that controls whether access logs are written for this streaming distribution.
Members
Bucket
Required: Yes
Type: string
The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
Enabled
Required: Yes
Type: boolean
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.
Prefix
Required: Yes
Type: string
An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

Tag

Description
A complex type that contains Tag key and Tag value.
Members
Key
Required: Yes
Type: string
A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
Value
Type: string
A string that contains an optional Tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

TagKeys

Description
A complex type that contains zero or more Tag elements.
Members
Items
Type: Array of strings
A complex type that contains Tag key elements

Tags

Description
A complex type that contains zero or more Tag elements.
Members
Items
Type: Array of Tag structures
A complex type that contains Tag elements

TooManyCacheBehaviors

Description
You cannot create anymore cache behaviors for the distribution.
Members
Message
Type: string

TooManyCertificates

Description
You cannot create anymore custom ssl certificates.
Members
Message
Type: string

TooManyCloudFrontOriginAccessIdentities

Description
Processing your request would cause you to exceed the maximum number of origin access identities allowed.
Members
Message
Type: string

TooManyCookieNamesInWhiteList

Description
Your request contains more cookie names in the whitelist than are allowed per cache behavior.
Members
Message
Type: string

TooManyDistributionCNAMEs

Description
Your request contains more CNAMEs than are allowed per distribution.
Members
Message
Type: string

TooManyDistributions

Description
Processing your request would cause you to exceed the maximum number of distributions allowed.
Members
Message
Type: string

TooManyHeadersInForwardedValues

Members
Message
Type: string

TooManyInvalidationsInProgress

Description
You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.
Members
Message
Type: string

TooManyOriginCustomHeaders

Members
Message
Type: string

TooManyOrigins

Description
You cannot create anymore origins for the distribution.
Members
Message
Type: string

TooManyStreamingDistributionCNAMEs

Members
Message
Type: string

TooManyStreamingDistributions

Description
Processing your request would cause you to exceed the maximum number of streaming distributions allowed.
Members
Message
Type: string

TooManyTrustedSigners

Description
Your request contains more trusted signers than are allowed per distribution.
Members
Message
Type: string

TrustedSignerDoesNotExist

Description
One or more of your trusted signers do not exist.
Members
Message
Type: string

TrustedSigners

Description
A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
Members
Enabled
Required: Yes
Type: boolean
Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId.
Items
Type: Array of strings
Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.
Quantity
Required: Yes
Type: int
The number of trusted signers for this cache behavior.

ViewerCertificate

Description
A complex type that contains information about viewer certificates for this distribution.
Members
ACMCertificateArn
Type: string
If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate.
Certificate
Type: string
Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].
CertificateSource
Type: string
Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].
CloudFrontDefaultCertificate
Type: boolean
If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId.
IAMCertificateId
Type: string
If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate.
MinimumProtocolVersion
Type: string
Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion.
SSLSupportMethod
Type: string
If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate.