Skip to content

list_procurement_portals

list_procurement_portals(
    *,
    config_overrides: Optional[InvoicingClientConfig] = None,
    next_token: Optional[BasicStringWithoutSpace] = None,
    max_results: Optional[MaxResults] = None,
) -> ListProcurementPortalsResponse

Returns the Amazon Web Services-supported procurement portals for e-invoice delivery and purchase order retrieval. Each entry includes the portal identifier, name, and default feature configurations, which define the supported document and attachment types. For faster, more reliable responses, use pagination.

Parameters:

  • next_token (Optional[BasicStringWithoutSpace], default: None ) –

    The token for the next set of results. You received this token from a previous call.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. Default is 100.

Raises:

Examples:

ListProcurementPortals

>>> client.list_procurement_portals()
Source code in docs_src/capo_invoicing/_services/invoicing.py
def list_procurement_portals(
    self,
    *,
    config_overrides: Optional[InvoicingClientConfig] = None,
    next_token: Optional[
        "capo_invoicing.types.basic_string_without_space.BasicStringWithoutSpace"
    ] = None,
    max_results: Optional["capo_invoicing.types.max_results.MaxResults"] = None,
) -> "capo_invoicing.types.list_procurement_portals_response.ListProcurementPortalsResponse":
    """<p>Returns the Amazon Web Services-supported procurement portals for e-invoice delivery and purchase order retrieval. Each entry includes the portal identifier, name, and default feature configurations, which define the supported document and attachment types. For faster, more reliable responses, use pagination.</p>

    Args:
        next_token: <p>The token for the next set of results. You received this token from a previous call.</p>
        max_results: <p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. Default is 100.</p>

    Raises:
        capo_invoicing.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
        capo_invoicing.errors.internal_server_exception.InternalServerException: <p>The processing request failed because of an unknown error, exception, or failure. </p>
        capo_invoicing.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_invoicing.errors.validation_exception.ValidationException: <p> The input fails to satisfy the constraints specified by an Amazon Web Services service. </p>
        capo_invoicing.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        ListProcurementPortals

        >>> client.list_procurement_portals()
    """

    def _handler(
        req: "OperationRequest[capo_invoicing.types.list_procurement_portals_request.ListProcurementPortalsRequest]",
    ) -> OperationResponse[
        "capo_invoicing.types.list_procurement_portals_response.ListProcurementPortalsResponse"
    ]:
        import capo_invoicing._operations.invoicing.list_procurement_portals

        output, http_response = (
            capo_invoicing._operations.invoicing.list_procurement_portals.list_procurement_portals(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListProcurementPortals")
    )
    input_: capo_invoicing.types.list_procurement_portals_request.ListProcurementPortalsRequest = {}
    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