Skip to content

list_procurement_portal_suppliers

list_procurement_portal_suppliers(
    portal_identifier: ProcurementPortalIdString,
    *,
    config_overrides: Optional[InvoicingClientConfig] = None,
    next_token: Optional[BasicStringWithoutSpace] = None,
    max_results: Optional[MaxResults] = None,
) -> ListProcurementPortalSuppliersResponse

Returns the suppliers configured for a specified procurement portal, including supplier identifiers and associated metadata. For faster, more reliable responses, use pagination.

Parameters:

  • portal_identifier (ProcurementPortalIdString) –

    The unique identifier of the procurement portal for which to list suppliers. Use the PortalIdentifier value returned by ListProcurementPortals.

  • 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:

ListProcurementPortalSuppliers

>>> client.list_procurement_portal_suppliers(portal_identifier='KXMJQWBRNP')
Source code in docs_src/capo_invoicing/_services/invoicing.py
def list_procurement_portal_suppliers(
    self,
    portal_identifier: "capo_invoicing.types.procurement_portal_id_string.ProcurementPortalIdString",
    *,
    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_portal_suppliers_response.ListProcurementPortalSuppliersResponse":
    """<p>Returns the suppliers configured for a specified procurement portal, including supplier identifiers and associated metadata. For faster, more reliable responses, use pagination.</p>

    Args:
        portal_identifier: <p>The unique identifier of the procurement portal for which to list suppliers. Use the <code>PortalIdentifier</code> value returned by <code>ListProcurementPortals</code>.</p>
        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.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found. </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:
        ListProcurementPortalSuppliers

        >>> client.list_procurement_portal_suppliers(portal_identifier='KXMJQWBRNP')
    """

    def _handler(
        req: "OperationRequest[capo_invoicing.types.list_procurement_portal_suppliers_request.ListProcurementPortalSuppliersRequest]",
    ) -> OperationResponse[
        "capo_invoicing.types.list_procurement_portal_suppliers_response.ListProcurementPortalSuppliersResponse"
    ]:
        import capo_invoicing._operations.invoicing.list_procurement_portal_suppliers

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListProcurementPortalSuppliers")
    )
    input_: capo_invoicing.types.list_procurement_portal_suppliers_request.ListProcurementPortalSuppliersRequest = {
        "portal_identifier": portal_identifier
    }
    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