Skip to content

StartMediaAnalysisJobRequest

Source code in docs_src/capo_rekognition/types/start_media_analysis_job_request.py
class StartMediaAnalysisJobRequest(TypedDict, closed=True):
    client_request_token: NotRequired[
        "capo_rekognition.types.client_request_token.ClientRequestToken"
    ]
    """<p>Idempotency token used to prevent the accidental creation of duplicate versions. If you use the same token with multiple <code>StartMediaAnalysisJobRequest</code> requests, the same response is returned. Use <code>ClientRequestToken</code> to prevent the same request from being processed more than once.</p>"""
    job_name: NotRequired[
        "capo_rekognition.types.media_analysis_job_name.MediaAnalysisJobName"
    ]
    """<p>The name of the job. Does not have to be unique.</p>"""
    operations_config: "capo_rekognition.types.media_analysis_operations_config.MediaAnalysisOperationsConfig"
    """<p>Configuration options for the media analysis job to be created.</p>"""
    input: "capo_rekognition.types.media_analysis_input.MediaAnalysisInput"
    """<p>Input data to be analyzed by the job.</p>"""
    output_config: (
        "capo_rekognition.types.media_analysis_output_config.MediaAnalysisOutputConfig"
    )
    """<p>The Amazon S3 bucket location to store the results.</p>"""
    kms_key_id: NotRequired["capo_rekognition.types.kms_key_id.KmsKeyId"]
    """<p>The identifier of customer managed AWS KMS key (name or ARN). The key is used to encrypt images copied into the service. The key is also used to encrypt results and manifest files written to the output Amazon S3 bucket.</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

Idempotency token used to prevent the accidental creation of duplicate versions. If you use the same token with multiple StartMediaAnalysisJobRequest requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

input instance-attribute

Input data to be analyzed by the job.

job_name instance-attribute

job_name: NotRequired[MediaAnalysisJobName]

The name of the job. Does not have to be unique.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The identifier of customer managed AWS KMS key (name or ARN). The key is used to encrypt images copied into the service. The key is also used to encrypt results and manifest files written to the output Amazon S3 bucket.

operations_config instance-attribute

operations_config: MediaAnalysisOperationsConfig

Configuration options for the media analysis job to be created.

output_config instance-attribute

The Amazon S3 bucket location to store the results.