BedrockAgentCoreControl / Client / create_payment_credential_provider

create_payment_credential_provider¶

BedrockAgentCoreControl.Client.create_payment_credential_provider(**kwargs)¶

Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.

Request Syntax

response = client.create_payment_credential_provider(
    name='string',
    credentialProviderVendor='CoinbaseCDP'|'StripePrivy',
    providerConfigurationInput={
        'coinbaseCdpConfiguration': {
            'apiKeyId': 'string',
            'apiKeySecret': 'string',
            'apiKeySecretSource': 'MANAGED'|'EXTERNAL',
            'apiKeySecretConfig': {
                'secretId': 'string',
                'jsonKey': 'string'
            },
            'walletSecret': 'string',
            'walletSecretSource': 'MANAGED'|'EXTERNAL',
            'walletSecretConfig': {
                'secretId': 'string',
                'jsonKey': 'string'
            }
        },
        'stripePrivyConfiguration': {
            'appId': 'string',
            'appSecret': 'string',
            'appSecretSource': 'MANAGED'|'EXTERNAL',
            'appSecretConfig': {
                'secretId': 'string',
                'jsonKey': 'string'
            },
            'authorizationPrivateKey': 'string',
            'authorizationPrivateKeySource': 'MANAGED'|'EXTERNAL',
            'authorizationPrivateKeyConfig': {
                'secretId': 'string',
                'jsonKey': 'string'
            },
            'authorizationId': 'string'
        }
    },
    tags={
        'string': 'string'
    }
)

Parameters:

name (string) –
[REQUIRED]

Unique name for the payment credential provider.
credentialProviderVendor (string) –
[REQUIRED]

The vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).
providerConfigurationInput (dict) –
[REQUIRED]

Configuration specific to the vendor, including API credentials.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: coinbaseCdpConfiguration, stripePrivyConfiguration.
- coinbaseCdpConfiguration (dict) –
  
  The Coinbase CDP configuration.
  - apiKeyId (string) – [REQUIRED]
    
    The API key identifier provided by Coinbase Developer Platform.
  - apiKeySecret (string) –
    
    The API key secret provided by Coinbase Developer Platform.
  - apiKeySecretSource (string) –
    
    The source type of the API key secret for the Coinbase Developer Platform. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in AWS Secrets Manager.
  - apiKeySecretConfig (dict) –
    
    A reference to the AWS Secrets Manager secret that stores the API key secret. This includes the secret ID and the JSON key used to extract the API key secret value from the secret. Required when apiKeySecretSource is set to EXTERNAL.
    - secretId (string) – [REQUIRED]
      
      The ID of the AWS Secrets Manager secret that stores the secret value.
    - jsonKey (string) – [REQUIRED]
      
      The JSON key used to extract the secret value from the AWS Secrets Manager secret.
  - walletSecret (string) –
    
    The wallet secret provided by Coinbase Developer Platform.
  - walletSecretSource (string) –
    
    The source type of the wallet secret for the Coinbase Developer Platform. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in AWS Secrets Manager.
  - walletSecretConfig (dict) –
    
    A reference to the AWS Secrets Manager secret that stores the wallet secret. This includes the secret ID and the JSON key used to extract the wallet secret value from the secret. Required when walletSecretSource is set to EXTERNAL.
    - secretId (string) – [REQUIRED]
      
      The ID of the AWS Secrets Manager secret that stores the secret value.
    - jsonKey (string) – [REQUIRED]
      
      The JSON key used to extract the secret value from the AWS Secrets Manager secret.
