Network.AWS.Rekognition.StartLabelDetection

Starts asynchronous detection of labels in a stored video.

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, 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 and pass the job identifier (JobId ) from the initial call to StartLabelDetection .

Creating a Request

startLabelDetection

Arguments

:: Video

sldVideo

-> StartLabelDetection

Creates a value of StartLabelDetection with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sldJobTag - Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
• sldNotificationChannel - The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the label detection operation to.
• sldClientRequestToken - 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.
• sldMinConfidence - Specifies the minimum confidence that 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. 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.
• sldVideo - The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.

data StartLabelDetection

See: startLabelDetection smart constructor.

Instances

Eq StartLabelDetection

Methods

(==) :: StartLabelDetection -> StartLabelDetection -> Bool

(/=) :: StartLabelDetection -> StartLabelDetection -> Bool

Data StartLabelDetection

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartLabelDetection -> c StartLabelDetection

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartLabelDetection

toConstr :: StartLabelDetection -> Constr

dataTypeOf :: StartLabelDetection -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartLabelDetection)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartLabelDetection)

gmapT :: (forall b. Data b => b -> b) -> StartLabelDetection -> StartLabelDetection

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartLabelDetection -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartLabelDetection -> r

gmapQ :: (forall d. Data d => d -> u) -> StartLabelDetection -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartLabelDetection -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartLabelDetection -> m StartLabelDetection

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartLabelDetection -> m StartLabelDetection

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartLabelDetection -> m StartLabelDetection

Read StartLabelDetection

Methods

readsPrec :: Int -> ReadS StartLabelDetection

readList :: ReadS [StartLabelDetection]

readPrec :: ReadPrec StartLabelDetection

readListPrec :: ReadPrec [StartLabelDetection]

Show StartLabelDetection

Methods

showsPrec :: Int -> StartLabelDetection -> ShowS

show :: StartLabelDetection -> String

showList :: [StartLabelDetection] -> ShowS

Generic StartLabelDetection

Associated Types

type Rep StartLabelDetection :: * -> *

Methods

from :: StartLabelDetection -> Rep StartLabelDetection x

to :: Rep StartLabelDetection x -> StartLabelDetection

Hashable StartLabelDetection

Methods

hashWithSalt :: Int -> StartLabelDetection -> Int

hash :: StartLabelDetection -> Int

ToJSON StartLabelDetection

Methods

toJSON :: StartLabelDetection -> Value

toEncoding :: StartLabelDetection -> Encoding

toJSONList :: [StartLabelDetection] -> Value

toEncodingList :: [StartLabelDetection] -> Encoding

NFData StartLabelDetection

Methods

rnf :: StartLabelDetection -> ()

AWSRequest StartLabelDetection

Associated Types

type Rs StartLabelDetection :: *

Methods

request :: StartLabelDetection -> Request StartLabelDetection

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * StartLabelDetection -> ClientResponse -> m (Response StartLabelDetection)

ToHeaders StartLabelDetection

Methods

toHeaders :: StartLabelDetection -> [Header]

ToPath StartLabelDetection

Methods

toPath :: StartLabelDetection -> ByteString

ToQuery StartLabelDetection

Methods

toQuery :: StartLabelDetection -> QueryString

type Rep StartLabelDetection

type Rep StartLabelDetection = D1 * (MetaData "StartLabelDetection" "Network.AWS.Rekognition.StartLabelDetection" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "StartLabelDetection'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sldJobTag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sldNotificationChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe NotificationChannel)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sldClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sldMinConfidence") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double))) (S1 * (MetaSel (Just Symbol "_sldVideo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Video))))))

type Rs StartLabelDetection

type Rs StartLabelDetection = StartLabelDetectionResponse

Request Lenses

sldJobTag :: Lens' StartLabelDetection (Maybe Text)

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

sldNotificationChannel :: Lens' StartLabelDetection (Maybe NotificationChannel)

The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the label detection operation to.

sldClientRequestToken :: Lens' StartLabelDetection (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.

sldMinConfidence :: Lens' StartLabelDetection (Maybe Double)

Specifies the minimum confidence that 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. 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.

sldVideo :: Lens' StartLabelDetection Video

The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.

Destructuring the Response

startLabelDetectionResponse

Arguments

:: Int

sldrsResponseStatus

-> StartLabelDetectionResponse

Creates a value of StartLabelDetectionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sldrsJobId - The identifier for the label detection job. Use JobId to identify the job in a subsequent call to GetLabelDetection .
• sldrsResponseStatus - -- | The response status code.

data StartLabelDetectionResponse

See: startLabelDetectionResponse smart constructor.

Instances

Eq StartLabelDetectionResponse

Methods

(==) :: StartLabelDetectionResponse -> StartLabelDetectionResponse -> Bool

(/=) :: StartLabelDetectionResponse -> StartLabelDetectionResponse -> Bool

Data StartLabelDetectionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartLabelDetectionResponse -> c StartLabelDetectionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartLabelDetectionResponse

toConstr :: StartLabelDetectionResponse -> Constr

dataTypeOf :: StartLabelDetectionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartLabelDetectionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartLabelDetectionResponse)

gmapT :: (forall b. Data b => b -> b) -> StartLabelDetectionResponse -> StartLabelDetectionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartLabelDetectionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartLabelDetectionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> StartLabelDetectionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartLabelDetectionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartLabelDetectionResponse -> m StartLabelDetectionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartLabelDetectionResponse -> m StartLabelDetectionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartLabelDetectionResponse -> m StartLabelDetectionResponse

Read StartLabelDetectionResponse

Methods

readsPrec :: Int -> ReadS StartLabelDetectionResponse

readList :: ReadS [StartLabelDetectionResponse]

readPrec :: ReadPrec StartLabelDetectionResponse

readListPrec :: ReadPrec [StartLabelDetectionResponse]

Show StartLabelDetectionResponse

Methods

showsPrec :: Int -> StartLabelDetectionResponse -> ShowS

show :: StartLabelDetectionResponse -> String

showList :: [StartLabelDetectionResponse] -> ShowS

Generic StartLabelDetectionResponse

Associated Types

type Rep StartLabelDetectionResponse :: * -> *

Methods

from :: StartLabelDetectionResponse -> Rep StartLabelDetectionResponse x

to :: Rep StartLabelDetectionResponse x -> StartLabelDetectionResponse

NFData StartLabelDetectionResponse

Methods

rnf :: StartLabelDetectionResponse -> ()

type Rep StartLabelDetectionResponse

type Rep StartLabelDetectionResponse = D1 * (MetaData "StartLabelDetectionResponse" "Network.AWS.Rekognition.StartLabelDetection" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "StartLabelDetectionResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sldrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sldrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

sldrsJobId :: Lens' StartLabelDetectionResponse (Maybe Text)

The identifier for the label detection job. Use JobId to identify the job in a subsequent call to GetLabelDetection .

sldrsResponseStatus :: Lens' StartLabelDetectionResponse Int

• - | The response status code.