Start Media Analysis Job

rekognition_start_media_analysis_job

R Documentation

Initiates a new media analysis job

Description

Initiates a new media analysis job. Accepts a manifest file in an Amazon S3 bucket. The output is a manifest file and a summary of the manifest stored in the Amazon S3 bucket.

Usage

rekognition_start_media_analysis_job(ClientRequestToken, JobName,
  OperationsConfig, Input, OutputConfig, KmsKeyId)

Arguments

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.

JobName

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

OperationsConfig

[required] Configuration options for the media analysis job to be created.

Input

[required] Input data to be analyzed by the job.

OutputConfig

[required] The Amazon S3 bucket location to store the results.

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.

Value

A list with the following syntax:

list(
  JobId = "string"
)

Request syntax

svc$start_media_analysis_job(
  ClientRequestToken = "string",
  JobName = "string",
  OperationsConfig = list(
    DetectModerationLabels = list(
      MinConfidence = 123.0,
      ProjectVersion = "string"
    )
  ),
  Input = list(
    S3Object = list(
      Bucket = "string",
      Name = "string",
      Version = "string"
    )
  ),
  OutputConfig = list(
    S3Bucket = "string",
    S3KeyPrefix = "string"
  ),
  KmsKeyId = "string"
)

Examples

## Not run: 
# Initiates a new media analysis job.
svc$start_media_analysis_job(
  Input = list(
    S3Object = list(
      Bucket = "input-bucket",
      Name = "input-manifest.json"
    )
  ),
  JobName = "job-name",
  OperationsConfig = list(
    DetectModerationLabels = list(
      MinConfidence = 50L,
      ProjectVersion = "arn:aws:rekognition:us-east-1:111122223333:project/..."
    )
  ),
  OutputConfig = list(
    S3Bucket = "output-bucket",
    S3KeyPrefix = "output-location"
  )
)

## End(Not run)