List Export Jobs

sesv2_list_export_jobs

R Documentation

Lists all of the export jobs

Description

Lists all of the export jobs.

Usage

sesv2_list_export_jobs(NextToken, PageSize, ExportSourceType, JobStatus)

Arguments

NextToken

The pagination token returned from a previous call to list_export_jobs to indicate the position in the list of export jobs.

PageSize

Maximum number of export jobs to return at once. Use this parameter to paginate results. If additional export jobs exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent calls to list_export_jobs to retrieve additional export jobs.

ExportSourceType

A value used to list export jobs that have a certain ExportSourceType.

JobStatus

A value used to list export jobs that have a certain JobStatus.

Value

A list with the following syntax:

list(
  ExportJobs = list(
    list(
      JobId = "string",
      ExportSourceType = "METRICS_DATA"|"MESSAGE_INSIGHTS",
      JobStatus = "CREATED"|"PROCESSING"|"COMPLETED"|"FAILED"|"CANCELLED",
      CreatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      CompletedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_export_jobs(
  NextToken = "string",
  PageSize = 123,
  ExportSourceType = "METRICS_DATA"|"MESSAGE_INSIGHTS",
  JobStatus = "CREATED"|"PROCESSING"|"COMPLETED"|"FAILED"|"CANCELLED"
)

Examples

## Not run: 
# Lists export jobs of type METRICS_DATA and status PROCESSING
svc$list_export_jobs(
  ExportSourceType = "METRICS_DATA",
  JobStatus = "PROCESSING",
  PageSize = 25L
)

## End(Not run)