Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

create-instance

Описание

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

Инициализирует экземпляр Amazon Connect со всеми поддерживаемыми каналами, включенными по умолчанию. Он не подключает никакого хранилища, например, Amazon Simple Storage Service (Amazon S3) или Amazon Kinesis. Также он не позволяет выполнять какие-либо настройки функций, таких как Contact Lens for Amazon Connect.

Для получения дополнительной информации см. раздел Создание экземпляра Amazon Connect в руководстве администратора Amazon Connect.

Amazon Connect ограничивает общее количество экземпляров, которые можно создать или удалить за 30 дней. Если вы превысите это ограничение, вам будет сообщено об ошибке, указывающей на чрезмерное количество попыток создания или удаления экземпляров. Вам необходимо подождать 30 дней, прежде чем вы сможете продолжить создание и удаление экземпляров в вашей учётной записи.

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

Синтаксис

  create-instance
[--client-token <value>]
--identity-management-type <value>
[--instance-alias <value>]
[--directory-id <value>]
--inbound-calls-enabled | --no-inbound-calls-enabled
--outbound-calls-enabled | --no-outbound-calls-enabled
[--tags <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]

Параметры

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

Маркер идемпотентности.

--identity-management-type (строка)

Тип управления идентификацией для ваших пользователей Amazon Connect.

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

  • SAML
  • CONNECT_MANAGED
  • EXISTING_DIRECTORY

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

Имя вашего экземпляра.

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

Идентификатор каталога.

--inbound-calls-enabled | --no-inbound-calls-enabled (логическое значение)

Ваш контактный центр обрабатывает входящие контакты.

--outbound-calls-enabled | --no-outbound-calls-enabled (логическое значение)

Ваш контактный центр позволяет осуществлять исходящие звонки.

--tags (карта)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, { "tags": {"key1":"value1", "key2":"value2"} }.

ключ -> (строка)

значение -> (строка)

Краткая запись синтаксиса:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

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

Вывод

Id -> (строка)

Идентификатор экземпляра.

Arn -> (строка)

Amazon Resource Name (ARN) экземпляра.

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

Spec-Zone.ru

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