Skip to content

list_vpc_origins

list_vpc_origins(
    *,
    config_overrides: Optional[CloudFrontClientConfig] = None,
    marker: Optional[string] = None,
    max_items: Optional[integer] = None,
) -> ListVpcOriginsResult

List the CloudFront VPC origins in your account.

Parameters:

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

    The marker associated with the VPC origins list.

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

    The maximum number of items included in the list.

Raises:

Examples:

To list VPC origins The following command lists VPC origins:

>>> client.list_vpc_origins()
Source code in docs_src/capo_cloudfront/_services/cloud_front.py
def list_vpc_origins(
    self,
    *,
    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_vpc_origins_result.ListVpcOriginsResult":
    """<p>List the CloudFront VPC origins in your account.</p>

    Args:
        marker: <p>The marker associated with the VPC origins list.</p>
        max_items: <p>The maximum number of items included in the list.</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 VPC origins
        The following command lists VPC origins:

        >>> client.list_vpc_origins()
    """

    def _handler(
        req: "OperationRequest[capo_cloudfront.types.list_vpc_origins_request.ListVpcOriginsRequest]",
    ) -> OperationResponse[
        "capo_cloudfront.types.list_vpc_origins_result.ListVpcOriginsResult"
    ]:
        import capo_cloudfront._operations.cloudfront2020_05_31.list_vpc_origins

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListVpcOrigins")
    )
    input_: capo_cloudfront.types.list_vpc_origins_request.ListVpcOriginsRequest = {}
    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