Spec-Zone.ru › AWS CLI v2

[ aws . supplychain ]

создать-озеро-данных-набор-данных

Описание

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

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

Синтаксис

  create-data-lake-dataset
--instance-id <value>
--namespace <value>
--name <value>
[--schema <value>]
[--description <value>]
[--partition-spec <value>]
[--tags <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]

Параметры

--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 - Для наборов данных с настраиваемыми схемами пользователей.

--name (строка)

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

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

Настраиваемая схема набора данных озера данных и необходимая для наборов данных в пространствах имён default и пользовательских.

name -> (строка)

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

fields -> (список)

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

(структура)

Подробные данные поля набора данных.

name -> (строка)

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

type -> (строка)

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

isRequired -> (булево)

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

primaryKeys -> (список)

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

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

(структура)

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

name -> (строка)

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

Краткая форма записи:

name=string,fields=[{name=string,type=string,isRequired=boolean},{name=string,type=string,isRequired=boolean}],primaryKeys=[{name=string},{name=string}]

Синтаксис JSON:

{
  "name": "string",
  "fields": [
    {
      "name": "string",
      "type": "INT"|"DOUBLE"|"STRING"|"TIMESTAMP"|"LONG",
      "isRequired": true|false
    }
    ...
  ],
  "primaryKeys": [
    {
      "name": "string"
    }
    ...
  ]
}

--description (строка)

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

--partition-spec (структура)

Спецификация разбиения набора данных. Разбиение на группы может эффективно улучшить производительность запроса к набору данных, уменьшая количество сканируемых данных во время выполнения запроса. Но разбиение на группы или нет повлияет на то, как данные будут импортированы методами извлечения данных, такими как UPSERT набора данных SendDataIntegrationEvent, который будет выполнять upsert записей в группе (вместо всего набора данных). Для получения более подробной информации см. эти документы по извлечению данных.

fields -> (список)

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

(структура)

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

name -> (строка)

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

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

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

type -> (строка)

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

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

Синтаксис JSON:

{
  "fields": [
    {
      "name": "string",
      "transform": {
        "type": "YEAR"|"MONTH"|"DAY"|"HOUR"|"IDENTITY"
      }
    }
    ...
  ]
}

--tags (массив)

Теги набора данных.

key -> (строка)

value -> (строка)

Краткая форма записи:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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
  • таблица
  • 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 (булево)

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

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

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

Вывод

набор данных -> (структура)

Подробная информация о созданном наборе данных.

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 будет использовать первичные ключи для выполнения удаления дубликатов записей перед записью в набор данных; UPSERT и DELETE SendDataIntegrationEvent могут работать только с набором данных с первичными ключами. Более подробную информацию см. в документации по загрузке данных.

Обратите внимание, что определение первичных ключей не обязательно означает, что в наборе данных не может быть дублирующих записей. Дублирующиеся записи всё ещё могут быть загружены, если стратегия устранения дубликатов 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 -> (временная метка)

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

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

Spec-Zone.ru

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