[ aws . pinpoint-sms-voice-v2 ]
describe-sender-ids
Описание
Описывает указанные SenderIds или все SenderIds, связанные с вашей учетной записью Amazon Web Services.
Если вы укажете SenderIds, вывод будет содержать информацию только для указанных SenderIds. Если вы укажете фильтры, вывод будет содержать информацию только для тех SenderIds, которые соответствуют критериям фильтра. Если вы не укажете SenderIds или фильтры, вывод будет содержать информацию обо всех SenderIds.
Если вы укажете неверный идентификатор отправителя, будет возвращена ошибка.
См. также: Документация AWS API
describe-sender-ids является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью аргумент --query должен извлекать данные из результатов следующих выражений запроса: SenderIds
Синтаксис
describe-sender-ids
[--sender-ids <value>]
[--filters <value>]
[--owner <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--sender-ids (список)
Массив объектов SenderIdAndCountry для поиска.
Предупреждение
Если вы используете общий ресурс AWS End User Messaging SMS и Voice, то вы должны использовать полное Amazon Resource Name (ARN).(структура)
Буквально-цифровой идентификатор отправителя в определенной стране, который вы хотите описать. Дополнительную информацию об идентификаторах отправителей см. в разделе Запрос идентификаторов отправителей в руководстве пользователя AWS End User Messaging SMS.
SenderId -> (строка)
IsoCountryCode -> (строка)
Сокращенный синтаксис:
SenderId=string,IsoCountryCode=string ...
Синтаксис JSON:
[
{
"SenderId": "string",
"IsoCountryCode": "string"
}
...
]
--filters (список)
Массив объектов SenderIdFilter для фильтрации результатов.
(структура)
Информация об идентификаторе отправителя, соответствующая заданным критериям.
Name -> (строка)
Values -> (список)
Массив значений для фильтрации.
(строка)
Сокращенный синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "sender-id"|"iso-country-code"|"message-type"|"deletion-protection-enabled"|"registered",
"Values": ["string", ...]
}
...
]
--owner (строка)
Используйте SELF для фильтрации списка идентификаторов отправителей, принадлежащих вашей учетной записи, или используйте SHARED для фильтрации по идентификаторам отправителей, общих с вашей учетной записью. Параметры Owner и SenderIds нельзя использовать одновременно.
Возможные значения:
SELFSHARED
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные через JSON. Передать произвольные двоичные значения с помощью значения, предоставленного в JSON, невозможно, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер для указания начала постраничного вывода. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничность в руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения данных в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничность в руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для продолжения постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничность в руководстве пользователя AWS Command Line Interface.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если указано без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (логическое значение)
Включение отладки.
--endpoint-url (строка)
Переопределение URL-адреса команды на указанный.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.
--no-paginate (логическое значение)
Отключение автоматической постраничности. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- text
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла с данными учетных записей.
--region (строка)
Используемый регион. Переопределяет настройки из конфигурации/окружения.
--version (строка)
Вывод версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- включено
- выключено
- автоматически
--no-sign-request (логическое значение)
Отключение подписи запросов. Данные учетных данных не будут загружены, если этот аргумент указан.
--ca-bundle (строка)
CA-сертификат для использования при проверке SSL-сертификатов. Переопределяет настройки из конфигурации/окружения.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время соединения сокета в секундах. Если значение равно 0, соединение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных данных. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные данные будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичные данные, fileb:// всегда будет рассматриваться как двоичные данные и будет использоваться непосредственно содержимое файла, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключение постраничного вывода для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключение автоматического запроса параметров CLI.
Вывод
SenderIds -> (список)
Массив объектов SernderIdInformation, содержащих подробности запрошенных SenderIds.
(структура)
Информация обо всех SenderIds в учетной записи Amazon Web Services.
SenderIdArn -> (строка)
SenderId -> (строка)
IsoCountryCode -> (строка)
MessageTypes -> (список)
Тип сообщения. Допустимые значения — TRANSACTIONAL для критически важных или срочных сообщений и PROMOTIONAL для сообщений, которые не являются критически важными или срочными.
(строка)
MonthlyLeasingPrice -> (строка)
DeletionProtectionEnabled -> (логическое значение)
Registered -> (логическое значение)
RegistrationId -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.