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.Comprehend.DescribeKeyPhrasesDetectionJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

Creating a Request

data DescribeKeyPhrasesDetectionJob Source #

See: newDescribeKeyPhrasesDetectionJob smart constructor.

Constructors

DescribeKeyPhrasesDetectionJob'
Fields jobId :: Text The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Instances

Instances details

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

newDescribeKeyPhrasesDetectionJob Source #

Arguments

:: Text	`DescribeKeyPhrasesDetectionJob`
-> DescribeKeyPhrasesDetectionJob

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

DescribeKeyPhrasesDetectionJob, describeKeyPhrasesDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Request Lenses

describeKeyPhrasesDetectionJob_jobId :: Lens' DescribeKeyPhrasesDetectionJob Text Source #

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Destructuring the Response

data DescribeKeyPhrasesDetectionJobResponse Source #

See: newDescribeKeyPhrasesDetectionJobResponse smart constructor.

Constructors

DescribeKeyPhrasesDetectionJobResponse'
Fields keyPhrasesDetectionJobProperties :: Maybe KeyPhrasesDetectionJobProperties An object that contains the properties associated with a key phrases detection job. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob Associated Types type Rep DescribeKeyPhrasesDetectionJobResponse :: Type -> Type # Methods from :: DescribeKeyPhrasesDetectionJobResponse -> Rep DescribeKeyPhrasesDetectionJobResponse x # to :: Rep DescribeKeyPhrasesDetectionJobResponse x -> DescribeKeyPhrasesDetectionJobResponse #
Read DescribeKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob Methods readsPrec :: Int -> ReadS DescribeKeyPhrasesDetectionJobResponse # readList :: ReadS [DescribeKeyPhrasesDetectionJobResponse] # readPrec :: ReadPrec DescribeKeyPhrasesDetectionJobResponse # readListPrec :: ReadPrec [DescribeKeyPhrasesDetectionJobResponse] #
Show DescribeKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob Methods showsPrec :: Int -> DescribeKeyPhrasesDetectionJobResponse -> ShowS # show :: DescribeKeyPhrasesDetectionJobResponse -> String # showList :: [DescribeKeyPhrasesDetectionJobResponse] -> ShowS #
NFData DescribeKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob Methods rnf :: DescribeKeyPhrasesDetectionJobResponse -> () #
Eq DescribeKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob Methods (==) :: DescribeKeyPhrasesDetectionJobResponse -> DescribeKeyPhrasesDetectionJobResponse -> Bool # (/=) :: DescribeKeyPhrasesDetectionJobResponse -> DescribeKeyPhrasesDetectionJobResponse -> Bool #
type Rep DescribeKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob type Rep DescribeKeyPhrasesDetectionJobResponse = D1 ('MetaData "DescribeKeyPhrasesDetectionJobResponse" "Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "DescribeKeyPhrasesDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPhrasesDetectionJobProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyPhrasesDetectionJobProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeKeyPhrasesDetectionJobResponse Source #

Arguments

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

Create a value of DescribeKeyPhrasesDetectionJobResponse 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:keyPhrasesDetectionJobProperties:DescribeKeyPhrasesDetectionJobResponse', describeKeyPhrasesDetectionJobResponse_keyPhrasesDetectionJobProperties - An object that contains the properties associated with a key phrases detection job.

$sel:httpStatus:DescribeKeyPhrasesDetectionJobResponse', describeKeyPhrasesDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

describeKeyPhrasesDetectionJobResponse_keyPhrasesDetectionJobProperties :: Lens' DescribeKeyPhrasesDetectionJobResponse (Maybe KeyPhrasesDetectionJobProperties) Source #

An object that contains the properties associated with a key phrases detection job.

describeKeyPhrasesDetectionJobResponse_httpStatus :: Lens' DescribeKeyPhrasesDetectionJobResponse Int Source #

The response's http status code.