list-associations
Описание
Возвращает все ассоциации State Manager в текущей учётной записи Amazon Web Services и регионе Amazon Web Services. Вы можете ограничить результаты определённым документом ассоциации State Manager или управляемым узлом, указав фильтр. State Manager — это инструмент в Amazon Web Services Systems Manager.
См. также: Документация API AWS
list-associations является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Associations
Синтаксис
list-associations
[--association-filter-list <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]
Параметры
--association-filter-list (список)
Один или несколько фильтров. Используйте фильтр, чтобы получить более конкретный список результатов.
Примечание
Фильтрация ассоциаций с помощью атрибутаInstanceID возвращает только устаревшие ассоциации, созданные с помощью атрибута InstanceID. Ассоциации, нацеленные на управляемый узел, которые являются частью атрибутов Target Attributes ResourceGroup или Tags, не возвращаются.(структура)
Описывает фильтр.
key -> (строка)
Имя фильтра.
Примечание
InstanceId устарел.value -> (строка)
Сокращённый синтаксис:
key=string,value=string ...
Синтаксис JSON:
[
{
"key": "InstanceId"|"Name"|"AssociationId"|"AssociationStatusName"|"LastExecutedBefore"|"LastExecutedAfter"|"AssociationName"|"ResourceGroupName",
"value": "string"
}
...
]
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Передавать произвольные двоичные значения с помощью значения, предоставленного JSON, невозможно, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничной загрузки. Это NextToken из ранее усечённого ответа.
Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.
Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, предоставляется NextToken в выводе команды. Для возобновления постраничной загрузки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.
--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.
Пример 1: Для отображения ваших ассоциаций для конкретного экземпляра
Следующий пример list-associations отображает все ассоциации с именем AssociationName, UpdateSSMAgent.
aws ssm list-associations /
--association-filter-list "key=AssociationName,value=UpdateSSMAgent"
Вывод:
{
"Associations": [
{
"Name": "AWS-UpdateSSMAgent",
"InstanceId": "i-1234567890abcdef0",
"AssociationId": "8dfe3659-4309-493a-8755-0123456789ab",
"AssociationVersion": "1",
"Targets": [
{
"Key": "InstanceIds",
"Values": [
"i-016648b75dd622dab"
]
}
],
"Overview": {
"Status": "Pending",
"DetailedStatus": "Associated",
"AssociationStatusAggregatedCount": {
"Pending": 1
}
},
"ScheduleExpression": "cron(0 00 12 ? * SUN *)",
"AssociationName": "UpdateSSMAgent"
}
]
}
Дополнительную информацию см. в разделе Работа с ассоциациями в Systems Manager в Руководстве пользователя Systems Manager.
Пример 2: Для отображения ваших ассоциаций для конкретного документа
Следующий пример list-associations отображает все ассоциации для указанного документа.
aws ssm list-associations /
--association-filter-list "key=Name,value=AWS-UpdateSSMAgent"
Вывод:
{
"Associations": [
{
"Name": "AWS-UpdateSSMAgent",
"InstanceId": "i-1234567890abcdef0",
"AssociationId": "8dfe3659-4309-493a-8755-0123456789ab",
"AssociationVersion": "1",
"Targets": [
{
"Key": "InstanceIds",
"Values": [
"i-1234567890abcdef0"
]
}
],
"LastExecutionDate": 1550505828.548,
"Overview": {
"Status": "Success",
"DetailedStatus": "Success",
"AssociationStatusAggregatedCount": {
"Success": 1
}
},
"ScheduleExpression": "cron(0 00 12 ? * SUN *)",
"AssociationName": "UpdateSSMAgent"
},
{
"Name": "AWS-UpdateSSMAgent",
"InstanceId": "i-9876543210abcdef0",
"AssociationId": "fbc07ef7-b985-4684-b82b-0123456789ab",
"AssociationVersion": "1",
"Targets": [
{
"Key": "InstanceIds",
"Values": [
"i-9876543210abcdef0"
]
}
],
"LastExecutionDate": 1550507531.0,
"Overview": {
"Status": "Success",
"AssociationStatusAggregatedCount": {
"Success": 1
}
}
}
]
}
Дополнительную информацию см. в разделе Работа с ассоциациями в Systems Manager в Руководстве пользователя Systems Manager.
Вывод
Ассоциации -> (список)
Ассоциации.
(структура)
Описывает ассоциацию документа Amazon Web Services Systems Manager (документ SSM) и управляемого узла.
Имя -> (строка)
InstanceId -> (строка)
AssociationId -> (строка)
AssociationVersion -> (строка)
DocumentVersion -> (строка)
Версия документа, используемая в ассоциации. Если вы измените версию документа для ассоциации State Manager, Systems Manager немедленно запустит ассоциацию, если ранее не был указан параметр apply-only-at-cron-interval.
Предупреждение
State Manager не поддерживает запуск ассоциаций, использующих новую версию документа, если этот документ совместно используется с другим аккаунтом. State Manager всегда выполняетdefault версию документа, если он совместно используется с другим аккаунтом, даже если консоль Systems Manager показывает, что была обработана новая версия. Если вы хотите запустить ассоциацию, используя новую версию документа, совместно используемого из другого аккаунта, вы должны установить версию документа в default.Targets -> (список)
Управляемые узлы, на которые направлен запрос на создание ассоциации. Вы можете указать все управляемые узлы в аккаунте Amazon Web Services, указав ключ InstanceIds со значением *.
(структура)
Массив критериев поиска, которые нацелены на управляемые узлы с использованием заданной вами пары «ключ-значение».
Примечание
Для задач типа Run Command в окне обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи, целевые объекты являются необязательными для других типов задач в окне обслуживания (Automation, Lambda и Step Functions). Дополнительную информацию о запуске задач без указания целевых объектов см. в руководстве пользователя Amazon Web Services Systems Manager, раздел «Регистрация задач окна обслуживания без целевых объектов».Поддерживаемые форматы включают следующие.
Key=tag-key,Values=tag-value-1,tag-value-2
Key=tag:tag-key,Values=tag-valueKey=ResourceGroup,Values=resource-group-nameKey=ParameterValues,Values=value-1,value-2,value-3- Для выбора всех экземпляров в регионе Amazon Web Services:
Key=AWS::EC2::Instance,Values=*Key=InstanceIds,Values=*
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2Key=resource-groups:Name,Values=resource-group-name- Кроме того, окна обслуживания поддерживают целевые типы ресурсов:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2- Для выбора всех экземпляров в регионе Amazon Web Services:
Key=InstanceIds,Values=*
Дополнительную информацию о том, как отправлять команды, которые нацелены на управляемые узлы с использованием параметров Key,Value, см. в руководстве пользователя Amazon Web Services Systems Manager, раздел «Целеуказание нескольких управляемых узлов».
Ключ -> (строка)
Значения -> (список)
Пользовательские критерии, которые соответствуют Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer, чтобы запустить команду на экземплярах, которые включают теги EC2 ServerRole,WebServer.
В зависимости от типа целевого объекта, максимальное количество значений для ключа может быть меньше глобального максимума 50.
(строка)
LastExecutionDate -> (временная метка)
Обзор -> (структура)
Информация об ассоциации.
Статус -> (строка)
ПодробныйСтатус -> (строка)
AssociationStatusAggregatedCount -> (массив)
Возвращает количество целевых объектов для статуса ассоциации. Например, если вы создали ассоциацию с двумя управляемыми узлами, и один из них был успешным, это вернёт количество управляемых узлов по статусам.
ключ -> (строка)
значение -> (целое число)
ScheduleExpression -> (строка)
AssociationName -> (строка)
ScheduleOffset -> (целое число)
Duration -> (целое число)
TargetMaps -> (список)
Сопоставление параметров документа с целевыми ресурсами. Оба Targets и TargetMaps не могут быть указаны одновременно.
(массив)
ключ -> (строка)
значение -> (список)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.