Skip to content

list_distributions_by_vpc_origin_id

list_distributions_by_vpc_origin_id(
    vpc_origin_id: string,
    *,
    config_overrides: Optional[CloudFrontClientConfig] = None,
    marker: Optional[string] = None,
    max_items: Optional[integer] = None,
) -> ListDistributionsByVpcOriginIdResult

List CloudFront distributions by their VPC origin ID.

Parameters:

  • marker (Optional[string], default: None ) –

    The marker associated with the VPC origin distributions list.

  • max_items (Optional[integer], default: None ) –

    The maximum number of items included in the list.

  • vpc_origin_id (string) –

    The VPC origin ID.

Raises:

Examples:

To list distributions by VPC origin ID The following command lists distributions by VPC origin ID:

>>> client.list_distributions_by_vpc_origin_id(vpc_origin_id='vo_BQwjxxQxjCaBcQLzJUFkDM')
Source code in docs_src/capo_cloudfront/_services/cloud_front.py
def list_distributions_by_vpc_origin_id(
    self,
    vpc_origin_id: "capo_cloudfront.types.string.string",
    *,
    config_overrides: Optional[CloudFrontClientConfig] = None,
    marker: Optional["capo_cloudfront.types.string.string"] = None,
    max_items: Optional["capo_cloudfront.types.integer.integer"] = None,
) -> "capo_cloudfront.types.list_distributions_by_vpc_origin_id_result.ListDistributionsByVpcOriginIdResult":
    """<p>List CloudFront distributions by their VPC origin ID.</p>

    Args:
        marker: <p>The marker associated with the VPC origin distributions list.</p>
        max_items: <p>The maximum number of items included in the list.</p>
        vpc_origin_id: <p>The VPC origin ID.</p>

    Raises:
        capo_cloudfront.errors.access_denied.AccessDenied: <p>Access denied.</p>
        capo_cloudfront.errors.entity_not_found.EntityNotFound: <p>The entity was not found.</p>
        capo_cloudfront.errors.invalid_argument.InvalidArgument: <p>An argument is invalid.</p>
        capo_cloudfront.errors.unsupported_operation.UnsupportedOperation: <p>This operation is not supported in this Amazon Web Services Region.</p>
        capo_cloudfront.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To list distributions by VPC origin ID
        The following command lists distributions by VPC origin ID:

        >>> client.list_distributions_by_vpc_origin_id(vpc_origin_id='vo_BQwjxxQxjCaBcQLzJUFkDM')
    """

    def _handler(
        req: "OperationRequest[capo_cloudfront.types.list_distributions_by_vpc_origin_id_request.ListDistributionsByVpcOriginIdRequest]",
    ) -> OperationResponse[
        "capo_cloudfront.types.list_distributions_by_vpc_origin_id_result.ListDistributionsByVpcOriginIdResult"
    ]:
        import capo_cloudfront._operations.cloudfront2020_05_31.list_distributions_by_vpc_origin_id

        output, http_response = (
            capo_cloudfront._operations.cloudfront2020_05_31.list_distributions_by_vpc_origin_id.list_distributions_by_vpc_origin_id(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDistributionsByVpcOriginId")
    )
    input_: capo_cloudfront.types.list_distributions_by_vpc_origin_id_request.ListDistributionsByVpcOriginIdRequest = {
        "vpc_origin_id": vpc_origin_id
    }
    if marker is not None:
        input_["marker"] = marker
    if max_items is not None:
        input_["max_items"] = max_items

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output