Invoicing / Paginator / ListProcurementPortals

ListProcurementPortals

class Invoicing.Paginator.ListProcurementPortals
paginator = client.get_paginator('list_procurement_portals')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Invoicing.Client.list_procurement_portals().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'ProcurementPortals': [
        {
            'PortalIdentifier': 'string',
            'PortalName': 'SAP_BUSINESS_NETWORK'|'COUPA',
            'PortalDisplayName': 'string',
            'DefaultFeatureConfigurations': {
                'InvoiceConfiguration': {
                    'DocumentTypes': [
                        'AWS_CLOUD_INVOICE'|'AWS_CLOUD_CREDIT_MEMO'|'AWS_MARKETPLACE_INVOICE'|'AWS_MARKETPLACE_CREDIT_MEMO'|'AWS_REQUEST_FOR_PAYMENT',
                    ],
                    'AttachmentTypes': [
                        'INVOICE_PDF'|'RFP_PDF',
                    ]
                }
            }
        },
    ],

}

Response Structure

  • (dict) –

    • ProcurementPortals (list) –

      The list of procurement portals available for configuration.

      • (dict) –

        Contains metadata for a procurement portal, including the portal identifier, name, and default feature configurations.

        • PortalIdentifier (string) –

          The unique identifier of the procurement portal.

        • PortalName (string) –

          The name of the procurement portal.

        • PortalDisplayName (string) –

          The display name of the procurement portal.

        • DefaultFeatureConfigurations (dict) –

          The default feature configurations for the procurement portal.

          • InvoiceConfiguration (dict) –

            The invoice configuration settings for the procurement portal.

            • DocumentTypes (list) –

              The e-invoice document types supported by the procurement portal.

              • (string) –

            • AttachmentTypes (list) –

              The attachment types supported by the procurement portal for e-invoice delivery.

              • (string) –