Pinpoint / Client / get_sms_channel

get_sms_channel#

Pinpoint.Client.get_sms_channel(**kwargs)#

Retrieves information about the status and settings of the SMS channel for an application.

Request Syntax

response = client.get_sms_channel(
    ApplicationId='string'
)

Parameters:

ApplicationId (string) –

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type:

dict

Returns:

Response Syntax

{
    'SMSChannelResponse': {
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'Enabled': True|False,
        'HasCredential': True|False,
        'Id': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'Platform': 'string',
        'PromotionalMessagesPerSecond': 123,
        'SenderId': 'string',
        'ShortCode': 'string',
        'TransactionalMessagesPerSecond': 123,
        'Version': 123
    }
}

Response Structure

(dict) –

The request succeeded.
- SMSChannelResponse (dict) –
  
  Provides information about the status and settings of the SMS channel for an application.
  - ApplicationId (string) –
    
    The unique identifier for the application that the SMS channel applies to.
  - CreationDate (string) –
    
    The date and time, in ISO 8601 format, when the SMS channel was enabled.
  - Enabled (boolean) –
    
    Specifies whether the SMS channel is enabled for the application.
  - HasCredential (boolean) –
    
    (Not used) This property is retained only for backward compatibility.
  - Id (string) –
    
    (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
  - IsArchived (boolean) –
    
    Specifies whether the SMS channel is archived.
  - LastModifiedBy (string) –
    
    The user who last modified the SMS channel.
  - LastModifiedDate (string) –
    
    The date and time, in ISO 8601 format, when the SMS channel was last modified.
  - Platform (string) –
    
    The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
  - PromotionalMessagesPerSecond (integer) –
    
    The maximum number of promotional messages that you can send through the SMS channel each second.
  - SenderId (string) –
    
    The identity that displays on recipients’ devices when they receive messages from the SMS channel.
  - ShortCode (string) –
    
    The registered short code to use when you send messages through the SMS channel.
  - TransactionalMessagesPerSecond (integer) –
    
    The maximum number of transactional messages that you can send through the SMS channel each second.
  - Version (integer) –
    
    The current version of the SMS channel.

Exceptions

Pinpoint.Client.exceptions.BadRequestException
Pinpoint.Client.exceptions.InternalServerErrorException
Pinpoint.Client.exceptions.PayloadTooLargeException
Pinpoint.Client.exceptions.ForbiddenException
Pinpoint.Client.exceptions.NotFoundException
Pinpoint.Client.exceptions.MethodNotAllowedException
Pinpoint.Client.exceptions.TooManyRequestsException