BedrockAgentCoreControl / Client / delete_payment_connector

delete_payment_connector

BedrockAgentCoreControl.Client.delete_payment_connector(**kwargs)

Deletes a payment connector.

See also: AWS API Documentation

Request Syntax

response = client.delete_payment_connector(
    paymentManagerId='string',
    paymentConnectorId='string',
    clientToken='string'
)
Parameters:
  • paymentManagerId (string) –

    [REQUIRED]

    The unique identifier of the parent payment manager.

  • paymentConnectorId (string) –

    [REQUIRED]

    The unique identifier of the payment connector to delete.

  • 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

{
    'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
    'paymentConnectorId': 'string'
}

Response Structure

  • (dict) –

    • status (string) –

      The current status of the payment connector, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

    • paymentConnectorId (string) –

      The unique identifier of the deleted payment connector.

Exceptions

  • BedrockAgentCoreControl.Client.exceptions.AccessDeniedException

  • BedrockAgentCoreControl.Client.exceptions.ConflictException

  • BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException

  • BedrockAgentCoreControl.Client.exceptions.ThrottlingException

  • BedrockAgentCoreControl.Client.exceptions.InternalServerException