create_payment_manager¶
Operation¶
async
¶
create_payment_manager(input: CreatePaymentManagerInput, plugins: list[Plugin] | None = None) -> CreatePaymentManagerOutput
Creates a new payment manager in your Amazon Web Services account. A payment manager serves as the top-level resource for managing payment processing capabilities, including payment connectors that integrate with supported payment providers.
If you specify CUSTOM_JWT as the authorizerType, you must provide an
authorizerConfiguration.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreatePaymentManagerInput
|
An instance of |
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 |
|---|---|
CreatePaymentManagerOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreatePaymentManagerInput structure.
Attributes¶
class-attribute
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | None = None
The authorizer configuration for the payment manager.
class-attribute
instance-attribute
¶
authorizer_type: PaymentsAuthorizerType | None = None
The type of authorizer to use for the payment manager.
-
CUSTOM_JWT- Authorize with a bearer token. -
AWS_IAM- Authorize with your Amazon Web Services IAM credentials.
class-attribute
instance-attribute
¶
client_token: str | None = None
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
class-attribute
instance-attribute
¶
description: str | None = None
A description of the payment manager.
class-attribute
instance-attribute
¶
role_arn: str | None = None
The Amazon Resource Name (ARN) of the IAM role that the payment manager assumes to access resources on your behalf.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
A map of tag keys and values to assign to the payment manager.
Output¶
dataclass
¶
Dataclass for CreatePaymentManagerOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | None = None
Represents inbound authorization configuration options used to authenticate incoming requests.
instance-attribute
¶
authorizer_type: PaymentsAuthorizerType
The type of authorizer for the created payment manager.
instance-attribute
¶
created_at: datetime
The timestamp when the payment manager was created.
instance-attribute
¶
payment_manager_arn: str
The Amazon Resource Name (ARN) of the created payment manager.
instance-attribute
¶
payment_manager_id: str
The unique identifier of the created payment manager.
instance-attribute
¶
role_arn: str
The Amazon Resource Name (ARN) of the IAM role associated with the created payment manager.
instance-attribute
¶
status: PaymentManagerStatus
The current status of the payment manager. Possible values include
CREATING, READY, UPDATING, DELETING, CREATE_FAILED,
UPDATE_FAILED, and DELETE_FAILED.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
The tags associated with the created payment manager.
class-attribute
instance-attribute
¶
workload_identity_details: WorkloadIdentityDetails | None = None
The information about the workload identity.