Spec-Zone.ru › AWS CLI v2

[ aws . dynamodb ]

list-tags-of-resource

Описание

Список всех тегов ресурса Amazon DynamoDB. Вы можете вызывать ListTagsOfResource до 10 раз в секунду на аккаунт.

Обзор по тегированию ресурсов DynamoDB см. в руководстве Amazon DynamoDB Developer Guide в разделе Тегирование ресурсов DynamoDB.

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

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

Синтаксис

  list-tags-of-resource
--resource-arn <value>
[--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]

Параметры

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

Ресурс Amazon DynamoDB с тегами, которые необходимо перечислить. Это Amazon Resource Name (ARN).

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

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

Маркер для указания, где начать постраничную обработку. Это NextToken из ранее усечённого ответа.

Примеры использования см. в руководстве AWS Command Line Interface User Guide в разделе Постраничная обработка.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в руководстве AWS Command Line Interface User Guide в разделе Постраничная обработка.

--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
  • текст
  • таблица
  • 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-auto-prompt (булево)

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

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

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

Примеры

Примечание

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

Если не указано иное, все примеры используют правила цитирования для Unix. Эти примеры потребуется адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в AWS CLI User Guide.

Пример 1: Перечисление тегов ресурса DynamoDB

Следующий list-tags-of-resource пример отображает теги для таблицы MusicCollection.

aws dynamodb list-tags-of-resource \
    --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection

Вывод:

{
    "Tags": [
        {
            "Key": "Owner",
            "Value": "blueTeam"
        },
        {
            "Key": "Environment",
            "Value": "Production"
        }
    ]
}

Дополнительную информацию см. в руководстве Amazon DynamoDB Developer Guide в разделе Тегирование ресурсов DynamoDB.

Пример 2: Ограничение количества возвращаемых тегов

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

aws dynamodb list-tags-of-resource \
    --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \
    --max-items 1

Вывод:

{
    "Tags": [
        {
            "Key": "Owner",
            "Value": "blueTeam"
        }
    ],
    "NextToken": "abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9"
}

Дополнительную информацию см. в руководстве Amazon DynamoDB Developer Guide в разделе Тегирование ресурсов DynamoDB.

Пример 3: Получение следующей страницы результатов

Следующая команда использует значение NextToken из предыдущего вызова команды list-tags-of-resource для получения другой страницы результатов. Поскольку ответ в данном случае не содержит значения NextToken, мы знаем, что мы достигли конца результатов.

aws dynamodb list-tags-of-resource \
    --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \
    --starting-token abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9

Вывод:

{
    "Tags": [
        {
            "Key": "Environment",
            "Value": "Production"
        }
    ]
}

Дополнительную информацию см. в руководстве Amazon DynamoDB Developer Guide в разделе Тегирование ресурсов DynamoDB.

Вывод

Теги -> (список)

Теги, которые в настоящее время связаны с ресурсом Amazon DynamoDB.

(структура)

Описание тега. Тег — это пара ключ-значение. Вы можете добавить до 50 тегов к одной таблице DynamoDB.

Назначенные Amazon Web Services имена и значения тегов автоматически получают префикс aws:, который пользователь не может назначить. Назначенные Amazon Web Services имена тегов не учитываются при подсчёте лимита в 50 тегов. Установленные пользователем имена тегов имеют префикс user: в отчёте о распределении затрат. Вы не можете перенести применение тега на более ранний период.

Обзор по тегированию ресурсов DynamoDB см. в руководстве Amazon DynamoDB Developer Guide в разделе Тегирование ресурсов DynamoDB.

Ключ -> (строка)

Ключ тега. Ключи тегов чувствительны к регистру. В каждой таблице DynamoDB может быть только по одному тегу с одинаковым ключом. Если вы попытаетесь добавить существующий тег (с тем же ключом), значение существующего тега будет обновлено на новое.

Значение -> (строка)

Значение тега. Значения тегов чувствительны к регистру и могут быть null.

NextToken -> (строка)

Если это значение возвращается, существуют дополнительные результаты, которые необходимо отобразить. Для их получения вызовите ListTagsOfResource снова, установив NextToken в это значение.

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

Spec-Zone.ru

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