Spec-Zone.ru › AWS CLI v2

[ aws . databrew ]

update-dataset

Описание

Изменяет определение существующего набора данных DataBrew.

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

Синтаксис

  update-dataset
--name <value>
[--format <value>]
[--format-options <value>]
--input <value>
[--path-options <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 (строка)

Имя набора данных, который нужно обновить.

--format (строка)

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

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

  • CSV
  • JSON
  • PARQUET
  • EXCEL
  • ORC

--format-options (структура)

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

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

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

MultiLine -> (булево)

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

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

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

SheetNames -> (список)

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

(строка)

SheetIndexes -> (список)

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

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

HeaderRow -> (булево)

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

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

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

Delimiter -> (строка)

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

HeaderRow -> (булево)

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

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

Json={MultiLine=boolean},Excel={SheetNames=[string,string],SheetIndexes=[integer,integer],HeaderRow=boolean},Csv={Delimiter=string,HeaderRow=boolean}

Синтаксис JSON:

{
  "Json": {
    "MultiLine": true|false
  },
  "Excel": {
    "SheetNames": ["string", ...],
    "SheetIndexes": [integer, ...],
    "HeaderRow": true|false
  },
  "Csv": {
    "Delimiter": "string",
    "HeaderRow": true|false
  }
}

--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 -> (строка)

Имя базы данных в каталоге.

TableName -> (строка)

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

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

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

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

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

BucketOwner -> (строка)

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

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

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

GlueConnectionName -> (строка)

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

DatabaseTableName -> (строка)

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

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

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

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

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

BucketOwner -> (строка)

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

QueryString -> (строка)

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

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

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

SourceArn -> (строка)

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

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

S3InputDefinition={Bucket=string,Key=string,BucketOwner=string},DataCatalogInputDefinition={CatalogId=string,DatabaseName=string,TableName=string,TempDirectory={Bucket=string,Key=string,BucketOwner=string}},DatabaseInputDefinition={GlueConnectionName=string,DatabaseTableName=string,TempDirectory={Bucket=string,Key=string,BucketOwner=string},QueryString=string},Metadata={SourceArn=string}

Синтаксис JSON:

{
  "S3InputDefinition": {
    "Bucket": "string",
    "Key": "string",
    "BucketOwner": "string"
  },
  "DataCatalogInputDefinition": {
    "CatalogId": "string",
    "DatabaseName": "string",
    "TableName": "string",
    "TempDirectory": {
      "Bucket": "string",
      "Key": "string",
      "BucketOwner": "string"
    }
  },
  "DatabaseInputDefinition": {
    "GlueConnectionName": "string",
    "DatabaseTableName": "string",
    "TempDirectory": {
      "Bucket": "string",
      "Key": "string",
      "BucketOwner": "string"
    },
    "QueryString": "string"
  },
  "Metadata": {
    "SourceArn": "string"
  }
}

--path-options (структура)

Набор параметров, определяющих, как 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 -> (строка)

Тип параметра набора данных, может быть ‘String’, ‘Number’ или ‘Datetime’.

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

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

Format -> (строка)

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

TimezoneOffset -> (строка)

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

LocaleCode -> (строка)

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

CreateColumn -> (булево)

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

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

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

Expression -> (строка)

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

ValuesMap -> (карта)

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

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

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

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

LastModifiedDateCondition={Expression=string,ValuesMap={KeyName1=string,KeyName2=string}},FilesLimit={MaxFiles=integer,OrderedBy=string,Order=string},Parameters={KeyName1={Name=string,Type=string,DatetimeOptions={Format=string,TimezoneOffset=string,LocaleCode=string},CreateColumn=boolean,Filter={Expression=string,ValuesMap={KeyName1=string,KeyName2=string}}},KeyName2={Name=string,Type=string,DatetimeOptions={Format=string,TimezoneOffset=string,LocaleCode=string},CreateColumn=boolean,Filter={Expression=string,ValuesMap={KeyName1=string,KeyName2=string}}}}

Синтаксис JSON:

{
  "LastModifiedDateCondition": {
    "Expression": "string",
    "ValuesMap": {"string": "string"
      ...}
  },
  "FilesLimit": {
    "MaxFiles": integer,
    "OrderedBy": "LAST_MODIFIED_DATE",
    "Order": "DESCENDING"|"ASCENDING"
  },
  "Parameters": {"string": {
        "Name": "string",
        "Type": "Datetime"|"Number"|"String",
        "DatetimeOptions": {
          "Format": "string",
          "TimezoneOffset": "string",
          "LocaleCode": "string"
        },
        "CreateColumn": true|false,
        "Filter": {
          "Expression": "string",
          "ValuesMap": {"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 (boolean)

Включить отладку.

--endpoint-url (string)

Переопределить стандартный URL команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один запрос для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла с учетными данными.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

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

Отключить кли-пагинатор для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

Имя -> (строка)

Имя набора данных, который был обновлён.

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

Spec-Zone.ru

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