Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

получение-заданий-экспорта-сегментов

Описание

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

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

Синтаксис

  get-segment-export-jobs
--application-id <value>
[--page-size <value>]
--segment-id <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 (строка)

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

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

Уникальный идентификатор сегмента.

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

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