Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

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

Описание

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

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

Синтаксис

  get-segment-import-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.

Вывод

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

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

Item -> (список)

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

(структура)

Предоставляет информацию о состоянии и настройках задачи, импортирующей определения конечных точек из одного или нескольких файлов. Файлы могут храниться в ведре 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 Resource Name (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 для задач импорта.

NextToken -> (строка)

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

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

Spec-Zone.ru

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