Network.AWS.Comprehend.StartTopicsDetectionJob

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

Creating a Request

startTopicsDetectionJob

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

See: startTopicsDetectionJob smart constructor.

Instances

Eq StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

(==) :: StartTopicsDetectionJob -> StartTopicsDetectionJob -> Bool

(/=) :: StartTopicsDetectionJob -> StartTopicsDetectionJob -> Bool

Data StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

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

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

readsPrec :: Int -> ReadS StartTopicsDetectionJob

readList :: ReadS [StartTopicsDetectionJob]

readPrec :: ReadPrec StartTopicsDetectionJob

readListPrec :: ReadPrec [StartTopicsDetectionJob]

Show StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

showsPrec :: Int -> StartTopicsDetectionJob -> ShowS

show :: StartTopicsDetectionJob -> String

showList :: [StartTopicsDetectionJob] -> ShowS

Generic StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Associated Types

type Rep StartTopicsDetectionJob :: Type -> Type

Methods

from :: StartTopicsDetectionJob -> Rep StartTopicsDetectionJob x

to :: Rep StartTopicsDetectionJob x -> StartTopicsDetectionJob

Hashable StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

hashWithSalt :: Int -> StartTopicsDetectionJob -> Int

hash :: StartTopicsDetectionJob -> Int

ToJSON StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

toJSON :: StartTopicsDetectionJob -> Value

toEncoding :: StartTopicsDetectionJob -> Encoding

toJSONList :: [StartTopicsDetectionJob] -> Value

toEncodingList :: [StartTopicsDetectionJob] -> Encoding

AWSRequest StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Associated Types

type Rs StartTopicsDetectionJob :: Type

Methods

request :: StartTopicsDetectionJob -> Request StartTopicsDetectionJob

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy StartTopicsDetectionJob -> ClientResponse -> m (Response StartTopicsDetectionJob)

ToHeaders StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

toHeaders :: StartTopicsDetectionJob -> [Header]

ToPath StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

toPath :: StartTopicsDetectionJob -> ByteString

ToQuery StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

toQuery :: StartTopicsDetectionJob -> QueryString

NFData StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

rnf :: StartTopicsDetectionJob -> ()

type Rep StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

type Rep StartTopicsDetectionJob = D1 (MetaData "StartTopicsDetectionJob" "Network.AWS.Comprehend.StartTopicsDetectionJob" "amazonka-comprehend-1.6.1-JmZRhcK5vJN1rBy4HW0MWx" False) (C1 (MetaCons "StartTopicsDetectionJob'" PrefixI True) ((S1 (MetaSel (Just "_stdjJobName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_stdjNumberOfTopics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_stdjClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_stdjInputDataConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 InputDataConfig) :*: (S1 (MetaSel (Just "_stdjOutputDataConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 OutputDataConfig) :*: S1 (MetaSel (Just "_stdjDataAccessRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs StartTopicsDetectionJob

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

type Rs StartTopicsDetectionJob = StartTopicsDetectionJobResponse

Request Lenses

stdjJobName :: Lens' StartTopicsDetectionJob (Maybe Text)

The identifier of the job.

stdjNumberOfTopics :: Lens' StartTopicsDetectionJob (Maybe Natural)

The number of topics to detect.

stdjClientRequestToken :: Lens' StartTopicsDetectionJob (Maybe Text)

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

stdjInputDataConfig :: Lens' StartTopicsDetectionJob InputDataConfig

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

stdjOutputDataConfig :: Lens' StartTopicsDetectionJob OutputDataConfig

Specifies where to send the output files.

stdjDataAccessRoleARN :: Lens' StartTopicsDetectionJob Text

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

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

See: startTopicsDetectionJobResponse smart constructor.

Instances

Eq StartTopicsDetectionJobResponse

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

(==) :: StartTopicsDetectionJobResponse -> StartTopicsDetectionJobResponse -> Bool

(/=) :: StartTopicsDetectionJobResponse -> StartTopicsDetectionJobResponse -> Bool

Data StartTopicsDetectionJobResponse

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

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

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

readsPrec :: Int -> ReadS StartTopicsDetectionJobResponse

readList :: ReadS [StartTopicsDetectionJobResponse]

readPrec :: ReadPrec StartTopicsDetectionJobResponse

readListPrec :: ReadPrec [StartTopicsDetectionJobResponse]

Show StartTopicsDetectionJobResponse

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

showsPrec :: Int -> StartTopicsDetectionJobResponse -> ShowS

show :: StartTopicsDetectionJobResponse -> String

showList :: [StartTopicsDetectionJobResponse] -> ShowS

Generic StartTopicsDetectionJobResponse

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Associated Types

type Rep StartTopicsDetectionJobResponse :: Type -> Type

Methods

from :: StartTopicsDetectionJobResponse -> Rep StartTopicsDetectionJobResponse x

to :: Rep StartTopicsDetectionJobResponse x -> StartTopicsDetectionJobResponse

NFData StartTopicsDetectionJobResponse

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

Methods

rnf :: StartTopicsDetectionJobResponse -> ()

type Rep StartTopicsDetectionJobResponse

Defined in Network.AWS.Comprehend.StartTopicsDetectionJob

type Rep StartTopicsDetectionJobResponse = D1 (MetaData "StartTopicsDetectionJobResponse" "Network.AWS.Comprehend.StartTopicsDetectionJob" "amazonka-comprehend-1.6.1-JmZRhcK5vJN1rBy4HW0MWx" False) (C1 (MetaCons "StartTopicsDetectionJobResponse'" PrefixI True) (S1 (MetaSel (Just "_stdjrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_stdjrsJobStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 (MetaSel (Just "_stdjrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

stdjrsJobId :: Lens' StartTopicsDetectionJobResponse (Maybe Text)

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)

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

• - | The response status code.