Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Comprehend.DescribeTopicsDetectionJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DescribeTopicsDetectionJob Source #

See: newDescribeTopicsDetectionJob smart constructor.

Constructors

DescribeTopicsDetectionJob'
Fields jobId :: Text The identifier assigned by the user to the detection job.

Instances

Instances details

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

newDescribeTopicsDetectionJob Source #

Arguments

:: Text	`$sel:jobId:DescribeTopicsDetectionJob'`
-> DescribeTopicsDetectionJob

Create a value of DescribeTopicsDetectionJob 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:DescribeTopicsDetectionJob', describeTopicsDetectionJob_jobId - The identifier assigned by the user to the detection job.

Request Lenses

describeTopicsDetectionJob_jobId :: Lens' DescribeTopicsDetectionJob Text Source #

The identifier assigned by the user to the detection job.

Destructuring the Response

data DescribeTopicsDetectionJobResponse Source #

See: newDescribeTopicsDetectionJobResponse smart constructor.

Constructors

DescribeTopicsDetectionJobResponse'
Fields topicsDetectionJobProperties :: Maybe TopicsDetectionJobProperties The list of properties for the requested job. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeTopicsDetectionJobResponse Source #

Arguments

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

Create a value of DescribeTopicsDetectionJobResponse 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:topicsDetectionJobProperties:DescribeTopicsDetectionJobResponse', describeTopicsDetectionJobResponse_topicsDetectionJobProperties - The list of properties for the requested job.

$sel:httpStatus:DescribeTopicsDetectionJobResponse', describeTopicsDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

describeTopicsDetectionJobResponse_topicsDetectionJobProperties :: Lens' DescribeTopicsDetectionJobResponse (Maybe TopicsDetectionJobProperties) Source #

The list of properties for the requested job.

describeTopicsDetectionJobResponse_httpStatus :: Lens' DescribeTopicsDetectionJobResponse Int Source #

The response's http status code.