| 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.StartKeyPhrasesDetectionJob
Description
Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
Synopsis
- data StartKeyPhrasesDetectionJob = StartKeyPhrasesDetectionJob' {}
- newStartKeyPhrasesDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartKeyPhrasesDetectionJob
- startKeyPhrasesDetectionJob_jobName :: Lens' StartKeyPhrasesDetectionJob (Maybe Text)
- startKeyPhrasesDetectionJob_vpcConfig :: Lens' StartKeyPhrasesDetectionJob (Maybe VpcConfig)
- startKeyPhrasesDetectionJob_volumeKmsKeyId :: Lens' StartKeyPhrasesDetectionJob (Maybe Text)
- startKeyPhrasesDetectionJob_clientRequestToken :: Lens' StartKeyPhrasesDetectionJob (Maybe Text)
- startKeyPhrasesDetectionJob_tags :: Lens' StartKeyPhrasesDetectionJob (Maybe [Tag])
- startKeyPhrasesDetectionJob_inputDataConfig :: Lens' StartKeyPhrasesDetectionJob InputDataConfig
- startKeyPhrasesDetectionJob_outputDataConfig :: Lens' StartKeyPhrasesDetectionJob OutputDataConfig
- startKeyPhrasesDetectionJob_dataAccessRoleArn :: Lens' StartKeyPhrasesDetectionJob Text
- startKeyPhrasesDetectionJob_languageCode :: Lens' StartKeyPhrasesDetectionJob LanguageCode
- data StartKeyPhrasesDetectionJobResponse = StartKeyPhrasesDetectionJobResponse' {}
- newStartKeyPhrasesDetectionJobResponse :: Int -> StartKeyPhrasesDetectionJobResponse
- startKeyPhrasesDetectionJobResponse_jobId :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text)
- startKeyPhrasesDetectionJobResponse_jobArn :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text)
- startKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe JobStatus)
- startKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StartKeyPhrasesDetectionJobResponse Int
Creating a Request
data StartKeyPhrasesDetectionJob Source #
See: newStartKeyPhrasesDetectionJob smart constructor.
Constructors
| StartKeyPhrasesDetectionJob' | |
Fields
| |
Instances
newStartKeyPhrasesDetectionJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> LanguageCode | |
| -> StartKeyPhrasesDetectionJob |
Create a value of StartKeyPhrasesDetectionJob 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:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_jobName - The identifier of the job.
$sel:vpcConfig:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_vpcConfig - Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your key phrases
detection job. For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_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"
$sel:clientRequestToken:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_tags - Tags to be associated with the key phrases 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:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_outputDataConfig - Specifies where to send the output files.
$sel:dataAccessRoleArn:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_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.
$sel:languageCode:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_languageCode - The language of the input documents. You can specify any of the primary
languages supported by Amazon Comprehend. All documents must be in the
same language.
Request Lenses
startKeyPhrasesDetectionJob_jobName :: Lens' StartKeyPhrasesDetectionJob (Maybe Text) Source #
The identifier of the job.
startKeyPhrasesDetectionJob_vpcConfig :: Lens' StartKeyPhrasesDetectionJob (Maybe VpcConfig) Source #
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
startKeyPhrasesDetectionJob_volumeKmsKeyId :: Lens' StartKeyPhrasesDetectionJob (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"
startKeyPhrasesDetectionJob_clientRequestToken :: Lens' StartKeyPhrasesDetectionJob (Maybe Text) Source #
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
startKeyPhrasesDetectionJob_tags :: Lens' StartKeyPhrasesDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the key phrases 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.
startKeyPhrasesDetectionJob_inputDataConfig :: Lens' StartKeyPhrasesDetectionJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startKeyPhrasesDetectionJob_outputDataConfig :: Lens' StartKeyPhrasesDetectionJob OutputDataConfig Source #
Specifies where to send the output files.
startKeyPhrasesDetectionJob_dataAccessRoleArn :: Lens' StartKeyPhrasesDetectionJob 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.
startKeyPhrasesDetectionJob_languageCode :: Lens' StartKeyPhrasesDetectionJob LanguageCode Source #
The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
Destructuring the Response
data StartKeyPhrasesDetectionJobResponse Source #
See: newStartKeyPhrasesDetectionJobResponse smart constructor.
Constructors
| StartKeyPhrasesDetectionJobResponse' | |
Fields
| |
Instances
newStartKeyPhrasesDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StartKeyPhrasesDetectionJobResponse |
Create a value of StartKeyPhrasesDetectionJobResponse 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:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_jobId - The identifier generated for the job. To get the status of a job, use
this identifier with the operation.
$sel:jobArn:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the key phrase 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>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobStatus:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_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 operation.
$sel:httpStatus:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_httpStatus - The response's http status code.
Response Lenses
startKeyPhrasesDetectionJobResponse_jobId :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
startKeyPhrasesDetectionJobResponse_jobArn :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the key phrase 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>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
startKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StartKeyPhrasesDetectionJobResponse (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 operation.
startKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StartKeyPhrasesDetectionJobResponse Int Source #
The response's http status code.