libZSservicesZSamazonka-rekognitionZSamazonka-rekognition
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Rekognition.StartSegmentDetection

Description

Starts asynchronous detection of segment detection in a stored video.

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call to StartSegmentDetection.

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

Synopsis

Creating a Request

data StartSegmentDetection Source #

See: newStartSegmentDetection smart constructor.

Constructors

StartSegmentDetection' 

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.

  • filters :: Maybe StartSegmentDetectionFilters

    Filters for technical cue or shot detection.

  • notificationChannel :: Maybe NotificationChannel

    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

  • clientRequestToken :: Maybe Text

    Idempotent token used to identify the start request. If you use the same token with multiple StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

  • video :: Video
     
  • segmentTypes :: NonEmpty SegmentType

    An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Instances

Instances details
Eq StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

(==) :: StartSegmentDetection -> StartSegmentDetection -> Bool #

(/=) :: StartSegmentDetection -> StartSegmentDetection -> Bool #

Read StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

readsPrec :: Int -> ReadS StartSegmentDetection #

readList :: ReadS [StartSegmentDetection] #

readPrec :: ReadPrec StartSegmentDetection #

readListPrec :: ReadPrec [StartSegmentDetection] #

Show StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

showsPrec :: Int -> StartSegmentDetection -> ShowS #

show :: StartSegmentDetection -> String #

showList :: [StartSegmentDetection] -> ShowS #

Generic StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Associated Types

type Rep StartSegmentDetection :: Type -> Type #

Methods

from :: StartSegmentDetection -> Rep StartSegmentDetection x #

to :: Rep StartSegmentDetection x -> StartSegmentDetection #

NFData StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

rnf :: StartSegmentDetection -> () #

Hashable StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

hashWithSalt :: Int -> StartSegmentDetection -> Int #

hash :: StartSegmentDetection -> Int #

ToJSON StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

toJSON :: StartSegmentDetection -> Value #

toEncoding :: StartSegmentDetection -> Encoding #

toJSONList :: [StartSegmentDetection] -> Value #

toEncodingList :: [StartSegmentDetection] -> Encoding #

AWSRequest StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Associated Types

type AWSResponse StartSegmentDetection #

Methods

request :: StartSegmentDetection -> Request StartSegmentDetection #

response :: MonadResource m => Logger -> Service -> Proxy StartSegmentDetection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartSegmentDetection))) #

ToHeaders StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

toHeaders :: StartSegmentDetection -> [Header] #

ToPath StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

toPath :: StartSegmentDetection -> ByteString #

ToQuery StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

toQuery :: StartSegmentDetection -> QueryString #

type Rep StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

type Rep StartSegmentDetection = D1 ('MetaData "StartSegmentDetection" "Amazonka.Rekognition.StartSegmentDetection" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "StartSegmentDetection'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StartSegmentDetectionFilters)) :*: S1 ('MetaSel ('Just "notificationChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationChannel)))) :*: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "video") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Video) :*: S1 ('MetaSel ('Just "segmentTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty SegmentType))))))
type AWSResponse StartSegmentDetection Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

type AWSResponse StartSegmentDetection = StartSegmentDetectionResponse

newStartSegmentDetection Source #

Arguments

:: Video

$sel:video:StartSegmentDetection'

-> NonEmpty SegmentType

$sel:segmentTypes:StartSegmentDetection'

-> StartSegmentDetection 

Create a value of StartSegmentDetection 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:StartSegmentDetection', startSegmentDetection_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:filters:StartSegmentDetection', startSegmentDetection_filters - Filters for technical cue or shot detection.

$sel:notificationChannel:StartSegmentDetection', startSegmentDetection_notificationChannel - The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

$sel:clientRequestToken:StartSegmentDetection', startSegmentDetection_clientRequestToken - Idempotent token used to identify the start request. If you use the same token with multiple StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

$sel:video:StartSegmentDetection', startSegmentDetection_video - Undocumented member.

$sel:segmentTypes:StartSegmentDetection', startSegmentDetection_segmentTypes - An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Request Lenses

startSegmentDetection_jobTag :: Lens' StartSegmentDetection (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.

startSegmentDetection_filters :: Lens' StartSegmentDetection (Maybe StartSegmentDetectionFilters) Source #

Filters for technical cue or shot detection.

startSegmentDetection_notificationChannel :: Lens' StartSegmentDetection (Maybe NotificationChannel) Source #

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

startSegmentDetection_clientRequestToken :: Lens' StartSegmentDetection (Maybe Text) Source #

Idempotent token used to identify the start request. If you use the same token with multiple StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

startSegmentDetection_video :: Lens' StartSegmentDetection Video Source #

Undocumented member.

startSegmentDetection_segmentTypes :: Lens' StartSegmentDetection (NonEmpty SegmentType) Source #

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Destructuring the Response

data StartSegmentDetectionResponse Source #

See: newStartSegmentDetectionResponse smart constructor.

Constructors

StartSegmentDetectionResponse' 

Fields

  • jobId :: Maybe Text

    Unique identifier for the segment detection job. The JobId is returned from StartSegmentDetection.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq StartSegmentDetectionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

(==) :: StartSegmentDetectionResponse -> StartSegmentDetectionResponse -> Bool #

(/=) :: StartSegmentDetectionResponse -> StartSegmentDetectionResponse -> Bool #

Read StartSegmentDetectionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

readsPrec :: Int -> ReadS StartSegmentDetectionResponse #

readList :: ReadS [StartSegmentDetectionResponse] #

readPrec :: ReadPrec StartSegmentDetectionResponse #

readListPrec :: ReadPrec [StartSegmentDetectionResponse] #

Show StartSegmentDetectionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

showsPrec :: Int -> StartSegmentDetectionResponse -> ShowS #

show :: StartSegmentDetectionResponse -> String #

showList :: [StartSegmentDetectionResponse] -> ShowS #

Generic StartSegmentDetectionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Associated Types

type Rep StartSegmentDetectionResponse :: Type -> Type #

Methods

from :: StartSegmentDetectionResponse -> Rep StartSegmentDetectionResponse x #

to :: Rep StartSegmentDetectionResponse x -> StartSegmentDetectionResponse #

NFData StartSegmentDetectionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

Methods

rnf :: StartSegmentDetectionResponse -> () #

type Rep StartSegmentDetectionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartSegmentDetection

type Rep StartSegmentDetectionResponse = D1 ('MetaData "StartSegmentDetectionResponse" "Amazonka.Rekognition.StartSegmentDetection" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "StartSegmentDetectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartSegmentDetectionResponse Source #

Arguments

:: Int

$sel:httpStatus:StartSegmentDetectionResponse'

-> StartSegmentDetectionResponse 

Create a value of StartSegmentDetectionResponse 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:StartSegmentDetectionResponse', startSegmentDetectionResponse_jobId - Unique identifier for the segment detection job. The JobId is returned from StartSegmentDetection.

$sel:httpStatus:StartSegmentDetectionResponse', startSegmentDetectionResponse_httpStatus - The response's http status code.

Response Lenses

startSegmentDetectionResponse_jobId :: Lens' StartSegmentDetectionResponse (Maybe Text) Source #

Unique identifier for the segment detection job. The JobId is returned from StartSegmentDetection.

startSegmentDetectionResponse_httpStatus :: Lens' StartSegmentDetectionResponse Int Source #

The response's http status code.