DescribeDatasetExportJob
Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
Request Syntax
{
"datasetExportJobArn": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- datasetExportJobArn
-
The Amazon Resource Name (ARN) of the dataset export job to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Required: Yes
Response Syntax
{
"datasetExportJob": {
"creationDateTime": number,
"datasetArn": "string",
"datasetExportJobArn": "string",
"failureReason": "string",
"ingestionMode": "string",
"jobName": "string",
"jobOutput": {
"s3DataDestination": {
"kmsKeyArn": "string",
"path": "string"
}
},
"lastUpdatedDateTime": number,
"roleArn": "string",
"status": "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.
- datasetExportJob
-
Information about the dataset export job, including the status.
The status is one of the following values:
-
CREATE PENDING
-
CREATE IN_PROGRESS
-
ACTIVE
-
CREATE FAILED
Type: DatasetExportJob object
-
Errors
- InvalidInputException
-
Provide a valid value for the field or parameter.
HTTP Status Code: 400
- ResourceNotFoundException
-
Could not find the specified resource.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: