Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

list-server-certificate-tags

Описание

Перечисляет метки, прикрепленные к указанному серверному сертификату IAM. Возвращаемый список меток сортируется по ключу метки. Дополнительную информацию о метках см. в разделе Метки ресурсов IAM в Руководстве пользователя IAM.

Примечание

Для сертификатов в регионах, поддерживаемых Certificate Manager (ACM), рекомендуется не использовать серверные сертификаты IAM. Вместо этого используйте ACM для подготовки, управления и развертывания серверных сертификатов. Дополнительную информацию о серверных сертификатах IAM см. в разделе Работа с серверными сертификатами в Руководстве пользователя IAM.

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

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

Синтаксис

  list-server-certificate-tags
--server-certificate-name <value>
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <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]

Параметры

--server-certificate-name (строка)

Имя серверного сертификата IAM, метки которого вы хотите просмотреть.

Этот параметр (через шаблон регулярного выражения) допускает строку символов, состоящую из буквенно-цифровых символов верхнего и нижнего регистров без пробелов. Вы также можете включить следующие символы: _+=,.@-

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

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

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

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

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

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

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

--page-size (целое число)

Размер каждой страницы для получения данных в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

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

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

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

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

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

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

Примеры

Примечание

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

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

Чтобы перечислить метки, прикрепленные к серверному сертификату

Следующая команда list-server-certificate-tags извлекает список меток, связанных с указанным серверным сертификатом.

aws iam list-server-certificate-tags \
    --server-certificate-name ExampleCertificate

Вывод:

{
    "Tags": [
        {
            "Key": "DeptID",
            "Value": "123456"
        },
        {
            "Key": "Department",
            "Value": "Accounting"
        }
    ]
}

Дополнительную информацию см. в разделе Метки ресурсов IAM в Руководстве пользователя IAM AWS.

Вывод

Метки -> (список)

Список меток, в настоящее время прикрепленных к серверному сертификату IAM. Каждая метка состоит из имени ключа и связанного значения. Если к указанному ресурсу не прикреплены метки, ответ содержит пустой список.

(структура)

Структура, представляющая пользовательские метаданные, которые можно связать с ресурсом IAM. Дополнительную информацию о метках см. в разделе Метки ресурсов IAM в Руководстве пользователя IAM.

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

Имя ключа, которое можно использовать для поиска или извлечения связанного значения. Например, Department или Cost Center — распространенные варианты.

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

Значение, связанное с этой меткой. Например, метки с именем ключа Department могут иметь значения, такие как Human Resources, Accounting и Support. Метки с именем ключа Cost Center могут иметь значения, состоящие из числа, связанного с различными центрами затрат в вашей компании. Как правило, многие ресурсы имеют метки с одинаковым именем ключа, но с разными значениями.

Примечание

AWS всегда интерпретирует метку Value как строку. Если вам нужно сохранить массив, вы можете сохранить значения, разделенные запятыми, в строке. Однако интерпретировать значение необходимо в вашем коде.

IsTruncated -> (булево)

Флаг, указывающий, есть ли еще элементы для возврата. Если результаты были усечены, вы можете выполнить последующий запрос постраничной обработки, используя параметр запроса Marker, чтобы получить больше элементов. Обратите внимание, что IAM может вернуть меньше, чем MaxItems, элементов, даже когда больше элементов доступно. Рекомендуется проверять IsTruncated после каждого вызова, чтобы убедиться, что вы получаете все результаты.

Маркер -> (строка)

Когда IsTruncated имеет значение true, этот элемент присутствует и содержит значение, которое следует использовать для параметра Marker в последующем запросе постраничной обработки.

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

Spec-Zone.ru

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