Spec-Zone.ru › AWS CLI v2

[ aws . supplychain ]

list-data-lake-datasets

Описание

Позволяет программно просматривать список наборов данных Amazon Web Services Supply Chain озера данных. Разработчики могут просматривать наборы данных и соответствующую информацию, такую как пространство имён, схема и так далее, для заданного идентификатора экземпляра и пространства имён.

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

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

Синтаксис

  list-data-lake-datasets
--instance-id <value>
--namespace <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]

Параметры

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

Идентификатор экземпляра Amazon Web Services Supply Chain.

--namespace (строка)

Пространство имён набора данных, помимо настраиваемого пространства имён, каждый экземпляр поставляется со следующими предопределёнными пространствами имён:

  • asc — Для получения информации о поддерживаемых наборах данных Amazon Web Services Supply Chain, см. https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html .
  • default — Для наборов данных с настраиваемыми схемами пользователей.

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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 (булево)

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

Вывод

datasets -> (список)

Список полученных подробностей набора данных.

(структура)

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

instanceId -> (строка)

Идентификатор экземпляра Amazon Web Services Supply Chain.

namespace -> (строка)

Пространство имён набора данных, помимо настраиваемого пространства имён, каждый экземпляр поставляется со следующими предопределёнными пространствами имён:

  • asc — Для получения информации о поддерживаемых наборах данных Amazon Web Services Supply Chain, см. https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html .
  • default — Для наборов данных с настраиваемыми схемами пользователей.

name -> (строка)

Имя набора данных. Для пространства имён asc имя должно быть одним из поддерживаемых сущностей данных по адресу https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html .

arn -> (строка)

Arn набора данных.

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

Схема набора данных.

name -> (строка)

Имя схемы набора данных.

fields -> (список)

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

(структура)

Подробности поля набора данных.

name -> (строка)

Имя поля набора данных.

type -> (строка)

Тип поля набора данных.

isRequired -> (булево)

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

primaryKeys -> (список)

Список полей первичного ключа для набора данных. Определённые первичные ключи могут помочь методам загрузки данных обеспечить уникальность данных: стратегия устранения дубликатов CreateDataIntegrationFlow будет использовать первичные ключи для выполнения дедупликации записей перед записью в набор данных; SendDataIntegrationEvent’s UPSERT и DELETE могут работать только с набором данных с первичными ключами. Для получения более подробной информации см. эти документы по загрузке данных.

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

(структура)

Подробности поля первичного ключа.

name -> (строка)

Имя поля первичного ключа.

description -> (строка)

Описание набора данных.

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

Спецификация разбиения для набора данных.

fields -> (список)

Поля, на которых нужно разделить набор данных. Разбиение будет применяться иерархически в соответствии с порядком этого списка.

(структура)

Подробности поля разбиения.

name -> (строка)

Имя поля разбиения.

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

Преобразование поля разбиения. Преобразование указывает, как разделить на основе данного поля. Например, со временем можно указать, что вы хотите разделить поля по дням, например, запись данных со значением 2025-01-03T00:00:00Z в поле разбиения находится в разбиении 2025-01-03. Также обратите внимание, что запись данных без значения в необязательном поле разбиения находится в разделе NULL.

type -> (строка)

Тип преобразования разбиения для этого поля. Доступные варианты:

  • IDENTITY — Разделение данных по данному полю по его точным значениям.
  • YEAR — Разделение данных по полю времени с использованием годовой детализации.
  • MONTH — Разделение данных по полю времени с использованием месячной детализации.
  • DAY — Разделение данных по полю времени с использованием дневной детализации.
  • HOUR — Разделение данных по полю времени с использованием часовой детализации.

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

Время создания набора данных.

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

Время последнего изменения набора данных.

nextToken -> (строка)

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

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

Spec-Zone.ru

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