Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

search-types

Описание

Поиск типов в Amazon DataZone.

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

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

Синтаксис

  search-types
--domain-identifier <value>
[--filters <value>]
--managed | --no-managed
[--search-in <value>]
--search-scope <value>
[--search-text <value>]
[--sort <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]

Параметры

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

Идентификатор домена Amazon DataZone, в котором необходимо вызвать действие SearchTypes.

--filters (меченная структура объединения)

Фильтры для действия SearchTypes.

Примечание

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

and -> (список)

Оператор поиска «and» в Amazon DataZone.

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

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

Примечание

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

and -> (список)

Оператор поиска «and» в Amazon DataZone.

( … рекурсивно … )

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

Фильтр поиска в Amazon DataZone.

attribute -> (строка)

Атрибут фильтра поиска в Amazon DataZone.

value -> (строка)

Значение фильтра поиска в Amazon DataZone.

or -> (список)

Оператор поиска «or» в Amazon DataZone.

( … рекурсивно … )

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

Фильтр поиска в Amazon DataZone.

attribute -> (строка)

Атрибут фильтра поиска в Amazon DataZone.

value -> (строка)

Значение фильтра поиска в Amazon DataZone.

or -> (список)

Оператор поиска «or» в Amazon DataZone.

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

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

Примечание

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

and -> (список)

Оператор поиска «and» в Amazon DataZone.

( … рекурсивно … )

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

Фильтр поиска в Amazon DataZone.

attribute -> (строка)

Атрибут фильтра поиска в Amazon DataZone.

value -> (строка)

Значение фильтра поиска в Amazon DataZone.

or -> (список)

Оператор поиска «or» в Amazon DataZone.

( … рекурсивно … )

Синтаксис JSON:

{
  "and": [
    {
      "and": [
        { ... recursive ... }
        ...
      ],
      "filter": {
        "attribute": "string",
        "value": "string"
      },
      "or": [
        { ... recursive ... }
        ...
      ]
    }
    ...
  ],
  "filter": {
    "attribute": "string",
    "value": "string"
  },
  "or": [
    {
      "and": [
        { ... recursive ... }
        ...
      ],
      "filter": {
        "attribute": "string",
        "value": "string"
      },
      "or": [
        { ... recursive ... }
        ...
      ]
    }
    ...
  ]
}

--managed | --no-managed (булево)

Указывает, управляемый ли поиск.

--search-in (список)

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

(структура)

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

attribute -> (строка)

Атрибут поиска.

Сокращённый синтаксис:

attribute=string ...

Синтаксис JSON:

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

--search-scope (строка)

Указывает область поиска типов.

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

  • ASSET_TYPE
  • FORM_TYPE
  • LINEAGE_NODE_TYPE

--search-text (строка)

Указывает текст для поиска.

--sort (структура)

Указывает способ сортировки результатов SearchTypes.

attribute -> (строка)

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

order -> (строка)

Детали порядка для сортировки результатов поиска.

Сокращённый синтаксис:

attribute=string,order=string

Синтаксис JSON:

{
  "attribute": "string",
  "order": "ASCENDING"|"DESCENDING"
}

--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
  • текст
  • таблица
  • 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 для вывода.

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

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

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

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

Вывод

items -> (список)

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

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

Подробности результатов действия SearchTypes.

Примечание

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

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

Тип актива, включённый в результаты действия SearchTypes.

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

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

createdBy -> (строка)

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

description -> (строка)

Описание типа актива.

domainId -> (строка)

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

formsOutput -> (отображение)

Формы, включённые в подробности типа актива.

key -> (строка)

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

Подробности записи формы.

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

Указывает, требуется ли запись формы.

typeName -> (строка)

Имя типа записи формы.

typeRevision -> (строка)

Ревизия типа записи формы.

name -> (строка)

Имя типа актива.

originDomainId -> (строка)

Идентификатор домена Amazon DataZone, в котором тип актива был первоначально создан.

originProjectId -> (строка)

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

owningProjectId -> (строка)

Идентификатор проекта Amazon DataZone, который владеет типом актива.

revision -> (строка)

Ревизия типа актива.

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

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

updatedBy -> (строка)

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

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

Тип формы, включённый в результаты действия SearchTypes.

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

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

createdBy -> (строка)

Пользователь Amazon DataZone, который создал тип формы метаданных.

description -> (строка)

Описание типа формы метаданных.

domainId -> (строка)

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

imports -> (список)

Импорты, указанные в типе формы.

(структура)

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

name -> (строка)

Имя импорта.

revision -> (строка)

Ревизия импорта.

model -> (структура помеченного объединения)

Модель типа формы.

Примечание

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

smithy -> (строка)

Указывает модель smithy API.

name -> (строка)

Имя типа формы.

originDomainId -> (строка)

Идентификатор домена Amazon DataZone, в котором тип формы был первоначально создан.

originProjectId -> (строка)

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

owningProjectId -> (строка)

Идентификатор проекта, который владеет типом формы.

revision -> (строка)

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

status -> (строка)

Статус типа формы.

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

Подробности типа узла родословной данных.

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

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

createdBy -> (строка)

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

description -> (строка)

Описание типа узла родословной данных.

domainId -> (строка)

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

formsOutput -> (отображение)

Вывод форм типа узла родословной данных.

key -> (строка)

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

Подробности записи формы.

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

Указывает, требуется ли запись формы.

typeName -> (строка)

Имя типа записи формы.

typeRevision -> (строка)

Ревизия типа записи формы.

name -> (строка)

Имя типа узла родословной данных.

revision -> (строка)

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

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

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

updatedBy -> (строка)

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

nextToken -> (строка)

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

totalMatchCount -> (целое число)

Общее количество результатов поиска.

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

Spec-Zone.ru

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