Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListDistributionsByWebACLId

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

Request Syntax


GET /2020-05-31/distributionsByWebACLId/WebACLId?Marker=Marker&MaxItems=MaxItems HTTP/1.1

URI Request Parameters

The request uses 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.

For AWS WAFV2, this is the ARN of the web ACL, such as arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

For AWS WAF Classic, this is the ID of the web ACL, such as a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

Required: Yes

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>
         <AliasICPRecordals>
            <AliasICPRecordal>
               <CNAME>string</CNAME>
               <ICPRecordalStatus>string</ICPRecordalStatus>
            </AliasICPRecordal>
         </AliasICPRecordals>
         <AnycastIpListId>string</AnycastIpListId>
         <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>
                  <CachePolicyId>string</CachePolicyId>
                  <Compress>boolean</Compress>
                  <DefaultTTL>long</DefaultTTL>
                  <FieldLevelEncryptionId>string</FieldLevelEncryptionId>
                  <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>
                  <FunctionAssociations>
                     <Items>
                        <FunctionAssociation>
                           <EventType>string</EventType>
                           <FunctionARN>string</FunctionARN>
                        </FunctionAssociation>
                     </Items>
                     <Quantity>integer</Quantity>
                  </FunctionAssociations>
                  <GrpcConfig>
                     <Enabled>boolean</Enabled>
                  </GrpcConfig>
                  <LambdaFunctionAssociations>
                     <Items>
                        <LambdaFunctionAssociation>
                           <EventType>string</EventType>
                           <IncludeBody>boolean</IncludeBody>
                           <LambdaFunctionARN>string</LambdaFunctionARN>
                        </LambdaFunctionAssociation>
                     </Items>
                     <Quantity>integer</Quantity>
                  </LambdaFunctionAssociations>
                  <MaxTTL>long</MaxTTL>
                  <MinTTL>long</MinTTL>
                  <OriginRequestPolicyId>string</OriginRequestPolicyId>
                  <PathPattern>string</PathPattern>
                  <RealtimeLogConfigArn>string</RealtimeLogConfigArn>
                  <ResponseHeadersPolicyId>string</ResponseHeadersPolicyId>
                  <SmoothStreaming>boolean</SmoothStreaming>
                  <TargetOriginId>string</TargetOriginId>
                  <TrustedKeyGroups>
                     <Enabled>boolean</Enabled>
                     <Items>
                        <KeyGroup>string</KeyGroup>
                     </Items>
                     <Quantity>integer</Quantity>
                  </TrustedKeyGroups>
                  <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>
            <CachePolicyId>string</CachePolicyId>
            <Compress>boolean</Compress>
            <DefaultTTL>long</DefaultTTL>
            <FieldLevelEncryptionId>string</FieldLevelEncryptionId>
            <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>
            <FunctionAssociations>
               <Items>
                  <FunctionAssociation>
                     <EventType>string</EventType>
                     <FunctionARN>string</FunctionARN>
                  </FunctionAssociation>
               </Items>
               <Quantity>integer</Quantity>
            </FunctionAssociations>
            <GrpcConfig>
               <Enabled>boolean</Enabled>
            </GrpcConfig>
            <LambdaFunctionAssociations>
               <Items>
                  <LambdaFunctionAssociation>
                     <EventType>string</EventType>
                     <IncludeBody>boolean</IncludeBody>
                     <LambdaFunctionARN>string</LambdaFunctionARN>
                  </LambdaFunctionAssociation>
               </Items>
               <Quantity>integer</Quantity>
            </LambdaFunctionAssociations>
            <MaxTTL>long</MaxTTL>
            <MinTTL>long</MinTTL>
            <OriginRequestPolicyId>string</OriginRequestPolicyId>
            <RealtimeLogConfigArn>string</RealtimeLogConfigArn>
            <ResponseHeadersPolicyId>string</ResponseHeadersPolicyId>
            <SmoothStreaming>boolean</SmoothStreaming>
            <TargetOriginId>string</TargetOriginId>
            <TrustedKeyGroups>
               <Enabled>boolean</Enabled>
               <Items>
                  <KeyGroup>string</KeyGroup>
               </Items>
               <Quantity>integer</Quantity>
            </TrustedKeyGroups>
            <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>
         <OriginGroups>
            <Items>
               <OriginGroup>
                  <FailoverCriteria>
                     <StatusCodes>
                        <Items>
                           <StatusCode>integer</StatusCode>
                        </Items>
                        <Quantity>integer</Quantity>
                     </StatusCodes>
                  </FailoverCriteria>
                  <Id>string</Id>
                  <Members>
                     <Items>
                        <OriginGroupMember>
                           <OriginId>string</OriginId>
                        </OriginGroupMember>
                     </Items>
                     <Quantity>integer</Quantity>
                  </Members>
                  <SelectionCriteria>string</SelectionCriteria>
               </OriginGroup>
            </Items>
            <Quantity>integer</Quantity>
         </OriginGroups>
         <Origins>
            <Items>
               <Origin>
                  <ConnectionAttempts>integer</ConnectionAttempts>
                  <ConnectionTimeout>integer</ConnectionTimeout>
                  <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>
                  <OriginAccessControlId>string</OriginAccessControlId>
                  <OriginPath>string</OriginPath>
                  <OriginShield>
                     <Enabled>boolean</Enabled>
                     <OriginShieldRegion>string</OriginShieldRegion>
                  </OriginShield>
                  <S3OriginConfig>
                     <OriginAccessIdentity>string</OriginAccessIdentity>
                  </S3OriginConfig>
                  <VpcOriginConfig>
                     <OriginKeepaliveTimeout>integer</OriginKeepaliveTimeout>
                     <OriginReadTimeout>integer</OriginReadTimeout>
                     <VpcOriginId>string</VpcOriginId>
                  </VpcOriginConfig>
               </Origin>
            </Items>
            <Quantity>integer</Quantity>
         </Origins>
         <PriceClass>string</PriceClass>
         <Restrictions>
            <GeoRestriction>
               <Items>
                  <Location>string</Location>
               </Items>
               <Quantity>integer</Quantity>
               <RestrictionType>string</RestrictionType>
            </GeoRestriction>
         </Restrictions>
         <Staging>boolean</Staging>
         <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

An argument is invalid.

HTTP Status Code: 400

InvalidWebACLId

A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

HTTP Status Code: 400