Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

describe-configuration-sets

Описание

Описывает указанные наборы конфигурации или все наборы конфигурации в вашей учетной записи.

Если вы укажете имена наборов конфигурации, вывод будет содержать информацию только для указанных наборов конфигурации. Если вы укажете фильтры, вывод будет содержать информацию только для тех наборов конфигурации, которые соответствуют критериям фильтра. Если вы не укажете имена наборов конфигурации или фильтры, вывод будет содержать информацию обо всех наборах конфигурации.

Если вы укажете имя набора конфигурации, которое не является допустимым, будет возвращена ошибка.

См. также: Документация API AWS

describe-configuration-sets является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную загрузку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничную загрузку, аргумент --query должен извлечь данные из результатов следующих выражений запроса: ConfigurationSets

Синтаксис

  describe-configuration-sets
[--configuration-set-names <value>]
[--filters <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]

Параметры

--configuration-set-names (список)

Массив строк. Каждый элемент может быть либо именем набора конфигурации (ConfigurationSetName), либо идентификатором ресурса набора конфигурации (ConfigurationSetArn).

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Массив фильтров, которые необходимо применить к возвращаемым результатам.

(структура)

Информация о наборах конфигурации, которые удовлетворяют указанным критериям.

Имя -> (строка)

Имя атрибута для фильтрации.

Значения -> (список)

Массив значений для фильтрации.

(строка)

Сокращенный синтаксис:

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

Синтаксис JSON:

[
  {
    "Name": "event-destination-name"|"matching-event-types"|"default-message-type"|"default-sender-id"|"default-message-feedback-enabled"|"protect-configuration-id",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного через JSON, поскольку строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания точки начала постраничной загрузки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе «Постраничная загрузка» в Руководстве пользователя командной строки AWS.

--page-size (целое число)

Размер каждой страницы для получения данных в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить сбой вызовов AWS-сервиса из-за превышения времени ожидания.

Примеры использования см. в разделе «Постраничная загрузка» в Руководстве пользователя командной строки AWS.

--max-items (целое число)

Общее количество элементов для возвращения в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную загрузку, предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничная загрузка» в Руководстве пользователя командной строки AWS.

--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 по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (логическое значение)

Отключить автоматическую постраничную загрузку. Если автоматическая постраничная загрузка отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • текст
  • таблица
  • 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.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров ввода CLI.

Вывод

ConfigurationSets -> (список)

Массив объектов ConfigurationSets.

(структура)

Информация, относящаяся к заданному набору конфигурации в вашей учетной записи Amazon Web Services.

ConfigurationSetArn -> (строка)

Идентификатор ресурса (ARN) набора конфигурации.

ConfigurationSetName -> (строка)

Имя набора конфигурации.

EventDestinations -> (список)

Массив объектов EventDestination, описывающих любые события для ведения журнала и место их ведения.

(структура)

Содержит информацию об пункте назначения событий.

Пункты назначения событий связаны с наборами конфигурации, что позволяет публиковать события отправки сообщений в CloudWatch, Firehose или Amazon SNS.

EventDestinationName -> (строка)

Имя EventDestination.

Enabled -> (логическое значение)

При значении true события будут записываться в журнал.

MatchingEventTypes -> (список)

Массив типов событий, определяющих, какие события регистрировать.

Примечание

Тип события TEXT_SENT не поддерживается.

(строка)

CloudWatchLogsDestination -> (структура)

Объект, содержащий информацию о пункте назначения событий, которые отправляются в журналы Amazon CloudWatch.

IamRoleArn -> (строка)

Идентификатор ресурса (ARN) роли управления доступом и безопасностью, которая может записывать данные событий в пункт назначения Amazon CloudWatch.

LogGroupArn -> (строка)

Имя группы журналов Amazon CloudWatch, в которой вы хотите регистрировать события.

KinesisFirehoseDestination -> (структура)

Объект, содержащий информацию о пункте назначения событий для ведения журнала в Amazon Data Firehose.

IamRoleArn -> (строка)

ARN роли управления доступом и безопасностью, которая может записывать данные событий в пункт назначения Amazon Data Firehose.

DeliveryStreamArn -> (строка)

Идентификатор ресурса (ARN) потока доставки.

SnsDestination -> (структура)

Объект, содержащий информацию о пункте назначения событий, которые отправляются в Amazon SNS.

TopicArn -> (строка)

Идентификатор ресурса (ARN) темы Amazon SNS, в которую вы хотите публиковать события.

DefaultMessageType -> (строка)

Тип сообщения. Допустимые значения: TRANSACTIONAL для сообщений, которые являются критическими или зависят от времени, и PROMOTIONAL для сообщений, которые не являются критическими или зависят от времени.

DefaultSenderId -> (строка)

Идентификатор отправителя по умолчанию, используемый набором конфигурации.

DefaultMessageFeedbackEnabled -> (логическое значение)

True, если обратная связь по сообщениям включена.

CreatedTimestamp -> (метка времени)

Время создания набора конфигурации в формате эпохи Unix.

ProtectConfigurationId -> (строка)

Уникальный идентификатор конфигурации защиты.

NextToken -> (строка)

Токен, который нужно использовать для следующего набора результатов постраничной загрузки. Если это поле пустое, значит больше результатов нет.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API