Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Rekognition.StartLabelDetection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

data StartLabelDetection = StartLabelDetection' {
- jobTag :: Maybe Text
- notificationChannel :: Maybe NotificationChannel
- clientRequestToken :: Maybe Text
- minConfidence :: Maybe Double
- video :: Video
}
newStartLabelDetection :: Video -> StartLabelDetection
startLabelDetection_jobTag :: Lens' StartLabelDetection (Maybe Text)
startLabelDetection_notificationChannel :: Lens' StartLabelDetection (Maybe NotificationChannel)
startLabelDetection_clientRequestToken :: Lens' StartLabelDetection (Maybe Text)
startLabelDetection_minConfidence :: Lens' StartLabelDetection (Maybe Double)
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

jobTag :: Maybe Text
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.
notificationChannel :: Maybe 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.
clientRequestToken :: Maybe Text
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.
minConfidence :: Maybe Double
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 with confidence values greater than or equal to 50 percent.
video :: Video
The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.

Instances

Instances details

Eq StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods (==) :: StartLabelDetection -> StartLabelDetection -> Bool # (/=) :: StartLabelDetection -> StartLabelDetection -> Bool #
Read StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods readsPrec :: Int -> ReadS StartLabelDetection # readList :: ReadS [StartLabelDetection] # readPrec :: ReadPrec StartLabelDetection # readListPrec :: ReadPrec [StartLabelDetection] #
Show StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods showsPrec :: Int -> StartLabelDetection -> ShowS # show :: StartLabelDetection -> String # showList :: [StartLabelDetection] -> ShowS #
Generic StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Associated Types type Rep StartLabelDetection :: Type -> Type # Methods from :: StartLabelDetection -> Rep StartLabelDetection x # to :: Rep StartLabelDetection x -> StartLabelDetection #
NFData StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods rnf :: StartLabelDetection -> () #
Hashable StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods hashWithSalt :: Int -> StartLabelDetection -> Int # hash :: StartLabelDetection -> Int #
ToJSON StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods toJSON :: StartLabelDetection -> Value # toEncoding :: StartLabelDetection -> Encoding # toJSONList :: [StartLabelDetection] -> Value # toEncodingList :: [StartLabelDetection] -> Encoding #
AWSRequest StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Associated Types type AWSResponse StartLabelDetection # Methods request :: StartLabelDetection -> Request StartLabelDetection # response :: MonadResource m => Logger -> Service -> Proxy StartLabelDetection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartLabelDetection))) #
ToHeaders StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods toHeaders :: StartLabelDetection -> [Header] #
ToPath StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods toPath :: StartLabelDetection -> ByteString #
ToQuery StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods toQuery :: StartLabelDetection -> QueryString #
type Rep StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection type Rep StartLabelDetection = D1 ('MetaData "StartLabelDetection" "Amazonka.Rekognition.StartLabelDetection" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "StartLabelDetection'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "notificationChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationChannel))) :: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "minConfidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "video") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Video)))))
type AWSResponse StartLabelDetection Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection type AWSResponse StartLabelDetection = StartLabelDetectionResponse

newStartLabelDetection Source #

Arguments

:: Video	`$sel:video:StartLabelDetection'`
-> 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: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.

$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: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:minConfidence: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 with confidence values greater than or equal to 50 percent.

$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_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_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_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_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 with confidence values greater than or equal to 50 percent.

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 jobId :: Maybe Text The identifier for the label detection job. Use `JobId` to identify the job in a subsequent call to `GetLabelDetection`. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartLabelDetectionResponse Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods (==) :: StartLabelDetectionResponse -> StartLabelDetectionResponse -> Bool # (/=) :: StartLabelDetectionResponse -> StartLabelDetectionResponse -> Bool #
Read StartLabelDetectionResponse Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods readsPrec :: Int -> ReadS StartLabelDetectionResponse # readList :: ReadS [StartLabelDetectionResponse] # readPrec :: ReadPrec StartLabelDetectionResponse # readListPrec :: ReadPrec [StartLabelDetectionResponse] #
Show StartLabelDetectionResponse Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods showsPrec :: Int -> StartLabelDetectionResponse -> ShowS # show :: StartLabelDetectionResponse -> String # showList :: [StartLabelDetectionResponse] -> ShowS #
Generic StartLabelDetectionResponse Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Associated Types type Rep StartLabelDetectionResponse :: Type -> Type # Methods from :: StartLabelDetectionResponse -> Rep StartLabelDetectionResponse x # to :: Rep StartLabelDetectionResponse x -> StartLabelDetectionResponse #
NFData StartLabelDetectionResponse Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection Methods rnf :: StartLabelDetectionResponse -> () #
type Rep StartLabelDetectionResponse Source #
Instance details Defined in Amazonka.Rekognition.StartLabelDetection type Rep StartLabelDetectionResponse = D1 ('MetaData "StartLabelDetectionResponse" "Amazonka.Rekognition.StartLabelDetection" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "StartLabelDetectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartLabelDetectionResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartLabelDetectionResponse'`
-> StartLabelDetectionResponse

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.