payment_managers

Creates, updates, deletes, gets or lists a payment_managers resource.

Overview

Name	`payment_managers`
Type	Resource
Id	`aws.bedrock_agentcore_control.payment_managers`

Fields

The following fields are returned by SELECT queries:

get_payment_manager
list_payment_managers

Name	Datatype	Description
`name`	`string`	The name of the payment manager. (pattern: <code>[a-zA-Z][a-zA-Z0-9]{0,47}</code>)
`authorizer_configuration`	`object`	Represents inbound authorization configuration options used to authenticate incoming requests.
`authorizer_type`	`string`	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. (CUSTOM_JWT, AWS_IAM)
`created_at`	`string (date-time)`	The timestamp when the payment manager was created.
`description`	`string`	The description of the payment manager. (pattern: <code>[^\p{C}]*</code>)
`kms_key_arn`	`string`	The Amazon Resource Name (ARN) of the KMS key used to encrypt sensitive payment manager data at rest, if configured. (pattern: <code>arn:aws(\|-cn\|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}</code>)
`last_updated_at`	`string (date-time)`	The timestamp when the payment manager was last updated.
`payment_manager_arn`	`string`	The Amazon Resource Name (ARN) of the payment manager. (pattern: <code>arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/([0-9a-z][-]?){1,48}-[a-z0-9]{10}</code>)
`payment_manager_id`	`string`	The unique identifier of the payment manager. (pattern: <code>([0-9a-z][-]?){1,100}-[0-9a-z]{10}</code>)
`role_arn`	`string`	The Amazon Resource Name (ARN) of the IAM role associated with the payment manager. (pattern: <code>arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+</code>)
`status`	`string`	The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED. (CREATING, UPDATING, DELETING, READY, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED)
`tags`	`object`	The tags associated with the payment manager.
`workload_identity_details`	`object`	The information about the workload identity.

