list-secrets

Описание

Перечисляет секреты, хранящиеся в Secrets Manager в учетной записи Amazon Web Services, не включая секреты, помеченные на удаление. Чтобы увидеть секреты, помеченные на удаление, используйте консоль Secrets Manager.

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

Для перечисления версий секрета используйте ListSecretVersionIds.

Для получения значений секретов используйте BatchGetSecretValue или GetSecretValue.

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

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

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

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

Синтаксис

  list-secrets
[--include-planned-deletion | --no-include-planned-deletion]
[--filters <value>]
[--sort-order <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]

Параметры

--include-planned-deletion | --no-include-planned-deletion (boolean)

--filters (список)

Сокращенный синтаксис:

Key=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Key": "description"|"name"|"tag-key"|"tag-value"|"primary-region"|"owning-service"|"all",
    "Values": ["string", ...]
  }
  ...
]

--sort-order (строка)

--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 (boolean)

Включает отладку.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключает автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

• json
• text
• table
• yaml
• yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использует определенный профиль из файла учетных данных.

--region (строка)

Используемая область. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображает версию данного инструмента.

--color (строка)

Включает/выключает цветной вывод.

• on
• off
• auto

--no-sign-request (boolean)

Не подписывает запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл CA-сертификата, используемый при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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 (boolean)

Отключает постраничный вывод CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Пример 1: Перечисление секретов в вашей учетной записи

Следующий list-secrets пример получает список секретов в вашей учетной записи.

aws secretsmanager list-secrets

Вывод:

{
    "SecretList": [
        {
            "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3",
            "Name": "MyTestSecret",
            "LastChangedDate": 1523477145.729,
            "SecretVersionsToStages": {
                "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111": [
                    "AWSCURRENT"
                ]
            }
        },
        {
            "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:AnotherSecret-d4e5f6",
            "Name": "AnotherSecret",
            "LastChangedDate": 1523482025.685,
            "SecretVersionsToStages": {
                "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222": [
                    "AWSCURRENT"
                ]
            }
        }
    ]
}

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

Пример 2: Фильтрация списка секретов в вашей учетной записи

Следующий list-secrets пример получает список секретов в вашей учетной записи, у которых Test в имени. Фильтрация по имени регистрозависима.

aws secretsmanager list-secrets \
    --filter Key="name",Values="Test"

Вывод:

{
    "SecretList": [
        {
            "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3",
            "Name": "MyTestSecret",
            "LastChangedDate": 1523477145.729,
            "SecretVersionsToStages": {
                "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111": [
                    "AWSCURRENT"
                ]
            }
        }
    ]
}

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

Пример 3: Перечисление секретов в вашей учетной записи, управляемых другой службой

Следующий list-secrets пример возвращает секреты в вашей учетной записи, управляемые Amazon RDS.

aws secretsmanager list-secrets \
    --filter Key="owning-service",Values="rds"

Вывод:

{
    "SecretList": [
        {
            "Name": "rds!cluster-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Tags": [
                {
                    "Value": "arn:aws:rds:us-west-2:123456789012:cluster:database-1",
                    "Key": "aws:rds:primaryDBClusterArn"
                },
                {
                    "Value": "rds",
                    "Key": "aws:secretsmanager:owningService"
                }
            ],
            "RotationRules": {
                "AutomaticallyAfterDays": 1
            },
            "LastChangedDate": 1673477781.275,
            "LastRotatedDate": 1673477781.26,
            "SecretVersionsToStages": {
                "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa": [
                    "AWSPREVIOUS"
                ],
                "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb": [
                    "AWSCURRENT",
                    "AWSPENDING"
                ]
            },
            "OwningService": "rds",
            "RotationEnabled": true,
            "CreatedDate": 1673467300.7,
            "LastAccessedDate": 1673395200.0,
            "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:rds!cluster-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111-a1b2c3",
            "Description": "Secret associated with primary RDS DB cluster: arn:aws:rds:us-west-2:123456789012:cluster:database-1"
        }
    ]
}

Дополнительную информацию см. в разделе Секреты, управляемые другими службами в Руководстве пользователя Secrets Manager.

Вывод

Список секретов -> (список)

Следующая страница -> (строка)