Skip to content

list_orders

list_orders(
    *,
    config_overrides: Optional[OutpostsClientConfig] = None,
    outpost_identifier_filter: Optional[OutpostIdentifier] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxResults1000] = None,
) -> ListOrdersOutput

Lists the Outpost orders for your Amazon Web Services account.

Parameters:

  • outpost_identifier_filter (Optional[OutpostIdentifier], default: None ) –

    The ID or the Amazon Resource Name (ARN) of the Outpost.

Raises:

Source code in docs_src/capo_outposts/_services/outposts.py
def list_orders(
    self,
    *,
    config_overrides: Optional[OutpostsClientConfig] = None,
    outpost_identifier_filter: Optional[
        "capo_outposts.types.outpost_identifier.OutpostIdentifier"
    ] = None,
    next_token: Optional["capo_outposts.types.token.Token"] = None,
    max_results: Optional[
        "capo_outposts.types.max_results1000.MaxResults1000"
    ] = None,
) -> "capo_outposts.types.list_orders_output.ListOrdersOutput":
    """<p>Lists the Outpost orders for your Amazon Web Services account.</p>

    Args:
        outpost_identifier_filter: <p> The ID or the Amazon Resource Name (ARN) of the Outpost. </p>

    Raises:
        capo_outposts.errors.access_denied_exception.AccessDeniedException: <p>You do not have permission to perform this operation.</p>
        capo_outposts.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_outposts.errors.not_found_exception.NotFoundException: <p>The specified request is not valid.</p>
        capo_outposts.errors.validation_exception.ValidationException: <p>A parameter is not valid.</p>
        capo_outposts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_outposts.types.list_orders_input.ListOrdersInput]",
    ) -> OperationResponse[
        "capo_outposts.types.list_orders_output.ListOrdersOutput"
    ]:
        import capo_outposts._operations.outposts_olaf_service.list_orders

        output, http_response = (
            capo_outposts._operations.outposts_olaf_service.list_orders.list_orders(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListOrders")
    )
    input_: capo_outposts.types.list_orders_input.ListOrdersInput = {}
    if outpost_identifier_filter is not None:
        input_["outpost_identifier_filter"] = outpost_identifier_filter
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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