AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-agentcore-control ]

create-payment-connector

Description

Creates a new payment connector for a payment manager. A payment connector integrates with a supported payment provider to enable payment processing capabilities.

See also: AWS API Documentation

Synopsis

  create-payment-connector
--payment-manager-id <value>
--name <value>
[--description <value>]
--type <value>
--credential-provider-configurations <value>
[--client-token <value>]
[--cli-input-json <value>]
[--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>]
[--v2-debug]

Options

--payment-manager-id (string)

The unique identifier of the payment manager to create the connector for.

--name (string)

The name of the payment connector.

--description (string)

A description of the payment connector.

--type (string)

The type of payment connector, which determines the payment provider integration.

Possible values:

  • CoinbaseCDP
  • StripePrivy

--credential-provider-configurations (list)

The credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.

(tagged union structure)

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 can be set: coinbaseCDP, stripePrivy.

coinbaseCDP -> (structure)

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 -> (structure)

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.

Shorthand Syntax:

coinbaseCDP={credentialProviderArn=string},stripePrivy={credentialProviderArn=string} ...

JSON Syntax:

[
  {
    "coinbaseCDP": {
      "credentialProviderArn": "string"
    },
    "stripePrivy": {
      "credentialProviderArn": "string"
    }
  }
  ...
]

--client-token (string)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

paymentConnectorId -> (string)

The unique identifier of the created payment connector.

paymentManagerId -> (string)

The unique identifier of the parent payment manager.

name -> (string)

The name of the created payment connector.

type -> (string)

The type of the created payment connector.

credentialProviderConfigurations -> (list)

The credential provider configurations for the created payment connector.

(tagged union structure)

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 can be set: coinbaseCDP, stripePrivy.

coinbaseCDP -> (structure)

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 -> (structure)

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 -> (timestamp)

The timestamp when the payment connector was created.

status -> (string)

The current status of the payment connector. Possible values include CREATING , READY , UPDATING , DELETING , CREATE_FAILED , UPDATE_FAILED , and DELETE_FAILED .