BedrockAgentCoreControl / Paginator / ListPaymentConnectors

ListPaymentConnectors

class BedrockAgentCoreControl.Paginator.ListPaymentConnectors
paginator = client.get_paginator('list_payment_connectors')
paginate(**kwargs)

Creates an iterator that will paginate through responses from BedrockAgentCoreControl.Client.list_payment_connectors().

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The unique identifier of the payment manager whose connectors to list.

  • 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

{
    'paymentConnectors': [
        {
            'paymentConnectorId': 'string',
            'name': 'string',
            'type': 'CoinbaseCDP'|'StripePrivy',
            'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • paymentConnectors (list) –

      The list of payment connector summaries. For details about the fields in each summary, see the PaymentConnectorSummary data type.

      • (dict) –

        Contains summary information about a payment connector.

        • paymentConnectorId (string) –

          The unique identifier of the payment connector.

        • name (string) –

          The name of the payment connector.

        • type (string) –

          The type of the payment connector, which determines the payment provider integration.

        • status (string) –

          The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

        • lastUpdatedAt (datetime) –

          The timestamp when the payment connector was last updated.

    • NextToken (string) –

      A token to resume pagination.