Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

list-instance-storage-configs

Описание

Этот API находится в предварительной версии для Amazon Connect и может быть изменён.

Возвращает постраничный список конфигураций хранилища для указанного экземпляра и типа ресурса.

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

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

Синтаксис

  list-instance-storage-configs
--instance-id <value>
--resource-type <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]

Параметры

--instance-id (строка)

Идентификатор экземпляра Amazon Connect. Идентификатор экземпляра можно найти в имени Amazon Resource Name (ARN) экземпляра.

--resource-type (строка)

Действительный тип ресурса.

Возможные значения:

  • CHAT_TRANSCRIPTS
  • CALL_RECORDINGS
  • SCHEDULED_REPORTS
  • MEDIA_STREAMS
  • CONTACT_TRACE_RECORDS
  • AGENT_EVENTS
  • REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
  • ATTACHMENTS
  • CONTACT_EVALUATIONS
  • SCREEN_RECORDINGS
  • REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS
  • REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
  • EMAIL_MESSAGES

--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
  • 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.

Вывод

StorageConfigs -> (список)

Действительный тип хранилища.

(структура)

Конфигурация хранилища для экземпляра.

AssociationId -> (строка)

Существующий идентификатор ассоциации, уникально идентифицирующий тип ресурса и конфигурацию хранилища для данного идентификатора экземпляра.

StorageType -> (строка)

Действительный тип хранилища.

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

Конфигурация S3-ведёр.

BucketName -> (строка)

Имя S3-ведёр.

BucketPrefix -> (строка)

Префикс S3-ведёр.

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

Конфигурация шифрования Amazon S3.

EncryptionType -> (строка)

Тип шифрования.

KeyId -> (строка)

Полный ARN ключа шифрования.

Примечание

Убедитесь, что предоставлен полный ARN ключа шифрования, а не только его ID.

Amazon Connect поддерживает только ключи KMS с параметрами ключей по умолчанию ` SYMMETRIC_DEFAULT https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default`__ .

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

Конфигурация потока видео Kinesis.

Prefix -> (строка)

Префикс потока видео.

RetentionPeriodHours -> (целое число)

Количество часов хранения данных в потоке. Kinesis Video Streams сохраняет данные в хранилище, связанном с потоком.

Значение по умолчанию — 0, что указывает на то, что поток не сохраняет данные.

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

Конфигурация шифрования.

EncryptionType -> (строка)

Тип шифрования.

KeyId -> (строка)

Полный ARN ключа шифрования.

Примечание

Убедитесь, что предоставлен полный ARN ключа шифрования, а не только его ID.

Amazon Connect поддерживает только ключи KMS с параметрами ключей по умолчанию ` SYMMETRIC_DEFAULT https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default`__ .

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

Конфигурация потока данных Kinesis.

StreamArn -> (строка)

Amazon Resource Name (ARN) потока данных.

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

Конфигурация потока доставки Kinesis Firehose.

FirehoseArn -> (строка)

Amazon Resource Name (ARN) потока доставки.

NextToken -> (строка)

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

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

Spec-Zone.ru

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