Skip to content

create_payment_manager

Operation

create_payment_manager

create_payment_manager(request: CreatePaymentManagerInput | CreatePaymentManagerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePaymentManagerInputDict]) -> 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
request CreatePaymentManagerInput | CreatePaymentManagerInputDict | 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[CreatePaymentManagerInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreatePaymentManagerOutput

An instance of CreatePaymentManagerOutput.

create_payment_manager async

create_payment_manager(request: CreatePaymentManagerInput | CreatePaymentManagerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePaymentManagerInputDict]) -> 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
request CreatePaymentManagerInput | CreatePaymentManagerInputDict | 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[CreatePaymentManagerInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreatePaymentManagerOutput

An instance of CreatePaymentManagerOutput.

Input

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

CreatePaymentManagerInputDict

Bases: TypedDict

Dictionary form of CreatePaymentManagerInput.

Attributes

authorizer_configuration instance-attribute
authorizer_configuration: AuthorizerConfiguration | AuthorizerConfigurationDict | None

The authorizer configuration for the payment manager.

authorizer_type instance-attribute
authorizer_type: Required[str]

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.

client_token instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

description instance-attribute
description: str | None

A description of the payment manager.

kms_key_arn instance-attribute
kms_key_arn: str | None

The Amazon Resource Name (ARN) of the customer managed KMS key to use for encrypting sensitive payment manager data at rest. If you don't specify a key, the data is encrypted with an Amazon Web Services owned key.

name instance-attribute
name: Required[str]

The name of the payment manager.

role_arn instance-attribute
role_arn: Required[str]

The Amazon Resource Name (ARN) of the IAM role that the payment manager assumes to access resources on your behalf.

tags instance-attribute
tags: Mapping[str, str] | None

A map of tag keys and values to assign to the payment manager.

CreatePaymentManagerInput dataclass

Bases: _SerdeShape

Dataclass for CreatePaymentManagerInput structure.

Attributes

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

The authorizer configuration for the payment manager.

authorizer_type class-attribute instance-attribute
authorizer_type: str | 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.

client_token class-attribute instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

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

A description of the payment manager.

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

The Amazon Resource Name (ARN) of the customer managed KMS key to use for encrypting sensitive payment manager data at rest. If you don't specify a key, the data is encrypted with an Amazon Web Services owned key.

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

The name of the payment manager.

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

The Amazon Resource Name (ARN) of the IAM role that the payment manager assumes to access resources on your behalf.

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

A map of tag keys and values to assign to the payment manager.

Output

CreatePaymentManagerOutput dataclass

Bases: _SerdeShape

Dataclass for CreatePaymentManagerOutput 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 for the created payment manager.

created_at instance-attribute
created_at: datetime

The timestamp when the payment manager was created.

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.

name instance-attribute
name: str

The name of the created payment manager.

payment_manager_arn instance-attribute
payment_manager_arn: str

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

payment_manager_id instance-attribute
payment_manager_id: str

The unique identifier of the created 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 created 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 created payment manager.

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

The information about the workload identity.