start-session

Описание

Инициализирует соединение с целевым объектом (например, управляемым узлом) для сессии Session Manager. Возвращает URL и токен, которые можно использовать для открытия соединения WebSocket для отправки входных данных и получения выходных.

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

Синтаксис

  start-session
--target <value>
[--document-name <value>]
[--reason <value>]
[--parameters <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]

Параметры

--target (строка)

--document-name (строка)

--reason (строка)

--parameters (карта)

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

KeyName1=string,string,KeyName2=string,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 (boolean)

Включить отладку.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

• json
• text
• table
• yaml
• yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

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

--color (string)

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

• on
• off
• auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл с корневыми сертификатами для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Пример 1: Запуск сеанса Session Manager

Этот start-session пример устанавливает соединение с экземпляром для сеанса Session Manager. Обратите внимание, что эта интерактивная команда требует установки плагина Session Manager на клиентской машине, выполняющей вызов.

aws ssm start-session \
    --target "i-1234567890abcdef0"

Вывод:

Starting session with SessionId: Jane-Roe-07a16060613c408b5

Пример 2: Запуск сеанса Session Manager с использованием SSH

Этот start-session пример устанавливает соединение с экземпляром для сеанса Session Manager с использованием SSH. Обратите внимание, что эта интерактивная команда требует установки плагина Session Manager на клиентской машине, выполняющей вызов, и что команда использует пользователя по умолчанию на экземпляре, например, ec2-user для экземпляров EC2 Linux.

ssh -i /path/my-key-pair.pem ec2-user@i-02573cafcfEXAMPLE

Вывод:

Starting session with SessionId: ec2-user-07a16060613c408b5

Для получения дополнительной информации см. «Запуск сеанса» и «Установка плагина Session Manager для AWS CLI» в Руководстве пользователя AWS Systems Manager.

Вывод

Нет