AWS Documentation » Amazon CloudFront » API Reference » Actions on Origin Access Identities » GET Origin Access Identity List	« Previous Next »
	Did this page help you? Yes \| No \| Tell us about it...

GET Origin Access Identity List

Topics

Description

To list your CloudFront origin access identities, you do a GET on the 2012-07-01/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

Requests

Syntax

GET /2012-07-01/origin-access-identity/cloudfront?Marker=value&MaxItems=value HTTP/1.1
Host: cloudfront.amazonaws.com
Authorization: AWS authentication string
Date: time stamp
Other required headers

Headers

The request must include the headers required in all CloudFront requests. For more information, see Common REST Headers.

Query Parameters

Name Description Required

Name	Description	Required
`Marker`	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). Type: String Default: All your origin access identities are listed from the beginning	No
`MaxItems`	The maximum number of origin access identities you want in the response body. Type: String with a maximum value of 100 Default: 100	No

Marker

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

Type: String

Default: All your origin access identities are listed from the beginning

MaxItems

The maximum number of origin access identities you want in the response body.

Type: String with a maximum value of 100

Default: 100

Responses

Syntax

200 OK
x-amz-request-id: Request ID

<?xml version="1.0" encoding="UTF-8"?>
<CloudFrontOriginAccessIdentityList xmlns="http://cloudfront.amazonaws.com/doc/2012-07-01/">
   <Marker>value that you specified for 
      Marker parameter in last request</Marker>
   <NextMarker>value to specify for Marker parameter 
      in next request</NextMarker>
   <MaxItems>value specified for MaxItems in request</MaxItems>
   <IsTruncated>true | false</IsTruncated>
   <Quantity>number of origin access identities created by 
      the current AWS account</Quantity>
   <Items>
      <CloudFrontOriginAccessIdentitySummary>
         <Id>origin access identity</Id>
         <S3CanonicalUserId>user id</S3CanonicalUserId>
         <Comment>comment about the origin access identity</Comment>
      </CloudFrontOriginAccessIdentitySummary>
   </Items>
</CloudFrontOriginAccessIdentityList>

Elements

The body of the response includes an XML document with a CloudFrontOriginAccessIdentityList element. The following table lists the child elements of the CloudFrontOriginAccessIdentityList element.

Name	Description
`Marker`	The value you provided for the `Marker` request parameter. Type: String Parent: CloudFrontOriginAccessIdentityList
`NextMarker`	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. Type: String Parent: CloudFrontOriginAccessIdentityList
`MaxItems`	The value you provided for the `MaxItems` request parameter. Type: String Parent: CloudFrontOriginAccessIdentityList
`IsTruncated`	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. Type: String Valid Values: `true` \| `false` Parent: CloudFrontOriginAccessIdentityList
`Quantity`	The number of CloudFront origin access identities that were created by the current AWS account. Type: String Parent: CloudFrontOriginAccessIdentityList
`Items`	A complex type that contains one `CloudFrontOriginAccessIdentitySummary` element for each origin access identity that was created by the current AWS account. Type: Complex Child: CloudFrontOriginAccessIdentitySummary Parent: CloudFrontOriginAccessIdentityList
`CloudFrontOriginAccessIdentitySummary`	Type: An XML structure containing a summary of the origin access identity. For information about the child elements, see CloudFrontOriginAccessIdentity Complex Type.

Special Errors

The action returns no special errors besides the common errors that all actions return. For more information, see Errors.

Examples

The following example request lists the first two of your ten origin access identities.

Sample Request

GET /2012-07-01/origin-access-identity/cloudfront?MaxItems=2 HTTP/1.1
Host: cloudfront.amazonaws.com
Authorization: AWS authentication string
Date: Thu, 17 May 2012 19:37:58 GMT
Other required headers

Sample Response

200 OK
x-amz-request-id: request_id

<?xml version="1.0" encoding="UTF-8"?>
<CloudFrontOriginAccessIdentityList xmlns="http://cloudfront.amazonaws.com/doc/2012-07-01/">
   <Marker>EDFDVBD6EXAMPLE</Marker>
   <NextMarker>EMLARXS9EXAMPLE</NextMarker>
   <MaxItems>2</MaxItems>
   <IsTruncated>true</IsTruncated>
   <Quantity>4</Quantity>
   <Items>
      <CloudFrontOriginAccessIdentitySummary>
         <Id>E74FTE3AEXAMPLE</Id>
         <S3CanonicalUserId>
            cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE
         </S3CanonicalUserId>
         <Comment>First origin access identity</Comment>
      </CloudFrontOriginAccessIdentitySummary>
      <CloudFrontOriginAccessIdentitySummary>
         <Id>E58SRM2XEXAMPLE</Id>
         <S3CanonicalUserId>
            7d843ae7f1792436e72691ab96a9c1414b7c3fbe2ab739a1cf21b0fe2EXAMPLE
         </S3CanonicalUserId>
         <Comment>Another origin access identity</Comment>
      </CloudFrontOriginAccessIdentitySummary>
   </Items>
</CloudFrontOriginAccessIdentityList>

Sample Request

The following example request gets the next four origin access identities in your list.

GET /2012-07-01/origin-access-identity/cloudfront?MaxItems=4?Marker=E58SRM2XEXAMPLE HTTP/1.1
Host: cloudfront.amazonaws.com
Authorization: AWS authentication string
Date: Thu, 17 May 2012 19:39:00 GMT
Other required headers

Related Actions

Document Conventions	« Previous Next »
Terms of Use	Did this page help you? Yes \| No \| Tell us about it...