get-tag-sync-task

Описание

Возвращает информацию о заданном задании синхронизации тегов.

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

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

resource-groups:GetTagSyncTask для группы приложений

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

Синтаксис

  get-tag-sync-task
--task-arn <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]

Параметры

--task-arn (строка)

Amazon Resource Name (ARN) задания синхронизации тегов.

--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
table
yaml
yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

on
off
auto

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

GroupArn -> (строка)

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

GroupName -> (строка)

Название группы приложений.

TaskArn -> (строка)

Amazon Resource Name (ARN) задания синхронизации тегов.

TagKey -> (строка)

Ключ тега.

TagValue -> (строка)

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

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

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

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

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

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

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

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

Type -> (строка)

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

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

Query -> (строка)

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

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

Пример: "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 Resource Name (ARN) стека CloudFormation, ресурсы которого необходимо включить в группу.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли, принимаемой группами ресурсов для тегирования и снятия тегов ресурсов от вашего имени.

Дополнительную информацию об этой роли см. в разделе Требуемые разрешения для синхронизации тегов.

Status -> (строка)

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

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

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

ErrorMessage -> (строка)

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

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

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