Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

associate-instance-storage-config

Описание

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

Связывает тип хранилища с ресурсом впервые. Вы можете связать только один тип конфигурации хранилища в одном вызове. Это означает, например, что вы не можете определить экземпляр с несколькими S3-бакетами для хранения транскриптов чата.

Этот API не создаёт ресурс, которого не существует. Он только связывает его с экземпляром. Убедитесь, что ресурс, указанный в конфигурации хранилища, например, S3-бакет, существует при использовании его для связывания.

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

Синтаксис

  associate-instance-storage-config
--instance-id <value>
--resource-type <value>
--storage-config <value>
[--client-token <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 Resource Name (ARN) экземпляра.

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

Действительный тип ресурса. Чтобы включить потоковую передачу для анализа контактов в режиме реального времени, используйте следующие типы:

  • Для чатовых контактов используйте REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS.
  • Для голосовых контактов используйте REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.

Примечание

REAL_TIME_CONTACT_ANALYSIS_SEGMENTS устарел, но всё ещё поддерживается и будет применяться только к контактам канала VOICE. Используйте REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS для голосовых контактов в дальнейшем.

Если вы ранее связали поток с REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, никаких действий по обновлению потока до REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS не требуется.

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

  • 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

--storage-config (структура)

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

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

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

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

FirehoseArn -> (строка)

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

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

AssociationId=string,StorageType=string,S3Config={BucketName=string,BucketPrefix=string,EncryptionConfig={EncryptionType=string,KeyId=string}},KinesisVideoStreamConfig={Prefix=string,RetentionPeriodHours=integer,EncryptionConfig={EncryptionType=string,KeyId=string}},KinesisStreamConfig={StreamArn=string},KinesisFirehoseConfig={FirehoseArn=string}

Синтаксис JSON:

{
  "AssociationId": "string",
  "StorageType": "S3"|"KINESIS_VIDEO_STREAM"|"KINESIS_STREAM"|"KINESIS_FIREHOSE",
  "S3Config": {
    "BucketName": "string",
    "BucketPrefix": "string",
    "EncryptionConfig": {
      "EncryptionType": "KMS",
      "KeyId": "string"
    }
  },
  "KinesisVideoStreamConfig": {
    "Prefix": "string",
    "RetentionPeriodHours": integer,
    "EncryptionConfig": {
      "EncryptionType": "KMS",
      "KeyId": "string"
    }
  },
  "KinesisStreamConfig": {
    "StreamArn": "string"
  },
  "KinesisFirehoseConfig": {
    "FirehoseArn": "string"
  }
}

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

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы обеспечить идемпотентность запроса. Если не указан, Amazon Web Services SDK заполняет это поле. Дополнительные сведения об идемпотентности см. в разделе Обеспечение безопасности повторных попыток с помощью идемпотентных API.

--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 (строка)

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

  • вкл
  • выкл
  • авто

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

Вывод

AssociationId -> (строка)

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

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

Spec-Zone.ru

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