Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-import-jobs

Описание

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

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

Синтаксис

  get-import-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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

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

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

Элемент -> (список)

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

(структура)

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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