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-resource-payment-token

Description

Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.

See also: AWS API Documentation

Synopsis

  get-resource-payment-token
--workload-identity-token <value>
--resource-credential-provider-name <value>
--payment-token-request <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

--workload-identity-token (string)

Workload access token for authorization. Named workloadIdentityToken for consistency with APIKey and OAuth2CredentialProvider.

--resource-credential-provider-name (string)

Name of the payment credential provider to use

--payment-token-request (tagged union structure)

Vendor-specific token request input Contains all request parameters in a type-safe, vendor-specific structure

Note

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

coinbaseCdpTokenRequest -> (structure)

Coinbase CDP token request parameters

requestMethod -> (string)

The HTTP method for the payment API request.

requestHost -> (string)

Optional - defaults to “api.cdp.coinbase.com”

requestPath -> (string)

The path of the payment API request.

includeWalletAuthToken -> (boolean)

Set to true for wallet write operations (requires walletSecret configured)

requestBody -> (string)

Request body JSON - used to generate wallet auth JWT

stripePrivyTokenRequest -> (structure)

StripePrivy token request parameters

requestHost -> (string)

Optional - defaults to “api.privy.io”

requestPath -> (string)

The path of the Stripe Privy API request.

requestBody -> (string)

Request body JSON for the Privy API call

includeAuthorizationSignature -> (boolean)

Set to true to generate privy-authorization-signature

Shorthand Syntax:

coinbaseCdpTokenRequest={requestMethod=string,requestHost=string,requestPath=string,includeWalletAuthToken=boolean,requestBody=string},stripePrivyTokenRequest={requestHost=string,requestPath=string,requestBody=string,includeAuthorizationSignature=boolean}

JSON Syntax:

{
  "coinbaseCdpTokenRequest": {
    "requestMethod": "GET"|"POST"|"PUT"|"DELETE"|"PATCH",
    "requestHost": "string",
    "requestPath": "string",
    "includeWalletAuthToken": true|false,
    "requestBody": "string"
  },
  "stripePrivyTokenRequest": {
    "requestHost": "string",
    "requestPath": "string",
    "requestBody": "string",
    "includeAuthorizationSignature": true|false
  }
}

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

paymentTokenResponse -> (tagged union structure)

Vendor-specific token response output Contains all response data in a type-safe, vendor-specific structure

Note

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

coinbaseCdpTokenResponse -> (structure)

Coinbase CDP token response

bearerToken -> (string)

Bearer Token for Authorization header

walletAuthToken -> (string)

Wallet Auth Token for X-Wallet-Auth header

stripePrivyTokenResponse -> (structure)

StripePrivy token response containing appId, basicAuthToken, and optionally authorizationSignature

authorizationSignature -> (string)

Base64-encoded ECDSA P-256 authorization signature (only present when includeAuthorizationSignature is true)

requestExpiry -> (long)

Unix timestamp in milliseconds when the authorization signature expires. Set as privy-request-expiry header.

appId -> (string)

The Privy app ID for the privy-app-id header

basicAuthToken -> (string)

Base64-encoded Basic Auth token (appId:appSecret) for the Authorization header