Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListExportJobs

Lists all of the export jobs.

Request Syntax


POST /v2/email/list-export-jobs HTTP/1.1
Content-type: application/json

{
   "ExportSourceType": "string",
   "JobStatus": "string",
   "NextToken": "string",
   "PageSize": number
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ExportSourceType

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

Type: String

Valid Values: METRICS_DATA | MESSAGE_INSIGHTS

Required: No

JobStatus

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

Type: String

Valid Values: CREATED | PROCESSING | COMPLETED | FAILED | CANCELLED

Required: No

NextToken

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

Type: String

Required: No

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 ListExportJobs to retrieve additional export jobs.

Type: Integer

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ExportJobs": [ 
      { 
         "CompletedTimestamp": number,
         "CreatedTimestamp": number,
         "ExportSourceType": "string",
         "JobId": "string",
         "JobStatus": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ExportJobs

A list of the export job summaries.

Type: Array of ExportJobSummary objects

NextToken

A string token indicating that there might be additional export jobs available to be listed. Use this token to a subsequent call to ListExportJobs with the same parameters to retrieve the next page of export jobs.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429