Amazon CloudFront
API Reference (API Version 2010-11-01)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

GET Distribution List

Description

To list your distributions, you do a GET on the 2010-11-01/distribution resource. The response includes a DistributionList element with zero or more DistributionSummary child elements. By default, your entire list of distributions is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

Requests

Syntax

GET /2010-11-01/distribution?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

NameDescriptionRequired

Marker

Use this when paginating results to indicate where to begin in your list of 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).

Type: String

Default: All your distributions are listed from the beginning

No

MaxItems

The maximum number of distributions you want in the response body.

Type: String with a maximum value of 100

Default: 100

No

Responses

Syntax

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

<?xml version="1.0" encoding="UTF-8"?>
<DistributionList xmlns="http://cloudfront.amazonaws.com/doc/2010-11-01/">
   <Marker>EDFDVBD632BHDS5</Marker>
   <NextMarker>EMLARXS993KSTG8</NextMarker>
   <MaxItems>5</MaxItems>
   <IsTruncated>false</IsTruncated>
   <DistributionSummary>
      <Id>EXE93JU2Q3AMY</Id>
      <Status>Enabled</Status>
      <LastModifiedTime>Thu, 14 Aug 2010 17:08:48 GMT</LastModifiedTime>
      <DomainName>d18fnx6jtq9vqf.cloudfront.net</DomainName>
      <S3Origin>1
         <DNSName>test-DNS-name</DNSName>
         <OriginAccessIdentity>EWEXM1PUO10I6</OriginAccessIdentity>
      </S3Origin>
      <CNAME>far.example.com</CNAME>
      <Comment>The comment.</Comment>
      <Enabled>true</Enabled>
      <TrustedSigners>
         <Self>true</Self>
         <AwsAccountNumber>111122223333</AwsAccountNumber>
      </TrustedSigners>
   </DistributionSummary>
   <DistributionSummary>
      <Id>DSE93JR8Q3AM
      <Status>Enabled</Status>
      <LastModifiedTime>Thu, 15 Aug 2010 12:53:17 GMT</LastModifiedTime>
      <DomainName>>u15fox6jtq1vqf.cloudfront.net</DomainName>
      <CustomOrigin>2
         <DNSName>custom-DNS-name</DNSName>
         <HTTPPort>8080</HTTPPort>
         <HTTPSPort>443</HTTPSPort>
         <OriginProtocolPolicy>MatchViewer</OriginProtocolPolicy>    
      </CustomOrigin>
      <CNAME>custom_far.example.com</CNAME>
      <Comment>The comment.</Comment>
      <Enabled>true</Enabled>
      <TrustedSigners>
         <Self>true</Self>
         <AwsAccountNumber>111122223333</AwsAccountNumber>
      </TrustedSigners>
   </DistributionSummary>
   </DistributionList>

1

The S3Origin element is returned only if you use an Amazon S3 origin for your distribution.

2

The CustomOrigin element is returned only if you use a custom origin for your distribution. For more information about the CustomOrigin element and the S3Origin element, see DistributionConfig Complex Type.

Elements

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

NameDescription

DistributionSummary

Type: An XML structure containing a summary of the distribution. For information about the child elements, see Distribution Complex Type.

IsTruncated

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.

Type: String

Valid Values: true | false

Marker

The value you provided for the Marker request parameter.

Type: String

MaxItems

The value you provided for the MaxItems request parameter.

Type: String

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 distributions where they left off.

Type: String

Special Errors

The action returns no special errors besides the common errors all actions return (for more information, see Errors).

Examples

The following example request lists the first two of your ten distributions.

Sample Request

GET /2010-11-01/distribution?MaxItems=2 HTTP/1.1
Host: cloudfront.amazonaws.com
Authorization: AWS O39F6A430S6FJNPPGDR2:frJIUN8DYpKDtOLEXAMPLE=
Date: Thu, 19 Nov 2009 19:37:58 GMT
[Other required headers]

Sample Response

200 OK
x-amz-request-id: request_id

<?xml version="1.0" encoding="UTF-8"?>
<DistributionList xmlns="http://cloudfront.amazonaws.com/doc/2010-11-01/">
   <Marker>RMPARXS293KSTG7</Marker>
   <NextMarker>EMLARXS993KSTG8</NextMarker>
   <MaxItems>2</MaxItems>
   <IsTruncated>true</IsTruncated>
   <DistributionSummary>
      <Id>EDFDVBD632BHDS5</Id>
      <Status>Deployed</Status>
      <LastModifiedTime>2009-11-19T19:37:58Z</LastModifiedTime>
      <DomainName>d604721fxaaqy9.cloudfront.net</DomainName>
      <S3Origin>
         <DNSName>mybucket.s3.amazonaws.com</DNSName>
      </S3Origin>
      <CNAME>beagles.com</CNAME>
      <CNAME>beagles.dogs.com</CNAME>
      <Comment>First distribution</Comment>
      <Enabled>true</Enabled>
      <TrustedSigners/>
   </DistributionSummary>
   <DistributionSummary>
      <Id>EMLARXS993KSTG8</Id>
      <Status>Deployed</Status>
      <LastModifiedTime>2009-11-27T06:51:03Z</LastModifiedTime>
      <DomainName>www.example.com</DomainName>
      <CustomOrigin>
         <DNSName>www.example.com</DNSName>
         <HTTPPort>80</HTTPPort>
         <HTTPSPort>443</HTTPSPort>
         <OriginProtocolPolicy>match-viewer</OriginProtocolPolicy>
      </CustomOrigin>   
      <Comment>Another distribution</Comment>
      <Enabled>true</Enabled>
      <TrustedSigners/>
   </DistributionSummary>
   </DistributionList>

Sample Request

The following example request gets the next four distributions in your list.

GET /2010-11-01/distribution?MaxItems=4?Marker=EMLARXS993KSTG8 HTTP/1.1
Host: cloudfront.amazonaws.com
Authorization: AWS O39F6A430S6FJNPPGDR2:frJIUN8DYpKDtOLEXAMPLE=
Date: Thu, 19 Nov 2009 19:39:00 GMT
[Other required headers]