Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

обновить-статус-ассоциации

Описание

Обновляет статус документа Amazon Web Services Systems Manager (документа SSM), связанного с указанным управляемым узлом.

UpdateAssociationStatus в основном используется агентом Amazon Web Services Systems Manager (SSM Agent) для отчёта об обновлениях статуса ваших ассоциаций и используется только для ассоциаций, созданных с параметром InstanceId legacy.

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

Синтаксис

  update-association-status
--name <value>
--instance-id <value>
--association-status <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]

Параметры

--name (строка)

Имя документа SSM.

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

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

--association-status (структура)

Статус ассоциации.

Дата -> (метка времени)

Дата изменения статуса.

Имя -> (строка)

Статус.

Сообщение -> (строка)

Причина статуса.

Дополнительная информация -> (строка)

Пользовательская строка.

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

Date=timestamp,Name=string,Message=string,AdditionalInfo=string

Синтаксис JSON:

{
  "Date": timestamp,
  "Name": "Pending"|"Success"|"Failed",
  "Message": "string",
  "AdditionalInfo": "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
  • таблица
  • yaml
  • yaml-поток

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила кавычек, подобные unix-подобным. Эти примеры необходимо адаптировать к правилам кавычек вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для обновления статуса ассоциации

Следующий update-association-status пример обновляет статус ассоциации между экземпляром и документом.

aws ssm update-association-status \
    --name "AWS-UpdateSSMAgent" \
    --instance-id "i-1234567890abcdef0" \
    --association-status "Date=1424421071.939,Name=Pending,Message=temp_status_change,AdditionalInfo=Additional-Config-Needed"

Вывод:

{
    "AssociationDescription": {
        "Name": "AWS-UpdateSSMAgent",
        "InstanceId": "i-1234567890abcdef0",
        "AssociationVersion": "1",
        "Date": 1550507529.604,
        "LastUpdateAssociationDate": 1550507806.974,
        "Status": {
            "Date": 1424421071.0,
            "Name": "Pending",
            "Message": "temp_status_change",
            "AdditionalInfo": "Additional-Config-Needed"
        },
        "Overview": {
            "Status": "Success",
            "AssociationStatusAggregatedCount": {
                "Success": 1
            }
        },
        "DocumentVersion": "$DEFAULT",
        "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab",
        "Targets": [
            {
                "Key": "InstanceIds",
                "Values": [
                    "i-1234567890abcdef0"
                ]
            }
        ],
        "LastExecutionDate": 1550507808.0,
        "LastSuccessfulExecutionDate": 1550507808.0
    }
}

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

Вывод

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

Информация об ассоциации.

Name -> (строка)

Название документа SSM.

InstanceId -> (строка)

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

AssociationVersion -> (строка)

Версия ассоциации.

Date -> (метка времени)

Дата создания ассоциации.

LastUpdateAssociationDate -> (метка времени)

Дата последнего обновления ассоциации.

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

Статус ассоциации.

Date -> (метка времени)

Дата изменения статуса.

Name -> (строка)

Статус.

Message -> (строка)

Причина статуса.

AdditionalInfo -> (строка)

Строка, определённая пользователем.

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

Информация об ассоциации.

Status -> (строка)

Статус ассоциации. Статус может быть: Pending, Success или Failed.

DetailedStatus -> (строка)

Подробный статус ассоциации.

AssociationStatusAggregatedCount -> (массив)

Возвращает количество целевых объектов для статуса ассоциации. Например, если вы создали ассоциацию с двумя управляемыми узлами, и один из них был успешным, это вернёт количество управляемых узлов по статусу.

key -> (строка)

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

DocumentVersion -> (строка)

Версия документа.

AutomationTargetParameterName -> (строка)

Выберите параметр, который определит, как ваша автоматизация будет разветвляться. Этот параметр необходим для ассоциаций, использующих Automation runbook и нацеливающихся на ресурсы с помощью контроля скорости. Automation — инструмент в Amazon Web Services Systems Manager.

Parameters -> (массив)

Описание параметров документа.

key -> (строка)

value -> (список)

(строка)

AssociationId -> (строка)

Идентификатор ассоциации.

Targets -> (список)

Управляемые узлы, на которые направлен запрос.

(структура)

Массив критериев поиска, которые нацеливают управляемые узлы с помощью заданной пары ключ-значение.

Примечание

Для задач типа Run Command в рамках окна обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи, целевые объекты являются необязательными для других типов задач в рамках окна обслуживания (Automation, Lambda и Step Functions). Дополнительную информацию о запуске задач без указания целевых объектов см. в руководстве пользователя Amazon Web Services Systems Manager.

Поддерживаются следующие форматы.

Для всех инструментов Systems Manager:
  • Key=tag-key,Values=tag-value-1,tag-value-2
Для Automation и Change Manager:
  • Key=tag:tag-key,Values=tag-value
  • Key=ResourceGroup,Values=resource-group-name
  • Key=ParameterValues,Values=value-1,value-2,value-3
  • Для нацеливания на все экземпляры в регионе Amazon Web Services:
    • Key=AWS::EC2::Instance,Values=*
    • Key=InstanceIds,Values=*
Для Run Command и Maintenance Windows:
  • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
  • Key=tag:tag-key,Values=tag-value-1,tag-value-2
  • Key=resource-groups:Name,Values=resource-group-name
  • Кроме того, Maintenance Windows поддерживают нацеливание на типы ресурсов:
    • Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Для State Manager:
  • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
  • Key=tag:tag-key,Values=tag-value-1,tag-value-2
  • Для нацеливания на все экземпляры в регионе Amazon Web Services:
    • Key=InstanceIds,Values=*

Дополнительную информацию о том, как отправлять команды, нацеленные на управляемые узлы с использованием Key,Value параметров, см. в руководстве пользователя Amazon Web Services Systems Manager.

Key -> (строка)

Критерии, определённые пользователем, для отправки команд, нацеленных на управляемые узлы, соответствующие этим критериям.

Values -> (список)

Критерии, определённые пользователем, которые сопоставляются с Key . Например, если вы указали tag:ServerRole, вы можете указать value:WebServer для запуска команды на экземплярах, содержащих теги EC2 ServerRole,WebServer .

В зависимости от типа целевого объекта, максимальное количество значений для ключа может быть ниже глобального максимума в 50.

(строка)

ScheduleExpression -> (строка)

Выражение cron, указывающее график выполнения ассоциации.

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

Ведро S3, в котором вы хотите хранить подробности результата запроса.

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

Ведро S3, в котором вы хотите хранить результаты этого запроса.

OutputS3Region -> (строка)

Регион Amazon Web Services для ведра S3.

OutputS3BucketName -> (строка)

Имя ведра S3.

OutputS3KeyPrefix -> (строка)

Подпапка ведра S3.

LastExecutionDate -> (метка времени)

Дата последнего выполнения ассоциации.

LastSuccessfulExecutionDate -> (метка времени)

Последняя дата успешного выполнения ассоциации.

AssociationName -> (строка)

Название ассоциации.

MaxErrors -> (строка)

Количество ошибок, разрешённых до того, как система перестанет отправлять запросы на выполнение ассоциации для дополнительных целевых объектов. Вы можете указать либо абсолютное число ошибок, например 10, либо процент от набора целевых объектов, например 10%. Если вы укажете 3, например, система прекратит отправлять запросы, когда будет получена четвёртая ошибка. Если вы укажете 0, система прекратит отправку запросов после первой возвращённой ошибки. Если вы выполняете ассоциацию на 50 управляемых узлах и зададите MaxError 10%, система прекратит отправку запроса, когда будет получена шестая ошибка.

Выполнения, которые уже выполняют ассоциацию, когда достигнуто MaxErrors, разрешается завершить, но некоторые из этих выполнений могут завершиться неудачно. Если нужно убедиться, что не будет больше, чем max-errors неудачных выполнений, установите MaxConcurrency в 1, чтобы выполнения продолжались по одному.

MaxConcurrency -> (строка)

Максимальное количество целевых объектов, разрешённых для одновременного выполнения ассоциации. Вы можете указать число, например 10, или процент от набора целевых объектов, например 10%. По умолчанию значение равно 100%, что означает, что все целевые объекты выполняют ассоциацию одновременно.

Если новый управляемый узел начинает и пытается выполнить ассоциацию, в то время как Systems Manager выполняет MaxConcurrency ассоциации, выполнение ассоциации разрешается. Во время следующего интервала ассоциации новый управляемый узел обработает свою ассоциацию в пределах ограничения, указанного для MaxConcurrency.

ComplianceSeverity -> (строка)

Уровень строгости, назначенный ассоциации.

SyncCompliance -> (строка)

Режим генерации соответствия ассоциации. Вы можете указать AUTO или MANUAL. В режиме AUTO система использует статус выполнения ассоциации для определения статуса соответствия. Если выполнение ассоциации прошло успешно, то ассоциация является COMPLIANT. Если выполнение ассоциации не прошло успешно, ассоциация является NON-COMPLIANT.

В режиме MANUAL вы должны указать AssociationId в качестве параметра для операции PutComplianceItems API. В этом случае данные соответствия не управляются State Manager, инструментом в Amazon Web Services Systems Manager. Они управляются вашим прямым вызовом операции PutComplianceItems API.

По умолчанию все ассоциации используют режим AUTO.

ApplyOnlyAtCronInterval -> (логическое значение)

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

CalendarNames -> (список)

Имена или Amazon Resource Names (ARN) документов типа Change Calendar, под которыми ваши ассоциации ограничены. Ассоциации выполняются только при открытии этого календаря изменений. Дополнительную информацию см. в руководстве пользователя Amazon Web Services Systems Manager.

(строка)

TargetLocations -> (список)

Сочетание регионов Amazon Web Services и учётных записей Amazon Web Services, где вы хотите запустить ассоциацию.

(структура)

Сочетание регионов Amazon Web Services и учётных записей Amazon Web Services, на которые направлено текущее выполнение автоматизации.

Учётные записи -> (список)

Учётные записи Amazon Web Services, на которые направлено текущее выполнение автоматизации.

(строка)

Регионы -> (список)

Регионы Amazon Web Services, на которые направлено текущее выполнение автоматизации.

(строка)

TargetLocationMaxConcurrency -> (строка)

Максимальное количество регионов Amazon Web Services и учётных записей Amazon Web Services, которые разрешено запускать автоматизацию одновременно.

TargetLocationMaxErrors -> (строка)

Максимальное количество ошибок, разрешённых перед тем, как система перестанет добавлять в очередь дополнительные выполнения автоматизации для текущего выполнения автоматизации.

ExecutionRoleName -> (строка)

Роль выполнения автоматизации, используемая текущей автоматизацией. Если не указано, используется значение по умолчанию AWS-SystemsManager-AutomationExecutionRole .

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

Подробности о сигнале CloudWatch, который вы хотите применить к автоматизации или команде.

IgnorePollAlarmFailure -> (булево)

Когда это значение равно true , ваша автоматизация или команда продолжают выполняться в тех случаях, когда мы не можем получить информацию о состоянии сигнала из CloudWatch. В тех случаях, когда мы успешно получаем состояние сигнала OK или INSUFFICIENT_DATA, автоматизация или команда продолжают выполняться независимо от этого значения. По умолчанию — false .

Alarms -> (список)

Имя сигнала CloudWatch, указанного в конфигурации.

(структура)

Сигнал CloudWatch, который вы применяете к автоматизации или команде.

Name -> (строка)

Имя вашего сигнала CloudWatch.

IncludeChildOrganizationUnits -> (булево)

Указывает, следует ли включать дочерние организационные единицы (OU), являющиеся дочерними по отношению к целевым OU. По умолчанию — false .

ExcludeAccounts -> (список)

Учётные записи Amazon Web Services или организационные единицы для исключения в качестве расширенных целей.

(строка)

Targets -> (список)

Список сопоставлений ключ-значение для целевых ресурсов. Если вы указываете значения для этого типа данных, вы также должны указать значение для TargetParameterName .

Этот параметр Targets имеет приоритет над параметром StartAutomationExecution:Targets, если оба указаны.

(структура)

Массив критериев поиска, которые нацеливаются на управляемые узлы с помощью пары ключ-значение, которую вы указываете.

Примечание

Для задач типа Run Command в окне обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи целевые объекты являются необязательными для других типов задач окна обслуживания (Automation, Lambda и Step Functions). Более подробную информацию о выполнении задач, не указывающих целевые объекты, см. в разделе «Регистрация задач окна обслуживания без целевых объектов» в руководстве пользователя Amazon Web Services Systems Manager.

Поддерживаемые форматы включают следующие.

Для всех инструментов Systems Manager:
  • Key=tag-key,Values=tag-value-1,tag-value-2
Для Automation и Change Manager:
  • Key=tag:tag-key,Values=tag-value
  • Key=ResourceGroup,Values=resource-group-name
  • Key=ParameterValues,Values=value-1,value-2,value-3
  • Для нацеливания на все экземпляры в регионе Amazon Web Services:
    • Key=AWS::EC2::Instance,Values=*
    • Key=InstanceIds,Values=*
Для Run Command и окон обслуживания:
  • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
  • Key=tag:tag-key,Values=tag-value-1,tag-value-2
  • Key=resource-groups:Name,Values=resource-group-name
  • Кроме того, окна обслуживания поддерживают нацеливание на типы ресурсов:
    • Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Для State Manager:
  • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
  • Key=tag:tag-key,Values=tag-value-1,tag-value-2
  • Для нацеливания на все экземпляры в регионе Amazon Web Services:
    • Key=InstanceIds,Values=*

Дополнительную информацию о том, как отправлять команды, нацеленные на управляемые узлы с помощью параметров Key,Value, см. в разделе «Нацеливание на несколько управляемых узлов» в руководстве пользователя Amazon Web Services Systems Manager.

Key -> (строка)

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

Values -> (список)

Пользовательские критерии, которые соответствуют Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer для запуска команды на экземплярах, включающих теги EC2 ServerRole,WebServer.

В зависимости от типа целевого объекта максимальное количество значений для ключа может быть меньше глобального максимума в 50.

(строка)

TargetsMaxConcurrency -> (строка)

Максимальное количество целевых объектов, которым разрешено запускать эту задачу параллельно. Этот параметр TargetsMaxConcurrency имеет приоритет над параметром StartAutomationExecution:MaxConcurrency, если оба указаны.

TargetsMaxErrors -> (строка)

Максимальное количество ошибок, разрешённых перед тем, как система прекратит выполнение автоматизации на дополнительных целевых объектах. Этот параметр TargetsMaxErrors имеет приоритет над параметром StartAutomationExecution:MaxErrors, если оба указаны.

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

Количество дней ожидания после запланированного дня для запуска ассоциации.

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

Количество часов, в течение которых ассоциация может выполняться на указанных целевых объектах. После истечения полученного времени окончания ассоциации, которые в настоящее время выполняются, отменяются, и новые ожидающие выполнения не запускаются на оставшихся целевых объектах.

TargetMaps -> (список)

Сопоставление ключ-значение параметров документа с целевыми ресурсами. Параметры Targets и TargetMaps нельзя указывать вместе.

(карта)

key -> (строка)

value -> (список)

(строка)

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

Подробности о сигнале CloudWatch, который вы хотите применить к автоматизации или команде.

IgnorePollAlarmFailure -> (булево)

Когда это значение равно true , ваша автоматизация или команда продолжают выполняться в тех случаях, когда мы не можем получить информацию о состоянии сигнала из CloudWatch. В тех случаях, когда мы успешно получаем состояние сигнала OK или INSUFFICIENT_DATA, автоматизация или команда продолжают выполняться независимо от этого значения. По умолчанию — false .

Alarms -> (список)

Имя сигнала CloudWatch, указанного в конфигурации.

(структура)

Сигнал CloudWatch, который вы применяете к автоматизации или команде.

Name -> (строка)

Имя вашего сигнала CloudWatch.

TriggeredAlarms -> (список)

Сигнал CloudWatch, который был вызван во время ассоциации.

(структура)

Подробности о состоянии вашего сигнала CloudWatch.

Name -> (строка)

Имя вашего сигнала CloudWatch.

State -> (строка)

Состояние вашего сигнала CloudWatch.

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

Spec-Zone.ru

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