Menu
Amazon CloudFront
API Reference (API Version 2016-11-25)

UpdateCloudFrontOriginAccessIdentity

Update an origin access identity.

Request Syntax

PUT /2016-11-25/origin-access-identity/cloudfront/Id/config HTTP/1.1
If-Match: IfMatch
<?xml version="1.0" encoding="UTF-8"?>
<UpdateCloudFrontOriginAccessIdentityRequest>
   <CloudFrontOriginAccessIdentityConfig>
      <CallerReference>string</CallerReference>
      <Comment>string</Comment>
   </CloudFrontOriginAccessIdentityConfig>
</UpdateCloudFrontOriginAccessIdentityRequest>

URI Request Parameters

The request requires the following URI parameters.

Id

The identity's id.

If-Match

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

Request Body

The request requires the following data in XML format.

UpdateCloudFrontOriginAccessIdentityRequest

Root level tag for the UpdateCloudFrontOriginAccessIdentityRequest parameters.

Required: Yes

CloudFrontOriginAccessIdentityConfig

The identity's configuration information.

Type: CloudFrontOriginAccessIdentityConfig object

Required: Yes

Response Syntax

HTTP/1.1 200
ETag: ETag
<?xml version="1.0" encoding="UTF-8"?>
<UpdateCloudFrontOriginAccessIdentityResult>
   <CloudFrontOriginAccessIdentity>
      <CloudFrontOriginAccessIdentityConfig>
         <CallerReference>string</CallerReference>
         <Comment>string</Comment>
      </CloudFrontOriginAccessIdentityConfig>
      <Id>string</Id>
      <S3CanonicalUserId>string</S3CanonicalUserId>
   </CloudFrontOriginAccessIdentity>
</UpdateCloudFrontOriginAccessIdentityResult>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

ETag

The current version of the configuration. For example: E2QWRUHAPOMQZL.

The following data is returned in XML format by the service.

UpdateCloudFrontOriginAccessIdentityResult

Root level tag for the UpdateCloudFrontOriginAccessIdentityResult parameters.

Required: Yes

CloudFrontOriginAccessIdentity

The origin access identity's information.

Type: CloudFrontOriginAccessIdentity object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDenied

Access denied.

HTTP Status Code: 403

IllegalUpdate

Origin and CallerReference cannot be updated.

HTTP Status Code: 400

InconsistentQuantities

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

HTTP Status Code: 400

InvalidArgument

The argument is invalid.

HTTP Status Code: 400

InvalidIfMatchVersion

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

HTTP Status Code: 400

MissingBody

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

HTTP Status Code: 400

NoSuchCloudFrontOriginAccessIdentity

The specified origin access identity does not exist.

HTTP Status Code: 404

PreconditionFailed

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

HTTP Status Code: 412