Container for the parameters to the StartLabelDetection operation. Starts asynchronous detection of labels in a stored video.
Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.
The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket
name and the filename of the video. StartLabelDetection returns a job identifier
(JobId) which you use to get the results of the operation. When label detection
is finished, Amazon Rekognition Video publishes a completion status to the Amazon
Simple Notification Service topic that you specify in NotificationChannel.
To get the results of the label detection operation, first check that the status value
published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection
and pass the job identifier (JobId) from the initial call to StartLabelDetection.
Optional Parameters
StartLabelDetection has the GENERAL_LABELS Feature applied by default.
This feature allows you to provide filtering criteria to the Settings parameter.
You can filter with sets of individual labels or with label categories. You can specify
inclusive filters, exclusive filters, or a combination of inclusive and exclusive
filters. For more information on filtering, see Detecting
labels in a video.
You can specify MinConfidence to control the confidence threshold for the labels
returned. The default is 50.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Rekognition.AmazonRekognitionRequest
Amazon.Rekognition.Model.StartLabelDetectionRequest
Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z
Syntax
public class StartLabelDetectionRequest : AmazonRekognitionRequest IAmazonWebServiceRequest
The StartLabelDetectionRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
StartLabelDetectionRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ClientRequestToken | System.String |
Gets and sets the property ClientRequestToken.
Idempotent token used to identify the start request. If you use the same token with
multiple |
|
|
Features | System.Collections.Generic.List<System.String> |
Gets and sets the property Features. The features to return after video analysis. You can specify that GENERAL_LABELS are returned. |
|
|
JobTag | System.String |
Gets and sets the property JobTag.
An identifier you specify that's returned in the completion notification that's published
to your Amazon Simple Notification Service topic. For example, you can use |
|
|
MinConfidence | System.Single |
Gets and sets the property MinConfidence. Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.
If you don't specify |
|
|
NotificationChannel | Amazon.Rekognition.Model.NotificationChannel |
Gets and sets the property NotificationChannel. The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy. |
|
|
Settings | Amazon.Rekognition.Model.LabelDetectionSettings |
Gets and sets the property Settings. The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation. Settings can include filters for GENERAL_LABELS. |
|
|
Video | Amazon.Rekognition.Model.Video |
Gets and sets the property Video. The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5