BedrockAgentCoreControl / Client / update_payment_manager

update_payment_manager

BedrockAgentCoreControl.Client.update_payment_manager(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_payment_manager(
    paymentManagerId='string',
    description='string',
    authorizerType='CUSTOM_JWT'|'AWS_IAM',
    authorizerConfiguration={
        'customJWTAuthorizer': {
            'discoveryUrl': 'string',
            'allowedAudience': [
                'string',
            ],
            'allowedClients': [
                'string',
            ],
            'allowedScopes': [
                'string',
            ],
            'customClaims': [
                {
                    'inboundTokenClaimName': 'string',
                    'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
                    'authorizingClaimMatchValue': {
                        'claimMatchValue': {
                            'matchValueString': 'string',
                            'matchValueStringList': [
                                'string',
                            ]
                        },
                        'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
                    }
                },
            ],
            'privateEndpoint': {
                'selfManagedLatticeResource': {
                    'resourceConfigurationIdentifier': 'string'
                },
                'managedVpcResource': {
                    'vpcIdentifier': 'string',
                    'subnetIds': [
                        'string',
                    ],
                    'endpointIpAddressType': 'IPV4'|'IPV6',
                    'securityGroupIds': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    },
                    'routingDomain': 'string'
                }
            },
            'privateEndpointOverrides': [
                {
                    'domain': 'string',
                    'privateEndpoint': {
                        'selfManagedLatticeResource': {
                            'resourceConfigurationIdentifier': 'string'
                        },
                        'managedVpcResource': {
                            'vpcIdentifier': 'string',
                            'subnetIds': [
                                'string',
                            ],
                            'endpointIpAddressType': 'IPV4'|'IPV6',
                            'securityGroupIds': [
                                'string',
                            ],
                            'tags': {
                                'string': 'string'
                            },
                            'routingDomain': 'string'
                        }
                    }
                },
            ]
        }
    },
    roleArn='string',
    clientToken='string'
)

Parameters:

• paymentManagerId (string) –

  [REQUIRED]

  The unique identifier of the payment manager to update.

• description (string) – The updated description of the payment manager.

• authorizerType (string) – The updated authorizer type for the payment manager.

• authorizerConfiguration (dict) –

  The updated authorizer configuration for the payment manager.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: customJWTAuthorizer.

  • customJWTAuthorizer (dict) –

    The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

    • discoveryUrl (string) – [REQUIRED]

      This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

    • allowedAudience (list) –

      Represents individual audience values that are validated in the incoming JWT token validation process.

      • (string) –

    • allowedClients (list) –

      Represents individual client IDs that are validated in the incoming JWT token validation process.

      • (string) –

    • allowedScopes (list) –

      An array of scopes that are allowed to access the token.

      • (string) –

    • customClaims (list) –

      An array of objects that define a custom claim validation name, value, and operation

      • (dict) –

        Defines the name of a custom claim field and rules for finding matches to authenticate its value.

        • inboundTokenClaimName (string) – [REQUIRED]

          The name of the custom claim field to check.

        • inboundTokenClaimValueType (string) – [REQUIRED]

          The data type of the claim value to check for.

          • Use STRING if you want to find an exact match to a string you define.

          • Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.

        • authorizingClaimMatchValue (dict) – [REQUIRED]

          Defines the value or values to match for and the relationship of the match.

          • claimMatchValue (dict) – [REQUIRED]

            The value or values to match for.

            Note

            This is a Tagged Union structure. Only one of the following top level keys can be set: matchValueString, matchValueStringList.

            • matchValueString (string) –

              The string value to match for.

            • matchValueStringList (list) –

              An array of strings to check for a match.

              • (string) –

          • claimMatchOperator (string) – [REQUIRED]

            Defines the relationship between the claim field value and the value or values you’re matching for.

    • privateEndpoint (dict) –

      The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: selfManagedLatticeResource, managedVpcResource.

      • selfManagedLatticeResource (dict) –

        Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: resourceConfigurationIdentifier.

        • resourceConfigurationIdentifier (string) –

          The ARN or ID of the VPC Lattice resource configuration.

      • managedVpcResource (dict) –

        Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.

        • vpcIdentifier (string) – [REQUIRED]

          The ID of the VPC that contains your private resource.

        • subnetIds (list) – [REQUIRED]

          The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.

          • (string) –

        • endpointIpAddressType (string) – [REQUIRED]

          The IP address type for the resource configuration endpoint.

        • securityGroupIds (list) –

          The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.

          • (string) –

        • tags (dict) –

          Tags to apply to the managed VPC Lattice resource gateway.

          • (string) –

            • (string) –

        • routingDomain (string) –

          An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].

    • privateEndpointOverrides (list) –

      The private endpoint overrides for the custom JWT authorizer configuration.

      • (dict) –

        A mapping of a specific domain to a private endpoint for secure connectivity through a VPC Lattice resource configuration.

        • domain (string) – [REQUIRED]

          The domain to override with a private endpoint.

        • privateEndpoint (dict) – [REQUIRED]

          The private endpoint configuration for the specified domain.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: selfManagedLatticeResource, managedVpcResource.

          • selfManagedLatticeResource (dict) –

            Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.

            Note

            This is a Tagged Union structure. Only one of the following top level keys can be set: resourceConfigurationIdentifier.

            • resourceConfigurationIdentifier (string) –

              The ARN or ID of the VPC Lattice resource configuration.

          • managedVpcResource (dict) –

            Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.

            • vpcIdentifier (string) – [REQUIRED]

              The ID of the VPC that contains your private resource.

            • subnetIds (list) – [REQUIRED]

              The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.

              • (string) –

            • endpointIpAddressType (string) – [REQUIRED]

              The IP address type for the resource configuration endpoint.

            • securityGroupIds (list) –

              The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.

              • (string) –

            • tags (dict) –

              Tags to apply to the managed VPC Lattice resource gateway.

              • (string) –

                • (string) –

            • routingDomain (string) –

              An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].

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

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

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'paymentManagerArn': 'string',
    'paymentManagerId': 'string',
    'name': 'string',
    'authorizerType': 'CUSTOM_JWT'|'AWS_IAM',
    'roleArn': 'string',
    'workloadIdentityDetails': {
        'workloadIdentityArn': 'string'
    },
    'lastUpdatedAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'
}

Response Structure

• (dict) –

  • paymentManagerArn (string) –

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

  • paymentManagerId (string) –

    The unique identifier of the updated payment manager.

  • name (string) –

    The name of the updated payment manager.

  • authorizerType (string) –

    The type of authorizer for the updated payment manager.

  • roleArn (string) –

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

  • workloadIdentityDetails (dict) –

    The information about the workload identity.

    • workloadIdentityArn (string) –

      The ARN associated with the workload identity.

  • lastUpdatedAt (datetime) –

    The timestamp when the payment manager was last updated.

  • status (string) –

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

Exceptions

• BedrockAgentCoreControl.Client.exceptions.ServiceQuotaExceededException

• BedrockAgentCoreControl.Client.exceptions.AccessDeniedException

• BedrockAgentCoreControl.Client.exceptions.ConflictException

• BedrockAgentCoreControl.Client.exceptions.ValidationException

• BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException

• BedrockAgentCoreControl.Client.exceptions.ThrottlingException

• BedrockAgentCoreControl.Client.exceptions.InternalServerException