Skip to content

Bedrock Agentcore Control  >  Operations  >  get_payment_manager

get_payment_manager

Operation

get_payment_manager async

get_payment_manager(input: GetPaymentManagerInput, plugins: list[Plugin] | None = None) -> GetPaymentManagerOutput

Retrieves information about a specific payment manager.

Parameters:

Name Type Description Default
input GetPaymentManagerInput

An instance of GetPaymentManagerInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetPaymentManagerOutput

An instance of GetPaymentManagerOutput.

Input

GetPaymentManagerInput dataclass

Dataclass for GetPaymentManagerInput structure.

Attributes

payment_manager_id class-attribute instance-attribute
payment_manager_id: str | None = None

The unique identifier of the payment manager to retrieve.

Output

GetPaymentManagerOutput dataclass

Dataclass for GetPaymentManagerOutput structure.

Attributes

authorizer_configuration class-attribute instance-attribute
authorizer_configuration: AuthorizerConfiguration | None = None

Represents inbound authorization configuration options used to authenticate incoming requests.

authorizer_type instance-attribute
authorizer_type: PaymentsAuthorizerType

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.

created_at instance-attribute
created_at: datetime

The timestamp when the payment manager was created.

description class-attribute instance-attribute
description: str | None = None

The description of the payment manager.

last_updated_at instance-attribute
last_updated_at: datetime

The timestamp when the payment manager was last updated.

name instance-attribute
name: str

The name of the payment manager.

payment_manager_arn instance-attribute
payment_manager_arn: str

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

payment_manager_id instance-attribute
payment_manager_id: str

The unique identifier of the payment manager.

role_arn instance-attribute
role_arn: str

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

status instance-attribute

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

tags class-attribute instance-attribute
tags: dict[str, str] | None = None

The tags associated with the payment manager.

workload_identity_details class-attribute instance-attribute
workload_identity_details: WorkloadIdentityDetails | None = None

The information about the workload identity.