Spec-Zone.ru › AWS CLI v2

[ aws . resource-groups ]

list-tag-sync-tasks

Описание

Возвращает список задач синхронизации тегов.

Минимальные разрешения

Для выполнения этой команды вам необходимо иметь следующие разрешения:

  • resource-groups:ListTagSyncTasks с группой, указанной в фильтрах, в качестве ресурса или * при отсутствии фильтров

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

list-tag-sync-tasks — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько API-вызовов. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом аргумент --query должен извлекать данные из результатов следующих выражений запроса: TagSyncTasks

Синтаксис

  list-tag-sync-tasks
[--filters <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]

Параметры

--filters (список)

Amazon Resource Name (ARN) или имя группы приложений, для которой вы хотите получить список задач синхронизации тегов.

(структура)

Возвращает задачи синхронизации тегов, отфильтрованные по Amazon Resource Name (ARN) или имени указанной группы приложений.

GroupArn -> (строка)

Amazon Resource Name (ARN) группы приложений.

GroupName -> (строка)

Имя группы приложений.

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

GroupArn=string,GroupName=string ...

Синтаксис JSON:

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

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Токен для указания, с какой точки начать постраничный вывод. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.

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

Вывод

TagSyncTasks -> (список)

Список задач синхронизации тегов и информация о каждой задаче.

(структура)

Идентификатор ресурса Amazon (ARN) задачи синхронизации тегов.

GroupArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы приложений.

GroupName -> (строка)

Имя группы приложений.

TaskArn -> (строка)

Идентификатор ресурса Amazon (ARN) задачи синхронизации тегов.

TagKey -> (строка)

Ключ тега.

TagValue -> (строка)

Значение тега.

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

Запрос, который можно использовать для определения группы ресурсов или поиска ресурсов. ResourceQuery указывает и запрос Type и строку Query как объекты JSON. См. раздел примеров для примеров JSON-строк. Для получения дополнительной информации о создании группы ресурсов с помощью запроса к ресурсам, см. Раздел «Создание запросов и групп в группах ресурсов» в руководстве пользователя «Группы ресурсов».

Когда вы объединяете все элементы в одну строку, любые двойные кавычки, вложенные в другую пару двойных кавычек, должны быть экранированы, предваряя вложенную кавычку обратной косой чертой (). Например, полный параметр ResourceQuery должен иметь формат, аналогичный следующему примеру параметра командной строки:

--resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}'

В приведенном примере все символы двойных кавычек в части значения элемента Query должны быть экранированы, потому что само значение окружено двойными кавычками. Для получения дополнительной информации, см. «Обрамление строк» в руководстве пользователя командной строки.

Полный список типов ресурсов, которые можно использовать в массиве значений для ResourceTypeFilters, см. в разделе «Ресурсы, которые можно использовать с группами ресурсов и редактором тегов» в руководстве пользователя «Группы ресурсов». Например:

"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]

Type -> (строка)

Тип запроса, который нужно выполнить. Он может иметь одно из двух значений:

  • *CLOUDFORMATION_STACK_1_0: * Указывает, что вы хотите, чтобы группа содержала члены стека CloudFormation. Query содержит элемент StackIdentifier с идентификатором ресурса Amazon (ARN) для стека CloudFormation.
  • *TAG_FILTERS_1_0: * Указывает, что вы хотите, чтобы группа включала ресурсы, имеющие теги, соответствующие запросу.

Query -> (строка)

Запрос, определяющий группу или поиск. Содержимое зависит от значения элемента Type.

  • ResourceTypeFilters — относится ко всем объектам ResourceQuery в Type. Этот элемент содержит один из следующих двух пунктов:
    • Значение AWS::AllSupported. Это заставляет ResourceQuery соответствовать ресурсам любого типа ресурса, которые также соответствуют запросу.
    • Список (массив JSON) идентификаторов типов ресурсов, ограничивающих запрос только ресурсами указанных типов. Полный список типов ресурсов, которые можно использовать в значении массива для ResourceTypeFilters, см. в разделе «Ресурсы, которые можно использовать с группами ресурсов и редактором тегов» в руководстве пользователя «Группы ресурсов».

Пример: "ResourceTypeFilters": ["AWS::AllSupported"] или "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]

  • TagFilters — применимо только если Type = TAG_FILTERS_1_0. Query содержит JSON-строку, представляющую набор простых фильтров тегов. JSON-строка использует синтаксис, аналогичный операции `` GetResources ``, но использует только поля `` ResourceTypeFilters `` и `` TagFilters ``. Если вы укажете более одного ключа тега, будут возвращены только ресурсы, соответствующие всем ключам тегов и по крайней мере одному значению для каждого указанного ключа тега. Если вы укажете более одного значения для ключа тега, ресурс соответствует фильтру, если у него есть значение ключа тега, соответствующее любому из указанных значений. Например, рассмотрим следующий пример запроса к ресурсам, имеющим два тега, Stage и Version, с двумя значениями каждый: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] Результаты этого запроса к ресурсам могут включать следующие элементы:
    • Экземпляр Amazon EC2, у которого есть следующие два тега: {"Stage":"Deploy"} и {"Version":"2"}
    • Ведро S3, у которого есть следующие два тега: {"Stage":"Test"} и {"Version":"1"}

Однако результаты запроса к ресурсам не будут включать следующие элементы:

  • Экземпляр Amazon EC2, у которого есть только следующий тег: {"Stage":"Deploy"}. У экземпляра нет всех ключей тегов, указанных в фильтре, поэтому он исключается из результатов.
  • База данных RDS, у которой есть следующие два тега: {"Stage":"Archived"} и {"Version":"4"}. У базы данных есть все ключи тегов, но ни один из этих ключей не имеет связанного значения, соответствующего по крайней мере одному из указанных значений в фильтре.

Пример: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }

  • StackIdentifier — применимо только если Type = CLOUDFORMATION_STACK_1_0. Значением этого параметра является идентификатор ресурса Amazon (ARN) стека CloudFormation, ресурсы которого должны быть включены в группу.

RoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли, принятой службой для добавления и удаления тегов ресурсов от вашего имени.

Status -> (строка)

Статус задачи синхронизации тегов.

Допустимые значения включают:

  • ACTIVE — задача синхронизации тегов активно управляет ресурсами в приложении, добавляя или удаляя тег awsApplication из ресурсов при их маркировке или разметке указанной парой ключ-значение тега.
  • ERROR — задача синхронизации тегов не активно управляет ресурсами в приложении. Проверьте ErrorMessage для получения дополнительной информации о решении проблемы.

ErrorMessage -> (строка)

Конкретное сообщение об ошибке в случае, если статус задачи синхронизации тегов Error.

CreatedAt -> (временная метка)

Временная метка создания задачи синхронизации тегов.

NextToken -> (строка)

Если присутствует, указывает, что доступно больше вывода, чем включено в текущем ответе. Используйте это значение в параметре запроса NextToken в последующем вызове операции для получения следующей части вывода. Повторяйте это до тех пор, пока элемент ответа NextToken не вернет значение null.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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