Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-import-job

Описание

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

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

Синтаксис

  get-import-job
--application-id <value>
--job-id <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.

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

Уникальный идентификатор задачи.

--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
  • text
  • table
  • yaml
  • yaml-stream

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

Вывод

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

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

Если файлы хранятся в расположении 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 для задач импорта.

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

Spec-Zone.ru

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