Interface StartMediaAnalysisJobRequest

interface StartMediaAnalysisJobRequest {
    ClientRequestToken?: string;
    Input: undefined | MediaAnalysisInput;
    JobName?: string;
    KmsKeyId?: string;
    OperationsConfig: undefined | MediaAnalysisOperationsConfig;
    OutputConfig: undefined | MediaAnalysisOutputConfig;
}

Hierarchy (view full)

Properties

ClientRequestToken? Input JobName? KmsKeyId? OperationsConfig OutputConfig

Properties

Optional ClientRequestToken

ClientRequestToken?: string

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

Input: undefined | MediaAnalysisInput

Input data to be analyzed by the job.

Optional JobName

JobName?: string

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

Optional KmsKeyId

KmsKeyId?: string

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.

OperationsConfig

OperationsConfig: undefined | MediaAnalysisOperationsConfig

Configuration options for the media analysis job to be created.

OutputConfig

OutputConfig: undefined | MediaAnalysisOutputConfig

The Amazon S3 bucket location to store the results.

Settings

Member Visibility

Theme

On This Page