Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListMediaAnalysisJobs

Important

Service availability notice: Streaming Video and Bulk Image Analysis is no longer available to new customers. For more information, see Rekognition feature availability changes.

This change does not impact the availability of other Amazon Rekognition features.

Returns a list of media analysis jobs. Results are sorted by CreationTimestamp in descending order.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "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.

MaxResults

The maximum number of results to return per paginated call. The largest value user can specify is 100. If user specifies a value greater than 100, an InvalidParameterException error occurs. The default value is 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

Pagination token, if the previous response was incomplete.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

Response Syntax


{
   "MediaAnalysisJobs": [ 
      { 
         "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"
      }
   ],
   "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.

MediaAnalysisJobs

Contains a list of all media analysis jobs.

Type: Array of MediaAnalysisJobDescription objects

NextToken

Pagination token, if the previous response was incomplete.

Type: String

Length Constraints: Maximum length of 1024.

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

InvalidPaginationTokenException

Pagination token in the request is not valid.

HTTP Status Code: 400

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

ThrottlingException

Amazon Rekognition is temporarily unable to process the request. Try your call again.

HTTP Status Code: 500