CloudFront / Client / list_distributions_by_vpc_origin_id

list_distributions_by_vpc_origin_id

CloudFront.Client.list_distributions_by_vpc_origin_id(**kwargs)

List CloudFront distributions by their VPC origin ID.

See also: AWS API Documentation

Request Syntax

response = client.list_distributions_by_vpc_origin_id(
    Marker='string',
    MaxItems='string',
    VpcOriginId='string'
)
Parameters:

  • Marker (string) – The marker associated with the VPC origin distributions list.

  • MaxItems (string) – The maximum number of items included in the list.

  • VpcOriginId (string) –

    [REQUIRED]

    The VPC origin ID.

Return type:

dict

Returns:

Response Syntax

{
    'DistributionIdList': {
        'Marker': 'string',
        'NextMarker': 'string',
        'MaxItems': 123,
        'IsTruncated': True|False,
        'Quantity': 123,
        'Items': [
            'string',
        ]
    }
}

Response Structure

  • (dict) –

    • DistributionIdList (dict) –

      A list of distribution IDs.

      • Marker (string) –

        The value provided in the Marker request field.

      • NextMarker (string) –

        Contains the value that you should use in the Marker field of a subsequent request to continue listing distribution IDs where you left off.

      • MaxItems (integer) –

        The maximum number of distribution IDs requested.

      • IsTruncated (boolean) –

        A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you can make a subsequent request using the Marker request field to retrieve more distribution IDs in the list.

      • Quantity (integer) –

        The total number of distribution IDs returned in the response.

      • Items (list) –

        Contains the distribution IDs in the list.

        • (string) –

Exceptions

  • CloudFront.Client.exceptions.EntityNotFound

  • CloudFront.Client.exceptions.AccessDenied

  • CloudFront.Client.exceptions.UnsupportedOperation

  • CloudFront.Client.exceptions.InvalidArgument