Spec-Zone.ru › AWS CLI v2

[ aws . timestream-write ]

create-batch-load-task

Описание

Создаёт новую задачу пакетной загрузки Timestream. Задача пакетной загрузки обрабатывает данные из CSV-источника в расположении S3 и записывает их в таблицу Timestream. Сопоставление источника и целевого объекта определено в задаче пакетной загрузки. Ошибки и события записываются в отчёт по расположению в S3. Для отчёта, если ключ KMS не указан, отчёт будет зашифрован с помощью управляемого ключа S3, когда SSE_S3 является опцией. В противном случае будет выброшено исключение. Для получения дополнительной информации см. Управляемые ключи Amazon Web Services. Применяются квоты на службы. Подробнее см. пример кода .

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

Синтаксис

  create-batch-load-task
[--client-token <value>]
[--data-model-configuration <value>]
--data-source-configuration <value>
--report-configuration <value>
--target-database-name <value>
--target-table-name <value>
[--record-version <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]

Параметры

--client-token (строка)

--data-model-configuration (структура)

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

TimeColumn -> (строка)

Столбец источника, который будет сопоставлен со временем.

TimeUnit -> (строка)

Гранularity временной метки. Указывает, находится ли значение времени во секундах, миллисекундах, наносекундах или в других поддерживаемых значениях. По умолчанию MILLISECONDS .

DimensionMappings -> (список)

Сопоставления источника и целевого объекта для измерений.

(структура)

SourceColumn -> (строка)

DestinationColumn -> (строка)

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

Сопоставления источника и целевого объекта для записей с несколькими измерениями.

TargetMultiMeasureName -> (строка)

MultiMeasureAttributeMappings -> (список)

(структура)

SourceColumn -> (строка)

TargetMultiMeasureAttributeName -> (строка)

MeasureValueType -> (строка)

MixedMeasureMappings -> (список)

Сопоставления источника и целевого объекта для измерений.

(структура)

MeasureName -> (строка)

SourceColumn -> (строка)

TargetMeasureName -> (строка)

MeasureValueType -> (строка)

MultiMeasureAttributeMappings -> (список)

(структура)

SourceColumn -> (строка)

TargetMultiMeasureAttributeName -> (строка)

MeasureValueType -> (строка)

MeasureNameColumn -> (строка)

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

BucketName -> (строка)

ObjectKey -> (строка)

Синтаксис JSON:

{
  "DataModel": {
    "TimeColumn": "string",
    "TimeUnit": "MILLISECONDS"|"SECONDS"|"MICROSECONDS"|"NANOSECONDS",
    "DimensionMappings": [
      {
        "SourceColumn": "string",
        "DestinationColumn": "string"
      }
      ...
    ],
    "MultiMeasureMappings": {
      "TargetMultiMeasureName": "string",
      "MultiMeasureAttributeMappings": [
        {
          "SourceColumn": "string",
          "TargetMultiMeasureAttributeName": "string",
          "MeasureValueType": "DOUBLE"|"BIGINT"|"BOOLEAN"|"VARCHAR"|"TIMESTAMP"
        }
        ...
      ]
    },
    "MixedMeasureMappings": [
      {
        "MeasureName": "string",
        "SourceColumn": "string",
        "TargetMeasureName": "string",
        "MeasureValueType": "DOUBLE"|"BIGINT"|"VARCHAR"|"BOOLEAN"|"TIMESTAMP"|"MULTI",
        "MultiMeasureAttributeMappings": [
          {
            "SourceColumn": "string",
            "TargetMultiMeasureAttributeName": "string",
            "MeasureValueType": "DOUBLE"|"BIGINT"|"BOOLEAN"|"VARCHAR"|"TIMESTAMP"
          }
          ...
        ]
      }
      ...
    ],
    "MeasureNameColumn": "string"
  },
  "DataModelS3Configuration": {
    "BucketName": "string",
    "ObjectKey": "string"
  }
}

--data-source-configuration (структура)

Определяет параметры конфигурации источника данных для задачи пакетной загрузки.

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

Конфигурация расположения S3 для файла, содержащего данные для загрузки.

BucketName -> (строка)

Имя ведра клиента S3.

ObjectKeyPrefix -> (строка)

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

Формат данных, разделенных разделителями, где разделитель столбцов может быть запятой, а разделитель записей — символом новой строки.

ColumnSeparator -> (строка)

Разделитель столбцов может быть запятой (','), вертикальной чертой ('|'), точкой с запятой (';'), табуляцией ('\t') или пробелом (' ').

EscapeChar -> (строка)

Символ экранирования может быть одним из

QuoteChar -> (строка)

Может быть одинарная (') или двойная кавычка (").

NullValue -> (строка)

Может быть пробелом (' ').

TrimWhiteSpace -> (логическое значение)

Указывает на обрезку начальных и конечных пробелов.

DataFormat -> (строка)

В настоящее время это CSV.

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

DataSourceS3Configuration={BucketName=string,ObjectKeyPrefix=string},CsvConfiguration={ColumnSeparator=string,EscapeChar=string,QuoteChar=string,NullValue=string,TrimWhiteSpace=boolean},DataFormat=string

Синтаксис JSON:

{
  "DataSourceS3Configuration": {
    "BucketName": "string",
    "ObjectKeyPrefix": "string"
  },
  "CsvConfiguration": {
    "ColumnSeparator": "string",
    "EscapeChar": "string",
    "QuoteChar": "string",
    "NullValue": "string",
    "TrimWhiteSpace": true|false
  },
  "DataFormat": "CSV"
}

--report-configuration (структура)

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

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

Конфигурация расположения S3 для записи отчётов об ошибках и событий для пакетной загрузки.

BucketName -> (строка)

ObjectKeyPrefix -> (строка)

EncryptionOption -> (строка)

KmsKeyId -> (строка)

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

ReportS3Configuration={BucketName=string,ObjectKeyPrefix=string,EncryptionOption=string,KmsKeyId=string}

Синтаксис JSON:

{
  "ReportS3Configuration": {
    "BucketName": "string",
    "ObjectKeyPrefix": "string",
    "EncryptionOption": "SSE_S3"|"SSE_KMS",
    "KmsKeyId": "string"
  }
}

--target-database-name (строка)

Целевая база данных Timestream для задачи пакетной загрузки.

--target-table-name (строка)

Целевая таблица Timestream для задачи пакетной загрузки.

--record-version (длинное целое число)

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

TaskId -> (строка)

Идентификатор задачи пакетной загрузки.

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

Spec-Zone.ru

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