media_analysis_jobs

Creates, updates, deletes, gets or lists a media_analysis_jobs resource.

Overview

Name	media_analysis_jobs
Type	Resource
Id	aws.rekognition.media_analysis_jobs

Fields

The following fields are returned by SELECT queries:

get_media_analysis_job

Name	Datatype	Description
completion_timestamp	string (date-time)	The Unix date and time when the job finished.
creation_timestamp	string (date-time)	The Unix date and time when the job was started.
failure_details	object	Details about the error that resulted in failure of the job.
input	object	Reference to the input manifest that was provided in the job creation request.
job_id	string	The identifier for the media analysis job. (pattern: <code>^[a-zA-Z0-9-_]+$</code>)
job_name	string	The name of the media analysis job. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
kms_key_id	string	KMS Key that was provided in the creation request. (pattern: <code>^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$</code>)
manifest_summary	object	The summary manifest provides statistics on input manifest and errors identified in the input manifest.
operations_config	object	Operation configurations that were provided during job creation.
output_config	object	Output configuration that was provided in the creation request.
results	object	Output manifest that contains prediction results.
status	string	The current status of the media analysis job. (CREATED, QUEUED, IN_PROGRESS, SUCCEEDED, FAILED)

list_media_analysis_jobs

Name	Datatype	Description
media_analysis_jobs	array	Contains a list of all media analysis jobs.
next_token	string	Pagination token, if the previous response was incomplete.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_media_analysis_job	select	region		Retrieves the results for a given media analysis job. Takes a JobId returned by StartMediaAnalysisJob.
list_media_analysis_jobs	select	region		Returns a list of media analysis jobs. Results are sorted by CreationTimestamp in descending order.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_media_analysis_job

Retrieves the results for a given media analysis job. Takes a JobId returned by StartMediaAnalysisJob.

SELECT
completion_timestamp,
creation_timestamp,
failure_details,
input,
job_id,
job_name,
kms_key_id,
manifest_summary,
operations_config,
output_config,
results,
status
FROM aws.rekognition.media_analysis_jobs
WHERE region = '{{ region }}' -- required
;

list_media_analysis_jobs

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

SELECT
media_analysis_jobs,
next_token
FROM aws.rekognition.media_analysis_jobs
WHERE region = '{{ region }}' -- required
;