{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.Comprehend.StartDominantLanguageDetectionJob -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Starts an asynchronous dominant language detection job for a collection -- of documents. Use the operation to track the status of a job. module Amazonka.Comprehend.StartDominantLanguageDetectionJob ( -- * Creating a Request StartDominantLanguageDetectionJob (..), newStartDominantLanguageDetectionJob, -- * Request Lenses startDominantLanguageDetectionJob_clientRequestToken, startDominantLanguageDetectionJob_jobName, startDominantLanguageDetectionJob_tags, startDominantLanguageDetectionJob_volumeKmsKeyId, startDominantLanguageDetectionJob_vpcConfig, startDominantLanguageDetectionJob_inputDataConfig, startDominantLanguageDetectionJob_outputDataConfig, startDominantLanguageDetectionJob_dataAccessRoleArn, -- * Destructuring the Response StartDominantLanguageDetectionJobResponse (..), newStartDominantLanguageDetectionJobResponse, -- * Response Lenses startDominantLanguageDetectionJobResponse_jobArn, startDominantLanguageDetectionJobResponse_jobId, startDominantLanguageDetectionJobResponse_jobStatus, startDominantLanguageDetectionJobResponse_httpStatus, ) where import Amazonka.Comprehend.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newStartDominantLanguageDetectionJob' smart constructor. data StartDominantLanguageDetectionJob = StartDominantLanguageDetectionJob' { -- | A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. clientRequestToken :: Prelude.Maybe Prelude.Text, -- | An identifier for the job. jobName :: Prelude.Maybe Prelude.Text, -- | 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. tags :: Prelude.Maybe [Tag], -- | 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\"@ volumeKmsKeyId :: Prelude.Maybe Prelude.Text, -- | 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 -- . vpcConfig :: Prelude.Maybe VpcConfig, -- | Specifies the format and location of the input data for the job. inputDataConfig :: InputDataConfig, -- | Specifies where to send the output files. outputDataConfig :: OutputDataConfig, -- | 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 -- . dataAccessRoleArn :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'StartDominantLanguageDetectionJob' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'clientRequestToken', 'startDominantLanguageDetectionJob_clientRequestToken' - A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. -- -- 'jobName', 'startDominantLanguageDetectionJob_jobName' - An identifier for the job. -- -- 'tags', '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. -- -- 'volumeKmsKeyId', '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\"@ -- -- 'vpcConfig', '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 -- . -- -- 'inputDataConfig', 'startDominantLanguageDetectionJob_inputDataConfig' - Specifies the format and location of the input data for the job. -- -- 'outputDataConfig', 'startDominantLanguageDetectionJob_outputDataConfig' - Specifies where to send the output files. -- -- 'dataAccessRoleArn', '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 -- . newStartDominantLanguageDetectionJob :: -- | 'inputDataConfig' InputDataConfig -> -- | 'outputDataConfig' OutputDataConfig -> -- | 'dataAccessRoleArn' Prelude.Text -> StartDominantLanguageDetectionJob newStartDominantLanguageDetectionJob pInputDataConfig_ pOutputDataConfig_ pDataAccessRoleArn_ = StartDominantLanguageDetectionJob' { clientRequestToken = Prelude.Nothing, jobName = Prelude.Nothing, tags = Prelude.Nothing, volumeKmsKeyId = Prelude.Nothing, vpcConfig = Prelude.Nothing, inputDataConfig = pInputDataConfig_, outputDataConfig = pOutputDataConfig_, dataAccessRoleArn = pDataAccessRoleArn_ } -- | A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. startDominantLanguageDetectionJob_clientRequestToken :: Lens.Lens' StartDominantLanguageDetectionJob (Prelude.Maybe Prelude.Text) startDominantLanguageDetectionJob_clientRequestToken = Lens.lens (\StartDominantLanguageDetectionJob' {clientRequestToken} -> clientRequestToken) (\s@StartDominantLanguageDetectionJob' {} a -> s {clientRequestToken = a} :: StartDominantLanguageDetectionJob) -- | An identifier for the job. startDominantLanguageDetectionJob_jobName :: Lens.Lens' StartDominantLanguageDetectionJob (Prelude.Maybe Prelude.Text) startDominantLanguageDetectionJob_jobName = Lens.lens (\StartDominantLanguageDetectionJob' {jobName} -> jobName) (\s@StartDominantLanguageDetectionJob' {} a -> s {jobName = a} :: StartDominantLanguageDetectionJob) -- | 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_tags :: Lens.Lens' StartDominantLanguageDetectionJob (Prelude.Maybe [Tag]) startDominantLanguageDetectionJob_tags = Lens.lens (\StartDominantLanguageDetectionJob' {tags} -> tags) (\s@StartDominantLanguageDetectionJob' {} a -> s {tags = a} :: StartDominantLanguageDetectionJob) Prelude.. Lens.mapping Lens.coerced -- | 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_volumeKmsKeyId :: Lens.Lens' StartDominantLanguageDetectionJob (Prelude.Maybe Prelude.Text) startDominantLanguageDetectionJob_volumeKmsKeyId = Lens.lens (\StartDominantLanguageDetectionJob' {volumeKmsKeyId} -> volumeKmsKeyId) (\s@StartDominantLanguageDetectionJob' {} a -> s {volumeKmsKeyId = a} :: StartDominantLanguageDetectionJob) -- | 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 -- . startDominantLanguageDetectionJob_vpcConfig :: Lens.Lens' StartDominantLanguageDetectionJob (Prelude.Maybe VpcConfig) startDominantLanguageDetectionJob_vpcConfig = Lens.lens (\StartDominantLanguageDetectionJob' {vpcConfig} -> vpcConfig) (\s@StartDominantLanguageDetectionJob' {} a -> s {vpcConfig = a} :: StartDominantLanguageDetectionJob) -- | Specifies the format and location of the input data for the job. startDominantLanguageDetectionJob_inputDataConfig :: Lens.Lens' StartDominantLanguageDetectionJob InputDataConfig startDominantLanguageDetectionJob_inputDataConfig = Lens.lens (\StartDominantLanguageDetectionJob' {inputDataConfig} -> inputDataConfig) (\s@StartDominantLanguageDetectionJob' {} a -> s {inputDataConfig = a} :: StartDominantLanguageDetectionJob) -- | Specifies where to send the output files. startDominantLanguageDetectionJob_outputDataConfig :: Lens.Lens' StartDominantLanguageDetectionJob OutputDataConfig startDominantLanguageDetectionJob_outputDataConfig = Lens.lens (\StartDominantLanguageDetectionJob' {outputDataConfig} -> outputDataConfig) (\s@StartDominantLanguageDetectionJob' {} a -> s {outputDataConfig = a} :: StartDominantLanguageDetectionJob) -- | 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 -- . startDominantLanguageDetectionJob_dataAccessRoleArn :: Lens.Lens' StartDominantLanguageDetectionJob Prelude.Text startDominantLanguageDetectionJob_dataAccessRoleArn = Lens.lens (\StartDominantLanguageDetectionJob' {dataAccessRoleArn} -> dataAccessRoleArn) (\s@StartDominantLanguageDetectionJob' {} a -> s {dataAccessRoleArn = a} :: StartDominantLanguageDetectionJob) instance Core.AWSRequest StartDominantLanguageDetectionJob where type AWSResponse StartDominantLanguageDetectionJob = StartDominantLanguageDetectionJobResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> StartDominantLanguageDetectionJobResponse' Prelude.<$> (x Data..?> "JobArn") Prelude.<*> (x Data..?> "JobId") Prelude.<*> (x Data..?> "JobStatus") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable StartDominantLanguageDetectionJob where hashWithSalt _salt StartDominantLanguageDetectionJob' {..} = _salt `Prelude.hashWithSalt` clientRequestToken `Prelude.hashWithSalt` jobName `Prelude.hashWithSalt` tags `Prelude.hashWithSalt` volumeKmsKeyId `Prelude.hashWithSalt` vpcConfig `Prelude.hashWithSalt` inputDataConfig `Prelude.hashWithSalt` outputDataConfig `Prelude.hashWithSalt` dataAccessRoleArn instance Prelude.NFData StartDominantLanguageDetectionJob where rnf StartDominantLanguageDetectionJob' {..} = Prelude.rnf clientRequestToken `Prelude.seq` Prelude.rnf jobName `Prelude.seq` Prelude.rnf tags `Prelude.seq` Prelude.rnf volumeKmsKeyId `Prelude.seq` Prelude.rnf vpcConfig `Prelude.seq` Prelude.rnf inputDataConfig `Prelude.seq` Prelude.rnf outputDataConfig `Prelude.seq` Prelude.rnf dataAccessRoleArn instance Data.ToHeaders StartDominantLanguageDetectionJob where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "Comprehend_20171127.StartDominantLanguageDetectionJob" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON StartDominantLanguageDetectionJob where toJSON StartDominantLanguageDetectionJob' {..} = Data.object ( Prelude.catMaybes [ ("ClientRequestToken" Data..=) Prelude.<$> clientRequestToken, ("JobName" Data..=) Prelude.<$> jobName, ("Tags" Data..=) Prelude.<$> tags, ("VolumeKmsKeyId" Data..=) Prelude.<$> volumeKmsKeyId, ("VpcConfig" Data..=) Prelude.<$> vpcConfig, Prelude.Just ("InputDataConfig" Data..= inputDataConfig), Prelude.Just ("OutputDataConfig" Data..= outputDataConfig), Prelude.Just ("DataAccessRoleArn" Data..= dataAccessRoleArn) ] ) instance Data.ToPath StartDominantLanguageDetectionJob where toPath = Prelude.const "/" instance Data.ToQuery StartDominantLanguageDetectionJob where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newStartDominantLanguageDetectionJobResponse' smart constructor. data StartDominantLanguageDetectionJobResponse = StartDominantLanguageDetectionJobResponse' { -- | 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:\:comprehend:\:\:dominant-language-detection-job\/\@ -- -- The following is an example job ARN: -- -- @arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job\/1234abcd12ab34cd56ef1234567890ab@ jobArn :: Prelude.Maybe Prelude.Text, -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. jobId :: Prelude.Maybe Prelude.Text, -- | 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. jobStatus :: Prelude.Maybe JobStatus, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'StartDominantLanguageDetectionJobResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'jobArn', '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:\:comprehend:\:\:dominant-language-detection-job\/\@ -- -- The following is an example job ARN: -- -- @arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job\/1234abcd12ab34cd56ef1234567890ab@ -- -- 'jobId', 'startDominantLanguageDetectionJobResponse_jobId' - The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. -- -- 'jobStatus', '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. -- -- 'httpStatus', 'startDominantLanguageDetectionJobResponse_httpStatus' - The response's http status code. newStartDominantLanguageDetectionJobResponse :: -- | 'httpStatus' Prelude.Int -> StartDominantLanguageDetectionJobResponse newStartDominantLanguageDetectionJobResponse pHttpStatus_ = StartDominantLanguageDetectionJobResponse' { jobArn = Prelude.Nothing, jobId = Prelude.Nothing, jobStatus = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | 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:\:comprehend:\:\:dominant-language-detection-job\/\@ -- -- The following is an example job ARN: -- -- @arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job\/1234abcd12ab34cd56ef1234567890ab@ startDominantLanguageDetectionJobResponse_jobArn :: Lens.Lens' StartDominantLanguageDetectionJobResponse (Prelude.Maybe Prelude.Text) startDominantLanguageDetectionJobResponse_jobArn = Lens.lens (\StartDominantLanguageDetectionJobResponse' {jobArn} -> jobArn) (\s@StartDominantLanguageDetectionJobResponse' {} a -> s {jobArn = a} :: StartDominantLanguageDetectionJobResponse) -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. startDominantLanguageDetectionJobResponse_jobId :: Lens.Lens' StartDominantLanguageDetectionJobResponse (Prelude.Maybe Prelude.Text) startDominantLanguageDetectionJobResponse_jobId = Lens.lens (\StartDominantLanguageDetectionJobResponse' {jobId} -> jobId) (\s@StartDominantLanguageDetectionJobResponse' {} a -> s {jobId = a} :: StartDominantLanguageDetectionJobResponse) -- | 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_jobStatus :: Lens.Lens' StartDominantLanguageDetectionJobResponse (Prelude.Maybe JobStatus) startDominantLanguageDetectionJobResponse_jobStatus = Lens.lens (\StartDominantLanguageDetectionJobResponse' {jobStatus} -> jobStatus) (\s@StartDominantLanguageDetectionJobResponse' {} a -> s {jobStatus = a} :: StartDominantLanguageDetectionJobResponse) -- | The response's http status code. startDominantLanguageDetectionJobResponse_httpStatus :: Lens.Lens' StartDominantLanguageDetectionJobResponse Prelude.Int startDominantLanguageDetectionJobResponse_httpStatus = Lens.lens (\StartDominantLanguageDetectionJobResponse' {httpStatus} -> httpStatus) (\s@StartDominantLanguageDetectionJobResponse' {} a -> s {httpStatus = a} :: StartDominantLanguageDetectionJobResponse) instance Prelude.NFData StartDominantLanguageDetectionJobResponse where rnf StartDominantLanguageDetectionJobResponse' {..} = Prelude.rnf jobArn `Prelude.seq` Prelude.rnf jobId `Prelude.seq` Prelude.rnf jobStatus `Prelude.seq` Prelude.rnf httpStatus