Get Export Job

sesv2_get_export_job

R Documentation

Provides information about an export job

Description

Provides information about an export job.

Usage

sesv2_get_export_job(JobId)

Arguments

JobId

[required] The export job ID.

Value

A list with the following syntax:

list(
  JobId = "string",
  ExportSourceType = "METRICS_DATA"|"MESSAGE_INSIGHTS",
  JobStatus = "CREATED"|"PROCESSING"|"COMPLETED"|"FAILED"|"CANCELLED",
  ExportDestination = list(
    DataFormat = "CSV"|"JSON",
    S3Url = "string"
  ),
  ExportDataSource = list(
    MetricsDataSource = list(
      Dimensions = list(
        list(
          "string"
        )
      ),
      Namespace = "VDM",
      Metrics = list(
        list(
          Name = "SEND"|"COMPLAINT"|"PERMANENT_BOUNCE"|"TRANSIENT_BOUNCE"|"OPEN"|"CLICK"|"DELIVERY"|"DELIVERY_OPEN"|"DELIVERY_CLICK"|"DELIVERY_COMPLAINT",
          Aggregation = "RATE"|"VOLUME"
        )
      ),
      StartDate = as.POSIXct(
        "2015-01-01"
      ),
      EndDate = as.POSIXct(
        "2015-01-01"
      )
    ),
    MessageInsightsDataSource = list(
      StartDate = as.POSIXct(
        "2015-01-01"
      ),
      EndDate = as.POSIXct(
        "2015-01-01"
      ),
      Include = list(
        FromEmailAddress = list(
          "string"
        ),
        Destination = list(
          "string"
        ),
        Subject = list(
          "string"
        ),
        Isp = list(
          "string"
        ),
        LastDeliveryEvent = list(
          "SEND"|"DELIVERY"|"TRANSIENT_BOUNCE"|"PERMANENT_BOUNCE"|"UNDETERMINED_BOUNCE"|"COMPLAINT"
        ),
        LastEngagementEvent = list(
          "OPEN"|"CLICK"
        )
      ),
      Exclude = list(
        FromEmailAddress = list(
          "string"
        ),
        Destination = list(
          "string"
        ),
        Subject = list(
          "string"
        ),
        Isp = list(
          "string"
        ),
        LastDeliveryEvent = list(
          "SEND"|"DELIVERY"|"TRANSIENT_BOUNCE"|"PERMANENT_BOUNCE"|"UNDETERMINED_BOUNCE"|"COMPLAINT"
        ),
        LastEngagementEvent = list(
          "OPEN"|"CLICK"
        )
      ),
      MaxResults = 123
    )
  ),
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  CompletedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  FailureInfo = list(
    FailedRecordsS3Url = "string",
    ErrorMessage = "string"
  ),
  Statistics = list(
    ProcessedRecordsCount = 123,
    ExportedRecordsCount = 123
  )
)

Request syntax

svc$get_export_job(
  JobId = "string"
)

Examples

## Not run: 
# Gets the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99
svc$get_export_job(
  JobId = "ef28cf62-9d8e-4b60-9283-b09816c99a99"
)

## End(Not run)