Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

create-export-job

Описание

Создаёт задание экспорта для приложения.

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

Синтаксис

  create-export-job
--application-id <value>
--export-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.

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

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

RoleArn -> (строка)

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

S3UrlPrefix -> (строка)

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

SegmentId -> (строка)

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

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

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

Краткая запись:

RoleArn=string,S3UrlPrefix=string,SegmentId=string,SegmentVersion=integer

Синтаксис JSON:

{
  "RoleArn": "string",
  "S3UrlPrefix": "string",
  "SegmentId": "string",
  "SegmentVersion": integer
}

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

Вывод

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

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

ApplicationId -> (строка)

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

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

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

CompletionDate -> (строка)

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

CreationDate -> (строка)

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

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

Настройки ресурса, относящиеся к заданию экспорта.

RoleArn -> (строка)

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

S3UrlPrefix -> (строка)

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

SegmentId -> (строка)

Идентификатор сегмента, из которого были экспортированы определения конечных точек. Если этот параметр отсутствует, Amazon Pinpoint экспортировал определения для всех конечных точек, связанных с приложением.

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

Версия сегмента, из которого были экспортированы определения конечных точек.

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

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

Failures -> (список)

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

(строка)

Id -> (строка)

Уникальный идентификатор задания экспорта.

JobStatus -> (строка)

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

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

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

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

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

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

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

Type -> (строка)

Тип задания. Для заданий экспорта это значение EXPORT.

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

Spec-Zone.ru

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