describe-snapshot-copy-grants
Описание
Возвращает список разрешений на копирование снимков, принадлежащих учетной записи Amazon Web Services в целевом регионе.
Дополнительную информацию о управлении разрешениями на копирование снимков см. в разделе Шифрование базы данных Amazon Redshift в руководстве Amazon Redshift Cluster Management Guide.
См. также: Документация API AWS
describe-snapshot-copy-grants является постраничным запросом. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: SnapshotCopyGrants
Синтаксис
describe-snapshot-copy-grants
[--snapshot-copy-grant-name <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]
Параметры
--snapshot-copy-grant-name (строка)
--tag-keys (список)
Ключ или ключи тега, для которых необходимо вернуть все соответствующие ресурсы, связанные с указанным ключом или ключами. Например, предположим, что у вас есть ресурсы, помеченные ключами owner и environment . Если вы укажете оба эти ключа тегов в запросе, Amazon Redshift вернёт ответ со всеми ресурсами, у которых есть либо тот, либо другой, либо оба тега.
(строка)
Синтаксис:
"string" "string" ...
--tag-values (список)
Значение или значения тега, для которых необходимо вернуть все соответствующие ресурсы, связанные с указанным значением или значениями. Например, предположим, что у вас есть ресурсы, помеченные значениями admin и test . Если вы укажете оба эти значения тегов в запросе, Amazon Redshift вернёт ответ со всеми ресурсами, у которых есть либо тот, либо другой, либо оба значения тегов.
(строка)
Синтаксис:
"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 User Guide.
--page-size (целое число)
Размер каждой страницы для запроса к службе AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов службы AWS, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.
Примеры использования см. в разделе Постраничный вывод в руководстве AWS Command Line Interface User Guide.
--max-items (целое число)
Общее количество элементов, возвращаемых в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно за пределами AWS CLI.
Примеры использования см. в разделе Постраничный вывод в руководстве AWS Command Line Interface User Guide.
--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 User Guide для получения дополнительной информации.
Если не указано иное, все примеры используют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве AWS CLI User Guide.
Для описания разрешений на копирование снимков
В следующем describe-snapshot-copy-grants примере отображаются подробности указанного разрешения на копирование снимка кластера.
aws redshift describe-snapshot-copy-grants \
--snapshot-copy-grant-name mysnapshotcopygrantname
Вывод:
{
"SnapshotCopyGrants": [
{
"SnapshotCopyGrantName": "mysnapshotcopygrantname",
"KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/bPxRfih3yCo8nvbEXAMPLEKEY",
"Tags": []
}
]
}
Дополнительную информацию см. в разделе Шифрование базы данных Amazon Redshift в руководстве Amazon Redshift Cluster Management Guide.
Вывод
Маркер -> (строка)
Необязательный параметр, определяющий точку начала возврата набора записей ответа. Когда результаты запроса DescribeSnapshotCopyGrant превышают значение, указанное в MaxRecords, Amazon Web Services возвращает значение в поле Marker ответа. Вы можете получить следующий набор записей ответа, указав возвращённое значение маркера в параметре Marker и повторив запрос.
Ограничения: вы можете указать либо параметр SnapshotCopyGrantName, либо параметр Marker, но не оба.
SnapshotCopyGrants -> (список)
Список объектов SnapshotCopyGrant.
(структура)
Разрешение на копирование снимка, предоставляющее Amazon Redshift разрешение на шифрование скопированных снимков с указанным зашифрованным симметричным ключом из Amazon Web Services KMS в целевом регионе.
Дополнительную информацию о управлении разрешениями на копирование снимков см. в разделе Шифрование базы данных Amazon Redshift в руководстве Amazon Redshift Cluster Management Guide.
SnapshotCopyGrantName -> (строка)
KmsKeyId -> (строка)
Tags -> (список)
Список экземпляров тегов.
(структура)
Тег, состоящий из пары имя/значение для ресурса.
Key -> (строка)
Value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|