Skip to content

get_payment_manager

Operation

get_payment_manager

get_payment_manager(request: GetPaymentManagerInput | GetPaymentManagerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPaymentManagerInputDict]) -> GetPaymentManagerOutput

Retrieves information about a specific payment manager.

Parameters:

Name Type Description Default
request GetPaymentManagerInput | GetPaymentManagerInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetPaymentManagerInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPaymentManagerOutput

An instance of GetPaymentManagerOutput.

get_payment_manager async

get_payment_manager(request: GetPaymentManagerInput | GetPaymentManagerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPaymentManagerInputDict]) -> GetPaymentManagerOutput

Retrieves information about a specific payment manager.

Parameters:

Name Type Description Default
request GetPaymentManagerInput | GetPaymentManagerInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetPaymentManagerInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPaymentManagerOutput

An instance of GetPaymentManagerOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetPaymentManagerInputDict

Bases: TypedDict

Dictionary form of GetPaymentManagerInput.

Attributes

payment_manager_id instance-attribute
payment_manager_id: Required[str]

The unique identifier of the payment manager to retrieve.

GetPaymentManagerInput dataclass

Bases: _SerdeShape

Dataclass for GetPaymentManagerInput structure.

Attributes

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

The unique identifier of the payment manager to retrieve.

Output

GetPaymentManagerOutput dataclass

Bases: _SerdeShape

Dataclass for GetPaymentManagerOutput structure.

Attributes

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

Represents inbound authorization configuration options used to authenticate incoming requests.

authorizer_type instance-attribute
authorizer_type: str

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

The description of the payment manager.

kms_key_arn class-attribute instance-attribute
kms_key_arn: str | None = ...

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

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

role_arn instance-attribute
role_arn: str

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

status instance-attribute
status: str

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

The tags associated with the payment manager.

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

The information about the workload identity.