Skip to content

MediaAnalysisJobDescription

Source code in docs_src/capo_rekognition/types/media_analysis_job_description.py
class MediaAnalysisJobDescription(TypedDict, closed=True):
    job_id: "capo_rekognition.types.media_analysis_job_id.MediaAnalysisJobId"
    """<p>The identifier for a media analysis job.</p>"""
    job_name: NotRequired[
        "capo_rekognition.types.media_analysis_job_name.MediaAnalysisJobName"
    ]
    """<p>The name of a media analysis job.</p>"""
    operations_config: "capo_rekognition.types.media_analysis_operations_config.MediaAnalysisOperationsConfig"
    """<p>Operation configurations that were provided during job creation.</p>"""
    status: "capo_rekognition.types.media_analysis_job_status.MediaAnalysisJobStatus"
    """<p>The status of the media analysis job being retrieved.</p>"""
    failure_details: NotRequired[
        "capo_rekognition.types.media_analysis_job_failure_details.MediaAnalysisJobFailureDetails"
    ]
    """<p>Details about the error that resulted in failure of the job.</p>"""
    creation_timestamp: "capo_rekognition.types.date_time.DateTime"
    """<p>The Unix date and time when the job was started.</p>"""
    completion_timestamp: NotRequired["capo_rekognition.types.date_time.DateTime"]
    """<p>The Unix date and time when the job finished.</p>"""
    input: "capo_rekognition.types.media_analysis_input.MediaAnalysisInput"
    """<p>Reference to the input manifest that was provided in the job creation request.</p>"""
    output_config: (
        "capo_rekognition.types.media_analysis_output_config.MediaAnalysisOutputConfig"
    )
    """<p>Output configuration that was provided in the creation request.</p>"""
    kms_key_id: NotRequired["capo_rekognition.types.kms_key_id.KmsKeyId"]
    """<p>KMS Key that was provided in the creation request.</p>"""
    results: NotRequired[
        "capo_rekognition.types.media_analysis_results.MediaAnalysisResults"
    ]
    """<p>Output manifest that contains prediction results.</p>"""
    manifest_summary: NotRequired[
        "capo_rekognition.types.media_analysis_manifest_summary.MediaAnalysisManifestSummary"
    ]
    """<p>Provides statistics on input manifest and errors identified in the input manifest.</p>"""

completion_timestamp instance-attribute

completion_timestamp: NotRequired[DateTime]

The Unix date and time when the job finished.

creation_timestamp instance-attribute

creation_timestamp: DateTime

The Unix date and time when the job was started.

failure_details instance-attribute

failure_details: NotRequired[MediaAnalysisJobFailureDetails]

Details about the error that resulted in failure of the job.

input instance-attribute

Reference to the input manifest that was provided in the job creation request.

job_id instance-attribute

The identifier for a media analysis job.

job_name instance-attribute

job_name: NotRequired[MediaAnalysisJobName]

The name of a media analysis job.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

KMS Key that was provided in the creation request.

manifest_summary instance-attribute

manifest_summary: NotRequired[MediaAnalysisManifestSummary]

Provides statistics on input manifest and errors identified in the input manifest.

operations_config instance-attribute

operations_config: MediaAnalysisOperationsConfig

Operation configurations that were provided during job creation.

output_config instance-attribute

Output configuration that was provided in the creation request.

results instance-attribute

results: NotRequired[MediaAnalysisResults]

Output manifest that contains prediction results.

status instance-attribute

The status of the media analysis job being retrieved.