Spec-Zone.ru › AWS CLI v2

[ aws . secretsmanager ]

list-secret-version-ids

Описание

Отображает версии секрета. Secrets Manager использует метки этапов для обозначения различных версий секрета. Дополнительную информацию см. в разделе Понятия Secrets Manager: Версии .

Чтобы отобразить секреты в аккаунте, используйте ListSecrets .

Secrets Manager генерирует запись журнала CloudTrail при вызове этого действия. Не включайте конфиденциальную информацию в параметры запроса, так как она может быть залогирована. Дополнительную информацию см. в разделе Ведение журнала событий Secrets Manager с помощью CloudTrail .

Требуемые разрешения: secretsmanager:ListSecretVersionIds . Дополнительную информацию см. в разделе Действия политики IAM для Secrets Manager и Аутентификация и управление доступом в Secrets Manager .

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

Синтаксис

  list-secret-version-ids
--secret-id <value>
[--max-results <value>]
[--next-token <value>]
[--include-deprecated | --no-include-deprecated]
[--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]

Параметры

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

ARN или имя секрета, версии которого вы хотите отобразить.

Для ARN рекомендуется указать полный ARN, а не частичный. См. Нахождение секрета по частичному ARN .

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

Количество результатов, которые следует включить в ответ.

Если доступно больше результатов, в ответе Secrets Manager включает NextToken . Чтобы получить следующие результаты, снова вызовите ListSecretVersionIds со значением из NextToken .

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

Маркер, указывающий, с какой точки следует продолжить вывод, если предыдущий вызов не показал все результаты. Чтобы получить следующие результаты, снова вызовите ListSecretVersionIds с этим значением.

--include-deprecated | --no-include-deprecated (логическое значение)

Указывает, нужно ли включать версии секретов, к которым не прикреплены метки этапов. Версии без меток этапов считаются устаревшими и могут быть удалены Secrets Manager. По умолчанию версии без меток этапов не включаются.

--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
  • текст
  • таблица
  • 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-secret-version-ids пример получает список всех версий секрета.

aws secretsmanager list-secret-version-ids \
    --secret-id MyTestSecret

Вывод:

{
  "Versions": [
    {
        "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "VersionStages": [
            "AWSPREVIOUS"
        ],
        "LastAccessedDate": 1523477145.713,
        "CreatedDate": 1523477145.713
    },
    {
        "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "VersionStages": [
            "AWSCURRENT"
        ],
        "LastAccessedDate": 1523477145.713,
        "CreatedDate": 1523486221.391
    },
    {
        "CreatedDate": 1.51197446236E9,
        "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333;"
    }
    ],
    "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3",
    "Name": "MyTestSecret"
}

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

Вывод

Versions -> (список)

Список версий секрета.

(структура)

Структура, содержащая информацию об одной версии секрета.

VersionId -> (строка)

Уникальный идентификатор версии этого секрета.

VersionStages -> (список)

Массив меток этапов, которые в данный момент связаны с этой версией секрета.

(строка)

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

Дата последнего доступа к этой версии секрета. Обратите внимание, что разрешение этого поля — на уровне даты, и оно не включает время.

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

Дата и время создания этой версии секрета.

KmsKeyIds -> (список)

Ключи KMS, используемые для шифрования версии секрета.

(строка)

NextToken -> (строка)

Secrets Manager включает это значение, если доступно больше вывода, чем включено в текущий ответ. Это может произойти даже тогда, когда ответ не включает никаких значений, например, при запросе отфильтрованного представления длинного списка. Чтобы получить следующие результаты, снова вызовите ListSecretVersionIds с этим значением.

ARN -> (строка)

ARN секрета.

Name -> (строка)

Имя секрета.

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

Spec-Zone.ru

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