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 |
Starts an asynchronous topic detection job. Use the
DescribeTopicDetectionJob
operation to track the status of a job.
Synopsis
- data StartTopicsDetectionJob = StartTopicsDetectionJob' {}
- newStartTopicsDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> StartTopicsDetectionJob
- startTopicsDetectionJob_clientRequestToken :: Lens' StartTopicsDetectionJob (Maybe Text)
- startTopicsDetectionJob_jobName :: Lens' StartTopicsDetectionJob (Maybe Text)
- startTopicsDetectionJob_numberOfTopics :: Lens' StartTopicsDetectionJob (Maybe Natural)
- startTopicsDetectionJob_tags :: Lens' StartTopicsDetectionJob (Maybe [Tag])
- startTopicsDetectionJob_volumeKmsKeyId :: Lens' StartTopicsDetectionJob (Maybe Text)
- startTopicsDetectionJob_vpcConfig :: Lens' StartTopicsDetectionJob (Maybe VpcConfig)
- startTopicsDetectionJob_inputDataConfig :: Lens' StartTopicsDetectionJob InputDataConfig
- startTopicsDetectionJob_outputDataConfig :: Lens' StartTopicsDetectionJob OutputDataConfig
- startTopicsDetectionJob_dataAccessRoleArn :: Lens' StartTopicsDetectionJob Text
- data StartTopicsDetectionJobResponse = StartTopicsDetectionJobResponse' {}
- newStartTopicsDetectionJobResponse :: Int -> StartTopicsDetectionJobResponse
- startTopicsDetectionJobResponse_jobArn :: Lens' StartTopicsDetectionJobResponse (Maybe Text)
- startTopicsDetectionJobResponse_jobId :: Lens' StartTopicsDetectionJobResponse (Maybe Text)
- startTopicsDetectionJobResponse_jobStatus :: Lens' StartTopicsDetectionJobResponse (Maybe JobStatus)
- startTopicsDetectionJobResponse_httpStatus :: Lens' StartTopicsDetectionJobResponse Int
Creating a Request
data StartTopicsDetectionJob Source #
See: newStartTopicsDetectionJob
smart constructor.
StartTopicsDetectionJob' | |
|
Instances
newStartTopicsDetectionJob Source #
Create a value of StartTopicsDetectionJob
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:clientRequestToken:StartTopicsDetectionJob'
, startTopicsDetectionJob_clientRequestToken
- A unique identifier for the request. If you do not set the client
request token, Amazon Comprehend generates one.
StartTopicsDetectionJob
, startTopicsDetectionJob_jobName
- The identifier of the job.
StartTopicsDetectionJob
, startTopicsDetectionJob_numberOfTopics
- The number of topics to detect.
$sel:tags:StartTopicsDetectionJob'
, startTopicsDetectionJob_tags
- Tags to be associated with the topics detection job. A tag is a
key-value pair that adds metadata to a resource used by Amazon
Comprehend. For example, a tag with "Sales" as the key might be added
to a resource to indicate its use by the sales department.
StartTopicsDetectionJob
, startTopicsDetectionJob_volumeKmsKeyId
- ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
- Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
StartTopicsDetectionJob
, startTopicsDetectionJob_vpcConfig
- Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your topic detection
job. For more information, see
Amazon VPC.
StartTopicsDetectionJob
, startTopicsDetectionJob_inputDataConfig
- Specifies the format and location of the input data for the job.
StartTopicsDetectionJob
, startTopicsDetectionJob_outputDataConfig
- Specifies where to send the output files. The output is a compressed
archive with two files, topic-terms.csv
that lists the terms
associated with each topic, and doc-topics.csv
that lists the
documents associated with each topic
StartTopicsDetectionJob
, startTopicsDetectionJob_dataAccessRoleArn
- The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
For more information, see
https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
Request Lenses
startTopicsDetectionJob_clientRequestToken :: Lens' StartTopicsDetectionJob (Maybe Text) Source #
A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
startTopicsDetectionJob_jobName :: Lens' StartTopicsDetectionJob (Maybe Text) Source #
The identifier of the job.
startTopicsDetectionJob_numberOfTopics :: Lens' StartTopicsDetectionJob (Maybe Natural) Source #
The number of topics to detect.
startTopicsDetectionJob_tags :: Lens' StartTopicsDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
startTopicsDetectionJob_volumeKmsKeyId :: Lens' StartTopicsDetectionJob (Maybe Text) Source #
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
- Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
startTopicsDetectionJob_vpcConfig :: Lens' StartTopicsDetectionJob (Maybe VpcConfig) Source #
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
startTopicsDetectionJob_inputDataConfig :: Lens' StartTopicsDetectionJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startTopicsDetectionJob_outputDataConfig :: Lens' StartTopicsDetectionJob OutputDataConfig Source #
Specifies where to send the output files. The output is a compressed
archive with two files, topic-terms.csv
that lists the terms
associated with each topic, and doc-topics.csv
that lists the
documents associated with each topic
startTopicsDetectionJob_dataAccessRoleArn :: 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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
Destructuring the Response
data StartTopicsDetectionJobResponse Source #
See: newStartTopicsDetectionJobResponse
smart constructor.
StartTopicsDetectionJobResponse' | |
|
Instances
newStartTopicsDetectionJobResponse Source #
Create a value of StartTopicsDetectionJobResponse
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:
StartTopicsDetectionJobResponse
, startTopicsDetectionJobResponse_jobArn
- The Amazon Resource Name (ARN) of the topics detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
StartTopicsDetectionJobResponse
, startTopicsDetectionJobResponse_jobId
- The identifier generated for the job. To get the status of the job, use
this identifier with the DescribeTopicDetectionJob
operation.
StartTopicsDetectionJobResponse
, startTopicsDetectionJobResponse_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.
$sel:httpStatus:StartTopicsDetectionJobResponse'
, startTopicsDetectionJobResponse_httpStatus
- The response's http status code.
Response Lenses
startTopicsDetectionJobResponse_jobArn :: Lens' StartTopicsDetectionJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
startTopicsDetectionJobResponse_jobId :: 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.
startTopicsDetectionJobResponse_jobStatus :: 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.
startTopicsDetectionJobResponse_httpStatus :: Lens' StartTopicsDetectionJobResponse Int Source #
The response's http status code.