Get Export Job

pinpoint_get_export_job

R Documentation

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

Description

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

Usage

pinpoint_get_export_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(
  ExportJobResponse = list(
    ApplicationId = "string",
    CompletedPieces = 123,
    CompletionDate = "string",
    CreationDate = "string",
    Definition = list(
      RoleArn = "string",
      S3UrlPrefix = "string",
      SegmentId = "string",
      SegmentVersion = 123
    ),
    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_export_job(
  ApplicationId = "string",
  JobId = "string"
)