Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

получение-метаданных-источника-данных

Описание

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

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

Синтаксис

  get-data-source-introspection
--introspection-id <value>
[--include-models-sdl | --no-include-models-sdl]
[--next-token <value>]
[--max-results <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]

Параметры

--introspection-id (строка)

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

--include-models-sdl | --no-include-models-sdl (булево)

Флаг булевого типа, определяющий, следует ли генерировать SDL для интроспективных типов. Если установлено значение true , каждый модель будет содержать свойство sdl, содержащее SDL для этого типа. SDL содержит только данные о типе и не содержит дополнительной метаданных или директив.

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

Определяет количество типов, которые будут возвращены в одном ответе перед пагинацией. Это значение обычно берется из значения nextToken из предыдущего ответа.

--max-results (целое число)

Максимальное количество интроспективных типов, которые будут возвращены в одном ответе.

--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
  • текст
  • таблица
  • 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 (булево)

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

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

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

Вывод

introspectionId -> (строка)

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

introspectionStatus -> (строка)

Состояние интроспекции во время получения. По умолчанию, когда извлекается новая интроспекция, состояние устанавливается в значение PROCESSING. После завершения операции состояние изменяется на SUCCESS или FAILED в зависимости от того, как были обработаны данные. Операция FAILED вернет ошибку и ее детали как introspectionStatusDetail.

introspectionStatusDetail -> (строка)

Поле детализации ошибки. При возвращении ошибки FAILED introspectionStatus, также возвращается точная ошибка, возникшая во время операции.

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

Данные объекта DataSourceIntrospectionResult.

models -> (список)

Массив объектов DataSourceIntrospectionModel.

(структура)

Содержит интроспективные данные, извлеченные из источника данных.

name -> (строка)

Имя модели. Например, это может быть имя одной таблицы в базе данных.

fields -> (список)

Данные объекта DataSourceIntrospectionModelField.

(структура)

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

name -> (строка)

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

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

Данные объекта DataSourceIntrospectionModelFieldType.

kind -> (строка)

Определяет классификацию данных. Например, это может быть установлено на значения, подобные Scalar или NonNull, чтобы указать фундаментальное свойство поля.

Допустимые значения:

  • Scalar : Указывает, что значение является примитивным типом (скаляр).
  • NonNull : Указывает, что поле не может быть null.
  • List : Указывает, что поле содержит список.

name -> (строка)

Имя типа данных, представляющего поле. Например, String является допустимым значением name.

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

Данные объекта DataSourceIntrospectionModelFieldType. Объект type присутствует только если DataSourceIntrospectionModelFieldType.kind установлено в значение NonNull или List.

Объект type обычно содержит свои поля kind и name для представления фактических данных типа. Например, type может содержать значение kind со значением name. Значения Scalar и String будут совместно храниться в поле values.

kind -> (строка)

Определяет классификацию данных. Например, это может быть установлено на значения, подобные Scalar или NonNull, чтобы указать фундаментальное свойство поля.

Допустимые значения:

  • Scalar : Указывает, что значение является примитивным типом (скаляр).
  • NonNull : Указывает, что поле не может быть null.
  • List : Указывает, что поле содержит список.

name -> (строка)

Имя типа данных, представляющего поле. Например, String является допустимым значением name.

( … рекурсивно … )values -> (список)

Значения поля type. Это поле представляет эквивалент типа данных AppSync интроспективного поля.

(строка)

values -> (список)

Значения поля type. Это поле представляет эквивалент типа данных AppSync интроспективного поля.

(строка)

length -> (длинное целое)

Значение длины интроспективного поля.

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

Первичный ключ, хранящийся как объект DataSourceIntrospectionModelIndex.

name -> (строка)

Имя индекса.

fields -> (список)

Поля индекса.

(строка)

indexes -> (список)

Массив объектов DataSourceIntrospectionModelIndex.

(структура)

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

name -> (строка)

Имя индекса.

fields -> (список)

Поля индекса.

(строка)

sdl -> (строка)

Содержит вывод SDL, сгенерированный из интроспективных типов. Это контролируется параметром includeModelsSDL операции GetDataSourceIntrospection.

nextToken -> (строка)

Определяет количество типов, которые будут возвращены в одном ответе перед пагинацией. Это значение обычно берется из значения nextToken из предыдущего ответа.

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

Spec-Zone.ru

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