CloudFront / Paginator / ListStreamingDistributions

ListStreamingDistributions#

class CloudFront.Paginator.ListStreamingDistributions#

paginator = client.get_paginator('list_streaming_distributions')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from CloudFront.Client.list_streaming_distributions().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –

The size of each page.
StartingToken (string) –

A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'StreamingDistributionList': {
        'Marker': 'string',
        'NextMarker': 'string',
        'MaxItems': 123,
        'IsTruncated': True|False,
        'Quantity': 123,
        'Items': [
            {
                'Id': 'string',
                'ARN': 'string',
                'Status': 'string',
                'LastModifiedTime': datetime(2015, 1, 1),
                'DomainName': 'string',
                'S3Origin': {
                    'DomainName': 'string',
                    'OriginAccessIdentity': 'string'
                },
                'Aliases': {
                    'Quantity': 123,
                    'Items': [
                        'string',
                    ]
                },
                'TrustedSigners': {
                    'Enabled': True|False,
                    'Quantity': 123,
                    'Items': [
                        'string',
                    ]
                },
                'Comment': 'string',
                'PriceClass': 'PriceClass_100'|'PriceClass_200'|'PriceClass_All',
                'Enabled': True|False
            },
        ]
    },
    'NextToken': 'string'
}

Response Structure

(dict) –

The returned result of the corresponding request.
- StreamingDistributionList (dict) –
  
  The StreamingDistributionList type.
  - Marker (string) –
    
    The value you provided for the Marker request parameter.
  - NextMarker (string) –
    
    If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.
  - MaxItems (integer) –
    
    The value you provided for the MaxItems request parameter.
  - IsTruncated (boolean) –
    
    A flag that indicates whether more streaming 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.
  - Quantity (integer) –
    
    The number of streaming distributions that were created by the current Amazon Web Services account.
  - Items (list) –
    
    A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current Amazon Web Services account.
    - (dict) –
      
      A summary of the information for a CloudFront streaming distribution.
      - Id (string) –
        
        The identifier for the distribution, for example, EDFDVBD632BHDS5.
      - ARN (string) –
        
        The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your Amazon Web Services account ID.
      - Status (string) –
        
        Indicates the current status of the distribution. When the status is Deployed, the distribution’s information is fully propagated throughout the Amazon CloudFront system.
      - LastModifiedTime (datetime) –
        
        The date and time the distribution was last modified.
      - DomainName (string) –
        
        The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.
      - S3Origin (dict) –
        
        A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
        
        DomainName (string) –
        
        The DNS name of the Amazon S3 origin.
        
        OriginAccessIdentity (string) –
        
        The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.
        
        If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
        
        To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
        
        To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
        
        For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide.
      - Aliases (dict) –
        
        A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
        
        Quantity (integer) –
        
        The number of CNAME aliases, if any, that you want to associate with this distribution.
        
        Items (list) –
        
        A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
        
        (string) –
      - TrustedSigners (dict) –
        
        A complex type that specifies the Amazon Web Services accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don’t want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it’s currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
        
        For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
        
        Enabled (boolean) –
        
        This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
        
        Quantity (integer) –
        
        The number of Amazon Web Services accounts in the list.
        
        Items (list) –
        
        A list of Amazon Web Services account identifiers.
        
        (string) –
      - Comment (string) –
        
        The comment originally specified when this distribution was created.
      - PriceClass (string) –
        
        A complex type that contains information about price class for this streaming distribution.
      - Enabled (boolean) –
        
        Whether the distribution is enabled to accept end user requests for content.
- NextToken (string) –
  
  A token to resume pagination.