get-tag-keys

Описание

Возвращает все ключи тегов, используемые в указанном регионе Amazon Web Services для учетной записи, вызывающей этот метод.

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

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

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

Синтаксис

  get-tag-keys
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

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

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

--max-items (целое число)

--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 для вывода.

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

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

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

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

Примеры

Чтобы получить список всех ключей тегов

Следующий пример get-tag-keys извлекает список всех имен ключей тегов, используемых ресурсами в учетной записи.

aws resourcegroupstaggingapi get-tag-keys

Вывод:

{
    "TagKeys": [
        "Environment",
        "CostCenter",
        "Department"
    ]
}

Дополнительную информацию см. в разделе GetTagKeys в Справочнике по API Resource Groups Tagging.

Вывод

PaginationToken -> (строка)

TagKeys -> (список)