PinpointSMSVoiceV2 / Client / describe_sender_ids

describe_sender_ids#

PinpointSMSVoiceV2.Client.describe_sender_ids(**kwargs)#

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don’t specify SenderIds or filters, the output includes information for all SenderIds.

f you specify a sender ID that isn’t valid, an error is returned.

See also: AWS API Documentation

Request Syntax

response = client.describe_sender_ids(
    SenderIds=[
        {
            'SenderId': 'string',
            'IsoCountryCode': 'string'
        },
    ],
    Filters=[
        {
            'Name': 'sender-id'|'iso-country-code'|'message-type'|'deletion-protection-enabled'|'registered',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123,
    Owner='SELF'|'SHARED'
)
Parameters:

  • SenderIds (list) –

    An array of SenderIdAndCountry objects to search for.

    Warning

    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    • (dict) –

      The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs in the AWS End User Messaging SMS User Guide.

      • SenderId (string) – [REQUIRED]

        The unique identifier of the sender.

      • IsoCountryCode (string) – [REQUIRED]

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

  • Filters (list) –

    An array of SenderIdFilter objects to filter the results.

    • (dict) –

      The information for a sender ID that meets a specified criteria.

      • Name (string) – [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) – [REQUIRED]

        An array of values to filter for.

        • (string) –

  • NextToken (string) – The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.

  • MaxResults (integer) – The maximum number of results to return per each request.

  • Owner (string) – Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can’t be used at the same time.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • SenderIds (list) –

      An array of SernderIdInformation objects that contain the details for the requested SenderIds.

      • (dict) –

        The information for all SenderIds in an Amazon Web Services account.

        • SenderIdArn (string) –

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

        • SenderId (string) –

          The alphanumeric sender ID in a specific country that you’d like to describe.

        • 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 leasing price, in US dollars.

        • DeletionProtectionEnabled (boolean) –

          By default this is set to false. When set to true the sender ID can’t be deleted.

        • Registered (boolean) –

          True if the sender ID is registered.

        • RegistrationId (string) –

          The unique identifier for the registration.

    • NextToken (string) –

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions