BedrockAgentCoreControl / Client / list_payment_connectors

list_payment_connectors

BedrockAgentCoreControl.Client.list_payment_connectors(**kwargs)

Lists all payment connectors for a specified payment manager.

See also: AWS API Documentation

Request Syntax

response = client.list_payment_connectors(
    paymentManagerId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • paymentManagerId (string) –

    [REQUIRED]

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

  • 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

{
    'paymentConnectors': [
        {
            'paymentConnectorId': 'string',
            'name': 'string',
            'type': 'CoinbaseCDP'|'StripePrivy',
            'provisionMode': 'MANUAL'|'QUICK_CREATE',
            'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED'|'PENDING_AUTHENTICATION'|'PROVISIONING'|'AUTHENTICATION_EXPIRED'|'AUTHENTICATION_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.

        • provisionMode (string) –

          Specifies how the payment connector was provisioned. Payment connectors that were created before this field was available return MANUAL.

          • MANUAL - You provided the credential provider configurations, so you own the credentials.

          • QUICK_CREATE - AgentCore provisioned the credential provider for you, so the credentials are service-managed and you can rotate them with RotatePaymentConnectorCredentials.

        • 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) –

      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