| 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.StartDominantLanguageDetectionJob
Description
Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
Synopsis
- data StartDominantLanguageDetectionJob = StartDominantLanguageDetectionJob' {}
- newStartDominantLanguageDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> StartDominantLanguageDetectionJob
- startDominantLanguageDetectionJob_jobName :: Lens' StartDominantLanguageDetectionJob (Maybe Text)
- startDominantLanguageDetectionJob_vpcConfig :: Lens' StartDominantLanguageDetectionJob (Maybe VpcConfig)
- startDominantLanguageDetectionJob_volumeKmsKeyId :: Lens' StartDominantLanguageDetectionJob (Maybe Text)
- startDominantLanguageDetectionJob_clientRequestToken :: Lens' StartDominantLanguageDetectionJob (Maybe Text)
- startDominantLanguageDetectionJob_tags :: Lens' StartDominantLanguageDetectionJob (Maybe [Tag])
- startDominantLanguageDetectionJob_inputDataConfig :: Lens' StartDominantLanguageDetectionJob InputDataConfig
- startDominantLanguageDetectionJob_outputDataConfig :: Lens' StartDominantLanguageDetectionJob OutputDataConfig
- startDominantLanguageDetectionJob_dataAccessRoleArn :: Lens' StartDominantLanguageDetectionJob Text
- data StartDominantLanguageDetectionJobResponse = StartDominantLanguageDetectionJobResponse' {}
- newStartDominantLanguageDetectionJobResponse :: Int -> StartDominantLanguageDetectionJobResponse
- startDominantLanguageDetectionJobResponse_jobId :: Lens' StartDominantLanguageDetectionJobResponse (Maybe Text)
- startDominantLanguageDetectionJobResponse_jobArn :: Lens' StartDominantLanguageDetectionJobResponse (Maybe Text)
- startDominantLanguageDetectionJobResponse_jobStatus :: Lens' StartDominantLanguageDetectionJobResponse (Maybe JobStatus)
- startDominantLanguageDetectionJobResponse_httpStatus :: Lens' StartDominantLanguageDetectionJobResponse Int
Creating a Request
data StartDominantLanguageDetectionJob Source #
See: newStartDominantLanguageDetectionJob smart constructor.
Constructors
| StartDominantLanguageDetectionJob' | |
Fields
| |
Instances
newStartDominantLanguageDetectionJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> StartDominantLanguageDetectionJob |
Create a value of StartDominantLanguageDetectionJob 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:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_jobName - An identifier for the job.
$sel:vpcConfig:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_vpcConfig - Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your dominant language
detection job. For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_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:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_clientRequestToken - A unique identifier for the request. If you do not set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_tags - Tags to be associated with the dominant language 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:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_outputDataConfig - Specifies where to send the output files.
$sel:dataAccessRoleArn:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_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
startDominantLanguageDetectionJob_jobName :: Lens' StartDominantLanguageDetectionJob (Maybe Text) Source #
An identifier for the job.
startDominantLanguageDetectionJob_vpcConfig :: Lens' StartDominantLanguageDetectionJob (Maybe VpcConfig) Source #
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
startDominantLanguageDetectionJob_volumeKmsKeyId :: Lens' StartDominantLanguageDetectionJob (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"
startDominantLanguageDetectionJob_clientRequestToken :: Lens' StartDominantLanguageDetectionJob (Maybe Text) Source #
A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
startDominantLanguageDetectionJob_tags :: Lens' StartDominantLanguageDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the dominant language 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.
startDominantLanguageDetectionJob_inputDataConfig :: Lens' StartDominantLanguageDetectionJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startDominantLanguageDetectionJob_outputDataConfig :: Lens' StartDominantLanguageDetectionJob OutputDataConfig Source #
Specifies where to send the output files.
startDominantLanguageDetectionJob_dataAccessRoleArn :: Lens' StartDominantLanguageDetectionJob 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 StartDominantLanguageDetectionJobResponse Source #
See: newStartDominantLanguageDetectionJobResponse smart constructor.
Constructors
| StartDominantLanguageDetectionJobResponse' | |
Fields
| |
Instances
newStartDominantLanguageDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StartDominantLanguageDetectionJobResponse |
Create a value of StartDominantLanguageDetectionJobResponse 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:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_jobId - The identifier generated for the job. To get the status of a job, use
this identifier with the operation.
$sel:jobArn:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the dominant language 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>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobStatus:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_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:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_httpStatus - The response's http status code.
Response Lenses
startDominantLanguageDetectionJobResponse_jobId :: Lens' StartDominantLanguageDetectionJobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
startDominantLanguageDetectionJobResponse_jobArn :: Lens' StartDominantLanguageDetectionJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dominant language 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>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
startDominantLanguageDetectionJobResponse_jobStatus :: Lens' StartDominantLanguageDetectionJobResponse (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.
startDominantLanguageDetectionJobResponse_httpStatus :: Lens' StartDominantLanguageDetectionJobResponse Int Source #
The response's http status code.