Spec-Zone.ru › AWS CLI v2

[ aws . databrew ]

describe-dataset

Описание

Возвращает определение определенного набора данных DataBrew.

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

Синтаксис

  describe-dataset
--name <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]

Параметры

--name (строка)

Имя набора данных, который требуется описать.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку 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.

Вывод

CreatedBy -> (строка)

Идентификатор (имя пользователя) пользователя, создавшего набор данных.

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

Дата и время создания набора данных.

Name -> (строка)

Название набора данных.

Format -> (строка)

Формат файла набора данных, созданного из файла или папки Amazon S3.

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

Представляет набор параметров, определяющих структуру входных данных в формате CSV, Excel или JSON.

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

Параметры, определяющие, как DataBrew интерпретирует входные данные в формате JSON.

MultiLine -> (булево)

Значение, указывающее, содержит ли входной JSON вложенные символы новой строки.

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

Параметры, определяющие, как DataBrew интерпретирует входные данные в формате Excel.

SheetNames -> (список)

Одно или несколько именованных листов в файле Excel, которые будут включены в набор данных.

(строка)

SheetIndexes -> (список)

Один или несколько номеров листов в файле Excel, которые будут включены в набор данных.

(целое число)

HeaderRow -> (булево)

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

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

Параметры, определяющие, как DataBrew интерпретирует входные данные в формате CSV.

Delimiter -> (строка)

Один символ, определяющий разделитель, используемый в файле CSV.

HeaderRow -> (булево)

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

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

Представляет информацию о том, как DataBrew может найти данные в каталоге Glue Data Catalog или Amazon S3.

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

Расположение Amazon S3, где хранятся данные.

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

Уникальное имя объекта в ведре.

BucketOwner -> (строка)

Идентификатор учетной записи Amazon Web Services владельца ведра.

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

Параметры Glue Data Catalog для данных.

CatalogId -> (строка)

Уникальный идентификатор учетной записи Amazon Web Services, содержащей Data Catalog, хранящий данные.

DatabaseName -> (строка)

Имя базы данных в Data Catalog.

TableName -> (строка)

Имя таблицы базы данных в Data Catalog. Эта таблица соответствует набору данных DataBrew.

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

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

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

Уникальное имя объекта в ведре.

BucketOwner -> (строка)

Идентификатор учетной записи Amazon Web Services владельца ведра.

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

Информация о подключении для файлов входных данных набора данных, хранящихся в базе данных.

GlueConnectionName -> (строка)

Glue Connection, хранящий информацию о подключении к целевой базе данных.

DatabaseTableName -> (строка)

Таблица в целевой базе данных.

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

Представляет расположение Amazon S3 (имя ведра, владелец ведра и ключ объекта), где DataBrew может читать входные данные или записывать выходные данные из задачи.

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

Уникальное имя объекта в ведре.

BucketOwner -> (строка)

Идентификатор учетной записи Amazon Web Services владельца ведра.

QueryString -> (строка)

Пользовательский SQL для выполнения запросов к предоставленному подключению Glue. Этот SQL будет использоваться как вход для проектов и задач DataBrew.

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

Содержит дополнительную информацию о ресурсах, необходимую для определенных наборов данных.

SourceArn -> (строка)

Amazon Resource Name (ARN), связанный с набором данных. В настоящее время DataBrew поддерживает только ARN из Amazon AppFlow.

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

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

LastModifiedBy -> (строка)

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

Source -> (строка)

Расположение данных для этого набора данных, Amazon S3 или Glue Data Catalog.

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

Набор параметров, определяющих, как DataBrew интерпретирует путь Amazon S3 к набору данных.

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

Если указано, эта структура определяет диапазон дат для сопоставления объектов Amazon S3 на основе их атрибута LastModifiedDate в Amazon S3.

Expression -> (строка)

Выражение, которое включает имена условий, за которыми следуют переменные подстановки, возможно сгруппированные и объединённые с другими условиями. Например, “(starts_with :prefix1 или starts_with :prefix2) и (ends_with :suffix1 или ends_with :suffix2)”. Переменные подстановки должны начинаться с символа ‘:’.

ValuesMap -> (карта)

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

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

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

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

Если задано, эта структура устанавливает ограничение на количество файлов, которые должны быть выбраны.

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

Количество файлов Amazon S3 для выбора.

OrderedBy -> (строка)

Критерий для сортировки файлов Amazon S3 перед их выбором. По умолчанию используется LAST_MODIFIED_DATE в качестве критерия сортировки. В настоящее время это единственное допустимое значение.

Order -> (строка)

Критерий для сортировки файлов Amazon S3 перед их выбором. По умолчанию используется DESCENDING порядок, т.е. файлы с самой последней датой изменения выбираются первыми. Другое возможное значение – ASCENDING.

Parameters -> (карта)

Структура, которая сопоставляет имена параметров, используемых в пути Amazon S3 набора данных, с их определениями.

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

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

Представляет параметр набора данных, определяющий тип и условия для параметра в пути Amazon S3 набора данных.

Name -> (строка)

Имя параметра, используемого в пути Amazon S3 набора данных.

Type -> (строка)

Тип параметра набора данных, может быть «Строка», «Число» или «Дата и время».

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

Дополнительные параметры, такие как формат и часовой пояс. Необходимы для параметров даты и времени.

Format -> (строка)

Обязательный параметр, определяющий формат даты и времени, используемый для параметра даты в пути Amazon S3. Следует использовать только поддерживаемые спецификаторы и разделители даты и времени, все буквенные символы a-z или A-Z должны быть экранированы одиночными кавычками. Например, “MM.dd.yyyy-‘at’-HH:mm”.

TimezoneOffset -> (строка)

Необязательное значение для смещения часового пояса значения параметра даты и времени в пути Amazon S3. Не следует использовать, если формат для этого параметра включает поля часового пояса. Если смещение не указано, предполагается UTC.

LocaleCode -> (строка)

Необязательное значение для кода региона, отличного от США, необходимое для правильной интерпретации некоторых форматов дат.

CreateColumn -> (булево)

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

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

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

Expression -> (строка)

Выражение, которое включает имена условий, за которыми следуют переменные подстановки, возможно сгруппированные и объединённые с другими условиями. Например, “(starts_with :prefix1 или starts_with :prefix2) и (ends_with :suffix1 или ends_with :suffix2)”. Переменные подстановки должны начинаться с символа ‘:’.

ValuesMap -> (карта)

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

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

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

Tags -> (карта)

Метки метаданных, связанные с этим набором данных.

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

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

ResourceArn -> (строка)

Amazon Resource Name (ARN) набора данных.

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

Spec-Zone.ru

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