BedrockAgentCoreControl / Client / get_payment_credential_provider

get_payment_credential_provider¶

BedrockAgentCoreControl.Client.get_payment_credential_provider(**kwargs)¶

Retrieves information about a specific payment credential provider.

Request Syntax

response = client.get_payment_credential_provider(
    name='string'
)

Parameters:

name (string) –

[REQUIRED]

The name of the payment credential provider to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'credentialProviderArn': 'string',
    'credentialProviderVendor': 'CoinbaseCDP'|'StripePrivy',
    'providerConfigurationOutput': {
        'coinbaseCdpConfiguration': {
            'apiKeyId': 'string',
            'apiKeySecretArn': {
                'secretArn': 'string'
            },
            'walletSecretArn': {
                'secretArn': 'string'
            }
        },
        'stripePrivyConfiguration': {
            'appId': 'string',
            'appSecretArn': {
                'secretArn': 'string'
            },
            'authorizationPrivateKeyArn': {
                'secretArn': 'string'
            },
            'authorizationId': 'string'
        }
    },
    'createdTime': datetime(2015, 1, 1),
    'lastUpdatedTime': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- name (string) –
  
  The name of the payment credential provider.
- credentialProviderArn (string) –
  
  The Amazon Resource Name (ARN) of the payment credential provider.
- credentialProviderVendor (string) –
  
  The vendor type for the payment credential provider.
- providerConfigurationOutput (dict) –
  
  Output configuration (contains secret ARNs, excludes actual secret values).
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: coinbaseCdpConfiguration, stripePrivyConfiguration. 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'}
  - coinbaseCdpConfiguration (dict) –
    
    The Coinbase CDP configuration.
    - apiKeyId (string) –
      
      The API key identifier provided by Coinbase Developer Platform.
    - apiKeySecretArn (dict) –
      
      Contains information about a secret in AWS Secrets Manager.
      - secretArn (string) –
        
        The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
    - walletSecretArn (dict) –
      
      Contains information about a secret in AWS Secrets Manager.
      - secretArn (string) –
        
        The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
  - stripePrivyConfiguration (dict) –
    
    The Stripe Privy configuration.
    - appId (string) –
      
      The app ID provided by Privy.
    - appSecretArn (dict) –
      
      Contains information about a secret in AWS Secrets Manager.
      - secretArn (string) –
        
        The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
    - authorizationPrivateKeyArn (dict) –
      
      Contains information about a secret in AWS Secrets Manager.
      - secretArn (string) –
        
        The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
    - authorizationId (string) –
      
      The authorization ID for the Stripe Privy integration.
- createdTime (datetime) –
  
  The timestamp when the payment credential provider was created.
- lastUpdatedTime (datetime) –
  
  The timestamp when the payment credential provider was last updated.
- tags (dict) –
  
  The tags associated with the payment credential provider.
  - (string) –
    - (string) –

Exceptions

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