Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

create-import-job

Описание

Создаёт задачу импорта для приложения.

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

Синтаксис

  create-import-job
--application-id <value>
--import-job-request <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]

Параметры

--application-id (строка)

Уникальный идентификатор приложения. Этот идентификатор отображается как Идентификатор проекта в консоли Amazon Pinpoint.

--import-job-request (структура)

Указывает параметры задачи, импортирующей определения конечных точек из корзины Amazon Simple Storage Service (Amazon S3).

DefineSegment -> (булево)

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

ExternalId -> (строка)

(Устарело) Идентификатор вашей учётной записи AWS, присвоенный ключу внешнего идентификатора в политике доверия IAM. Amazon Pinpoint ранее использовал это значение для принятия роли IAM при импорте определений конечных точек, но мы удалили это требование. Мы не рекомендуем использовать внешние идентификаторы для ролей IAM, которые принимаются Amazon Pinpoint.

Format -> (строка)

Формат файлов, содержащих импортируемые определения конечных точек. Допустимые значения: CSV (формат с разделителями запятых) и JSON (формат с разделителями новых строк JSON). Если расположение в Amazon S3 содержит несколько файлов с различными форматами, Amazon Pinpoint импортирует данные только из файлов, использующих указанный формат.

RegisterEndpoints -> (булево)

Указывает, следует ли регистрировать конечные точки в Amazon Pinpoint при импорте определений конечных точек.

RoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли AWS Identity and Access Management (IAM), которая предоставляет Amazon Pinpoint разрешение на доступ к расположению Amazon S3 для импорта определений конечных точек.

S3Url -> (строка)

URL корзины Amazon Simple Storage Service (Amazon S3), содержащей импортируемые определения конечных точек. Это местоположение может быть папкой или отдельным файлом. Если это папка, Amazon Pinpoint импортирует определения конечных точек из файлов в этом расположении, включая любые вложенные папки.

URL должен иметь следующий формат: s3://имя-корзины/имя-папки/имя-файла. Местоположение может заканчиваться ключом для отдельного объекта или префиксом, который квалифицирует несколько объектов.

SegmentId -> (строка)

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

SegmentName -> (строка)

Пользовательское имя для сегмента, созданного задачей импорта, если значение свойства DefineSegment равно true.

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

DefineSegment=boolean,ExternalId=string,Format=string,RegisterEndpoints=boolean,RoleArn=string,S3Url=string,SegmentId=string,SegmentName=string

Синтаксис JSON:

{
  "DefineSegment": true|false,
  "ExternalId": "string",
  "Format": "CSV"|"JSON",
  "RegisterEndpoints": true|false,
  "RoleArn": "string",
  "S3Url": "string",
  "SegmentId": "string",
  "SegmentName": "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
  • текст
  • таблица
  • 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.

Вывод

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

Предоставляет информацию о состоянии и параметрах задачи, импортирующей определения конечных точек из одного или нескольких файлов. Файлы могут храниться в корзине Amazon Simple Storage Service (Amazon S3) или загружаться непосредственно с компьютера с помощью консоли Amazon Pinpoint.

ApplicationId -> (строка)

Уникальный идентификатор приложения, связанного с задачей импорта.

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

Количество фрагментов, успешно обработанных (завершённых) задачей импорта на момент запроса.

CompletionDate -> (строка)

Дата завершения задачи импорта в формате ISO 8601.

CreationDate -> (строка)

Дата создания задачи импорта в формате ISO 8601.

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

Параметры ресурса, применимые к задаче импорта.

DefineSegment -> (булево)

Указывает, создаёт ли задача импорта сегмент, содержащий конечные точки при импорте определений конечных точек.

ExternalId -> (строка)

(Устарело) Идентификатор вашей учётной записи AWS, присвоенный ключу внешнего идентификатора в политике доверия IAM. Amazon Pinpoint ранее использовал это значение для принятия роли IAM при импорте определений конечных точек, но мы удалили это требование. Мы не рекомендуем использовать внешние идентификаторы для ролей IAM, которые принимаются Amazon Pinpoint.

Format -> (строка)

Формат файлов, содержащих импортируемые определения конечных точек. Допустимые значения: CSV (формат с разделителями запятых) и JSON (формат с разделителями новых строк JSON).

Если файлы хранятся в расположении Amazon S3, и это расположение содержит несколько файлов с различными форматами, Amazon Pinpoint импортирует данные только из файлов, использующих указанный формат.

RegisterEndpoints -> (булево)

Указывает, регистрирует ли задача импорта конечные точки в Amazon Pinpoint при импорте определений конечных точек.

RoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли AWS Identity and Access Management (IAM), которая предоставляет Amazon Pinpoint разрешение на доступ к расположению Amazon S3 для импорта определений конечных точек.

S3Url -> (строка)

URL корзины Amazon Simple Storage Service (Amazon S3), содержащей импортируемые определения конечных точек. Это местоположение может быть папкой или отдельным файлом. Если это папка, Amazon Pinpoint импортирует определения конечных точек из файлов в этом расположении, включая любые вложенные папки.

URL должен иметь следующий формат: s3://имя-корзины/имя-папки/имя-файла. Местоположение может заканчиваться ключом для отдельного объекта или префиксом, который квалифицирует несколько объектов.

SegmentId -> (строка)

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

SegmentName -> (строка)

Пользовательское имя сегмента, созданного задачей импорта, если значение свойства DefineSegment равно true.

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

Количество фрагментов, которые не были успешно обработаны (неудачные) задачей импорта на момент запроса.

Failures -> (список)

Массив записей, по одной для каждой из первых 100 записей, которые не были обработаны успешно (с ошибками) задачей импорта, если таковые имеются.

(строка)

Id -> (строка)

Уникальный идентификатор задачи импорта.

JobStatus -> (строка)

Статус задачи импорта. Статус задачи - FAILED, если Amazon Pinpoint не смог обработать один или несколько фрагментов в задаче.

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

Общее количество определений конечных точек, которые не были обработаны успешно (с ошибками) задачей импорта, как правило, из-за ошибки, такой как синтаксическая ошибка.

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

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

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

Общее количество определений конечных точек, обработанных задачей импорта.

Type -> (строка)

Тип задачи. Это значение IMPORT для задач импорта.

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

Spec-Zone.ru

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