Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

list-subscriptions

Описание

Отображает подписки в Amazon DataZone.

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

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

Синтаксис

  list-subscriptions
[--approver-project-id <value>]
--domain-identifier <value>
[--owning-project-id <value>]
[--sort-by <value>]
[--sort-order <value>]
[--status <value>]
[--subscribed-listing-id <value>]
[--subscription-request-identifier <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]

Параметры

--approver-project-id (строка)

Идентификатор проекта для одобрителя подписки.

--domain-identifier (строка)

Идентификатор домена Amazon DataZone.

--owning-project-id (строка)

Идентификатор владеющего проекта.

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

Указывает способ сортировки результатов этого действия.

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

  • CREATED_AT
  • UPDATED_AT

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

Указывает порядок сортировки результатов этого действия.

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

  • ASCENDING
  • DESCENDING

--status (строка)

Статус подписок, которые вы хотите отобразить.

Примечание

Это не обязательный параметр, но если он не предоставлен, по умолчанию Amazon DataZone возвращает только APPROVED подписки.

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

  • APPROVED
  • REVOKED
  • CANCELLED

--subscribed-listing-id (строка)

Идентификатор подписки для отображения подписок.

--subscription-request-identifier (строка)

Идентификатор запроса на подписку для отображения подписок.

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

Вывод

items -> (список)

Результаты действия ListSubscriptions.

(структура)

Подробности подписки.

createdAt -> (метка времени)

Метка времени создания подписки.

createdBy -> (строка)

Пользователь Amazon DataZone, создавший подписку.

domainId -> (строка)

Идентификатор домена Amazon DataZone, в котором существует подписка.

id -> (строка)

Идентификатор подписки.

retainPermissions -> (булево)

Включенные в подписку права сохранения.

status -> (строка)

Статус подписки.

subscribedListing -> (структура)

Список, включённый в подписку.

description -> (строка)

Описание опубликованного актива, для которого создано предоставление доступа по подписке.

id -> (строка)

Идентификатор опубликованного актива, для которого создано предоставление доступа по подписке.

item -> (структура с тегами)

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

Примечание

Это структура с тегами. Только один из следующих верхних ключей может быть задан: assetListing, productListing.

assetListing -> (структура)

Актив, для которого создано предоставление доступа по подписке.

assetScope -> (структура)

Область актива для подписки на список активов.

assetId -> (строка)

Идентификатор актива области актива.

errorMessage -> (строка)

Сообщение об ошибке области актива.

filterIds -> (список)

Идентификаторы фильтров области актива.

(строка)

status -> (строка)

Статус области актива.

entityId -> (строка)

Идентификатор опубликованного актива, для которого создано предоставление доступа по подписке.

entityRevision -> (строка)

Ревизия опубликованного актива, для которого создано предоставление доступа по подписке.

entityType -> (строка)

Тип опубликованного актива, для которого создано предоставление доступа по подписке.

forms -> (строка)

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

glossaryTerms -> (список)

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

(структура)

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

name -> (строка)

Имя словаря терминов, присоединённого к активу инвентаризации.

shortDescription -> (строка)

Краткое описание словаря терминов, присоединённого к активу инвентаризации.

productListing -> (структура)

Список данных продукта.

assetListings -> (список)

Данные активы списка продукта данных.

(структура)

Список актива в продукте данных.

entityId -> (строка)

Идентификатор сущности списка актива в продукте данных.

entityRevision -> (строка)

Ревизия сущности списка актива в продукте данных.

entityType -> (строка)

Тип сущности списка актива в продукте данных.

description -> (строка)

Описание списка продукта данных.

entityId -> (строка)

Идентификатор списка продукта данных.

entityRevision -> (строка)

Ревизия списка продукта данных.

glossaryTerms -> (список)

Словари терминов списка продукта данных.

(структура)

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

name -> (строка)

Имя словаря терминов, присоединённого к активу инвентаризации.

shortDescription -> (строка)

Краткое описание словаря терминов, присоединённого к активу инвентаризации.

name -> (строка)

Название списка продукта данных.

name -> (строка)

Название опубликованного актива, для которого создано предоставление доступа по подписке.

ownerProjectId -> (строка)

Идентификатор проекта опубликованного актива, для которого создано предоставление доступа по подписке.

ownerProjectName -> (строка)

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

revision -> (строка)

Ревизия опубликованного актива, для которого создано предоставление доступа по подписке.

subscribedPrincipal -> (структура с тегами)

Сущность, включённая в подписку.

Примечание

Это структура с тегами. Только один из следующих верхних ключей может быть задан: project.

project -> (структура)

Проект, обладающий предоставлением доступа по подписке.

id -> (строка)

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

name -> (строка)

Название проекта, обладающего предоставлением доступа по подписке.

subscriptionRequestId -> (строка)

Идентификатор запроса подписки для подписки.

updatedAt -> (метка времени)

Метка времени обновления подписки.

updatedBy -> (строка)

Пользователь Amazon DataZone, обновивший подписку.

nextToken -> (строка)

Если количество подписок больше, чем значение по умолчанию для параметра MaxResults, или если вы явно указали значение для MaxResults, которое меньше количества подписок, в ответ включается токен постраничной навигации под названием NextToken. Вы можете указать это значение NextToken в последующем вызове ListSubscriptions, чтобы отобразить следующий набор подписок.

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

Spec-Zone.ru

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