Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

describe-data-shares-for-consumer

Описание

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

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

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

Синтаксис

  describe-data-shares-for-consumer
[--consumer-arn <value>]
[--status <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]

Параметры

--consumer-arn (строка)

Amazon Resource Name (ARN) пространства имен потребителя, возвращаемого в списке совместного доступа к данным.

--status (строка)

Идентификатор, определяющий состояние совместного доступа к данным в кластере потребителя. Если этот параметр указан, Amazon Redshift возвращает список совместного доступа к данным, имеющих указанный статус.

Возможные значения:

  • ACTIVE
  • AVAILABLE

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

Вывод

DataShares -> (список)

Показывает результаты доступных совместных доступов к данным для потребителей.

(структура)

DataShareArn -> (строка)

Amazon Resource Name (ARN) совместного доступа к данным, который должен использовать потребитель.

ProducerArn -> (строка)

Amazon Resource Name (ARN) пространства имен производителя.

AllowPubliclyAccessibleConsumers -> (логическое значение)

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

DataShareAssociations -> (список)

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

(структура)

Ассоциация совместного доступа к данным от учетной записи производителя с потребителем данных.

ConsumerIdentifier -> (строка)

Имя учетных записей потребителей, имеющих ассоциацию со совместным доступом к данным производителя.

Status -> (строка)

Статус совместного доступа к данным, который связан.

ConsumerRegion -> (строка)

Регион Amazon Web Services учетных записей потребителей, имеющих ассоциацию со совместным доступом к данным производителя.

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

Дата создания совместного доступа к данным, который связан.

StatusChangeDate -> (временная метка)

Дата изменения статуса совместного доступа к данным, который связан.

ProducerAllowedWrites -> (логическое значение)

Указывает, были ли разрешены операции записи во время авторизации совместного доступа к данным.

ConsumerAcceptedWrites -> (логическое значение)

Указывает, были ли разрешены операции записи во время ассоциации совместного доступа к данным.

ManagedBy -> (строка)

Идентификатор совместного доступа к данным для отображения управляющего субъекта.

DataShareType -> (строка)

Тип совместного доступа к данным, созданного функцией RegisterNamespace.

Marker -> (строка)

Необязательный параметр, определяющий стартовую точку для возврата набора записей ответа. Когда результаты запроса DescribeDataSharesForConsumer превышают значение, указанное в MaxRecords, Amazon Web Services возвращает значение в поле Marker ответа. Вы можете получить следующий набор записей ответа, указав возвращённое значение маркера в параметре Marker и повторив запрос.

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

Spec-Zone.ru

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