GetExportJob
Provides information about an export job.
Request Syntax
GET /v2/email/export-jobs/JobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- JobId
-
The export job ID.
Length Constraints: Minimum length of 1.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CompletedTimestamp": number,
"CreatedTimestamp": number,
"ExportDataSource": {
"MessageInsightsDataSource": {
"EndDate": number,
"Exclude": {
"Destination": [ "string" ],
"FromEmailAddress": [ "string" ],
"Isp": [ "string" ],
"LastDeliveryEvent": [ "string" ],
"LastEngagementEvent": [ "string" ],
"Subject": [ "string" ]
},
"Include": {
"Destination": [ "string" ],
"FromEmailAddress": [ "string" ],
"Isp": [ "string" ],
"LastDeliveryEvent": [ "string" ],
"LastEngagementEvent": [ "string" ],
"Subject": [ "string" ]
},
"MaxResults": number,
"StartDate": number
},
"MetricsDataSource": {
"Dimensions": {
"string" : [ "string" ]
},
"EndDate": number,
"Metrics": [
{
"Aggregation": "string",
"Name": "string"
}
],
"Namespace": "string",
"StartDate": number
}
},
"ExportDestination": {
"DataFormat": "string",
"S3Url": "string"
},
"ExportSourceType": "string",
"FailureInfo": {
"ErrorMessage": "string",
"FailedRecordsS3Url": "string"
},
"JobId": "string",
"JobStatus": "string",
"Statistics": {
"ExportedRecordsCount": number,
"ProcessedRecordsCount": number
}
}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.
- CompletedTimestamp
-
The timestamp of when the export job was completed.
Type: Timestamp
- CreatedTimestamp
-
The timestamp of when the export job was created.
Type: Timestamp
- ExportDataSource
-
The data source of the export job.
Type: ExportDataSource object
- ExportDestination
-
The destination of the export job.
Type: ExportDestination object
- ExportSourceType
-
The type of source of the export job.
Type: String
Valid Values:
METRICS_DATA | MESSAGE_INSIGHTS - FailureInfo
-
The failure details about an export job.
Type: FailureInfo object
- JobId
-
The export job ID.
Type: String
Length Constraints: Minimum length of 1.
- JobStatus
-
The status of the export job.
Type: String
Valid Values:
CREATED | PROCESSING | COMPLETED | FAILED | CANCELLED - Statistics
-
The statistics about the export job.
Type: ExportStatistics object
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
- NotFoundException
-
The resource you attempted to access doesn't exist.
HTTP Status Code: 404
- TooManyRequestsException
-
Too many requests have been made to the operation.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
