Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

describe-hsm-client-certificates

Описание

Возвращает информацию о заданном клиенте HSM-сертификата. Если идентификатор сертификата не указан, возвращает информацию обо всех сертификатах HSM, принадлежащих вашей учетной записи Amazon Web Services.

Если вы укажете и ключи тегов, и значения тегов в одном запросе, Amazon Redshift вернёт все сертификаты клиентов HSM, которые соответствуют любому сочетанию указанных ключей и значений. Например, если у вас есть ключи тегов owner и environment, и значения тегов admin и test, будут возвращены все сертификаты клиентов HSM, имеющие любое сочетание этих значений.

Если оба ключа и значения тегов опущены из запроса, сертификаты клиентов HSM возвращаются независимо от того, связаны ли с ними ключи или значения тегов.

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

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

Синтаксис

  describe-hsm-client-certificates
[--hsm-client-certificate-identifier <value>]
[--tag-keys <value>]
[--tag-values <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]

Параметры

--hsm-client-certificate-identifier (строка)

Идентификатор конкретного HSM-сертификата клиента, для которого вам нужна информация. Если идентификатор не указан, возвращается информация обо всех HSM-сертификатах клиентов, принадлежащих вашей учетной записи Amazon Web Services.

--tag-keys (список)

Ключ или ключи тегов, для которых необходимо вернуть все соответствующие сертификаты клиентов HSM, связанные с указанным ключом или ключами. Например, предположим, что у вас есть HSM-сертификаты клиентов, помеченные ключами, называемыми owner и environment. Если вы укажете оба эти ключа тегов в запросе, Amazon Redshift вернёт ответ с HSM-сертификатами клиентов, у которых ассоциированы те или оба этих ключа тегов.

(строка)

Синтаксис:

"string" "string" ...

--tag-values (список)

Значение или значения тегов, для которых необходимо вернуть все соответствующие сертификаты клиентов HSM, связанные с указанным значением или значениями тегов. Например, предположим, что у вас есть HSM-сертификаты клиентов, помеченные значениями, называемыми admin и test. Если вы укажете оба эти значения тегов в запросе, Amazon Redshift вернёт ответ с HSM-сертификатами клиентов, у которых ассоциированы те или оба этих значения тегов.

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

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

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

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

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

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

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

--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-поток

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

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

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

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

Примеры

Примечание

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

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

Для описания HSM-сертификатов клиентов

Следующий пример describe-hsm-client-certificates отображает детали указанного HSM-сертификата клиента.

aws redshift describe-hsm-client-certificates \
    --hsm-client-certificate-identifier myhsmclientcert

Вывод:

{
    "HsmClientCertificates": [
        {
        "HsmClientCertificateIdentifier": "myhsmclientcert",
        "HsmClientCertificatePublicKey": "-----BEGIN CERTIFICATE-----\
        EXAMPLECAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
        VVMxCzAJBgNVBAEXAMPLERAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
        b24xFDASBgNVBAsTC0lBTSBDb25zEXAMPLEwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
        BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhEXAMPLEDI1MjA0EXAMPLEN
        EXAMPLE0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD
        VQQHEwdTZWF0dGEXAMPLEQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
        b2xlMRIwEAYDVQQDEwlUZXN0Q2lsEXAMPLEdBgkqhkiG9w0BCQEWEG5vb25lQGFt
        YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIEXAMPLEMaK0dn+a4GmWIWJ
        21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
        rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY67EXAMPLEE
        EXAMPLEZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
        nUhVVxYUntneD9EXAMPLE6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
        FFBjvSfpJIlJ00zbhNYS5f6GuoEDEXAMPLEBHjJnyp378OD8uTs7fLvjx79LjSTb
        NYiytVbZPQUQ5Yaxu2jXnimvw3rEXAMPLE=-----END CERTIFICATE-----\n",
        "Tags": []
        }
    ]
}

Дополнительную информацию см. в разделе Разрешения API Amazon Redshift в Руководстве по управлению кластерами Amazon Redshift.

Вывод

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

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

HsmClientCertificates -> (список)

Список идентификаторов одного или нескольких HSM-сертификатов клиентов, используемых кластерами Amazon Redshift для хранения и извлечения ключей шифрования базы данных в HSM.

(структура)

Возвращает информацию об HSM-сертификате клиента. Сертификат хранится в защищённом модуле хранения ключей (HSM) и используется кластером Amazon Redshift для шифрования файлов данных.

HsmClientCertificateIdentifier -> (строка)

Идентификатор HSM-сертификата клиента.

HsmClientCertificatePublicKey -> (строка)

Открытый ключ, который кластер Amazon Redshift будет использовать для подключения к HSM. Вы должны зарегистрировать открытый ключ в HSM.

Теги -> (список)

Список тегов для HSM-сертификата клиента.

(структура)

Тег, состоящий из пары имя/значение для ресурса.

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

Ключ или имя для тега ресурса.

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

Значение для тега ресурса.

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

Spec-Zone.ru

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