update-payment-credential-provider¶

Description¶

Updates an existing payment credential provider with new authentication credentials.

Synopsis¶

  update-payment-credential-provider
--name <value>
--credential-provider-vendor <value>
--provider-configuration-input <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--name (string) [required]

The name of the payment credential provider to update.

Constraints:

min: 1

max: 128

pattern: [a-zA-Z0-9\-_]+

--credential-provider-vendor (string) [required]

Supported vendor types for payment providers using non-standard auth protocols

Possible values:

CoinbaseCDP

StripePrivy

--provider-configuration-input (tagged union structure) [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 -> (structure)

Coinbase CDP configuration - credentials provided by Coinbase Developer Platform

apiKeyId -> (string) [required]

The API key identifier provided by Coinbase Developer Platform.

Constraints:

min: 1

max: 512

pattern: [a-zA-Z0-9\-_]+

apiKeySecret -> (string) [required]

The API key secret provided by Coinbase Developer Platform.

Constraints:

min: 1

max: 2048

pattern: [a-zA-Z0-9+/=\-_\s]+

walletSecret -> (string) [required]

The wallet secret provided by Coinbase Developer Platform.

Constraints:

min: 1

max: 2048

pattern: [a-zA-Z0-9+/=\-_\s]+

stripePrivyConfiguration -> (structure)

StripePrivy configuration - credentials provided by Stripe + Privy

appId -> (string) [required]

The app ID provided by Privy.

Constraints:

min: 1

max: 512

pattern: [a-zA-Z0-9\-_]+

appSecret -> (string) [required]

The app secret provided by Privy.

Constraints:

min: 1

max: 2048

pattern: [a-zA-Z0-9+/=\-_\s]+

authorizationPrivateKey -> (string) [required]

The authorization private key for the Stripe Privy integration.

Constraints:

min: 1

max: 2048

pattern: [a-zA-Z0-9+/=\-_\s]+

authorizationId -> (string) [required]

The authorization ID for the Stripe Privy integration.

Constraints:

min: 1

max: 512

pattern: [a-zA-Z0-9\-_]+

Shorthand Syntax:

coinbaseCdpConfiguration={apiKeyId=string,apiKeySecret=string,walletSecret=string},stripePrivyConfiguration={appId=string,appSecret=string,authorizationPrivateKey=string,authorizationId=string}

JSON Syntax:

{
  "coinbaseCdpConfiguration": {
    "apiKeyId": "string",
    "apiKeySecret": "string",
    "walletSecret": "string"
  },
  "stripePrivyConfiguration": {
    "appId": "string",
    "appSecret": "string",
    "authorizationPrivateKey": "string",
    "authorizationId": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

name -> (string)

The name of the updated payment credential provider.

Constraints:

min: 1

max: 128

pattern: [a-zA-Z0-9\-_]+

credentialProviderVendor -> (string)

Supported vendor types for payment providers using non-standard auth protocols

Possible values:

CoinbaseCDP

StripePrivy

credentialProviderArn -> (string)

The Amazon Resource Name (ARN) of the updated payment credential provider.

Constraints:

pattern: arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/paymentcredentialprovider/[a-zA-Z0-9-.]+

providerConfigurationOutput -> (tagged union structure)

Output configuration (contains secret ARNs, excludes actual secret values)

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: coinbaseCdpConfiguration, stripePrivyConfiguration.

coinbaseCdpConfiguration -> (structure)

Coinbase CDP configuration output with secret ARNs

apiKeyId -> (string) [required]

The API key identifier provided by Coinbase Developer Platform.

Constraints:

min: 1

max: 512

pattern: [a-zA-Z0-9\-_]+

apiKeySecretArn -> (structure) [required]

Contains information about a secret in AWS Secrets Manager.

secretArn -> (string) [required]

The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.

Constraints:

pattern: arn:(aws|aws-us-gov):secretsmanager:[A-Za-z0-9-]{1,64}:[0-9]{12}:secret:[a-zA-Z0-9-_/+=.@!]+

walletSecretArn -> (structure) [required]

Contains information about a secret in AWS Secrets Manager.

secretArn -> (string) [required]

The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.

Constraints:

pattern: arn:(aws|aws-us-gov):secretsmanager:[A-Za-z0-9-]{1,64}:[0-9]{12}:secret:[a-zA-Z0-9-_/+=.@!]+

stripePrivyConfiguration -> (structure)

StripePrivy configuration output with secret ARNs

appId -> (string) [required]

The app ID provided by Privy.

Constraints:

min: 1

max: 512

pattern: [a-zA-Z0-9\-_]+

appSecretArn -> (structure) [required]

Contains information about a secret in AWS Secrets Manager.

secretArn -> (string) [required]

The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.

Constraints:

pattern: arn:(aws|aws-us-gov):secretsmanager:[A-Za-z0-9-]{1,64}:[0-9]{12}:secret:[a-zA-Z0-9-_/+=.@!]+

authorizationPrivateKeyArn -> (structure) [required]

Contains information about a secret in AWS Secrets Manager.

secretArn -> (string) [required]

The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.

Constraints:

pattern: arn:(aws|aws-us-gov):secretsmanager:[A-Za-z0-9-]{1,64}:[0-9]{12}:secret:[a-zA-Z0-9-_/+=.@!]+

authorizationId -> (string) [required]

The authorization ID for the Stripe Privy integration.

Constraints:

min: 1

max: 512

pattern: [a-zA-Z0-9\-_]+

createdTime -> (timestamp)

The timestamp when the payment credential provider was created.

lastUpdatedTime -> (timestamp)

The timestamp when the payment credential provider was last updated.

Table of Contents

Feedback

User Guide

update-payment-credential-provider¶

Description¶

Synopsis¶

Options¶

Note

Global Options¶

Output¶

Note