Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

Запрос на подписку

Описание

Создает запрос на подписку в Amazon DataZone.

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

Синтаксис

  create-subscription-request
[--client-token <value>]
--domain-identifier <value>
[--metadata-forms <value>]
--request-reason <value>
--subscribed-listings <value>
--subscribed-principals <value>
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

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

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

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

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

--metadata-forms (список)

Форма метаданных, включенная в запрос на подписку.

(структура)

Подробности формы метаданных.

content -> (строка)

Содержание формы метаданных.

formName -> (строка)

Имя формы метаданных.

typeIdentifier -> (строка)

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

typeRevision -> (строка)

Ревизия типа формы метаданных.

Краткий синтаксис:

content=string,formName=string,typeIdentifier=string,typeRevision=string ...

Синтаксис JSON:

[
  {
    "content": "string",
    "formName": "string",
    "typeIdentifier": "string",
    "typeRevision": "string"
  }
  ...
]

--request-reason (строка)

Причина запроса на подписку.

--subscribed-listings (список)

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

(структура)

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

identifier -> (строка)

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

Краткий синтаксис:

identifier=string ...

Синтаксис JSON:

[
  {
    "identifier": "string"
  }
  ...
]

--subscribed-principals (список)

Принципалы Amazon DataZone, для которых создается запрос на подписку.

(структура сортированного объединения)

Принципал, которому должна быть предоставлена подписка.

Примечание

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

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

Проект, которому должна быть предоставлена подписка.

identifier -> (строка)

Идентификатор проекта, которому должна быть предоставлена подписка.

Краткий синтаксис:

project={identifier=string} ...

Синтаксис JSON:

[
  {
    "project": {
      "identifier": "string"
    }
  }
  ...
]

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

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

createdAt -> (timestamp)

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

createdBy -> (string)

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

decisionComment -> (string)

Комментарий к решению по запросу на подписку.

domainId -> (string)

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

existingSubscriptionId -> (string)

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

id -> (string)

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

metadataForms -> (list)

Форма метаданных, включенная в запрос на подписку.

(структура)

Детали формы метаданных.

content -> (string)

Содержимое формы метаданных.

formName -> (string)

Имя формы метаданных.

typeName -> (string)

Имя типа формы метаданных.

typeRevision -> (string)

Ревизия типа формы метаданных.

requestReason -> (string)

Причина запроса на подписку.

reviewerId -> (string)

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

status -> (string)

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

subscribedListings -> (list)

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

(структура)

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

description -> (string)

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

id -> (string)

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

item -> (tagged union structure)

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

Примечание

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

assetListing -> (structure)

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

assetScope -> (structure)

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

assetId -> (string)

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

errorMessage -> (string)

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

filterIds -> (list)

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

(string)

status -> (string)

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

entityId -> (string)

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

entityRevision -> (string)

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

entityType -> (string)

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

forms -> (string)

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

glossaryTerms -> (list)

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

(структура)

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

name -> (string)

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

shortDescription -> (string)

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

productListing -> (structure)

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

assetListings -> (list)

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

(структура)

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

entityId -> (string)

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

entityRevision -> (string)

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

entityType -> (string)

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

description -> (string)

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

entityId -> (string)

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

entityRevision -> (string)

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

glossaryTerms -> (list)

Термины глоссария списка продукта данных.

(структура)

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

name -> (string)

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

shortDescription -> (string)

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

name -> (string)

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

name -> (string)

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

ownerProjectId -> (string)

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

ownerProjectName -> (string)

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

revision -> (string)

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

subscribedPrincipals -> (list)

Подписавшиеся принципы запроса на подписку.

(tagged union structure)

Принцип, имеющий грант подписки на актив.

Примечание

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

project -> (structure)

Проект, имеющий грант подписки.

id -> (string)

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

name -> (string)

Имя проекта, имеющего грант подписки.

updatedAt -> (timestamp)

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

updatedBy -> (string)

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

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

Spec-Zone.ru

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