View a markdown version of this page

PaymentManagerSummary - Amazon Bedrock AgentCore Control Plane
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

PaymentManagerSummary

Contains summary information about a payment manager.

Contents

authorizerType

The type of authorizer used by the payment manager.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon IAM credentials.

Type: String

Valid Values: CUSTOM_JWT | AWS_IAM

Required: Yes

lastUpdatedAt

The timestamp when the payment manager was last updated.

Type: Timestamp

Required: Yes

name

The name of the payment manager.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [a-zA-Z][a-zA-Z0-9]{0,47}

Required: Yes

paymentManagerArn

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

Type: String

Length Constraints: Minimum length of 66. Maximum length of 2048.

Pattern: arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/([0-9a-z][-]?){1,48}-[a-z0-9]{10}

Required: Yes

paymentManagerId

The unique identifier of the payment manager.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 211.

Pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10}

Required: Yes

roleArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+

Required: Yes

status

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

Type: String

Valid Values: CREATING | UPDATING | DELETING | READY | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED

Required: Yes

createdAt

The timestamp when the payment manager was created.

Type: Timestamp

Required: No

description

The description of the payment manager.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [^\p{C}]*

Required: No

kmsKeyArn

The Amazon Resource Name (ARN) of the Amazon KMS key used to encrypt sensitive payment manager data at rest, if configured.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: