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 ]

get-payment-manager

Description

Retrieves information about a specific payment manager.

See also: AWS API Documentation

Synopsis

  get-payment-manager
--payment-manager-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

--payment-manager-id (string)

The unique identifier of the payment manager 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

paymentManagerArn -> (string)

The Amazon Resource Name (ARN) of the payment manager.

paymentManagerId -> (string)

The unique identifier of the payment manager.

name -> (string)

The name of the payment manager.

description -> (string)

The description of the payment manager.

authorizerType -> (string)

The type of authorizer used by the payment manager.

  • CUSTOM_JWT - Authorize with a bearer token.
  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

authorizerConfiguration -> (tagged union structure)

Represents inbound authorization configuration options used to authenticate incoming requests.

Note

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

customJWTAuthorizer -> (structure)

The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

discoveryUrl -> (string)

This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

allowedAudience -> (list)

Represents individual audience values that are validated in the incoming JWT token validation process.

(string)

allowedClients -> (list)

Represents individual client IDs that are validated in the incoming JWT token validation process.

(string)

allowedScopes -> (list)

An array of scopes that are allowed to access the token.

(string)

customClaims -> (list)

An array of objects that define a custom claim validation name, value, and operation

(structure)

Defines the name of a custom claim field and rules for finding matches to authenticate its value.

inboundTokenClaimName -> (string)

The name of the custom claim field to check.

inboundTokenClaimValueType -> (string)

The data type of the claim value to check for.

  • Use STRING if you want to find an exact match to a string you define.
  • Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.

authorizingClaimMatchValue -> (structure)

Defines the value or values to match for and the relationship of the match.

claimMatchValue -> (tagged union structure)

The value or values to match for.

Note

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

matchValueString -> (string)

The string value to match for.

matchValueStringList -> (list)

An array of strings to check for a match.

(string)

claimMatchOperator -> (string)

Defines the relationship between the claim field value and the value or values you’re matching for.

privateEndpoint -> (tagged union structure)

The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.

Note

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

selfManagedLatticeResource -> (tagged union structure)

Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.

Note

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

resourceConfigurationIdentifier -> (string)

The ARN or ID of the VPC Lattice resource configuration.

managedVpcResource -> (structure)

Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.

vpcIdentifier -> (string)

The ID of the VPC that contains your private resource.

subnetIds -> (list)

The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.

(string)

endpointIpAddressType -> (string)

The IP address type for the resource configuration endpoint.

securityGroupIds -> (list)

The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.

(string)

tags -> (map)

Tags to apply to the managed VPC Lattice resource gateway.

key -> (string)

value -> (string)

routingDomain -> (string)

An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].

privateEndpointOverrides -> (list)

The private endpoint overrides for the custom JWT authorizer configuration.

(structure)

A mapping of a specific domain to a private endpoint for secure connectivity through a VPC Lattice resource configuration.

domain -> (string)

The domain to override with a private endpoint.

privateEndpoint -> (tagged union structure)

The private endpoint configuration for the specified domain.

Note

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

selfManagedLatticeResource -> (tagged union structure)

Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.

Note

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

resourceConfigurationIdentifier -> (string)

The ARN or ID of the VPC Lattice resource configuration.

managedVpcResource -> (structure)

Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.

vpcIdentifier -> (string)

The ID of the VPC that contains your private resource.

subnetIds -> (list)

The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.

(string)

endpointIpAddressType -> (string)

The IP address type for the resource configuration endpoint.

securityGroupIds -> (list)

The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.

(string)

tags -> (map)

Tags to apply to the managed VPC Lattice resource gateway.

key -> (string)

value -> (string)

routingDomain -> (string)

An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.

workloadIdentityDetails -> (structure)

The information about the workload identity.

workloadIdentityArn -> (string)

The ARN associated with the workload identity.

createdAt -> (timestamp)

The timestamp when the payment manager was created.

lastUpdatedAt -> (timestamp)

The timestamp when the payment manager was last updated.

status -> (string)

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

tags -> (map)

The tags associated with the payment manager.

key -> (string)

value -> (string)