PinpointSMSVoiceV2 / Client / create_rcs_agent

create_rcs_agent¶

PinpointSMSVoiceV2.Client.create_rcs_agent(**kwargs)¶

Creates a new RCS agent for sending rich messages through the RCS channel. The RCS agent serves as an origination identity for sending RCS messages to your recipients.

Request Syntax

response = client.create_rcs_agent(
    DeletionProtectionEnabled=True|False,
    OptOutListName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)

Parameters:

DeletionProtectionEnabled (boolean) – By default this is set to false. When set to true the RCS agent can’t be deleted. You can change this value using the UpdateRcsAgent action.
OptOutListName (string) – The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.
Tags (list) –
An array of tags (key and value pairs) associated with the RCS agent.
- (dict) –
  
  The list of tags to be added to the specified topic.
  - Key (string) – [REQUIRED]
    
    The key identifier, or name, of the tag.
  - Value (string) – [REQUIRED]
    
    The string value associated with the key of the tag.
ClientToken (string) –
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, a randomly generated token is used for the request to ensure idempotency.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- RcsAgentArn (string) –
  
  The Amazon Resource Name (ARN) of the newly created RCS agent.
- RcsAgentId (string) –
  
  The unique identifier for the RCS agent.
- Status (string) –
  
  The current status of the RCS agent.
- DeletionProtectionEnabled (boolean) –
  
  When set to true deletion protection is enabled. By default this is set to false.
- OptOutListName (string) –
  
  The name of the OptOutList associated with the RCS agent.
- CreatedTimestamp (datetime) –
  
  The time when the RCS agent was created, in UNIX epoch time format.
- 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.
- Tags (list) –
  
  An array of tags (key and value pairs) associated with the RCS agent.
  - (dict) –
    
    The list of tags to be added to the specified topic.
    - Key (string) –
      
      The key identifier, or name, of the tag.
    - Value (string) –
      
      The string value associated with the key of the tag.

Exceptions

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