BedrockAgentCoreControl / Client / get_payment_connector

get_payment_connector¶

BedrockAgentCoreControl.Client.get_payment_connector(**kwargs)¶

Retrieves information about a specific payment connector.

Request Syntax

response = client.get_payment_connector(
    paymentManagerId='string',
    paymentConnectorId='string'
)

Parameters:

paymentManagerId (string) –
[REQUIRED]

The unique identifier of the parent payment manager.
paymentConnectorId (string) –
[REQUIRED]

The unique identifier of the payment connector to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'paymentConnectorId': 'string',
    'name': 'string',
    'description': 'string',
    'type': 'CoinbaseCDP'|'StripePrivy',
    'credentialProviderConfigurations': [
        {
            'coinbaseCDP': {
                'credentialProviderArn': 'string'
            },
            'stripePrivy': {
                'credentialProviderArn': 'string'
            }
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'
}

Response Structure

(dict) –
- paymentConnectorId (string) –
  
  The unique identifier of the payment connector.
- name (string) –
  
  The name of the payment connector.
- description (string) –
  
  The description of the payment connector.
- type (string) –
  
  The type of the payment connector, which determines the payment provider integration.
- credentialProviderConfigurations (list) –
  
  The credential provider configurations for the payment connector.
  - (dict) –
    
    The credential provider configuration for a payment connector. Specifies the payment provider type and its associated credential provider.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: coinbaseCDP, stripePrivy. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - coinbaseCDP (dict) –
      
      The credential provider configuration for a Coinbase CDP payment connector.
      - credentialProviderArn (string) –
        
        The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
    - stripePrivy (dict) –
      
      The credential provider configuration for a Stripe Privy payment connector.
      - credentialProviderArn (string) –
        
        The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
- createdAt (datetime) –
  
  The timestamp when the payment connector was created.
- lastUpdatedAt (datetime) –
  
  The timestamp when the payment connector was last updated.
- status (string) –
  
  The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

Exceptions

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