Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-export-jobs

Описание

Получает информацию о состоянии и параметрах всех задач экспорта для приложения.

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

Синтаксис

  get-export-jobs
--application-id <value>
[--page-size <value>]
[--token <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.

--page-size (строка)

Максимальное количество элементов на каждой странице в ответ при постраничном выводе. Этот параметр не поддерживается для метрик приложений, кампаний и маршрутов.

--token (строка)

Строка NextToken, определяющая, какую страницу результатов вернуть в ответе при постраничном выводе.

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

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

Item -> (список)

Массив ответов, по одному для каждой задачи экспорта, связанной с приложением (ресурс Задачи экспорта) или сегментом (ресурс Задачи экспорта сегмента).

(структура)

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

ApplicationId -> (строка)

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

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

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

CompletionDate -> (строка)

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

CreationDate -> (строка)

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

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

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

RoleArn -> (строка)

Amazon Resource Name (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.

NextToken -> (строка)

Строка, которую нужно использовать в последующем запросе для получения следующей страницы результатов в ответе при постраничном выводе. Это значение равно null, если дополнительных страниц нет.

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

Spec-Zone.ru

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