Bedrock Agentcore  >  Operations  >  get_payment_instrument

get_payment_instrument

Operation

get_payment_instrument async

get_payment_instrument(input: GetPaymentInstrumentInput, plugins: list[Plugin] | None = None) -> GetPaymentInstrumentOutput

Get a payment instrument by ID.

Parameters:

Name	Type	Description	Default
input	GetPaymentInstrumentInput	An instance of GetPaymentInstrumentInput.	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
GetPaymentInstrumentOutput	An instance of GetPaymentInstrumentOutput.

Input

GetPaymentInstrumentInput dataclass

Request structure for getting a payment instrument.

Attributes

agent_name class-attribute instance-attribute

agent_name: str | None = None

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

payment_connector_id class-attribute instance-attribute

payment_connector_id: str | None = None

The ID of the payment connector.

payment_instrument_id class-attribute instance-attribute

payment_instrument_id: str | None = None

The ID of the payment instrument to retrieve.

payment_manager_arn class-attribute instance-attribute

payment_manager_arn: str | None = None

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

user_id class-attribute instance-attribute

user_id: str | None = None

The user ID associated with this payment instrument.

Output

GetPaymentInstrumentOutput dataclass

Response structure for getting a payment instrument.

Attributes

payment_instrument instance-attribute

payment_instrument: PaymentInstrument

The payment instrument details.