| 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.StartEventsDetectionJob
Description
Starts an asynchronous event detection job for a collection of documents.
Synopsis
- data StartEventsDetectionJob = StartEventsDetectionJob' {}
- newStartEventsDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> NonEmpty Text -> StartEventsDetectionJob
- startEventsDetectionJob_jobName :: Lens' StartEventsDetectionJob (Maybe Text)
- startEventsDetectionJob_clientRequestToken :: Lens' StartEventsDetectionJob (Maybe Text)
- startEventsDetectionJob_tags :: Lens' StartEventsDetectionJob (Maybe [Tag])
- startEventsDetectionJob_inputDataConfig :: Lens' StartEventsDetectionJob InputDataConfig
- startEventsDetectionJob_outputDataConfig :: Lens' StartEventsDetectionJob OutputDataConfig
- startEventsDetectionJob_dataAccessRoleArn :: Lens' StartEventsDetectionJob Text
- startEventsDetectionJob_languageCode :: Lens' StartEventsDetectionJob LanguageCode
- startEventsDetectionJob_targetEventTypes :: Lens' StartEventsDetectionJob (NonEmpty Text)
- data StartEventsDetectionJobResponse = StartEventsDetectionJobResponse' {}
- newStartEventsDetectionJobResponse :: Int -> StartEventsDetectionJobResponse
- startEventsDetectionJobResponse_jobId :: Lens' StartEventsDetectionJobResponse (Maybe Text)
- startEventsDetectionJobResponse_jobArn :: Lens' StartEventsDetectionJobResponse (Maybe Text)
- startEventsDetectionJobResponse_jobStatus :: Lens' StartEventsDetectionJobResponse (Maybe JobStatus)
- startEventsDetectionJobResponse_httpStatus :: Lens' StartEventsDetectionJobResponse Int
Creating a Request
data StartEventsDetectionJob Source #
See: newStartEventsDetectionJob smart constructor.
Constructors
| StartEventsDetectionJob' | |
Fields
| |
Instances
newStartEventsDetectionJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> LanguageCode | |
| -> NonEmpty Text | |
| -> StartEventsDetectionJob |
Create a value of StartEventsDetectionJob 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:jobName:StartEventsDetectionJob', startEventsDetectionJob_jobName - The identifier of the events detection job.
$sel:clientRequestToken:StartEventsDetectionJob', startEventsDetectionJob_clientRequestToken - An unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartEventsDetectionJob', startEventsDetectionJob_tags - Tags to be associated with the events 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.
$sel:inputDataConfig:StartEventsDetectionJob', startEventsDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartEventsDetectionJob', startEventsDetectionJob_outputDataConfig - Specifies where to send the output files.
$sel:dataAccessRoleArn:StartEventsDetectionJob', startEventsDetectionJob_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.
$sel:languageCode:StartEventsDetectionJob', startEventsDetectionJob_languageCode - The language code of the input documents.
$sel:targetEventTypes:StartEventsDetectionJob', startEventsDetectionJob_targetEventTypes - The types of events to detect in the input documents.
Request Lenses
startEventsDetectionJob_jobName :: Lens' StartEventsDetectionJob (Maybe Text) Source #
The identifier of the events detection job.
startEventsDetectionJob_clientRequestToken :: Lens' StartEventsDetectionJob (Maybe Text) Source #
An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
startEventsDetectionJob_tags :: Lens' StartEventsDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the events 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.
startEventsDetectionJob_inputDataConfig :: Lens' StartEventsDetectionJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startEventsDetectionJob_outputDataConfig :: Lens' StartEventsDetectionJob OutputDataConfig Source #
Specifies where to send the output files.
startEventsDetectionJob_dataAccessRoleArn :: Lens' StartEventsDetectionJob 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.
startEventsDetectionJob_languageCode :: Lens' StartEventsDetectionJob LanguageCode Source #
The language code of the input documents.
startEventsDetectionJob_targetEventTypes :: Lens' StartEventsDetectionJob (NonEmpty Text) Source #
The types of events to detect in the input documents.
Destructuring the Response
data StartEventsDetectionJobResponse Source #
See: newStartEventsDetectionJobResponse smart constructor.
Constructors
| StartEventsDetectionJobResponse' | |
Fields
| |
Instances
newStartEventsDetectionJobResponse Source #
Create a value of StartEventsDetectionJobResponse 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:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_jobId - An unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:jobArn:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the events 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>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobStatus:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_jobStatus - The status of the events detection job.
$sel:httpStatus:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_httpStatus - The response's http status code.
Response Lenses
startEventsDetectionJobResponse_jobId :: Lens' StartEventsDetectionJobResponse (Maybe Text) Source #
An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
startEventsDetectionJobResponse_jobArn :: Lens' StartEventsDetectionJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the events 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>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
startEventsDetectionJobResponse_jobStatus :: Lens' StartEventsDetectionJobResponse (Maybe JobStatus) Source #
The status of the events detection job.
startEventsDetectionJobResponse_httpStatus :: Lens' StartEventsDetectionJobResponse Int Source #
The response's http status code.