Get Import Job

pinpoint_get_import_job

R Documentation

Retrieves information about the status and settings of a specific import job for an application

Description

Retrieves information about the status and settings of a specific import job for an application.

Usage

pinpoint_get_import_job(ApplicationId, JobId)

Arguments

ApplicationId

[required] The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

JobId

[required] The unique identifier for the job.

Value

A list with the following syntax:

list(
  ImportJobResponse = list(
    ApplicationId = "string",
    CompletedPieces = 123,
    CompletionDate = "string",
    CreationDate = "string",
    Definition = list(
      DefineSegment = TRUE|FALSE,
      ExternalId = "string",
      Format = "CSV"|"JSON",
      RegisterEndpoints = TRUE|FALSE,
      RoleArn = "string",
      S3Url = "string",
      SegmentId = "string",
      SegmentName = "string"
    ),
    FailedPieces = 123,
    Failures = list(
      "string"
    ),
    Id = "string",
    JobStatus = "CREATED"|"PREPARING_FOR_INITIALIZATION"|"INITIALIZING"|"PROCESSING"|"PENDING_JOB"|"COMPLETING"|"COMPLETED"|"FAILING"|"FAILED",
    TotalFailures = 123,
    TotalPieces = 123,
    TotalProcessed = 123,
    Type = "string"
  )
)

Request syntax

svc$get_import_job(
  ApplicationId = "string",
  JobId = "string"
)