PinpointSMSVoiceV2 / Client / delete_rcs_agent

delete_rcs_agent¶

PinpointSMSVoiceV2.Client.delete_rcs_agent(**kwargs)¶

Deletes an existing RCS agent. If deletion protection is enabled, an error is returned.

Request Syntax

response = client.delete_rcs_agent(
    RcsAgentId='string'
)

Parameters:

RcsAgentId (string) –

[REQUIRED]

The unique identifier of the RCS agent to delete. You can use either the RcsAgentId or RcsAgentArn.

Return type:

dict

Returns:

Response Syntax

{
    'RcsAgentArn': 'string',
    'RcsAgentId': 'string',
    'Status': 'CREATED'|'PENDING'|'TESTING'|'PARTIAL'|'ACTIVE'|'DELETED',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'DeletionProtectionEnabled': True|False,
    'OptOutListName': 'string',
    'SelfManagedOptOutsEnabled': True|False,
    'TwoWayChannelArn': 'string',
    'TwoWayChannelRole': 'string',
    'TwoWayEnabled': True|False
}

Response Structure

(dict) –
- RcsAgentArn (string) –
  
  The Amazon Resource Name (ARN) of the deleted RCS agent.
- RcsAgentId (string) –
  
  The unique identifier for the deleted RCS agent.
- Status (string) –
  
  The current status of the RCS agent.
- CreatedTimestamp (datetime) –
  
  The time when the RCS agent was created, in UNIX epoch time format.
- DeletionProtectionEnabled (boolean) –
  
  When set to true deletion protection is enabled. By default this is set to false.
- OptOutListName (string) –
  
  The name of the OptOutList that was associated with the deleted RCS agent.
- SelfManagedOptOutsEnabled (boolean) –
  
  By default this is set to false. When set to true you’re responsible for responding to HELP and STOP requests. You’re also responsible for tracking and honoring opt-out requests.
- TwoWayChannelArn (string) –
  
  The Amazon Resource Name (ARN) of the two way channel.
- TwoWayChannelRole (string) –
  
  An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- TwoWayEnabled (boolean) –
  
  By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

Exceptions

PinpointSMSVoiceV2.Client.exceptions.ThrottlingException
PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException
PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException
PinpointSMSVoiceV2.Client.exceptions.ValidationException
PinpointSMSVoiceV2.Client.exceptions.ConflictException
PinpointSMSVoiceV2.Client.exceptions.InternalServerException