BedrockAgentCore / Client / list_payment_instruments

list_payment_instruments¶

BedrockAgentCore.Client.list_payment_instruments(**kwargs)¶

List payment instruments for a manager

Request Syntax

response = client.list_payment_instruments(
    userId='string',
    agentName='string',
    paymentManagerArn='string',
    paymentConnectorId='string',
    nextToken='string',
    maxResults=123
)

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.
nextToken (string) – Token for pagination to retrieve the next set of results.
maxResults (integer) – Maximum number of results to return in a single 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) –
  
  Token for pagination to retrieve the next set of results.

Exceptions

BedrockAgentCore.Client.exceptions.AccessDeniedException
BedrockAgentCore.Client.exceptions.ValidationException
BedrockAgentCore.Client.exceptions.ThrottlingException
BedrockAgentCore.Client.exceptions.InternalServerException