| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Rekognition.StartLabelDetection
Description
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.
Synopsis
- data StartLabelDetection = StartLabelDetection' {}
- newStartLabelDetection :: Video -> StartLabelDetection
- startLabelDetection_clientRequestToken :: Lens' StartLabelDetection (Maybe Text)
- startLabelDetection_features :: Lens' StartLabelDetection (Maybe [LabelDetectionFeatureName])
- startLabelDetection_jobTag :: Lens' StartLabelDetection (Maybe Text)
- startLabelDetection_minConfidence :: Lens' StartLabelDetection (Maybe Double)
- startLabelDetection_notificationChannel :: Lens' StartLabelDetection (Maybe NotificationChannel)
- startLabelDetection_settings :: Lens' StartLabelDetection (Maybe LabelDetectionSettings)
- startLabelDetection_video :: Lens' StartLabelDetection Video
- data StartLabelDetectionResponse = StartLabelDetectionResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
- newStartLabelDetectionResponse :: Int -> StartLabelDetectionResponse
- startLabelDetectionResponse_jobId :: Lens' StartLabelDetectionResponse (Maybe Text)
- startLabelDetectionResponse_httpStatus :: Lens' StartLabelDetectionResponse Int
Creating a Request
data StartLabelDetection Source #
See: newStartLabelDetection smart constructor.
Constructors
| StartLabelDetection' | |
Fields
| |
Instances
newStartLabelDetection Source #
Arguments
| :: Video | |
| -> StartLabelDetection |
Create a value of StartLabelDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:StartLabelDetection', startLabelDetection_clientRequestToken - Idempotent token used to identify the start request. If you use the same
token with multiple StartLabelDetection requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being
accidently started more than once.
$sel:features:StartLabelDetection', startLabelDetection_features - The features to return after video analysis. You can specify that
GENERAL_LABELS are returned.
$sel:jobTag:StartLabelDetection', startLabelDetection_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 JobTag to group related jobs
and identify them in the completion notification.
StartLabelDetection, startLabelDetection_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 MinConfidence, the operation returns labels and
bounding boxes (if detected) with confidence values greater than or
equal to 50 percent.
$sel:notificationChannel:StartLabelDetection', startLabelDetection_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.
$sel:settings:StartLabelDetection', startLabelDetection_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.
$sel:video:StartLabelDetection', startLabelDetection_video - The video in which you want to detect labels. The video must be stored
in an Amazon S3 bucket.
Request Lenses
startLabelDetection_clientRequestToken :: Lens' StartLabelDetection (Maybe Text) Source #
Idempotent token used to identify the start request. If you use the same
token with multiple StartLabelDetection requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being
accidently started more than once.
startLabelDetection_features :: Lens' StartLabelDetection (Maybe [LabelDetectionFeatureName]) Source #
The features to return after video analysis. You can specify that GENERAL_LABELS are returned.
startLabelDetection_jobTag :: Lens' StartLabelDetection (Maybe Text) Source #
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 JobTag to group related jobs
and identify them in the completion notification.
startLabelDetection_minConfidence :: Lens' StartLabelDetection (Maybe Double) Source #
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 MinConfidence, the operation returns labels and
bounding boxes (if detected) with confidence values greater than or
equal to 50 percent.
startLabelDetection_notificationChannel :: Lens' StartLabelDetection (Maybe NotificationChannel) Source #
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.
startLabelDetection_settings :: Lens' StartLabelDetection (Maybe LabelDetectionSettings) Source #
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.
startLabelDetection_video :: Lens' StartLabelDetection Video Source #
The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.
Destructuring the Response
data StartLabelDetectionResponse Source #
See: newStartLabelDetectionResponse smart constructor.
Constructors
| StartLabelDetectionResponse' | |
Fields
| |
Instances
newStartLabelDetectionResponse Source #
Create a value of StartLabelDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartLabelDetectionResponse', startLabelDetectionResponse_jobId - The identifier for the label detection job. Use JobId to identify the
job in a subsequent call to GetLabelDetection.
$sel:httpStatus:StartLabelDetectionResponse', startLabelDetectionResponse_httpStatus - The response's http status code.
Response Lenses
startLabelDetectionResponse_jobId :: Lens' StartLabelDetectionResponse (Maybe Text) Source #
The identifier for the label detection job. Use JobId to identify the
job in a subsequent call to GetLabelDetection.
startLabelDetectionResponse_httpStatus :: Lens' StartLabelDetectionResponse Int Source #
The response's http status code.