Skip to content

update_payment_manager

Operation

update_payment_manager

update_payment_manager(request: UpdatePaymentManagerInput | UpdatePaymentManagerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdatePaymentManagerInputDict]) -> UpdatePaymentManagerOutput

Updates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

Parameters:

Name Type Description Default
request UpdatePaymentManagerInput | UpdatePaymentManagerInputDict | 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[UpdatePaymentManagerInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdatePaymentManagerOutput

An instance of UpdatePaymentManagerOutput.

update_payment_manager async

update_payment_manager(request: UpdatePaymentManagerInput | UpdatePaymentManagerInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdatePaymentManagerInputDict]) -> UpdatePaymentManagerOutput

Updates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

Parameters:

Name Type Description Default
request UpdatePaymentManagerInput | UpdatePaymentManagerInputDict | 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[UpdatePaymentManagerInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdatePaymentManagerOutput

An instance of UpdatePaymentManagerOutput.

Input

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

UpdatePaymentManagerInputDict

Bases: TypedDict

Dictionary form of UpdatePaymentManagerInput.

Attributes

authorizer_configuration instance-attribute
authorizer_configuration: AuthorizerConfiguration | AuthorizerConfigurationDict | None

The updated authorizer configuration for the payment manager.

authorizer_type instance-attribute
authorizer_type: str | None

The updated authorizer type for the payment manager.

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

The updated description of the payment manager.

kms_key_arn instance-attribute
kms_key_arn: str | None

The updated Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt sensitive payment manager data at rest.

payment_manager_id instance-attribute
payment_manager_id: Required[str]

The unique identifier of the payment manager to update.

role_arn instance-attribute
role_arn: str | None

The updated Amazon Resource Name (ARN) of the IAM role for the payment manager.

UpdatePaymentManagerInput dataclass

Bases: _SerdeShape

Dataclass for UpdatePaymentManagerInput structure.

Attributes

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

The updated authorizer configuration for the payment manager.

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

The updated authorizer type for the payment manager.

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

The updated description of the payment manager.

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

The updated Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt sensitive payment manager data at rest.

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

The unique identifier of the payment manager to update.

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

The updated Amazon Resource Name (ARN) of the IAM role for the payment manager.

Output

UpdatePaymentManagerOutput dataclass

Bases: _SerdeShape

Dataclass for UpdatePaymentManagerOutput structure.

Attributes

authorizer_type instance-attribute
authorizer_type: str

The type of authorizer for the updated 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 updated payment manager.

payment_manager_arn instance-attribute
payment_manager_arn: str

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

payment_manager_id instance-attribute
payment_manager_id: str

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

status instance-attribute
status: str

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

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

The information about the workload identity.