start-automation-execution

Описание

Инициализирует выполнение скрипта автоматизации.

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

Синтаксис

  start-automation-execution
--document-name <value>
[--document-version <value>]
[--parameters <value>]
[--client-token <value>]
[--mode <value>]
[--target-parameter-name <value>]
[--targets <value>]
[--target-maps <value>]
[--max-concurrency <value>]
[--max-errors <value>]
[--target-locations <value>]
[--tags <value>]
[--alarm-configuration <value>]
[--target-locations-url <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]

Параметры

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

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

--parameters (словарь)

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

KeyName1=string,string,KeyName2=string,string

Синтаксис JSON:

{"string": ["string", ...]
  ...}

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

--mode (строка)

--target-parameter-name (строка)

--targets (список)

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

Key=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Values": ["string", ...]
  }
  ...
]

--target-maps (список)

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

KeyName1=string,string,KeyName2=string,string ...

Синтаксис JSON:

[
  {"string": ["string", ...]
    ...}
  ...
]

--max-concurrency (строка)

--max-errors (строка)

--target-locations (список)

Синтаксис JSON:

[
  {
    "Accounts": ["string", ...],
    "Regions": ["string", ...],
    "TargetLocationMaxConcurrency": "string",
    "TargetLocationMaxErrors": "string",
    "ExecutionRoleName": "string",
    "TargetLocationAlarmConfiguration": {
      "IgnorePollAlarmFailure": true|false,
      "Alarms": [
        {
          "Name": "string"
        }
        ...
      ]
    },
    "IncludeChildOrganizationUnits": true|false,
    "ExcludeAccounts": ["string", ...],
    "Targets": [
      {
        "Key": "string",
        "Values": ["string", ...]
      }
      ...
    ],
    "TargetsMaxConcurrency": "string",
    "TargetsMaxErrors": "string"
  }
  ...
]

--tags (список)

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--alarm-configuration (структура)

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

IgnorePollAlarmFailure=boolean,Alarms=[{Name=string},{Name=string}]

Синтаксис JSON:

{
  "IgnorePollAlarmFailure": true|false,
  "Alarms": [
    {
      "Name": "string"
    }
    ...
  ]
}

--target-locations-url (строка)

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

Переопределить стандартный URL команды указанным URL.

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

Файл сертификатов CA для проверки 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: Запуск документа автоматизации

Следующий start-automation-execution пример запускает документ автоматизации.

aws ssm start-automation-execution \
    --document-name "AWS-UpdateLinuxAmi" \
    --parameters "AutomationAssumeRole=arn:aws:iam::123456789012:role/SSMAutomationRole,SourceAmiId=ami-EXAMPLE,IamInstanceProfileName=EC2InstanceRole"

Вывод:

{
  "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE"
}

Для получения дополнительной информации см. Руководство по работе с рабочим процессом автоматизации вручную в Руководстве пользователя AWS Systems Manager.

Пример 2: Запуск общего документа автоматизации

Следующий start-automation-execution пример запускает общий документ автоматизации.

aws ssm start-automation-execution \
    --document-name "arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument"

Вывод:

{
  "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2EXAMPLE"
}

Для получения дополнительной информации см. Использование общих документов SSM в Руководстве пользователя AWS Systems Manager.

Вывод

AutomationExecutionId -> (string)