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.GetCelebrityInfo

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.

For more information, see Getting information about a celebrity in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:GetCelebrityInfo action.

Creating a Request

data GetCelebrityInfo Source #

See: newGetCelebrityInfo smart constructor.

Constructors

GetCelebrityInfo'
Fields id :: Text The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.

Instances

Instances details

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

newGetCelebrityInfo Source #

Arguments

:: Text	`GetCelebrityInfo`
-> GetCelebrityInfo

Create a value of GetCelebrityInfo 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:

GetCelebrityInfo, getCelebrityInfo_id - The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.

Request Lenses

getCelebrityInfo_id :: Lens' GetCelebrityInfo Text Source #

The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.

Destructuring the Response

data GetCelebrityInfoResponse Source #

See: newGetCelebrityInfoResponse smart constructor.

Constructors

GetCelebrityInfoResponse'
Fields knownGender :: Maybe KnownGender Retrieves the known gender for the celebrity. name :: Maybe Text The name of the celebrity. urls :: Maybe [Text] An array of URLs pointing to additional celebrity information. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetCelebrityInfoResponse Source #

Arguments

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

Create a value of GetCelebrityInfoResponse 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:

GetCelebrityInfoResponse, getCelebrityInfoResponse_knownGender - Retrieves the known gender for the celebrity.

GetCelebrityInfoResponse, getCelebrityInfoResponse_name - The name of the celebrity.

GetCelebrityInfoResponse, getCelebrityInfoResponse_urls - An array of URLs pointing to additional celebrity information.

$sel:httpStatus:GetCelebrityInfoResponse', getCelebrityInfoResponse_httpStatus - The response's http status code.

Response Lenses

getCelebrityInfoResponse_knownGender :: Lens' GetCelebrityInfoResponse (Maybe KnownGender) Source #

Retrieves the known gender for the celebrity.

getCelebrityInfoResponse_name :: Lens' GetCelebrityInfoResponse (Maybe Text) Source #

The name of the celebrity.

getCelebrityInfoResponse_urls :: Lens' GetCelebrityInfoResponse (Maybe [Text]) Source #

An array of URLs pointing to additional celebrity information.

getCelebrityInfoResponse_httpStatus :: Lens' GetCelebrityInfoResponse Int Source #

The response's http status code.