Amazon CloudFront
API Reference (API Version 2012-07-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

GET Streaming Distribution List

Description

To list your streaming distributions, you do a GET on the 2012-07-01/streaming-distribution resource. The response includes a StreamingDistributionList element with zero or more StreamingDistributionSummary child elements. By default, your entire list of streaming 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 /2012-07-01/streaming-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 streaming 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 streaming distributions are listed from the beginning

No

MaxItems

The maximum number of streaming 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"?>
<StreamingDistributionList xmlns="http://cloudfront.amazonaws.com/doc/2012-07-01/">
   <Marker>value specified in request</Marker>
   <NextMarker>value for Marker parameter in 
      next request</NextMarker>
   <MaxItems>value specified in request</MaxItems>
   <IsTruncated>true | false</IsTruncated>
   <Quantity>number of streaming distributions 
      created by current AWS account</Quantity>
   <Items>
      <StreamingDistributionSummary>
         <Id>id</Id>
         <Status>status</Status>
         <LastModifiedTime>time</LastModifiedTime>
         <DomainName>name</DomainName>
         <S3Origin>
            <DNSName>Amazon S3 bucket name</DNSName>
            <OriginAccessIdentity>OAI</OriginAccessIdentity>
         </S3Origin>
         <CNAME>CNAME alias</CNAME>
         <Comment>comment about the distribution</Comment>
         <PriceClass>maximum price class for the distribution</PriceClass>
         <Enabled>true | false</Enabled>
      </StreamingDistributionSummary>
   </Items>
</StreamingDistributionList>

Elements

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

NameDescription

Marker

The value you provided for the Marker request parameter.

Type: String

Parent: StreamingDistributionList

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

Type: String

Parent: StreamingDistributionList

MaxItems

The value you provided for the MaxItems request parameter.

Type: String

Parent: StreamingDistributionList

IsTruncated

A flag that indicates whether more streaming 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

Parent: StreamingDistributionList

Quantity

The number of streaming distributions that were created by the current AWS account.

Type: String

Parent: DistributionList

Items

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

Type: Complex

Child: StreamingDistributionSummary

Parent: DistributionList

StreamingDistributionSummary

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

Special Errors

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

Examples

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

Sample Request

GET /2012-07-01/streaming-distribution?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"?>
<StreamingDistributionList xmlns="http://cloudfront.amazonaws.com/doc/2012-07-01/">
   <Marker>EGTXBD79EXAMPLE</Marker>
   <NextMarker>ED4L98SBEXAMPLE</NextMarker>
   <MaxItems>1</MaxItems>
   <IsTruncated>true</IsTruncated>
   <Quantity>4</Quantity>
   <Items>
      <StreamingDistributionSummary>
         <Id>EGTXBD79EXAMPLE</Id>
         <Status>Deployed</Status>
         <LastModifiedTime>2012-05-19T19:37:58Z</LastModifiedTime>
         <DomainName>s5c39gqb8ow64r.cloudfront.net</DomainName>
         <S3Origin>
            <DNSName>mystreamingbucket.s3.amazonaws.com</DNSName>
         </S3Origin>
         <CNAME>www.example.com</CNAME>
         <CNAME>product.example.com</CNAME>
         <Comment>First distribution</Comment>
         <PriceClass>PriceClass_All</PriceClass>
         <Enabled>true</Enabled>
      </StreamingDistributionSummary>
   </Items>
</StreamingDistributionList>

Sample Request

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

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