- stripePrivyConfiguration (dict) –
  
  The Stripe Privy configuration.
  - appId (string) – [REQUIRED]
    
    The app ID provided by Privy.
  - appSecret (string) –
    
    The app secret provided by Privy.
  - appSecretSource (string) –
    
    The source type of the app secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in AWS Secrets Manager.
  - appSecretConfig (dict) –
    
    A reference to the AWS Secrets Manager secret that stores the app secret. This includes the secret ID and the JSON key used to extract the app secret value from the secret. Required when appSecretSource is set to EXTERNAL.
    - secretId (string) – [REQUIRED]
      
      The ID of the AWS Secrets Manager secret that stores the secret value.
    - jsonKey (string) – [REQUIRED]
      
      The JSON key used to extract the secret value from the AWS Secrets Manager secret.
  - authorizationPrivateKey (string) –
    
    The authorization private key for the Stripe Privy integration.
  - authorizationPrivateKeySource (string) –
    
    The source type of the authorization private key. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in AWS Secrets Manager.
  - authorizationPrivateKeyConfig (dict) –
    
    A reference to the AWS Secrets Manager secret that stores the authorization private key. This includes the secret ID and the JSON key used to extract the authorization private key value from the secret. Required when authorizationPrivateKeySource is set to EXTERNAL.
    - secretId (string) – [REQUIRED]
      
      The ID of the AWS Secrets Manager secret that stores the secret value.
    - jsonKey (string) – [REQUIRED]
      
      The JSON key used to extract the secret value from the AWS Secrets Manager secret.
  - authorizationId (string) – [REQUIRED]
    
    The authorization ID for the Stripe Privy integration.
tags (dict) –
Optional tags for resource organization.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'credentialProviderVendor': 'CoinbaseCDP'|'StripePrivy',
    'credentialProviderArn': 'string',
    'providerConfigurationOutput': {
        'coinbaseCdpConfiguration': {
            'apiKeyId': 'string',
            'apiKeySecretArn': {
                'secretArn': 'string'
            },
            'apiKeySecretJsonKey': 'string',
            'apiKeySecretSource': 'MANAGED'|'EXTERNAL',
            'walletSecretArn': {
                'secretArn': 'string'
            },
            'walletSecretJsonKey': 'string',
            'walletSecretSource': 'MANAGED'|'EXTERNAL'
        },
        'stripePrivyConfiguration': {
            'appId': 'string',
            'appSecretArn': {
                'secretArn': 'string'
            },
            'appSecretJsonKey': 'string',
            'appSecretSource': 'MANAGED'|'EXTERNAL',
            'authorizationPrivateKeyArn': {
                'secretArn': 'string'
            },
            'authorizationPrivateKeyJsonKey': 'string',
            'authorizationPrivateKeySource': 'MANAGED'|'EXTERNAL',
            'authorizationId': 'string'
        }
    }
}

Response Structure

(dict) –
- name (string) –
  
  The name of the created payment credential provider.
- credentialProviderVendor (string) –
  
  The vendor type for the created payment credential provider.
- credentialProviderArn (string) –
  
  The Amazon Resource Name (ARN) of the created 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.
    - apiKeySecretJsonKey (string) –
      
      The JSON key used to extract the API key secret value from the AWS Secrets Manager secret.
    - apiKeySecretSource (string) –
      
      The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user 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.
    - walletSecretJsonKey (string) –
      
      The JSON key used to extract the wallet secret value from the AWS Secrets Manager secret.
    - walletSecretSource (string) –
      
      The source type of the wallet secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user 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.
    - appSecretJsonKey (string) –
      
      The JSON key used to extract the app secret value from the AWS Secrets Manager secret.
    - appSecretSource (string) –
      
      The source type of the app secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user 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.
    - authorizationPrivateKeyJsonKey (string) –
      
      The JSON key used to extract the authorization private key value from the AWS Secrets Manager secret.
    - authorizationPrivateKeySource (string) –
      
      The source type of the authorization private key. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in AWS Secrets Manager.
    - authorizationId (string) –
      
      The authorization ID for the Stripe Privy integration.

Exceptions

BedrockAgentCoreControl.Client.exceptions.ServiceQuotaExceededException
BedrockAgentCoreControl.Client.exceptions.UnauthorizedException
BedrockAgentCoreControl.Client.exceptions.ResourceLimitExceededException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.ConflictException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.DecryptionFailure
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException
BedrockAgentCoreControl.Client.exceptions.EncryptionFailure