BedrockAgentCore / Paginator / ListPaymentInstruments

ListPaymentInstruments¶

class BedrockAgentCore.Paginator.ListPaymentInstruments¶

paginator = client.get_paginator('list_payment_instruments')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from BedrockAgentCore.Client.list_payment_instruments().

Request Syntax

response_iterator = paginator.paginate(
    userId='string',
    agentName='string',
    paymentManagerArn='string',
    paymentConnectorId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

userId (string) – The user ID associated with the payment instruments.
agentName (string) – The agent name associated with this request, used for observability.
paymentManagerArn (string) –
[REQUIRED]

The ARN of the payment manager that owns the payment instruments.
paymentConnectorId (string) – The ID of the payment connector to filter by.
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

{
    'paymentInstruments': [
        {
            'paymentInstrumentId': 'string',
            'paymentManagerArn': 'string',
            'paymentConnectorId': 'string',
            'userId': 'string',
            'paymentInstrumentType': 'EMBEDDED_CRYPTO_WALLET',
            'status': 'INITIATED'|'ACTIVE'|'FAILED'|'DELETED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

Response structure for listing payment instruments.
- paymentInstruments (list) –
  
  List of payment instrument summaries matching the request criteria.
  - (dict) –
    
    Summary of a payment instrument for list operations.
    - paymentInstrumentId (string) –
      
      The unique identifier for this payment instrument.
    - paymentManagerArn (string) –
      
      The ARN of the payment manager that owns this payment instrument.
    - paymentConnectorId (string) –
      
      The ID of the payment connector associated with this instrument.
    - userId (string) –
      
      The user ID associated with this payment instrument.
    - paymentInstrumentType (string) –
      
      The type of payment instrument (e.g., EMBEDDED_CRYPTO_WALLET).
    - status (string) –
      
      The current status of this payment instrument.
    - createdAt (datetime) –
      
      The timestamp when this payment instrument was created.
    - updatedAt (datetime) –
      
      The timestamp when this payment instrument was last updated.
- NextToken (string) –
  
  A token to resume pagination.