Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

describe-instance-storage-config

Описание

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

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

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

Синопсис

  describe-instance-storage-config
--instance-id <value>
--association-id <value>
--resource-type <value>
[--cli-input-json | --cli-input-yaml]
[--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 (ARN) экземпляра.

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

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

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

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Используйте определенный профиль из файла ключей.

--region (строка)

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

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

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

Вывод

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

Допустимый тип хранилища.

AssociationId -> (строка)

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

StorageType -> (строка)

Допустимый тип хранилища.

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

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

BucketName -> (строка)

Имя ведра S3.

BucketPrefix -> (строка)

Префикс ведра S3.

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

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

EncryptionType -> (строка)

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

KeyId -> (строка)

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

Примечание

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

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

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

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

Prefix -> (строка)

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

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

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

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

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

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

EncryptionType -> (строка)

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

KeyId -> (строка)

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

Примечание

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

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 (ARN) потока данных.

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

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

FirehoseArn -> (строка)

Имя ресурса Amazon (ARN) потока доставки.

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

Spec-Zone.ru

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