Menu
Amazon CloudFront
API Reference (API Version 2016-09-29)

GetDistribution

Get the information about a distribution.

Request Syntax

GET /2016-09-29/distribution/Id HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

Id

The distribution's ID.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
ETag: ETag
<?xml version="1.0" encoding="UTF-8"?>
<GetDistributionResult>
   <Distribution>
      <ActiveTrustedSigners>
         <Enabled>boolean</Enabled>
         <Items>
            <Signer>
               <AwsAccountNumber>string</AwsAccountNumber>
               <KeyPairIds>
                  <Items>
                     <KeyPairId>string</KeyPairId></Items>
                  <Quantity>integer</Quantity>
               </KeyPairIds>
            </Signer></Items>
         <Quantity>integer</Quantity>
      </ActiveTrustedSigners>
      <ARN>string</ARN>
      <DistributionConfig>
         <Aliases>
            <Items>
               <CNAME>string</CNAME></Items>
            <Quantity>integer</Quantity>
         </Aliases>
         <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>
                  <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>
         <CallerReference>string</CallerReference>
         <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>
            <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>
         <DefaultRootObject>string</DefaultRootObject>
         <Enabled>boolean</Enabled>
         <HttpVersion>string</HttpVersion>
         <IsIPV6Enabled>boolean</IsIPV6Enabled>
         <Logging>
            <Bucket>string</Bucket>
            <Enabled>boolean</Enabled>
            <IncludeCookies>boolean</IncludeCookies>
            <Prefix>string</Prefix>
         </Logging>
         <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>
                     <OriginProtocolPolicy>string</OriginProtocolPolicy>
                     <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>
         <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>
      </DistributionConfig>
      <DomainName>string</DomainName>
      <Id>string</Id>
      <InProgressInvalidationBatches>integer</InProgressInvalidationBatches>
      <LastModifiedTime>timestamp</LastModifiedTime>
      <Status>string</Status>
   </Distribution>
</GetDistributionResult>

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 distribution's information. For example: E2QWRUHAPOMQZL.

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

GetDistributionResult

Root level tag for the GetDistributionResult parameters.

Required: Yes

Distribution

The distribution's information.

Type: Distribution object

Errors

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

AccessDenied

Access denied.

HTTP Status Code: 403

NoSuchDistribution

The specified distribution does not exist.

HTTP Status Code: 404