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 |
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob
operation to track the status of a job.
Synopsis
- startTopicsDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> StartTopicsDetectionJob
- data StartTopicsDetectionJob
- stdjJobName :: Lens' StartTopicsDetectionJob (Maybe Text)
- stdjNumberOfTopics :: Lens' StartTopicsDetectionJob (Maybe Natural)
- stdjClientRequestToken :: Lens' StartTopicsDetectionJob (Maybe Text)
- stdjInputDataConfig :: Lens' StartTopicsDetectionJob InputDataConfig
- stdjOutputDataConfig :: Lens' StartTopicsDetectionJob OutputDataConfig
- stdjDataAccessRoleARN :: Lens' StartTopicsDetectionJob Text
- startTopicsDetectionJobResponse :: Int -> StartTopicsDetectionJobResponse
- data StartTopicsDetectionJobResponse
- stdjrsJobId :: Lens' StartTopicsDetectionJobResponse (Maybe Text)
- stdjrsJobStatus :: Lens' StartTopicsDetectionJobResponse (Maybe JobStatus)
- stdjrsResponseStatus :: Lens' StartTopicsDetectionJobResponse Int
Creating a Request
startTopicsDetectionJob Source #
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
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 #
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 theDescribeTopicDetectionJob
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 theDescribeTopicDetectionJob
operation.stdjrsResponseStatus
- -- | The response status code.
data StartTopicsDetectionJobResponse Source #
See: startTopicsDetectionJobResponse
smart constructor.
Instances
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.