list-aliases

Описание

Получает список псевдонимов в учетной записи Amazon Web Services и регионе вызывающего пользователя. Для получения дополнительной информации о псевдонимах, см. CreateAlias.

По умолчанию операция ListAliases возвращает все псевдонимы в учетной записи и регионе. Чтобы получить только псевдонимы, связанные с определенным ключом KMS, используйте параметр KeyId.

Ответ ListAliases может содержать псевдонимы, которые вы создали и связали с вашими управляемыми клиентом ключами, а также псевдонимы, созданные Amazon Web Services и связанные с управляемыми Amazon Web Services ключами в вашей учетной записи. Вы можете распознать псевдонимы Amazon Web Services по их именам, имеющим формат aws/<service-name>, например, aws/dynamodb.

Ответ также может содержать псевдонимы, у которых отсутствует поле TargetKeyId. Это предопределённые псевдонимы, созданные Amazon Web Services, но ещё не связанные с ключом KMS. Псевдонимы, создаваемые Amazon Web Services в вашей учетной записи, включая предопределенные псевдонимы, не учитываются при подсчете квоты псевдонимов KMS.

Для получения подробностей, см. Управление доступом к псевдонимам в Руководстве разработчика Key Management Service.

• CreateAlias
• DeleteAlias
• UpdateAlias

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

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

Синтаксис

  list-aliases
[--key-id <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]

Параметры

--key-id (строка)

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

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

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

--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
• таблица
• yaml
• yaml-stream

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

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

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

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

Примеры

Пример 1: Чтобы получить список всех псевдонимов в учетной записи AWS и регионе

В следующем примере используется команда list-aliases для получения списка всех псевдонимов в регионе по умолчанию учетной записи AWS. Вывод включает псевдонимы, связанные с управляемыми AWS ключами KMS и управляемыми клиентом ключами KMS.

aws kms list-aliases

Вывод:

{
    "Aliases": [
        {
            "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/testKey",
            "AliasName": "alias/testKey",
            "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        {
            "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/FinanceDept",
            "AliasName": "alias/FinanceDept",
            "TargetKeyId": "0987dcba-09fe-87dc-65ba-ab0987654321"
        },
        {
            "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/aws/dynamodb",
            "AliasName": "alias/aws/dynamodb",
            "TargetKeyId": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"
        },
        {
            "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/aws/ebs",
            "AliasName": "alias/aws/ebs",
            "TargetKeyId": "0987ab65-43cd-21ef-09ab-87654321cdef"
        },
        ...
    ]
}

Пример 2: Чтобы получить список всех псевдонимов для определенного ключа KMS

В следующем примере используется команда list-aliases и ее параметр key-id для получения списка всех псевдонимов, связанных с определенным ключом KMS.

Каждый псевдоним связан только с одним ключом KMS, но ключ KMS может иметь несколько псевдонимов. Эта команда очень полезна, так как консоль AWS KMS отображает только один псевдоним для каждого ключа KMS. Чтобы найти все псевдонимы для ключа KMS, необходимо использовать команду list-aliases.

В этом примере используется идентификатор ключа ключа KMS для параметра --key-id, но вы можете использовать идентификатор ключа, ARN ключа, имя псевдонима или ARN псевдонима в этой команде.

aws kms list-aliases --key-id 1234abcd-12ab-34cd-56ef-1234567890ab

Вывод:

{
    "Aliases": [
        {
            "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
            "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/oregon-test-key",
            "AliasName": "alias/oregon-test-key"
        },
        {
            "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
            "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/project121-test",
            "AliasName": "alias/project121-test"
        }
    ]
}

Дополнительную информацию см. в разделе Работа с псевдонимами в Руководстве разработчика AWS Key Management Service.

Вывод

Псевдонимы -> (список)

NextMarker -> (строка)

Truncated -> (булево)