PinpointSMSVoiceV2 / Client / release_sender_id

release_sender_id#

PinpointSMSVoiceV2.Client.release_sender_id(**kwargs)#

Releases an existing sender ID in your account.

See also: AWS API Documentation

Request Syntax

response = client.release_sender_id(
    SenderId='string',
    IsoCountryCode='string'
)
Parameters:

  • SenderId (string) –

    [REQUIRED]

    The sender ID to release.

  • IsoCountryCode (string) –

    [REQUIRED]

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Return type:

dict

Returns:

Response Syntax

{
    'SenderIdArn': 'string',
    'SenderId': 'string',
    'IsoCountryCode': 'string',
    'MessageTypes': [
        'TRANSACTIONAL'|'PROMOTIONAL',
    ],
    'MonthlyLeasingPrice': 'string',
    'Registered': True|False,
    'RegistrationId': 'string'
}

Response Structure

  • (dict) –

    • SenderIdArn (string) –

      The Amazon Resource Name (ARN) associated with the SenderId.

    • SenderId (string) –

      The sender ID that was released.

    • IsoCountryCode (string) –

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    • MessageTypes (list) –

      The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren’t critical or time-sensitive.

      • (string) –

    • MonthlyLeasingPrice (string) –

      The monthly price, in US dollars, to lease the sender ID.

    • Registered (boolean) –

      True if the sender ID is registered.

    • RegistrationId (string) –

      The unique identifier for the registration.

Exceptions