CloudFrontClient Class

Member Function Documentation

CloudFrontClient::CloudFrontClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a CloudFrontClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

CloudFrontClient::CloudFrontClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads CloudFrontClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CreateCloudFrontOriginAccessIdentityResponse *CloudFrontClient::createCloudFrontOriginAccessIdentity(const CreateCloudFrontOriginAccessIdentityRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an CreateCloudFrontOriginAccessIdentityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see <a href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer

[slot] CreateDistributionResponse *CloudFrontClient::createDistribution(const CreateDistributionRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an CreateDistributionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new web distribution. Send a <code>POST</code> request to the <code>/<i>CloudFront API version</i>/distribution</code>/<code>distribution ID</code>

[slot] CreateDistributionWithTagsResponse *CloudFrontClient::createDistributionWithTags(const CreateDistributionWithTagsRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an CreateDistributionWithTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Create a new distribution with

[slot] CreateFieldLevelEncryptionConfigResponse *CloudFrontClient::createFieldLevelEncryptionConfig(const CreateFieldLevelEncryptionConfigRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an CreateFieldLevelEncryptionConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Create a new field-level encryption

[slot] CreateFieldLevelEncryptionProfileResponse *CloudFrontClient::createFieldLevelEncryptionProfile(const CreateFieldLevelEncryptionProfileRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an CreateFieldLevelEncryptionProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Create a field-level encryption

[slot] CreateInvalidationResponse *CloudFrontClient::createInvalidation(const CreateInvalidationRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an CreateInvalidationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Create a new invalidation.

[slot] CreatePublicKeyResponse *CloudFrontClient::createPublicKey(const CreatePublicKeyRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an CreatePublicKeyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CreateStreamingDistributionResponse *CloudFrontClient::createStreamingDistribution(const CreateStreamingDistributionRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an CreateStreamingDistributionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

</p

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

distribution>

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

minutes>

For more information about web distributions, see <a href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-rtmp.html">Working with RTMP Distributions</a> in the <i>Amazon CloudFront Developer

Guide</i>> <b>

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the <code>Quantity</code> element and the number of values

[slot] CreateStreamingDistributionWithTagsResponse *CloudFrontClient::createStreamingDistributionWithTags(const CreateStreamingDistributionWithTagsRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an CreateStreamingDistributionWithTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Create a new streaming distribution with

[slot] DeleteCloudFrontOriginAccessIdentityResponse *CloudFrontClient::deleteCloudFrontOriginAccessIdentity(const DeleteCloudFrontOriginAccessIdentityRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an DeleteCloudFrontOriginAccessIdentityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Delete an origin access identity.

[slot] DeleteDistributionResponse *CloudFrontClient::deleteDistribution(const DeleteDistributionRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an DeleteDistributionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Delete a distribution.

[slot] DeleteFieldLevelEncryptionConfigResponse *CloudFrontClient::deleteFieldLevelEncryptionConfig(const DeleteFieldLevelEncryptionConfigRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an DeleteFieldLevelEncryptionConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Remove a field-level encryption

[slot] DeleteFieldLevelEncryptionProfileResponse *CloudFrontClient::deleteFieldLevelEncryptionProfile(const DeleteFieldLevelEncryptionProfileRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an DeleteFieldLevelEncryptionProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Remove a field-level encryption

[slot] DeletePublicKeyResponse *CloudFrontClient::deletePublicKey(const DeletePublicKeyRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an DeletePublicKeyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Remove a public key you previously added to

[slot] DeleteServiceLinkedRoleResponse *CloudFrontClient::deleteServiceLinkedRole(const DeleteServiceLinkedRoleRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an DeleteServiceLinkedRoleResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] DeleteStreamingDistributionResponse *CloudFrontClient::deleteStreamingDistribution(const DeleteStreamingDistributionRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an DeleteStreamingDistributionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

steps>

<b>To delete an RTMP distribution using the CloudFront

API</b>> <ol> <li>

Disable the RTMP

distribution> </li> <li>

Submit a <code>GET Streaming Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution.

</p </li> <li>

Update the XML document that was returned in the response to your <code>GET Streaming Distribution Config</code> request to change the value of <code>Enabled</code> to

<code>false</code>> </li> <li>

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

2> </li> <li>

Review the response to the <code>PUT Streaming Distribution Config</code> request to confirm that the distribution was successfully

disabled> </li> <li>

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

<code>Deployed</code>> </li> <li>

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

2> </li> <li>

Review the response to your <code>DELETE Streaming Distribution</code> request to confirm that the distribution was successfully

deleted> </li> </ol>

For information about deleting a distribution using the CloudFront console, see <a href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer

[slot] GetCloudFrontOriginAccessIdentityResponse *CloudFrontClient::getCloudFrontOriginAccessIdentity(const GetCloudFrontOriginAccessIdentityRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetCloudFrontOriginAccessIdentityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get the information about an origin access identity.

[slot] GetCloudFrontOriginAccessIdentityConfigResponse *CloudFrontClient::getCloudFrontOriginAccessIdentityConfig(const GetCloudFrontOriginAccessIdentityConfigRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetCloudFrontOriginAccessIdentityConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get the configuration information about an origin access identity.

[slot] GetDistributionResponse *CloudFrontClient::getDistribution(const GetDistributionRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetDistributionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get the information about a distribution.

[slot] GetDistributionConfigResponse *CloudFrontClient::getDistributionConfig(const GetDistributionConfigRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetDistributionConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get the configuration information about a distribution.

[slot] GetFieldLevelEncryptionResponse *CloudFrontClient::getFieldLevelEncryption(const GetFieldLevelEncryptionRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetFieldLevelEncryptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get the field-level encryption configuration

[slot] GetFieldLevelEncryptionConfigResponse *CloudFrontClient::getFieldLevelEncryptionConfig(const GetFieldLevelEncryptionConfigRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetFieldLevelEncryptionConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get the field-level encryption configuration

[slot] GetFieldLevelEncryptionProfileResponse *CloudFrontClient::getFieldLevelEncryptionProfile(const GetFieldLevelEncryptionProfileRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetFieldLevelEncryptionProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get the field-level encryption profile

[slot] GetFieldLevelEncryptionProfileConfigResponse *CloudFrontClient::getFieldLevelEncryptionProfileConfig(const GetFieldLevelEncryptionProfileConfigRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetFieldLevelEncryptionProfileConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get the field-level encryption profile configuration

[slot] GetInvalidationResponse *CloudFrontClient::getInvalidation(const GetInvalidationRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetInvalidationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get the information about an invalidation.

[slot] GetPublicKeyResponse *CloudFrontClient::getPublicKey(const GetPublicKeyRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetPublicKeyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get the public key

[slot] GetPublicKeyConfigResponse *CloudFrontClient::getPublicKeyConfig(const GetPublicKeyConfigRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetPublicKeyConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Return public key configuration

[slot] GetStreamingDistributionResponse *CloudFrontClient::getStreamingDistribution(const GetStreamingDistributionRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetStreamingDistributionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a specified RTMP distribution, including the distribution

[slot] GetStreamingDistributionConfigResponse *CloudFrontClient::getStreamingDistributionConfig(const GetStreamingDistributionConfigRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an GetStreamingDistributionConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get the configuration information about a streaming distribution.

[slot] ListCloudFrontOriginAccessIdentitiesResponse *CloudFrontClient::listCloudFrontOriginAccessIdentities(const ListCloudFrontOriginAccessIdentitiesRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an ListCloudFrontOriginAccessIdentitiesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists origin access

[slot] ListDistributionsResponse *CloudFrontClient::listDistributions(const ListDistributionsRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an ListDistributionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

List distributions.

[slot] ListDistributionsByWebACLIdResponse *CloudFrontClient::listDistributionsByWebACLId(const ListDistributionsByWebACLIdRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an ListDistributionsByWebACLIdResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListFieldLevelEncryptionConfigsResponse *CloudFrontClient::listFieldLevelEncryptionConfigs(const ListFieldLevelEncryptionConfigsRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an ListFieldLevelEncryptionConfigsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListFieldLevelEncryptionProfilesResponse *CloudFrontClient::listFieldLevelEncryptionProfiles(const ListFieldLevelEncryptionProfilesRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an ListFieldLevelEncryptionProfilesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListInvalidationsResponse *CloudFrontClient::listInvalidations(const ListInvalidationsRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an ListInvalidationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists invalidation batches.

[slot] ListPublicKeysResponse *CloudFrontClient::listPublicKeys(const ListPublicKeysRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an ListPublicKeysResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListStreamingDistributionsResponse *CloudFrontClient::listStreamingDistributions(const ListStreamingDistributionsRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an ListStreamingDistributionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

List streaming distributions.

[slot] ListTagsForResourceResponse *CloudFrontClient::listTagsForResource(const ListTagsForResourceRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an ListTagsForResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

List tags for a CloudFront

[slot] TagResourceResponse *CloudFrontClient::tagResource(const TagResourceRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an TagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Add tags to a CloudFront

[slot] UntagResourceResponse *CloudFrontClient::untagResource(const UntagResourceRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an UntagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Remove tags from a CloudFront

[slot] UpdateCloudFrontOriginAccessIdentityResponse *CloudFrontClient::updateCloudFrontOriginAccessIdentity(const UpdateCloudFrontOriginAccessIdentityRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an UpdateCloudFrontOriginAccessIdentityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Update an origin access identity.

[slot] UpdateDistributionResponse *CloudFrontClient::updateDistribution(const UpdateDistributionRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an UpdateDistributionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the configuration for a web distribution. Perform the following

steps>

For information about updating a distribution using the CloudFront console, see <a href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-creating-console.html">Creating or Updating a Web Distribution Using the CloudFront Console </a> in the <i>Amazon CloudFront Developer

Guide</i>>

<b>To update a web distribution using the CloudFront API</b>

</p <ol> <li>

Submit a <a>GetDistributionConfig</a> request to get the current configuration and an <code>Etag</code> header for the

distribution> <note>

If you update the distribution again, you need to get a new <code>Etag</code>

header> </note> </li> <li>

Update the XML document that was returned in the response to your <code>GetDistributionConfig</code> request to include the desired changes. You can't change the value of <code>CallerReference</code>. If you try to change this value, CloudFront returns an <code>IllegalUpdate</code>

error> <b>

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

element> </b> </li> <li>

Submit an <code>UpdateDistribution</code> request to update the configuration for your

distribution> <ul> <li>

In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a <code>DistributionConfig</code>

element> </li> <li>

Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GetDistributionConfig</code> request in Step

1> </li> </ul> </li> <li>

Review the response to the <code>UpdateDistribution</code> request to confirm that the configuration was successfully

updated> </li> <li>

Optional: Submit a <a>GetDistribution</a> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is

<code>Deployed</code>> <b>

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a distribution. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the <code>Quantity</code> element and the number of values you're actually

[slot] UpdateFieldLevelEncryptionConfigResponse *CloudFrontClient::updateFieldLevelEncryptionConfig(const UpdateFieldLevelEncryptionConfigRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an UpdateFieldLevelEncryptionConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Update a field-level encryption configuration.

[slot] UpdateFieldLevelEncryptionProfileResponse *CloudFrontClient::updateFieldLevelEncryptionProfile(const UpdateFieldLevelEncryptionProfileRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an UpdateFieldLevelEncryptionProfileResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Update a field-level encryption profile.

[slot] UpdatePublicKeyResponse *CloudFrontClient::updatePublicKey(const UpdatePublicKeyRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an UpdatePublicKeyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateStreamingDistributionResponse *CloudFrontClient::updateStreamingDistribution(const UpdateStreamingDistributionRequest &request)

Sends request to the CloudFrontClient service, and returns a pointer to an UpdateStreamingDistributionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Update a streaming distribution.