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

ListDistributionsByWebACLId

List the distributions that are associated with a specified AWS WAF web ACL.

Request Syntax

GET /2016-09-29/distributionsByWebACLId/WebACLId?Marker=Marker&MaxItems=MaxItems HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

Marker

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

MaxItems

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

WebACLId

The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListDistributionsByWebACLIdResult>
   <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>
                     <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>
               <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>
                        <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>
            <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>
</ListDistributionsByWebACLIdResult>

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.

ListDistributionsByWebACLIdResult

Root level tag for the ListDistributionsByWebACLIdResult parameters.

Required: Yes

DistributionList

The DistributionList type.

Type: DistributionList object

Errors

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

InvalidArgument

The argument is invalid.

HTTP Status Code: 400

InvalidWebACLId

HTTP Status Code: 400