describe-custom-key-stores

Описание

Получает информацию о пользовательских хранилищах ключей в аккаунте и регионе.

Данная операция является частью функции пользовательских хранилищ ключей в KMS, которая объединяет удобство и широкую интеграцию KMS с изоляцией и контролем хранилища ключей, которым вы владеете и управляете.

По умолчанию эта операция возвращает информацию обо всех пользовательских хранилищах ключей в аккаунте и регионе. Чтобы получить информацию только об определённом пользовательском хранилище ключей, используйте параметр CustomKeyStoreName или CustomKeyStoreId (но не оба).

Чтобы определить, подключено ли пользовательское хранилище ключей к кластеру CloudHSM или внешнему прокси-серверу хранилища ключей, используйте элемент ConnectionState в ответе. Если попытка подключения пользовательского хранилища ключей завершилась неудачно, значение ConnectionState равно FAILED, и элемент ConnectionErrorCode в ответе указывает причину неудачи. Для помощи в интерпретации ConnectionErrorCode, см. CustomKeyStoresListEntry.

Пользовательские хранилища ключей имеют состояние подключения DISCONNECTED, если хранилище никогда не подключалось или вы использовали операцию DisconnectCustomKeyStore для его отключения. В противном случае, состояние подключения равно CONNECTED. Если состояние подключения вашего пользовательского хранилища ключей равно CONNECTED, но вы испытываете проблемы с его использованием, убедитесь, что хранилище данных активно и доступно. Для хранилища ключей CloudHSM убедитесь, что связанный кластер CloudHSM активен и содержит минимальное количество HSM, требуемое для операции, если таковые имеются. Для внешнего хранилища ключей убедитесь, что внешний прокси-сервер хранилища ключей и связанный с ним внешний менеджер ключей доступны и включены.

Для помощи в устранении неполадок с вашим хранилищем ключей CloudHSM, см. Раздел Устранение неполадок с хранилищами ключей CloudHSM. Для помощи в устранении неполадок с внешним хранилищем ключей, см. Раздел Устранение неполадок с внешними хранилищами ключей. Оба раздела содержатся в руководстве для разработчиков службы управления ключами.

• ConnectCustomKeyStore
• CreateCustomKeyStore
• DeleteCustomKeyStore
• DisconnectCustomKeyStore
• UpdateCustomKeyStore

См. также: AWS API Documentation

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

Синопсис

  describe-custom-key-stores
[--custom-key-store-id <value>]
[--custom-key-store-name <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]

Параметры

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

--custom-key-store-name (строка)

--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
• table
• yaml
• yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить вывод цвета.

• on
• off
• auto

--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.

Примеры

Пример 1: Получение сведений об хранилище ключей AWS CloudHSM

В следующем describe-custom-key-store примере отображаются сведения о заданном хранилище ключей AWS CloudHSM. Команда одинакова для всех типов пользовательских хранилищ ключей, но вывод отличается в зависимости от типа хранилища ключей и, для внешнего хранилища ключей, от его параметра подключения.

По умолчанию эта команда отображает информацию обо всех пользовательских хранилищах ключей в аккаунте и регионе. Чтобы отобразить информацию о конкретном пользовательском хранилище ключей, используйте параметр custom-key-store-name или custom-key-store-id.

aws kms describe-custom-key-stores \
    --custom-key-store-name ExampleCloudHSMKeyStore

Вывод этой команды включает полезные сведения о хранилище ключей AWS CloudHSM, включая состояние подключения (ConnectionState). Если состояние подключения равно FAILED, вывод включает поле ConnectionErrorCode, описывающее проблему.

Вывод:

{
    "CustomKeyStores": [
        {
            "CloudHsmClusterId": "cluster-1a23b4cdefg",
            "ConnectionState": "CONNECTED",
            "CreationDate": "2022-04-05T14:04:55-07:00",
            "CustomKeyStoreId": "cks-1234567890abcdef0",
            "CustomKeyStoreName": "ExampleExternalKeyStore",
            "TrustAnchorCertificate": "<certificate appears here>"
        }
    ]
}

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

Пример 2: Получение сведений об внешнем хранилище ключей с подключением через общедоступный конечный пункт

В следующем describe-custom-key-store примере отображаются сведения о заданном внешнем хранилище ключей. Команда одинакова для всех типов пользовательских хранилищ ключей, но вывод отличается в зависимости от типа хранилища ключей и, для внешнего хранилища ключей, от его параметра подключения.

По умолчанию эта команда отображает информацию обо всех пользовательских хранилищах ключей в аккаунте и регионе. Чтобы отобразить информацию о конкретном пользовательском хранилище ключей, используйте параметр custom-key-store-name или custom-key-store-id.

aws kms describe-custom-key-stores \
    --custom-key-store-id cks-9876543210fedcba9

Вывод этой команды включает полезные сведения об внешнем хранилище ключей, включая состояние подключения (ConnectionState). Если состояние подключения равно FAILED, вывод включает поле ConnectionErrorCode, описывающее проблему.

Вывод:

{
    "CustomKeyStores": [
        {
            "CustomKeyStoreId": "cks-9876543210fedcba9",
            "CustomKeyStoreName": "ExampleXKS",
            "ConnectionState": "CONNECTED",
            "CreationDate": "2022-12-02T07:48:55-07:00",
            "CustomKeyStoreType": "EXTERNAL_KEY_STORE",
            "XksProxyConfiguration": {
                "AccessKeyId": "ABCDE12345670EXAMPLE",
                "Connectivity": "PUBLIC_ENDPOINT",
                "UriEndpoint": "https://myproxy.xks.example.com",
                "UriPath": "/example-prefix/kms/xks/v1"
            }
        }
    ]
}

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

Пример 3: Получение сведений об внешнем хранилище ключей с подключением через сервис VPC конечной точки

В следующем describe-custom-key-store примере отображаются сведения о заданном внешнем хранилище ключей. Команда одинакова для всех типов пользовательских хранилищ ключей, но вывод отличается в зависимости от типа хранилища ключей и, для внешнего хранилища ключей, от его параметра подключения.

По умолчанию эта команда отображает информацию обо всех пользовательских хранилищах ключей в аккаунте и регионе. Чтобы отобразить информацию о конкретном пользовательском хранилище ключей, используйте параметр custom-key-store-name или custom-key-store-id.

aws kms describe-custom-key-stores \
    --custom-key-store-id cks-2234567890abcdef0

Вывод этой команды включает полезные сведения об внешнем хранилище ключей, включая состояние подключения (ConnectionState). Если состояние подключения равно FAILED, вывод включает поле ConnectionErrorCode, описывающее проблему.

Вывод:

{
    "CustomKeyStores": [
        {
            "CustomKeyStoreId": "cks-3234567890abcdef0",
            "CustomKeyStoreName": "ExampleVPCExternalKeyStore",
            "ConnectionState": "CONNECTED",
            "CreationDate": "2022-12-22T07:48:55-07:00",
            "CustomKeyStoreType": "EXTERNAL_KEY_STORE",
            "XksProxyConfiguration": {
                "AccessKeyId": "ABCDE12345670EXAMPLE",
                "Connectivity": "VPC_ENDPOINT_SERVICE",
                "UriEndpoint": "https://myproxy-private.xks.example.com",
                "UriPath": "/kms/xks/v1",
                "VpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-example1"
            }
        }
    ]
}

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

Вывод

CustomKeyStores -> (список)

NextMarker -> (строка)

Усечённый -> (boolean)