CloudFront / Client / list_distributions_by_owned_resource

list_distributions_by_owned_resource

CloudFront.Client.list_distributions_by_owned_resource(**kwargs)

Lists the CloudFront distributions that are associated with the specified resource that you own.

See also: AWS API Documentation

Request Syntax

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

  • ResourceArn (string) –

    [REQUIRED]

    The ARN of the CloudFront resource that you’ve shared with other Amazon Web Services accounts.

  • Marker (string) – 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.

  • MaxItems (string) – The maximum number of distributions to return.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • DistributionList (dict) –

      The list of distributions that are using the shared resource.

      • Marker (string) –

        Use this field when paginating results to indicate where to begin in your list of DistributionIdOwner objects. 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.

      • NextMarker (string) –

        A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.

      • MaxItems (integer) –

        The maximum number of DistributionIdOwner objects to return.

      • IsTruncated (boolean) –

        A flag that indicates whether more DistributionIdOwner objects 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 results in the list.

      • Quantity (integer) –

        Specifies the actual number of DistributionIdOwner objects included in the list for the current page.

      • Items (list) –

        The number of DistributionIdOwner objects.

        • (dict) –

          A structure that pairs a CloudFront distribution ID with its owning Amazon Web Services account ID.

          • DistributionId (string) –

            The ID of the distribution.

          • OwnerAccountId (string) –

            The ID of the Amazon Web Services account that owns the distribution.

Exceptions

  • CloudFront.Client.exceptions.AccessDenied

  • CloudFront.Client.exceptions.EntityNotFound

  • CloudFront.Client.exceptions.UnsupportedOperation

  • CloudFront.Client.exceptions.InvalidArgument