BedrockAgentCoreControl / Client / list_payment_managers

list_payment_managers¶

BedrockAgentCoreControl.Client.list_payment_managers(**kwargs)¶

Lists all payment managers in the account.

Request Syntax

response = client.list_payment_managers(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Return type:

dict

Returns:

Response Syntax

{
    'paymentManagers': [
        {
            'paymentManagerArn': 'string',
            'paymentManagerId': 'string',
            'name': 'string',
            'description': 'string',
            'authorizerType': 'CUSTOM_JWT'|'AWS_IAM',
            'roleArn': 'string',
            'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- paymentManagers (list) –
  
  The list of payment manager summaries. For details about the fields in each summary, see the PaymentManagerSummary data type.
  - (dict) –
    
    Contains summary information about a payment manager.
    - paymentManagerArn (string) –
      
      The Amazon Resource Name (ARN) of the payment manager.
    - paymentManagerId (string) –
      
      The unique identifier of the payment manager.
    - name (string) –
      
      The name of the payment manager.
    - description (string) –
      
      The description of the payment manager.
    - authorizerType (string) –
      
      The type of authorizer used by the payment manager.
      - CUSTOM_JWT - Authorize with a bearer token.
      - AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
    - roleArn (string) –
      
      The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.
    - status (string) –
      
      The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
    - createdAt (datetime) –
      
      The timestamp when the payment manager was created.
    - lastUpdatedAt (datetime) –
      
      The timestamp when the payment manager was last updated.
- nextToken (string) –
  
  If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions

BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException