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 ]

get-payment-instrument

Description

Get a payment instrument by ID

See also: AWS API Documentation

Synopsis

  get-payment-instrument
[--user-id <value>]
[--agent-name <value>]
--payment-manager-arn <value>
[--payment-connector-id <value>]
--payment-instrument-id <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

--user-id (string)

The user ID associated with this payment instrument.

--agent-name (string)

The agent name associated with this request, used for observability.

--payment-manager-arn (string)

The ARN of the payment manager that owns this payment instrument.

--payment-connector-id (string)

The ID of the payment connector.

--payment-instrument-id (string)

The ID of the payment instrument to retrieve.

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

paymentInstrument -> (structure)

Represents a payment instrument

paymentInstrumentId -> (string)

The unique identifier for this payment instrument.

paymentManagerArn -> (string)

The ARN of the payment manager that owns this payment instrument.

paymentConnectorId -> (string)

The ID of the payment connector associated with this instrument.

userId -> (string)

The user ID associated with this payment instrument.

paymentInstrumentType -> (string)

The type of payment instrument (e.g., EMBEDDED_CRYPTO_WALLET).

paymentInstrumentDetails -> (tagged union structure)

The details specific to the payment instrument type.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: embeddedCryptoWallet.

embeddedCryptoWallet -> (structure)

Embedded crypto wallet managed directly by end user

network -> (string)

The blockchain network for this embedded crypto wallet. Supported networks: ETHEREUM, SOLANA

linkedAccounts -> (list)

List of linkedAccounts linked to this wallet. Each linkedAccount represents a way the end user can authenticate to this wallet. Can be empty when adding a new linkedAccount to an existing wallet.

(tagged union structure)

Represents different linkedAccounts that can be linked to an embedded wallet. This union supports multiple linkedAccount approaches: email, SMS, JWT, and OAuth2.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: email, sms, developerJwt, oAuth2.

email -> (structure)

Email-based linkedAccount

emailAddress -> (string)

The email address used for linkedAccount. Must be a valid email format.

sms -> (structure)

SMS-based linkedAccount using phone number

phoneNumber -> (string)

The phone number in E.164 format (e.g., +1234567890). Must be a valid E.164 formatted phone number starting with + and containing 1-15 digits.

developerJwt -> (structure)

Developer JWT linkedAccount with key ID and subject

kid -> (string)

The key ID (kid) from the JWT header. Identifies which key was used to sign the JWT.

sub -> (string)

The subject (sub) claim from the JWT payload. Identifies the principal that is the subject of the JWT.

oAuth2 -> (tagged union structure)

OAuth2 provider linkedAccount (Google, Apple, X, Telegram, GitHub)

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: google, apple, x, telegram, github.

google -> (structure)

Google OAuth2 authentication

sub -> (string)

The subject (sub) claim from the OAuth2 provider. Uniquely identifies the user at the provider.

emailAddress -> (string)

The email address from the OAuth2 provider (optional).

name -> (string)

The user’s name from the OAuth2 provider (optional).

username -> (string)

The username from the OAuth2 provider (optional).

apple -> (structure)

Apple OAuth2 authentication

sub -> (string)

The subject (sub) claim from the OAuth2 provider. Uniquely identifies the user at the provider.

emailAddress -> (string)

The email address from the OAuth2 provider (optional).

name -> (string)

The user’s name from the OAuth2 provider (optional).

username -> (string)

The username from the OAuth2 provider (optional).

x -> (structure)

X (formerly Twitter) OAuth2 authentication

sub -> (string)

The subject (sub) claim from the OAuth2 provider. Uniquely identifies the user at the provider.

emailAddress -> (string)

The email address from the OAuth2 provider (optional).

name -> (string)

The user’s name from the OAuth2 provider (optional).

username -> (string)

The username from the OAuth2 provider (optional).

telegram -> (structure)

Telegram OAuth2 authentication

sub -> (string)

The subject (sub) claim from the OAuth2 provider. Uniquely identifies the user at the provider.

emailAddress -> (string)

The email address from the OAuth2 provider (optional).

name -> (string)

The user’s name from the OAuth2 provider (optional).

username -> (string)

The username from the OAuth2 provider (optional).

github -> (structure)

GitHub OAuth2 authentication

sub -> (string)

The subject (sub) claim from the OAuth2 provider. Uniquely identifies the user at the provider.

emailAddress -> (string)

The email address from the OAuth2 provider (optional).

name -> (string)

The user’s name from the OAuth2 provider (optional).

username -> (string)

The username from the OAuth2 provider (optional).

walletAddress -> (string)

The wallet address on the specified blockchain network.

redirectUrl -> (string)

URL for the end user to complete a provider-specific action (e.g., wallet linking, onboarding). Returned by the payment connector during instrument creation.

createdAt -> (timestamp)

The timestamp when this payment instrument was created.

status -> (string)

The current status of this payment instrument.

updatedAt -> (timestamp)

The timestamp when this payment instrument was last updated.