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

ListDistributionsByRealtimeLogConfig

Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.

You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Request Syntax


POST /2020-05-31/distributionsByRealtimeLogConfig HTTP/1.1
<?xml version="1.0" encoding="UTF-8"?>
<ListDistributionsByRealtimeLogConfigRequest xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/">
   <Marker>string</Marker>
   <MaxItems>string</MaxItems>
   <RealtimeLogConfigArn>string</RealtimeLogConfigArn>
   <RealtimeLogConfigName>string</RealtimeLogConfigName>
</ListDistributionsByRealtimeLogConfigRequest>

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in XML format.

ListDistributionsByRealtimeLogConfigRequest

Root level tag for the ListDistributionsByRealtimeLogConfigRequest parameters.

Required: Yes

Marker

Use this field when paginating results to indicate where to begin in your list of distributions. The response includes distributions in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.

Type: String

Required: No

MaxItems

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

Type: String

Required: No

RealtimeLogConfigArn

The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list.

Type: String

Required: No

RealtimeLogConfigName

The name of the real-time log configuration whose associated distributions you want to list.

Type: String

Required: No

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