Menu
Amazon CloudFront
API Reference (API Version 2017-03-25)

ListDistributions

List distributions.

Request Syntax

GET /2017-03-25/distribution?Marker=Marker&MaxItems=MaxItems HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

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

MaxItems

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<DistributionList>
   <IsTruncated>boolean</IsTruncated>
   <Items>
      <DistributionSummary>
         <Aliases>
            <Items>
               <CNAME>string</CNAME>
            </Items>
            <Quantity>integer</Quantity>
         </Aliases>
         <ARN>string</ARN>
         <CacheBehaviors>
            <Items>
               <CacheBehavior>
                  <AllowedMethods>
                     <CachedMethods>
                        <Items>
                           <Method>string</Method>
                        </Items>
                        <Quantity>integer</Quantity>
                     </CachedMethods>
                     <Items>
                        <Method>string</Method>
                     </Items>
                     <Quantity>integer</Quantity>
                  </AllowedMethods>
                  <Compress>boolean</Compress>
                  <DefaultTTL>long</DefaultTTL>
                  <ForwardedValues>
                     <Cookies>
                        <Forward>string</Forward>
                        <WhitelistedNames>
                           <Items>
                              <Name>string</Name>
                           </Items>
                           <Quantity>integer</Quantity>
                        </WhitelistedNames>
                     </Cookies>
                     <Headers>
                        <Items>
                           <Name>string</Name>
                        </Items>
                        <Quantity>integer</Quantity>
                     </Headers>
                     <QueryString>boolean</QueryString>
                     <QueryStringCacheKeys>
                        <Items>
                           <Name>string</Name>
                        </Items>
                        <Quantity>integer</Quantity>
                     </QueryStringCacheKeys>
                  </ForwardedValues>
                  <LambdaFunctionAssociations>
                     <Items>
                        <LambdaFunctionAssociation>
                           <EventType>string</EventType>
                           <LambdaFunctionARN>string</LambdaFunctionARN>
                        </LambdaFunctionAssociation>
                     </Items>
                     <Quantity>integer</Quantity>
                  </LambdaFunctionAssociations>
                  <MaxTTL>long</MaxTTL>
                  <MinTTL>long</MinTTL>
                  <PathPattern>string</PathPattern>
                  <SmoothStreaming>boolean</SmoothStreaming>
                  <TargetOriginId>string</TargetOriginId>
                  <TrustedSigners>
                     <Enabled>boolean</Enabled>
                     <Items>
                        <AwsAccountNumber>string</AwsAccountNumber>
                     </Items>
                     <Quantity>integer</Quantity>
                  </TrustedSigners>
                  <ViewerProtocolPolicy>string</ViewerProtocolPolicy>
               </CacheBehavior>
            </Items>
            <Quantity>integer</Quantity>
         </CacheBehaviors>
         <Comment>string</Comment>
         <CustomErrorResponses>
            <Items>
               <CustomErrorResponse>
                  <ErrorCachingMinTTL>long</ErrorCachingMinTTL>
                  <ErrorCode>integer</ErrorCode>
                  <ResponseCode>string</ResponseCode>
                  <ResponsePagePath>string</ResponsePagePath>
               </CustomErrorResponse>
            </Items>
            <Quantity>integer</Quantity>
         </CustomErrorResponses>
         <DefaultCacheBehavior>
            <AllowedMethods>
               <CachedMethods>
                  <Items>
                     <Method>string</Method>
                  </Items>
                  <Quantity>integer</Quantity>
               </CachedMethods>
               <Items>
                  <Method>string</Method>
               </Items>
               <Quantity>integer</Quantity>
            </AllowedMethods>
            <Compress>boolean</Compress>
            <DefaultTTL>long</DefaultTTL>
            <ForwardedValues>
               <Cookies>
                  <Forward>string</Forward>
                  <WhitelistedNames>
                     <Items>
                        <Name>string</Name>
                     </Items>
                     <Quantity>integer</Quantity>
                  </WhitelistedNames>
               </Cookies>
               <Headers>
                  <Items>
                     <Name>string</Name>
                  </Items>
                  <Quantity>integer</Quantity>
               </Headers>
               <QueryString>boolean</QueryString>
               <QueryStringCacheKeys>
                  <Items>
                     <Name>string</Name>
                  </Items>
                  <Quantity>integer</Quantity>
               </QueryStringCacheKeys>
            </ForwardedValues>
            <LambdaFunctionAssociations>
               <Items>
                  <LambdaFunctionAssociation>
                     <EventType>string</EventType>
                     <LambdaFunctionARN>string</LambdaFunctionARN>
                  </LambdaFunctionAssociation>
               </Items>
               <Quantity>integer</Quantity>
            </LambdaFunctionAssociations>
            <MaxTTL>long</MaxTTL>
            <MinTTL>long</MinTTL>
            <SmoothStreaming>boolean</SmoothStreaming>
            <TargetOriginId>string</TargetOriginId>
            <TrustedSigners>
               <Enabled>boolean</Enabled>
               <Items>
                  <AwsAccountNumber>string</AwsAccountNumber>
               </Items>
               <Quantity>integer</Quantity>
            </TrustedSigners>
            <ViewerProtocolPolicy>string</ViewerProtocolPolicy>
         </DefaultCacheBehavior>
         <DomainName>string</DomainName>
         <Enabled>boolean</Enabled>
         <HttpVersion>string</HttpVersion>
         <Id>string</Id>
         <IsIPV6Enabled>boolean</IsIPV6Enabled>
         <LastModifiedTime>timestamp</LastModifiedTime>
         <Origins>
            <Items>
               <Origin>
                  <CustomHeaders>
                     <Items>
                        <OriginCustomHeader>
                           <HeaderName>string</HeaderName>
                           <HeaderValue>string</HeaderValue>
                        </OriginCustomHeader>
                     </Items>
                     <Quantity>integer</Quantity>
                  </CustomHeaders>
                  <CustomOriginConfig>
                     <HTTPPort>integer</HTTPPort>
                     <HTTPSPort>integer</HTTPSPort>
                     <OriginKeepaliveTimeout>integer</OriginKeepaliveTimeout>
                     <OriginProtocolPolicy>string</OriginProtocolPolicy>
                     <OriginReadTimeout>integer</OriginReadTimeout>
                     <OriginSslProtocols>
                        <Items>
                           <SslProtocol>string</SslProtocol>
                        </Items>
                        <Quantity>integer</Quantity>
                     </OriginSslProtocols>
                  </CustomOriginConfig>
                  <DomainName>string</DomainName>
                  <Id>string</Id>
                  <OriginPath>string</OriginPath>
                  <S3OriginConfig>
                     <OriginAccessIdentity>string</OriginAccessIdentity>
                  </S3OriginConfig>
               </Origin>
            </Items>
            <Quantity>integer</Quantity>
         </Origins>
         <PriceClass>string</PriceClass>
         <Restrictions>
            <GeoRestriction>
               <Items>
                  <Location>string</Location>
               </Items>
               <Quantity>integer</Quantity>
               <RestrictionType>string</RestrictionType>
            </GeoRestriction>
         </Restrictions>
         <Status>string</Status>
         <ViewerCertificate>
            <ACMCertificateArn>string</ACMCertificateArn>
            <Certificate>string</Certificate>
            <CertificateSource>string</CertificateSource>
            <CloudFrontDefaultCertificate>boolean</CloudFrontDefaultCertificate>
            <IAMCertificateId>string</IAMCertificateId>
            <MinimumProtocolVersion>string</MinimumProtocolVersion>
            <SSLSupportMethod>string</SSLSupportMethod>
         </ViewerCertificate>
         <WebACLId>string</WebACLId>
      </DistributionSummary>
   </Items>
   <Marker>string</Marker>
   <MaxItems>integer</MaxItems>
   <NextMarker>string</NextMarker>
   <Quantity>integer</Quantity>
</DistributionList>

Response Elements

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

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

DistributionList

Root level tag for the DistributionList parameters.

Required: Yes

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: Boolean

Items

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

Type: Array of DistributionSummary objects

Marker

The value you provided for the Marker request parameter.

Type: String

MaxItems

The value you provided for the MaxItems request parameter.

Type: Integer

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

Quantity

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

Type: Integer

Errors

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

InvalidArgument

The argument is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: