Spec-Zone.ru › AWS CLI v2

[ aws . glue ]

create-schema

Описание

Создаёт новый набор схем и регистрирует определение схемы. Возвращает ошибку, если набор схем уже существует, не выполняя при этом фактической регистрации версии.

При создании набора схем контрольная точка версии будет установлена на первую версию. Режим совместимости «ВЫКЛЮЧЕН» ограничивает добавление дополнительных версий схемы после первой версии схемы. Для всех остальных режимов совместимости проверка настроек совместимости будет применяться только с второй версии и далее, когда используется API RegisterSchemaVersion.

Если этот API вызывается без RegistryId, это создаст запись для «default-registry» в таблицах базы данных реестра, если она ещё не существует.

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

Синтаксис

  create-schema
[--registry-id <value>]
--schema-name <value>
--data-format <value>
[--compatibility <value>]
[--description <value>]
[--tags <value>]
[--schema-definition <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]

Параметры

--registry-id (структура)

Это обёртка для хранения идентификационных полей реестра. Если она не указана, будет использован реестр по умолчанию. Формат ARN для него будет: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id.

RegistryName -> (строка)

Имя реестра. Используется только для поиска. Необходимо указать либо RegistryArn, либо RegistryName.

RegistryArn -> (строка)

Arn реестра для обновления. Необходимо указать либо RegistryArn, либо RegistryName.

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

RegistryName=string,RegistryArn=string

Синтаксис JSON:

{
  "RegistryName": "string",
  "RegistryArn": "string"
}

--schema-name (строка)

Имя создаваемой схемы, максимальной длины 255 символов, содержащей только буквы, цифры, дефисы, нижние подчеркивания, знаки доллара или диэзы. Без пробелов.

--data-format (строка)

Формат данных определения схемы. В настоящее время поддерживаются AVRO, JSON и PROTOBUF.

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

  • AVRO
  • JSON
  • PROTOBUF

--compatibility (строка)

Режим совместимости схемы. Возможные значения:

  • NONE : Режим совместимости не применяется. Вы можете использовать этот вариант в сценариях разработки или если вы не знаете режим совместимости, который хотите применить к схемам. Любая новая версия будет принята без проверки совместимости.
  • ВЫКЛЮЧЕН : Этот режим совместимости предотвращает версионирование для конкретной схемы. Вы можете использовать этот вариант, чтобы предотвратить будущее версионирование схемы.
  • НАЗАД : Этот режим совместимости рекомендуется, так как он позволяет получателям данных читать текущую и одну предыдущую версию схемы. Это означает, что, например, новая версия схемы не может удалять поля данных или изменять тип этих полей, поэтому их могут читать читатели, использующие предыдущую версию.
  • ВСЁ_НАЗАД : Этот режим совместимости позволяет получателям данных читать текущую и все предыдущие версии схемы. Вы можете использовать этот вариант, когда вам нужно удалять поля или добавлять необязательные поля и проверять совместимость со всеми предыдущими версиями схемы.
  • ВПЕРЕД : Этот режим совместимости позволяет получателям данных читать текущую и одну следующую версию схемы, но не обязательно более поздние версии. Вы можете использовать этот вариант, когда вам нужно добавлять поля или удалять необязательные поля, но проверять совместимость только с последней версией схемы.
  • ВСЁ_ВПЕРЕД : Этот режим совместимости позволяет получателям данных читать данные, записанные производителями любой новой зарегистрированной схемы. Вы можете использовать этот вариант, когда вам нужно добавлять поля или удалять необязательные поля и проверять совместимость со всеми предыдущими версиями схемы.
  • ПОЛНАЯ : Этот режим совместимости позволяет получателям данных читать данные, записанные производителями, использующими предыдущую или следующую версию схемы, но не обязательно более ранние или более поздние версии. Вы можете использовать этот вариант, когда вам нужно добавлять или удалять необязательные поля, но проверять совместимость только с последней версией схемы.
  • ПОЛНАЯ_ВСЁ : Этот режим совместимости позволяет получателям данных читать данные, записанные производителями, использующими все предыдущие версии схемы. Вы можете использовать этот вариант, когда вам нужно добавлять или удалять необязательные поля и проверять совместимость со всеми предыдущими версиями схемы.

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

  • NONE
  • DISABLED
  • BACKWARD
  • BACKWARD_ALL
  • FORWARD
  • FORWARD_ALL
  • FULL
  • FULL_ALL

--description (строка)

Необязательное описание схемы. Если описание не указано, для этого не будет значения по умолчанию.

--tags (карта)

Теги Amazon Web Services, содержащие пару «ключ-значение», которые можно искать в консоли, командной строке или через API. Если указаны, следуют шаблону тегов Amazon Web Services при создании.

ключ -> (строка)

значение -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--schema-definition (строка)

Определение схемы, использующее DataFormat для SchemaName.

--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.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

RegistryName -> (строка)

Имя реестра.

RegistryArn -> (строка)

Amazon Resource Name (ARN) реестра.

SchemaName -> (строка)

Имя схемы.

SchemaArn -> (строка)

Amazon Resource Name (ARN) схемы.

Description -> (строка)

Описание схемы, если оно было указано при создании.

DataFormat -> (строка)

Формат данных определения схемы. В настоящее время поддерживаются AVRO, JSON и PROTOBUF.

Compatibility -> (строка)

Режим совместимости схемы.

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

Номер версии контрольной точки (последний раз, когда был изменён режим совместимости).

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

Последняя версия схемы, связанная с возвращённым определением схемы.

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

Следующая версия схемы, связанная с возвращённым определением схемы.

SchemaStatus -> (строка)

Статус схемы.

Tags -> (карта)

Теги схемы.

ключ -> (строка)

значение -> (строка)

SchemaVersionId -> (строка)

Уникальный идентификатор первой версии схемы.

SchemaVersionStatus -> (строка)

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

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

Spec-Zone.ru

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