CloudFront / Client / list_vpc_origins

list_vpc_origins#

CloudFront.Client.list_vpc_origins(**kwargs)#

List the CloudFront VPC origins in your account.

See also: AWS API Documentation

Request Syntax

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

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

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

Return type:

dict

Returns:

Response Syntax

{
    'VpcOriginList': {
        'Marker': 'string',
        'NextMarker': 'string',
        'MaxItems': 123,
        'IsTruncated': True|False,
        'Quantity': 123,
        'Items': [
            {
                'Id': 'string',
                'Name': 'string',
                'Status': 'string',
                'CreatedTime': datetime(2015, 1, 1),
                'LastModifiedTime': datetime(2015, 1, 1),
                'Arn': 'string',
                'OriginEndpointArn': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • VpcOriginList (dict) –

      List of VPC origins.

      • Marker (string) –

        The marker associated with the VPC origins list.

      • NextMarker (string) –

        The next marker associated with the VPC origins list.

      • MaxItems (integer) –

        The maximum number of items included in the list.

      • IsTruncated (boolean) –

        A flag that indicates whether more VPC origins 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 VPC origins in the list.

      • Quantity (integer) –

        The number of VPC origins in the list.

      • Items (list) –

        The items of the VPC origins list.

        • (dict) –

          A summary of the CloudFront VPC origin.

          • Id (string) –

            The VPC origin summary ID.

          • Name (string) –

            The VPC origin summary name.

          • Status (string) –

            The VPC origin summary status.

          • CreatedTime (datetime) –

            The VPC origin summary created time.

          • LastModifiedTime (datetime) –

            The VPC origin summary last modified time.

          • Arn (string) –

            The VPC origin summary ARN.

          • OriginEndpointArn (string) –

            The VPC origin summary origin endpoint ARN.

Exceptions

  • CloudFront.Client.exceptions.EntityNotFound

  • CloudFront.Client.exceptions.AccessDenied

  • CloudFront.Client.exceptions.UnsupportedOperation

  • CloudFront.Client.exceptions.InvalidArgument