Name	Datatype	Description
`name`	`string`	The name of the payment manager. (pattern: <code>[a-zA-Z][a-zA-Z0-9]{0,47}</code>)
`authorizer_type`	`string`	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. (CUSTOM_JWT, AWS_IAM)
`created_at`	`string (date-time)`	The timestamp when the payment manager was created.
`description`	`string`	The description of the payment manager. (pattern: <code>[^\p{C}]*</code>)
`kms_key_arn`	`string`	The Amazon Resource Name (ARN) of the KMS key used to encrypt sensitive payment manager data at rest, if configured. (pattern: <code>arn:aws(\|-cn\|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}</code>)
`last_updated_at`	`string (date-time)`	The timestamp when the payment manager was last updated.
`payment_manager_arn`	`string`	The Amazon Resource Name (ARN) of the payment manager. (pattern: <code>arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/([0-9a-z][-]?){1,48}-[a-z0-9]{10}</code>)
`payment_manager_id`	`string`	The unique identifier of the payment manager. (pattern: <code>([0-9a-z][-]?){1,100}-[0-9a-z]{10}</code>)
`role_arn`	`string`	The Amazon Resource Name (ARN) of the IAM role associated with the payment manager. (pattern: <code>arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+</code>)
`status`	`string`	The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED. (CREATING, UPDATING, DELETING, READY, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_payment_manager`	`select`	`payment_manager_id`, `region`		Retrieves information about a specific payment manager.
`list_payment_managers`	`select`	`region`	`maxResults`, `nextToken`	Lists all payment managers in the account.
`create_payment_manager`	`insert`	`region`, `name`, `authorizerType`, `roleArn`		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.
`update_payment_manager`	`update`	`payment_manager_id`, `region`		Updates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
`delete_payment_manager`	`delete`	`payment_manager_id`, `region`	`clientToken`	Deletes a payment manager. All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This operation initiates the deletion process asynchronously.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`payment_manager_id`	`string`	The unique identifier of the payment manager to delete.
`region`	`string`	AWS region (default: us-east-1)
`clientToken`	`string`	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.
`maxResults`	`integer`	The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
`nextToken`	`string`	If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

`SELECT` examples

get_payment_manager
list_payment_managers

Retrieves information about a specific payment manager.

SELECT
name,
authorizer_configuration,
authorizer_type,
created_at,
description,
kms_key_arn,
last_updated_at,
payment_manager_arn,
payment_manager_id,
role_arn,
status,
tags,
workload_identity_details
FROM aws.bedrock_agentcore_control.payment_managers
WHERE payment_manager_id = '{{ payment_manager_id }}' -- required
AND region = '{{ region }}' -- required
;

Lists all payment managers in the account.

SELECT
name,
authorizer_type,
created_at,
description,
kms_key_arn,
last_updated_at,
payment_manager_arn,
payment_manager_id,
role_arn,
status
FROM aws.bedrock_agentcore_control.payment_managers
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

`INSERT` examples

create_payment_manager
Manifest

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.

INSERT INTO aws.bedrock_agentcore_control.payment_managers (
name,
description,
authorizerType,
authorizerConfiguration,
roleArn,
clientToken,
tags,
kmsKeyArn,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ authorizerType }}' /* required */,
'{{ authorizerConfiguration }}',
'{{ roleArn }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ kmsKeyArn }}',
'{{ region }}'
RETURNING
name,
authorizer_configuration,
authorizer_type,
created_at,
kms_key_arn,
payment_manager_arn,
payment_manager_id,
role_arn,
status,
tags,
workload_identity_details
;

# Description fields are for documentation purposes
- name: payment_managers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the payment_managers resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: authorizerType
    value: "{{ authorizerType }}"
    valid_values: ['CUSTOM_JWT', 'AWS_IAM']
  - name: authorizerConfiguration
    description: |
      Represents inbound authorization configuration options used to authenticate incoming requests.
    value:
      customJWTAuthorizer:
        discoveryUrl: "{{ discoveryUrl }}"
        allowedAudience:
          - "{{ allowedAudience }}"
        allowedClients:
          - "{{ allowedClients }}"
        allowedScopes:
          - "{{ allowedScopes }}"
        advertisedScopeMapping: "{{ advertisedScopeMapping }}"
        customClaims:
          - inboundTokenClaimName: "{{ inboundTokenClaimName }}"
            inboundTokenClaimValueType: "{{ inboundTokenClaimValueType }}"
            authorizingClaimMatchValue:
              claimMatchValue:
                matchValueString: "{{ matchValueString }}"
                matchValueStringList: "{{ matchValueStringList }}"
              claimMatchOperator: "{{ claimMatchOperator }}"
        privateEndpoint:
          selfManagedLatticeResource:
            resourceConfigurationIdentifier: "{{ resourceConfigurationIdentifier }}"
          managedVpcResource:
            vpcIdentifier: "{{ vpcIdentifier }}"
            subnetIds:
              - "{{ subnetIds }}"
            endpointIpAddressType: "{{ endpointIpAddressType }}"
            securityGroupIds:
              - "{{ securityGroupIds }}"
            tags: "{{ tags }}"
            routingDomain: "{{ routingDomain }}"
        privateEndpointOverrides:
          - domain: "{{ domain }}"
            privateEndpoint:
              selfManagedLatticeResource:
                resourceConfigurationIdentifier: "{{ resourceConfigurationIdentifier }}"
              managedVpcResource:
                vpcIdentifier: "{{ vpcIdentifier }}"
                subnetIds: "{{ subnetIds }}"
                endpointIpAddressType: "{{ endpointIpAddressType }}"
                securityGroupIds: "{{ securityGroupIds }}"
                tags: "{{ tags }}"
                routingDomain: "{{ routingDomain }}"
        allowedWorkloadConfiguration:
          hostingEnvironments:
            - arn: "{{ arn }}"
          workloadIdentities:
            - "{{ workloadIdentities }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"
  - name: kmsKeyArn
    value: "{{ kmsKeyArn }}"

`UPDATE` examples

update_payment_manager

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

UPDATE aws.bedrock_agentcore_control.payment_managers
SET 
description = '{{ description }}',
authorizerType = '{{ authorizerType }}',
authorizerConfiguration = '{{ authorizerConfiguration }}',
roleArn = '{{ roleArn }}',
clientToken = '{{ clientToken }}',
kmsKeyArn = '{{ kmsKeyArn }}'
WHERE 
payment_manager_id = '{{ payment_manager_id }}' --required
AND region = '{{ region }}' --required
RETURNING
name,
authorizer_type,
kms_key_arn,
last_updated_at,
payment_manager_arn,
payment_manager_id,
role_arn,
status,
workload_identity_details;

`DELETE` examples

delete_payment_manager

Deletes a payment manager. All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This operation initiates the deletion process asynchronously.

DELETE FROM aws.bedrock_agentcore_control.payment_managers
WHERE payment_manager_id = '{{ payment_manager_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​