GetMediaAnalysisJob
Important
Amazon Rekognition Batch Image Content Moderation will no longer be open to new customers starting April 30, 2026. If you would like to use Batch Image Content Moderation, sign up prior to that date. Existing customers for accounts that have used this feature within the last 12 months can continue to use the service as normal. For more information, see Amazon Rekognition Batch Image Content Moderation availability change.
Retrieves the results for a given media analysis job.
Takes a JobId returned by StartMediaAnalysisJob.
Request Syntax
{
"JobId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- JobId
-
Unique identifier for the media analysis job for which you want to retrieve results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$Required: Yes
Response Syntax
{
"CompletionTimestamp": number,
"CreationTimestamp": number,
"FailureDetails": {
"Code": "string",
"Message": "string"
},
"Input": {
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
},
"JobId": "string",
"JobName": "string",
"KmsKeyId": "string",
"ManifestSummary": {
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
},
"OperationsConfig": {
"DetectModerationLabels": {
"MinConfidence": number,
"ProjectVersion": "string"
}
},
"OutputConfig": {
"S3Bucket": "string",
"S3KeyPrefix": "string"
},
"Results": {
"ModelVersions": {
"Moderation": "string"
},
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "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.
- CompletionTimestamp
-
The Unix date and time when the job finished.
Type: Timestamp
- CreationTimestamp
-
The Unix date and time when the job was started.
Type: Timestamp
- FailureDetails
-
Details about the error that resulted in failure of the job.
Type: MediaAnalysisJobFailureDetails object
- Input
-
Reference to the input manifest that was provided in the job creation request.
Type: MediaAnalysisInput object
- JobId
-
The identifier for the media analysis job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$ - JobName
-
The name of the media analysis job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_.\-]+ - KmsKeyId
-
KMS Key that was provided in the creation request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ - ManifestSummary
-
The summary manifest provides statistics on input manifest and errors identified in the input manifest.
Type: MediaAnalysisManifestSummary object
- OperationsConfig
-
Operation configurations that were provided during job creation.
Type: MediaAnalysisOperationsConfig object
- OutputConfig
-
Output configuration that was provided in the creation request.
Type: MediaAnalysisOutputConfig object
- Results
-
Output manifest that contains prediction results.
Type: MediaAnalysisResults object
- Status
-
The current status of the media analysis job.
Type: String
Valid Values:
CREATED | QUEUED | IN_PROGRESS | SUCCEEDED | FAILED
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 400
- InternalServerError
-
Amazon Rekognition experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidParameterException
-
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
HTTP Status Code: 400
- ProvisionedThroughputExceededException
-
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource specified in the request cannot be found.
HTTP Status Code: 400
- ThrottlingException
-
Amazon Rekognition is temporarily unable to process the request. Try your call again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: