amazonka-rekognition-2.0: Amazon Rekognition SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Rekognition.StartCelebrityRecognition

Description

Starts asynchronous recognition of celebrities in a stored video.

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis 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 celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition.

For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

Synopsis

Creating a Request

data StartCelebrityRecognition Source #

See: newStartCelebrityRecognition smart constructor.

Constructors

StartCelebrityRecognition' 

Fields

  • clientRequestToken :: Maybe Text

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

  • 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 that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

  • video :: Video

    The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

Instances

Instances details
ToJSON StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

ToHeaders StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

ToPath StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

ToQuery StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

AWSRequest StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

Generic StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

Associated Types

type Rep StartCelebrityRecognition :: Type -> Type #

Read StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

Show StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

NFData StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

Eq StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

Hashable StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

type AWSResponse StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

type Rep StartCelebrityRecognition Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

type Rep StartCelebrityRecognition = D1 ('MetaData "StartCelebrityRecognition" "Amazonka.Rekognition.StartCelebrityRecognition" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "StartCelebrityRecognition'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "notificationChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationChannel)) :*: S1 ('MetaSel ('Just "video") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Video))))

newStartCelebrityRecognition Source #

Create a value of StartCelebrityRecognition 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:StartCelebrityRecognition', startCelebrityRecognition_clientRequestToken - Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

$sel:jobTag:StartCelebrityRecognition', startCelebrityRecognition_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:StartCelebrityRecognition', startCelebrityRecognition_notificationChannel - The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

$sel:video:StartCelebrityRecognition', startCelebrityRecognition_video - The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

Request Lenses

startCelebrityRecognition_clientRequestToken :: Lens' StartCelebrityRecognition (Maybe Text) Source #

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

startCelebrityRecognition_jobTag :: Lens' StartCelebrityRecognition (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.

startCelebrityRecognition_notificationChannel :: Lens' StartCelebrityRecognition (Maybe NotificationChannel) Source #

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

startCelebrityRecognition_video :: Lens' StartCelebrityRecognition Video Source #

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

Destructuring the Response

data StartCelebrityRecognitionResponse Source #

See: newStartCelebrityRecognitionResponse smart constructor.

Constructors

StartCelebrityRecognitionResponse' 

Fields

  • jobId :: Maybe Text

    The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic StartCelebrityRecognitionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

Associated Types

type Rep StartCelebrityRecognitionResponse :: Type -> Type #

Read StartCelebrityRecognitionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

Show StartCelebrityRecognitionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

NFData StartCelebrityRecognitionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

Eq StartCelebrityRecognitionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

type Rep StartCelebrityRecognitionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartCelebrityRecognition

type Rep StartCelebrityRecognitionResponse = D1 ('MetaData "StartCelebrityRecognitionResponse" "Amazonka.Rekognition.StartCelebrityRecognition" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "StartCelebrityRecognitionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartCelebrityRecognitionResponse Source #

Create a value of StartCelebrityRecognitionResponse 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:StartCelebrityRecognitionResponse', startCelebrityRecognitionResponse_jobId - The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition.

$sel:httpStatus:StartCelebrityRecognitionResponse', startCelebrityRecognitionResponse_httpStatus - The response's http status code.

Response Lenses

startCelebrityRecognitionResponse_jobId :: Lens' StartCelebrityRecognitionResponse (Maybe Text) Source #

The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition.