Class CloudFrontClient
Client to interact with Amazon CloudFront
- Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
- Guzzle\Http\Client implements Guzzle\Http\ClientInterface
- Guzzle\Service\Client implements Guzzle\Service\ClientInterface
- Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
- Aws\CloudFront_2012_05_05\CloudFrontClient
Link: User guide
Link: API docs
Located at Aws/CloudFront_2012_05_05/CloudFrontClient.php
Methods summary
-
public static
factory ( array|Collection $config = array() )
Factory method to create a new Amazon CloudFront client using an array of configuration options.
-
public
createCloudFrontOriginAccessIdentity ( array $args = array() )
Executes the CreateCloudFrontOriginAccessIdentity operation.
-
public
createDistribution ( array $args = array() )
Executes the CreateDistribution operation.
-
public
createInvalidation ( array $args = array() )
Executes the CreateInvalidation operation.
-
public
createStreamingDistribution ( array $args = array() )
Executes the CreateStreamingDistribution operation.
-
public
deleteCloudFrontOriginAccessIdentity ( array $args = array() )
Executes the DeleteCloudFrontOriginAccessIdentity operation.
-
public
deleteDistribution ( array $args = array() )
Executes the DeleteDistribution operation.
-
public
deleteStreamingDistribution ( array $args = array() )
Executes the DeleteStreamingDistribution operation.
-
public
getCloudFrontOriginAccessIdentity ( array $args = array() )
Executes the GetCloudFrontOriginAccessIdentity operation.
-
public
getCloudFrontOriginAccessIdentityConfig ( array $args = array() )
Executes the GetCloudFrontOriginAccessIdentityConfig operation.
-
public
getDistribution ( array $args = array() )
Executes the GetDistribution operation.
-
public
getDistributionConfig ( array $args = array() )
Executes the GetDistributionConfig operation.
-
public
getInvalidation ( array $args = array() )
Executes the GetInvalidation operation.
-
public
getStreamingDistribution ( array $args = array() )
Executes the GetStreamingDistribution operation.
-
public
getStreamingDistributionConfig ( array $args = array() )
Executes the GetStreamingDistributionConfig operation.
-
public
listCloudFrontOriginAccessIdentities ( array $args = array() )
Executes the ListCloudFrontOriginAccessIdentities operation.
-
public
listDistributions ( array $args = array() )
Executes the ListDistributions operation.
-
public
listInvalidations ( array $args = array() )
Executes the ListInvalidations operation.
-
public
listStreamingDistributions ( array $args = array() )
Executes the ListStreamingDistributions operation.
-
public
updateCloudFrontOriginAccessIdentity ( array $args = array() )
Executes the UpdateCloudFrontOriginAccessIdentity operation.
-
public
updateDistribution ( array $args = array() )
Executes the UpdateDistribution operation.
-
public
updateStreamingDistribution ( array $args = array() )
Executes the UpdateStreamingDistribution operation.
-
public
waitUntilStreamingDistributionDeployed ( array $input )
Wait until a streaming distribution is deployed. The input array uses the parameters of the GetStreamingDistribution operation and waiter specific settings
-
public
waitUntilDistributionDeployed ( array $input )
Wait until a distribution is deployed. The input array uses the parameters of the GetDistribution operation and waiter specific settings
-
public
waitUntilInvalidationCompleted ( array $input )
Wait until an invalidation has completed. The input array uses the parameters of the GetInvalidation operation and waiter specific settings
-
public
getListCloudFrontOriginAccessIdentitiesIterator ( array $args = array() )
The input array uses the parameters of the ListCloudFrontOriginAccessIdentities operation
-
public
getListDistributionsIterator ( array $args = array() )
The input array uses the parameters of the ListDistributions operation
-
public
getListInvalidationsIterator ( array $args = array() )
The input array uses the parameters of the ListInvalidations operation
-
public
getListStreamingDistributionsIterator ( array $args = array() )
The input array uses the parameters of the ListStreamingDistributions operation
Methods detail
public static
Aws\CloudFront_2012_05_05\CloudFrontClient
factory( array|Guzzle\Common\Collection
$config = array() )
Factory method to create a new Amazon CloudFront client using an array of configuration options.
See http://docs.aws.amazon.com/aws-sdk-php/v2/guide/configuration.html#client-configuration-options
Parameters
- $config
array|
Guzzle\Common\Collection
$config Client configuration data
Returns
Link
Overrides
public
Guzzle\Service\Resource\Model
createCloudFrontOriginAccessIdentity( array $args = array() )
Executes the CreateCloudFrontOriginAccessIdentity operation.
Examples
- Basic formatting example
$result = $client->createCloudFrontOriginAccessIdentity(array( // CallerReference is required 'CallerReference' => 'string', // Comment is required 'Comment' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
CallerReference => (string) -
Comment => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Id => (string) -
S3CanonicalUserId => (string) -
CloudFrontOriginAccessIdentityConfig => (associative-array)-
CallerReference => (string) -
Comment => (string)
-
-
Location => (string) -
ETag => (string) -
RequestId => ()Request ID of the operation
Executes the CreateDistribution operation.
Examples
- Basic formatting example
$result = $client->createDistribution(array( // CallerReference is required 'CallerReference' => 'string', 'Aliases' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), 'DefaultRootObject' => 'string', // Origins is required 'Origins' => array( // Quantity is required 'Quantity' => integer, 'Items' => array( array( // Id is required 'Id' => 'string', // DomainName is required 'DomainName' => 'string', 'OriginPath' => 'string', 'CustomHeaders' => array( // Quantity is required 'Quantity' => integer, 'Items' => array( array( // HeaderName is required 'HeaderName' => 'string', // HeaderValue is required 'HeaderValue' => 'string', ), // ... repeated ), ), 'S3OriginConfig' => array( // OriginAccessIdentity is required 'OriginAccessIdentity' => 'string', ), 'CustomOriginConfig' => array( // HTTPPort is required 'HTTPPort' => integer, // HTTPSPort is required 'HTTPSPort' => integer, // OriginProtocolPolicy is required 'OriginProtocolPolicy' => 'string', 'OriginSslProtocols' => array( // Quantity is required 'Quantity' => integer, // Items is required 'Items' => array('string', ... ), ), ), ), // ... repeated ), ), // DefaultCacheBehavior is required 'DefaultCacheBehavior' => array( // TargetOriginId is required 'TargetOriginId' => 'string', // ForwardedValues is required 'ForwardedValues' => array( // QueryString is required 'QueryString' => true || false, // Cookies is required 'Cookies' => array( // Forward is required 'Forward' => 'string', 'WhitelistedNames' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), ), 'Headers' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), ), // TrustedSigners is required 'TrustedSigners' => array( // Enabled is required 'Enabled' => true || false, // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), // ViewerProtocolPolicy is required 'ViewerProtocolPolicy' => 'string', // MinTTL is required 'MinTTL' => integer, 'AllowedMethods' => array( // Quantity is required 'Quantity' => integer, // Items is required 'Items' => array('string', ... ), 'CachedMethods' => array( // Quantity is required 'Quantity' => integer, // Items is required 'Items' => array('string', ... ), ), ), 'SmoothStreaming' => true || false, 'DefaultTTL' => integer, 'MaxTTL' => integer, 'Compress' => true || false, ), 'CacheBehaviors' => array( // Quantity is required 'Quantity' => integer, 'Items' => array( array( // PathPattern is required 'PathPattern' => 'string', // TargetOriginId is required 'TargetOriginId' => 'string', // ForwardedValues is required 'ForwardedValues' => array( // QueryString is required 'QueryString' => true || false, // Cookies is required 'Cookies' => array( // Forward is required 'Forward' => 'string', 'WhitelistedNames' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), ), 'Headers' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), ), // TrustedSigners is required 'TrustedSigners' => array( // Enabled is required 'Enabled' => true || false, // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), // ViewerProtocolPolicy is required 'ViewerProtocolPolicy' => 'string', // MinTTL is required 'MinTTL' => integer, 'AllowedMethods' => array( // Quantity is required 'Quantity' => integer, // Items is required 'Items' => array('string', ... ), 'CachedMethods' => array( // Quantity is required 'Quantity' => integer, // Items is required 'Items' => array('string', ... ), ), ), 'SmoothStreaming' => true || false, 'DefaultTTL' => integer, 'MaxTTL' => integer, 'Compress' => true || false, ), // ... repeated ), ), 'CustomErrorResponses' => array( // Quantity is required 'Quantity' => integer, 'Items' => array( array( // ErrorCode is required 'ErrorCode' => integer, 'ResponsePagePath' => 'string', 'ResponseCode' => 'string', 'ErrorCachingMinTTL' => integer, ), // ... repeated ), ), // Comment is required 'Comment' => 'string', 'Logging' => array( // Enabled is required 'Enabled' => true || false, // IncludeCookies is required 'IncludeCookies' => true || false, // Bucket is required 'Bucket' => 'string', // Prefix is required 'Prefix' => 'string', ), 'PriceClass' => 'string', // Enabled is required 'Enabled' => true || false, 'ViewerCertificate' => array( 'Certificate' => 'string', 'CertificateSource' => 'string', 'SSLSupportMethod' => 'string', 'MinimumProtocolVersion' => 'string', 'IAMCertificateId' => 'string', 'CloudFrontDefaultCertificate' => true || false, ), 'Restrictions' => array( // GeoRestriction is required 'GeoRestriction' => array( // RestrictionType is required 'RestrictionType' => 'string', // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), ), 'WebACLId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
CallerReference => (string) -
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
DefaultRootObject => (string) -
Origins => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
Id => (string) -
DomainName => (string) -
S3OriginConfig => (associative-array)-
OriginAccessIdentity => (string)
-
-
CustomOriginConfig => (associative-array)-
HTTPPort => (int) -
HTTPSPort => (int) -
OriginProtocolPolicy => (string:http-only |match-viewer )
-
-
- (associative-array)
-
-
DefaultCacheBehavior => (associative-array)-
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string:allow-all |https-only ) -
MinTTL => (int)
-
-
CacheBehaviors => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
PathPattern => (string) -
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string:allow-all |https-only ) -
MinTTL => (int)
-
- (associative-array)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
Enabled => (bool)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Id => (string) -
Status => (string) -
LastModifiedTime => (string) -
InProgressInvalidationBatches => (int) -
DomainName => (string) -
ActiveTrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
AwsAccountNumber => (string) -
KeyPairIds => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
- (associative-array)
-
-
DistributionConfig => (associative-array)-
CallerReference => (string) -
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
DefaultRootObject => (string) -
Origins => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
Id => (string) -
DomainName => (string) -
S3OriginConfig => (associative-array)-
OriginAccessIdentity => (string)
-
-
CustomOriginConfig => (associative-array)-
HTTPPort => (int) -
HTTPSPort => (int) -
OriginProtocolPolicy => (string)
-
-
- (associative-array)
-
-
DefaultCacheBehavior => (associative-array)-
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string) -
MinTTL => (int)
-
-
CacheBehaviors => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
PathPattern => (string) -
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string) -
MinTTL => (int)
-
- (associative-array)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
Enabled => (bool)
-
-
Location => (string) -
ETag => (string) -
RequestId => ()Request ID of the operation
Executes the CreateInvalidation operation.
Examples
- Basic formatting example
$result = $client->createInvalidation(array( // DistributionId is required 'DistributionId' => 'string', // Paths is required 'Paths' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), // CallerReference is required 'CallerReference' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
DistributionId => (string) -
Paths => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
CallerReference => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Location => (string) -
Id => (string) -
Status => (string) -
CreateTime => (string) -
InvalidationBatch => (associative-array)-
Paths => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
CallerReference => (string)
-
-
RequestId => ()Request ID of the operation
Executes the CreateStreamingDistribution operation.
Examples
- Basic formatting example
$result = $client->createStreamingDistribution(array( // CallerReference is required 'CallerReference' => 'string', // S3Origin is required 'S3Origin' => array( // DomainName is required 'DomainName' => 'string', // OriginAccessIdentity is required 'OriginAccessIdentity' => 'string', ), 'Aliases' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), // Comment is required 'Comment' => 'string', 'Logging' => array( // Enabled is required 'Enabled' => true || false, // Bucket is required 'Bucket' => 'string', // Prefix is required 'Prefix' => 'string', ), // TrustedSigners is required 'TrustedSigners' => array( // Enabled is required 'Enabled' => true || false, // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), 'PriceClass' => 'string', // Enabled is required 'Enabled' => true || false, ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
CallerReference => (string) -
S3Origin => (associative-array)-
DomainName => (string) -
OriginAccessIdentity => (string)
-
-
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
Enabled => (bool)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Id => (string) -
Status => (string) -
LastModifiedTime => (string) -
DomainName => (string) -
ActiveTrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
AwsAccountNumber => (string) -
KeyPairIds => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
- (associative-array)
-
-
StreamingDistributionConfig => (associative-array)-
CallerReference => (string) -
S3Origin => (associative-array)-
DomainName => (string) -
OriginAccessIdentity => (string)
-
-
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
Enabled => (bool)
-
-
Location => (string) -
ETag => (string) -
RequestId => ()Request ID of the operation
public
Guzzle\Service\Resource\Model
deleteCloudFrontOriginAccessIdentity( array $args = array() )
Executes the DeleteCloudFrontOriginAccessIdentity operation.
Examples
- Basic formatting example
$result = $client->deleteCloudFrontOriginAccessIdentity(array( // Id is required 'Id' => 'string', 'IfMatch' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string) -
IfMatch => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
RequestId => ()Request ID of the operation
Executes the DeleteDistribution operation.
Examples
- Basic formatting example
$result = $client->deleteDistribution(array( // Id is required 'Id' => 'string', 'IfMatch' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string) -
IfMatch => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
RequestId => ()Request ID of the operation
Executes the DeleteStreamingDistribution operation.
Examples
- Basic formatting example
$result = $client->deleteStreamingDistribution(array( // Id is required 'Id' => 'string', 'IfMatch' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string) -
IfMatch => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
RequestId => ()Request ID of the operation
Executes the GetCloudFrontOriginAccessIdentity operation.
Examples
- Basic formatting example
$result = $client->getCloudFrontOriginAccessIdentity(array( // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Id => (string) -
S3CanonicalUserId => (string) -
CloudFrontOriginAccessIdentityConfig => (associative-array)-
CallerReference => (string) -
Comment => (string)
-
-
ETag => (string) -
RequestId => ()Request ID of the operation
public
Guzzle\Service\Resource\Model
getCloudFrontOriginAccessIdentityConfig( array $args = array() )
Executes the GetCloudFrontOriginAccessIdentityConfig operation.
Examples
- Basic formatting example
$result = $client->getCloudFrontOriginAccessIdentityConfig(array( // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
CallerReference => (string) -
Comment => (string) -
ETag => (string) -
RequestId => ()Request ID of the operation
Executes the GetDistribution operation.
Examples
- Basic formatting example
$result = $client->getDistribution(array( // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Id => (string) -
Status => (string) -
LastModifiedTime => (string) -
InProgressInvalidationBatches => (int) -
DomainName => (string) -
ActiveTrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
AwsAccountNumber => (string) -
KeyPairIds => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
- (associative-array)
-
-
DistributionConfig => (associative-array)-
CallerReference => (string) -
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
DefaultRootObject => (string) -
Origins => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
Id => (string) -
DomainName => (string) -
S3OriginConfig => (associative-array)-
OriginAccessIdentity => (string)
-
-
CustomOriginConfig => (associative-array)-
HTTPPort => (int) -
HTTPSPort => (int) -
OriginProtocolPolicy => (string)
-
-
- (associative-array)
-
-
DefaultCacheBehavior => (associative-array)-
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string) -
MinTTL => (int)
-
-
CacheBehaviors => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
PathPattern => (string) -
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string) -
MinTTL => (int)
-
- (associative-array)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
Enabled => (bool)
-
-
ETag => (string) -
RequestId => ()Request ID of the operation
Executes the GetDistributionConfig operation.
Examples
- Basic formatting example
$result = $client->getDistributionConfig(array( // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
CallerReference => (string) -
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
DefaultRootObject => (string) -
Origins => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
Id => (string) -
DomainName => (string) -
S3OriginConfig => (associative-array)-
OriginAccessIdentity => (string)
-
-
CustomOriginConfig => (associative-array)-
HTTPPort => (int) -
HTTPSPort => (int) -
OriginProtocolPolicy => (string)
-
-
- (associative-array)
-
-
DefaultCacheBehavior => (associative-array)-
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string) -
MinTTL => (int)
-
-
CacheBehaviors => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
PathPattern => (string) -
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string) -
MinTTL => (int)
-
- (associative-array)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
Enabled => (bool) -
ETag => (string) -
RequestId => ()Request ID of the operation
Executes the GetInvalidation operation.
Examples
- Basic formatting example
$result = $client->getInvalidation(array( // DistributionId is required 'DistributionId' => 'string', // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
DistributionId => (string) -
Id => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Id => (string) -
Status => (string) -
CreateTime => (string) -
InvalidationBatch => (associative-array)-
Paths => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
CallerReference => (string)
-
-
RequestId => ()Request ID of the operation
Executes the GetStreamingDistribution operation.
Examples
- Basic formatting example
$result = $client->getStreamingDistribution(array( // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Id => (string) -
Status => (string) -
LastModifiedTime => (string) -
DomainName => (string) -
ActiveTrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
AwsAccountNumber => (string) -
KeyPairIds => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
- (associative-array)
-
-
StreamingDistributionConfig => (associative-array)-
CallerReference => (string) -
S3Origin => (associative-array)-
DomainName => (string) -
OriginAccessIdentity => (string)
-
-
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
Enabled => (bool)
-
-
ETag => (string) -
RequestId => ()Request ID of the operation
Executes the GetStreamingDistributionConfig operation.
Examples
- Basic formatting example
$result = $client->getStreamingDistributionConfig(array( // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
CallerReference => (string) -
S3Origin => (associative-array)-
DomainName => (string) -
OriginAccessIdentity => (string)
-
-
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
Enabled => (bool) -
ETag => (string) -
RequestId => ()Request ID of the operation
public
Guzzle\Service\Resource\Model
listCloudFrontOriginAccessIdentities( array $args = array() )
Executes the ListCloudFrontOriginAccessIdentities operation.
Examples
- Basic formatting example
$result = $client->listCloudFrontOriginAccessIdentities(array( 'Marker' => 'string', 'MaxItems' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Marker => (string) -
MaxItems => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Marker => (string) -
NextMarker => (string) -
MaxItems => (int) -
IsTruncated => (bool) -
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
Id => (string) -
S3CanonicalUserId => (string) -
Comment => (string)
-
- (associative-array)
-
RequestId => ()Request ID of the operation
Executes the ListDistributions operation.
Examples
- Basic formatting example
$result = $client->listDistributions(array( 'Marker' => 'string', 'MaxItems' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Marker => (string) -
MaxItems => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Marker => (string) -
NextMarker => (string) -
MaxItems => (int) -
IsTruncated => (bool) -
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
Id => (string) -
Status => (string) -
LastModifiedTime => (string) -
DomainName => (string) -
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
Origins => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
Id => (string) -
DomainName => (string) -
S3OriginConfig => (associative-array)-
OriginAccessIdentity => (string)
-
-
CustomOriginConfig => (associative-array)-
HTTPPort => (int) -
HTTPSPort => (int) -
OriginProtocolPolicy => (string)
-
-
- (associative-array)
-
-
DefaultCacheBehavior => (associative-array)-
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string) -
MinTTL => (int)
-
-
CacheBehaviors => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
PathPattern => (string) -
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string) -
MinTTL => (int)
-
- (associative-array)
-
-
Comment => (string) -
Enabled => (bool)
-
- (associative-array)
-
RequestId => ()Request ID of the operation
Executes the ListInvalidations operation.
Examples
- Basic formatting example
$result = $client->listInvalidations(array( // DistributionId is required 'DistributionId' => 'string', 'Marker' => 'string', 'MaxItems' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
DistributionId => (string) -
Marker => (string) -
MaxItems => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Marker => (string) -
NextMarker => (string) -
MaxItems => (int) -
IsTruncated => (bool) -
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
Id => (string) -
Status => (string)
-
- (associative-array)
-
RequestId => ()Request ID of the operation
Executes the ListStreamingDistributions operation.
Examples
- Basic formatting example
$result = $client->listStreamingDistributions(array( 'Marker' => 'string', 'MaxItems' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Marker => (string) -
MaxItems => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Marker => (string) -
NextMarker => (string) -
MaxItems => (int) -
IsTruncated => (bool) -
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
Id => (string) -
Status => (string) -
LastModifiedTime => (string) -
DomainName => (string) -
S3Origin => (associative-array)-
DomainName => (string) -
OriginAccessIdentity => (string)
-
-
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
Comment => (string) -
Enabled => (bool)
-
- (associative-array)
-
RequestId => ()Request ID of the operation
public
Guzzle\Service\Resource\Model
updateCloudFrontOriginAccessIdentity( array $args = array() )
Executes the UpdateCloudFrontOriginAccessIdentity operation.
Examples
- Basic formatting example
$result = $client->updateCloudFrontOriginAccessIdentity(array( // CallerReference is required 'CallerReference' => 'string', // Comment is required 'Comment' => 'string', // Id is required 'Id' => 'string', 'IfMatch' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
CallerReference => (string) -
Comment => (string) -
Id => (string) -
IfMatch => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Id => (string) -
S3CanonicalUserId => (string) -
CloudFrontOriginAccessIdentityConfig => (associative-array)-
CallerReference => (string) -
Comment => (string)
-
-
ETag => (string) -
RequestId => ()Request ID of the operation
Executes the UpdateDistribution operation.
Examples
- Basic formatting example
$result = $client->updateDistribution(array( // CallerReference is required 'CallerReference' => 'string', 'Aliases' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), 'DefaultRootObject' => 'string', // Origins is required 'Origins' => array( // Quantity is required 'Quantity' => integer, 'Items' => array( array( // Id is required 'Id' => 'string', // DomainName is required 'DomainName' => 'string', 'OriginPath' => 'string', 'CustomHeaders' => array( // Quantity is required 'Quantity' => integer, 'Items' => array( array( // HeaderName is required 'HeaderName' => 'string', // HeaderValue is required 'HeaderValue' => 'string', ), // ... repeated ), ), 'S3OriginConfig' => array( // OriginAccessIdentity is required 'OriginAccessIdentity' => 'string', ), 'CustomOriginConfig' => array( // HTTPPort is required 'HTTPPort' => integer, // HTTPSPort is required 'HTTPSPort' => integer, // OriginProtocolPolicy is required 'OriginProtocolPolicy' => 'string', 'OriginSslProtocols' => array( // Quantity is required 'Quantity' => integer, // Items is required 'Items' => array('string', ... ), ), ), ), // ... repeated ), ), // DefaultCacheBehavior is required 'DefaultCacheBehavior' => array( // TargetOriginId is required 'TargetOriginId' => 'string', // ForwardedValues is required 'ForwardedValues' => array( // QueryString is required 'QueryString' => true || false, // Cookies is required 'Cookies' => array( // Forward is required 'Forward' => 'string', 'WhitelistedNames' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), ), 'Headers' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), ), // TrustedSigners is required 'TrustedSigners' => array( // Enabled is required 'Enabled' => true || false, // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), // ViewerProtocolPolicy is required 'ViewerProtocolPolicy' => 'string', // MinTTL is required 'MinTTL' => integer, 'AllowedMethods' => array( // Quantity is required 'Quantity' => integer, // Items is required 'Items' => array('string', ... ), 'CachedMethods' => array( // Quantity is required 'Quantity' => integer, // Items is required 'Items' => array('string', ... ), ), ), 'SmoothStreaming' => true || false, 'DefaultTTL' => integer, 'MaxTTL' => integer, 'Compress' => true || false, ), 'CacheBehaviors' => array( // Quantity is required 'Quantity' => integer, 'Items' => array( array( // PathPattern is required 'PathPattern' => 'string', // TargetOriginId is required 'TargetOriginId' => 'string', // ForwardedValues is required 'ForwardedValues' => array( // QueryString is required 'QueryString' => true || false, // Cookies is required 'Cookies' => array( // Forward is required 'Forward' => 'string', 'WhitelistedNames' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), ), 'Headers' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), ), // TrustedSigners is required 'TrustedSigners' => array( // Enabled is required 'Enabled' => true || false, // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), // ViewerProtocolPolicy is required 'ViewerProtocolPolicy' => 'string', // MinTTL is required 'MinTTL' => integer, 'AllowedMethods' => array( // Quantity is required 'Quantity' => integer, // Items is required 'Items' => array('string', ... ), 'CachedMethods' => array( // Quantity is required 'Quantity' => integer, // Items is required 'Items' => array('string', ... ), ), ), 'SmoothStreaming' => true || false, 'DefaultTTL' => integer, 'MaxTTL' => integer, 'Compress' => true || false, ), // ... repeated ), ), 'CustomErrorResponses' => array( // Quantity is required 'Quantity' => integer, 'Items' => array( array( // ErrorCode is required 'ErrorCode' => integer, 'ResponsePagePath' => 'string', 'ResponseCode' => 'string', 'ErrorCachingMinTTL' => integer, ), // ... repeated ), ), // Comment is required 'Comment' => 'string', 'Logging' => array( // Enabled is required 'Enabled' => true || false, // IncludeCookies is required 'IncludeCookies' => true || false, // Bucket is required 'Bucket' => 'string', // Prefix is required 'Prefix' => 'string', ), 'PriceClass' => 'string', // Enabled is required 'Enabled' => true || false, 'ViewerCertificate' => array( 'Certificate' => 'string', 'CertificateSource' => 'string', 'SSLSupportMethod' => 'string', 'MinimumProtocolVersion' => 'string', 'IAMCertificateId' => 'string', 'CloudFrontDefaultCertificate' => true || false, ), 'Restrictions' => array( // GeoRestriction is required 'GeoRestriction' => array( // RestrictionType is required 'RestrictionType' => 'string', // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), ), 'WebACLId' => 'string', // Id is required 'Id' => 'string', 'IfMatch' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
CallerReference => (string) -
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
DefaultRootObject => (string) -
Origins => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
Id => (string) -
DomainName => (string) -
S3OriginConfig => (associative-array)-
OriginAccessIdentity => (string)
-
-
CustomOriginConfig => (associative-array)-
HTTPPort => (int) -
HTTPSPort => (int) -
OriginProtocolPolicy => (string:http-only |match-viewer )
-
-
- (associative-array)
-
-
DefaultCacheBehavior => (associative-array)-
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string:allow-all |https-only ) -
MinTTL => (int)
-
-
CacheBehaviors => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
PathPattern => (string) -
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string:allow-all |https-only ) -
MinTTL => (int)
-
- (associative-array)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
Enabled => (bool) -
Id => (string) -
IfMatch => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Id => (string) -
Status => (string) -
LastModifiedTime => (string) -
InProgressInvalidationBatches => (int) -
DomainName => (string) -
ActiveTrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
AwsAccountNumber => (string) -
KeyPairIds => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
- (associative-array)
-
-
DistributionConfig => (associative-array)-
CallerReference => (string) -
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
DefaultRootObject => (string) -
Origins => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
Id => (string) -
DomainName => (string) -
S3OriginConfig => (associative-array)-
OriginAccessIdentity => (string)
-
-
CustomOriginConfig => (associative-array)-
HTTPPort => (int) -
HTTPSPort => (int) -
OriginProtocolPolicy => (string)
-
-
- (associative-array)
-
-
DefaultCacheBehavior => (associative-array)-
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string) -
MinTTL => (int)
-
-
CacheBehaviors => (associative-array)-
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
PathPattern => (string) -
TargetOriginId => (string) -
ForwardedValues => (associative-array)-
QueryString => (bool)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
ViewerProtocolPolicy => (string) -
MinTTL => (int)
-
- (associative-array)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
Enabled => (bool)
-
-
ETag => (string) -
RequestId => ()Request ID of the operation
Executes the UpdateStreamingDistribution operation.
Examples
- Basic formatting example
$result = $client->updateStreamingDistribution(array( // CallerReference is required 'CallerReference' => 'string', // S3Origin is required 'S3Origin' => array( // DomainName is required 'DomainName' => 'string', // OriginAccessIdentity is required 'OriginAccessIdentity' => 'string', ), 'Aliases' => array( // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), // Comment is required 'Comment' => 'string', 'Logging' => array( // Enabled is required 'Enabled' => true || false, // Bucket is required 'Bucket' => 'string', // Prefix is required 'Prefix' => 'string', ), // TrustedSigners is required 'TrustedSigners' => array( // Enabled is required 'Enabled' => true || false, // Quantity is required 'Quantity' => integer, 'Items' => array('string', ... ), ), 'PriceClass' => 'string', // Enabled is required 'Enabled' => true || false, // Id is required 'Id' => 'string', 'IfMatch' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
CallerReference => (string) -
S3Origin => (associative-array)-
DomainName => (string) -
OriginAccessIdentity => (string)
-
-
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
Enabled => (bool) -
Id => (string) -
IfMatch => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
Id => (string) -
Status => (string) -
LastModifiedTime => (string) -
DomainName => (string) -
ActiveTrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<associative-array>)- (associative-array)
-
AwsAccountNumber => (string) -
KeyPairIds => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
- (associative-array)
-
-
StreamingDistributionConfig => (associative-array)-
CallerReference => (string) -
S3Origin => (associative-array)-
DomainName => (string) -
OriginAccessIdentity => (string)
-
-
Aliases => (associative-array)-
Quantity => (int) -
Items => (array<string>)
-
-
Comment => (string) -
Logging => (associative-array)-
Enabled => (bool) -
Bucket => (string) -
Prefix => (string)
-
-
TrustedSigners => (associative-array)-
Enabled => (bool) -
Quantity => (int) -
Items => (array<string>)
-
-
Enabled => (bool)
-
-
ETag => (string) -
RequestId => ()Request ID of the operation
Wait until a streaming distribution is deployed. The input array uses the parameters of the GetStreamingDistribution operation and waiter specific settings
Parameters
- $input
array
$input
Wait until a distribution is deployed. The input array uses the parameters of the GetDistribution operation and waiter specific settings
Parameters
- $input
array
$input
Wait until an invalidation has completed. The input array uses the parameters of the GetInvalidation operation and waiter specific settings
Parameters
- $input
array
$input
public
ResourceIteratorInterface
getListCloudFrontOriginAccessIdentitiesIterator( array $args = array() )
The input array uses the parameters of the ListCloudFrontOriginAccessIdentities operation
Parameters
- $args
array
$args
Returns
ResourceIteratorInterface
The input array uses the parameters of the ListDistributions operation
Parameters
- $args
array
$args
Returns
ResourceIteratorInterface
The input array uses the parameters of the ListInvalidations operation
Parameters
- $args
array
$args
Returns
ResourceIteratorInterface
The input array uses the parameters of the ListStreamingDistributions operation
Parameters
- $args
array
$args
Returns
ResourceIteratorInterface
Methods inherited from Aws\Common\Client\AbstractClient
__call()
,
__construct()
,
createRequest()
,
getAllEvents()
,
getApiVersion()
,
getCredentials()
,
getRegion()
,
getRegions()
,
getSignature()
,
getWaiter()
,
getWaiterFactory()
,
send()
,
setCredentials()
,
setRegion()
,
setWaiterFactory()
,
waitUntil()
Methods inherited from Guzzle\Service\Client
execute()
,
executeMultiple()
,
getCommand()
,
getCommandFactory()
,
getDescription()
,
getInflector()
,
getIterator()
,
getResourceIteratorFactory()
,
prepareCommand()
,
setCommandFactory()
,
setDescription()
,
setInflector()
,
setResourceIteratorFactory()
Methods inherited from Guzzle\Http\Client
delete()
,
expandTemplate()
,
extractPharCacert()
,
get()
,
getBaseUrl()
,
getConfig()
,
getCurlMulti()
,
getDefaultOption()
,
getDefaultUserAgent()
,
getUriTemplate()
,
head()
,
initSsl()
,
options()
,
patch()
,
post()
,
prepareRequest()
,
put()
,
sendMultiple()
,
setBaseUrl()
,
setConfig()
,
setCurlMulti()
,
setDefaultOption()
,
setRequestFactory()
,
setSslVerification()
,
setUriTemplate()
,
setUserAgent()
Methods inherited from Guzzle\Common\AbstractHasDispatcher
addSubscriber()
,
dispatch()
,
getEventDispatcher()
,
setEventDispatcher()
Magic methods summary
Constants summary
string |
LATEST_API_VERSION |
'2012-05-05' |
Constants inherited from Guzzle\Service\Client
Constants inherited from Guzzle\Http\Client
CURL_OPTIONS
,
DEFAULT_SELECT_TIMEOUT
,
DISABLE_REDIRECTS
,
MAX_HANDLES
,
REQUEST_OPTIONS
,
SSL_CERT_AUTHORITY
Constants inherited from Guzzle\Http\ClientInterface
Properties summary
Properties inherited from Aws\Common\Client\AbstractClient
$aggregator
,
$credentials
,
$signature
,
$waiterFactory
Properties inherited from Guzzle\Service\Client
$commandFactory
,
$inflector
,
$resourceIteratorFactory
,
$serviceDescription
Properties inherited from Guzzle\Http\Client
$defaultHeaders
,
$requestFactory
,
$userAgent