Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . pinpoint-sms-voice-v2 ]

describe-sender-ids

Description

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

describe-sender-ids is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: SenderIds

Synopsis

  describe-sender-ids
[--sender-ids <value>]
[--filters <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--sender-ids (list)

An array of SenderIdAndCountry objects to search for.

(structure)

The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs for SMS messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide .

SenderId -> (string)

The unique identifier of the sender.

IsoCountryCode -> (string)

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

Shorthand Syntax:

SenderId=string,IsoCountryCode=string ...

JSON Syntax:

[
  {
    "SenderId": "string",
    "IsoCountryCode": "string"
  }
  ...
]

--filters (list)

An array of SenderIdFilter objects to filter the results.

(structure)

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

Name -> (string)

The name of the attribute to filter on.

Values -> (list)

An array of values to filter for.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "sender-id"|"iso-country-code"|"message-type"|"deletion-protection-enabled"|"registered",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

SenderIds -> (list)

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

(structure)

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.