Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.Comprehend.StartTopicsDetectionJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

Creating a Request

startTopicsDetectionJob Source #

Arguments

:: InputDataConfig	`stdjInputDataConfig`
-> OutputDataConfig	`stdjOutputDataConfig`
-> Text	`stdjDataAccessRoleARN`
-> StartTopicsDetectionJob

Creates a value of StartTopicsDetectionJob with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

stdjJobName - The identifier of the job.
stdjNumberOfTopics - The number of topics to detect.
stdjClientRequestToken - A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
stdjInputDataConfig - Specifies the format and location of the input data for the job.
stdjOutputDataConfig - Specifies where to send the output files.
stdjDataAccessRoleARN - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

data StartTopicsDetectionJob Source #

See: startTopicsDetectionJob smart constructor.

Instances

Eq StartTopicsDetectionJob Source #
Methods (==) :: StartTopicsDetectionJob -> StartTopicsDetectionJob -> Bool # (/=) :: StartTopicsDetectionJob -> StartTopicsDetectionJob -> Bool #
Data StartTopicsDetectionJob Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartTopicsDetectionJob -> c StartTopicsDetectionJob # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartTopicsDetectionJob # toConstr :: StartTopicsDetectionJob -> Constr # dataTypeOf :: StartTopicsDetectionJob -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c StartTopicsDetectionJob) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartTopicsDetectionJob) # gmapT :: (forall b. Data b => b -> b) -> StartTopicsDetectionJob -> StartTopicsDetectionJob # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartTopicsDetectionJob -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartTopicsDetectionJob -> r # gmapQ :: (forall d. Data d => d -> u) -> StartTopicsDetectionJob -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StartTopicsDetectionJob -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartTopicsDetectionJob -> m StartTopicsDetectionJob # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTopicsDetectionJob -> m StartTopicsDetectionJob # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTopicsDetectionJob -> m StartTopicsDetectionJob #
Read StartTopicsDetectionJob Source #
Methods readsPrec :: Int -> ReadS StartTopicsDetectionJob # readList :: ReadS [StartTopicsDetectionJob] # readPrec :: ReadPrec StartTopicsDetectionJob # readListPrec :: ReadPrec [StartTopicsDetectionJob] #
Show StartTopicsDetectionJob Source #
Methods showsPrec :: Int -> StartTopicsDetectionJob -> ShowS # show :: StartTopicsDetectionJob -> String # showList :: [StartTopicsDetectionJob] -> ShowS #
Generic StartTopicsDetectionJob Source #
Associated Types type Rep StartTopicsDetectionJob :: * -> * # Methods from :: StartTopicsDetectionJob -> Rep StartTopicsDetectionJob x # to :: Rep StartTopicsDetectionJob x -> StartTopicsDetectionJob #
Hashable StartTopicsDetectionJob Source #
Methods hashWithSalt :: Int -> StartTopicsDetectionJob -> Int # hash :: StartTopicsDetectionJob -> Int #
ToJSON StartTopicsDetectionJob Source #
Methods toJSON :: StartTopicsDetectionJob -> Value # toEncoding :: StartTopicsDetectionJob -> Encoding # toJSONList :: [StartTopicsDetectionJob] -> Value # toEncodingList :: [StartTopicsDetectionJob] -> Encoding #
NFData StartTopicsDetectionJob Source #
Methods rnf :: StartTopicsDetectionJob -> () #
AWSRequest StartTopicsDetectionJob Source #
Associated Types type Rs StartTopicsDetectionJob :: * # Methods request :: StartTopicsDetectionJob -> Request StartTopicsDetectionJob # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * StartTopicsDetectionJob -> ClientResponse -> m (Response StartTopicsDetectionJob) #
ToHeaders StartTopicsDetectionJob Source #
Methods toHeaders :: StartTopicsDetectionJob -> [Header] #
ToPath StartTopicsDetectionJob Source #
Methods toPath :: StartTopicsDetectionJob -> ByteString #
ToQuery StartTopicsDetectionJob Source #
Methods toQuery :: StartTopicsDetectionJob -> QueryString #
type Rep StartTopicsDetectionJob Source #
type Rep StartTopicsDetectionJob = D1 * (MetaData "StartTopicsDetectionJob" "Network.AWS.Comprehend.StartTopicsDetectionJob" "amazonka-comprehend-1.6.0-7ky9kDszQAoCEHl21SoVpv" False) (C1 * (MetaCons "StartTopicsDetectionJob'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_stdjJobName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((::) (S1 * (MetaSel (Just Symbol "_stdjNumberOfTopics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_stdjClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((::) (S1 * (MetaSel (Just Symbol "_stdjInputDataConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * InputDataConfig)) ((::) (S1 * (MetaSel (Just Symbol "_stdjOutputDataConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * OutputDataConfig)) (S1 * (MetaSel (Just Symbol "_stdjDataAccessRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))
type Rs StartTopicsDetectionJob Source #
type Rs StartTopicsDetectionJob = StartTopicsDetectionJobResponse

Request Lenses

stdjJobName :: Lens' StartTopicsDetectionJob (Maybe Text) Source #

The identifier of the job.

stdjNumberOfTopics :: Lens' StartTopicsDetectionJob (Maybe Natural) Source #

The number of topics to detect.

stdjClientRequestToken :: Lens' StartTopicsDetectionJob (Maybe Text) Source #

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

stdjInputDataConfig :: Lens' StartTopicsDetectionJob InputDataConfig Source #

Specifies the format and location of the input data for the job.

stdjOutputDataConfig :: Lens' StartTopicsDetectionJob OutputDataConfig Source #

Specifies where to send the output files.

stdjDataAccessRoleARN :: Lens' StartTopicsDetectionJob Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Destructuring the Response

startTopicsDetectionJobResponse Source #

Arguments

:: Int	`stdjrsResponseStatus`
-> StartTopicsDetectionJobResponse

Creates a value of StartTopicsDetectionJobResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

stdjrsJobId - The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.
stdjrsJobStatus - The status of the job: * SUBMITTED - The job has been received and is queued for processing. * IN_PROGRESS - Amazon Comprehend is processing the job. * COMPLETED - The job was successfully completed and the output is available. * FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.
stdjrsResponseStatus - -- | The response status code.

data StartTopicsDetectionJobResponse Source #

See: startTopicsDetectionJobResponse smart constructor.

Instances

Eq StartTopicsDetectionJobResponse Source #
Methods (==) :: StartTopicsDetectionJobResponse -> StartTopicsDetectionJobResponse -> Bool # (/=) :: StartTopicsDetectionJobResponse -> StartTopicsDetectionJobResponse -> Bool #
Data StartTopicsDetectionJobResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartTopicsDetectionJobResponse -> c StartTopicsDetectionJobResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartTopicsDetectionJobResponse # toConstr :: StartTopicsDetectionJobResponse -> Constr # dataTypeOf :: StartTopicsDetectionJobResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c StartTopicsDetectionJobResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartTopicsDetectionJobResponse) # gmapT :: (forall b. Data b => b -> b) -> StartTopicsDetectionJobResponse -> StartTopicsDetectionJobResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartTopicsDetectionJobResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartTopicsDetectionJobResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> StartTopicsDetectionJobResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StartTopicsDetectionJobResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartTopicsDetectionJobResponse -> m StartTopicsDetectionJobResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTopicsDetectionJobResponse -> m StartTopicsDetectionJobResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTopicsDetectionJobResponse -> m StartTopicsDetectionJobResponse #
Read StartTopicsDetectionJobResponse Source #
Methods readsPrec :: Int -> ReadS StartTopicsDetectionJobResponse # readList :: ReadS [StartTopicsDetectionJobResponse] # readPrec :: ReadPrec StartTopicsDetectionJobResponse # readListPrec :: ReadPrec [StartTopicsDetectionJobResponse] #
Show StartTopicsDetectionJobResponse Source #
Methods showsPrec :: Int -> StartTopicsDetectionJobResponse -> ShowS # show :: StartTopicsDetectionJobResponse -> String # showList :: [StartTopicsDetectionJobResponse] -> ShowS #
Generic StartTopicsDetectionJobResponse Source #
Associated Types type Rep StartTopicsDetectionJobResponse :: * -> * # Methods from :: StartTopicsDetectionJobResponse -> Rep StartTopicsDetectionJobResponse x # to :: Rep StartTopicsDetectionJobResponse x -> StartTopicsDetectionJobResponse #
NFData StartTopicsDetectionJobResponse Source #
Methods rnf :: StartTopicsDetectionJobResponse -> () #
type Rep StartTopicsDetectionJobResponse Source #
type Rep StartTopicsDetectionJobResponse = D1 * (MetaData "StartTopicsDetectionJobResponse" "Network.AWS.Comprehend.StartTopicsDetectionJob" "amazonka-comprehend-1.6.0-7ky9kDszQAoCEHl21SoVpv" False) (C1 * (MetaCons "StartTopicsDetectionJobResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_stdjrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((::) (S1 * (MetaSel (Just Symbol "_stdjrsJobStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobStatus))) (S1 * (MetaSel (Just Symbol "_stdjrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

stdjrsJobId :: Lens' StartTopicsDetectionJobResponse (Maybe Text) Source #

The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

stdjrsJobStatus :: Lens' StartTopicsDetectionJobResponse (Maybe JobStatus) Source #

The status of the job: * SUBMITTED - The job has been received and is queued for processing. * IN_PROGRESS - Amazon Comprehend is processing the job. * COMPLETED - The job was successfully completed and the output is available. * FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.

stdjrsResponseStatus :: Lens' StartTopicsDetectionJobResponse Int Source #

- | The response status code.