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

Amazonka.Comprehend.StartDocumentClassificationJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts an asynchronous document classification job. Use the operation to track the progress of the job.

Synopsis

Creating a Request

data StartDocumentClassificationJob Source #

See: newStartDocumentClassificationJob smart constructor.

Constructors

StartDocumentClassificationJob'

Fields

clientRequestToken :: Maybe Text
A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
jobName :: Maybe Text
The identifier of the job.
tags :: Maybe [Tag]
Tags to be associated with the document classification 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 :: Maybe Text
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 :: Maybe VpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
documentClassifierArn :: Text
The Amazon Resource Name (ARN) of the document classifier to use to process the job.
inputDataConfig :: InputDataConfig
Specifies the format and location of the input data for the job.
outputDataConfig :: OutputDataConfig
Specifies where to send the output files.
dataAccessRoleArn :: Text
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Instances

Instances details

ToJSON StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods toJSON :: StartDocumentClassificationJob -> Value # toEncoding :: StartDocumentClassificationJob -> Encoding # toJSONList :: [StartDocumentClassificationJob] -> Value # toEncodingList :: [StartDocumentClassificationJob] -> Encoding #
ToHeaders StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods toHeaders :: StartDocumentClassificationJob -> [Header] #
ToPath StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods toPath :: StartDocumentClassificationJob -> ByteString #
ToQuery StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods toQuery :: StartDocumentClassificationJob -> QueryString #
AWSRequest StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Associated Types type AWSResponse StartDocumentClassificationJob # Methods request :: (Service -> Service) -> StartDocumentClassificationJob -> Request StartDocumentClassificationJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartDocumentClassificationJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartDocumentClassificationJob))) #
Generic StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Associated Types type Rep StartDocumentClassificationJob :: Type -> Type # Methods from :: StartDocumentClassificationJob -> Rep StartDocumentClassificationJob x # to :: Rep StartDocumentClassificationJob x -> StartDocumentClassificationJob #
Read StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods readsPrec :: Int -> ReadS StartDocumentClassificationJob # readList :: ReadS [StartDocumentClassificationJob] # readPrec :: ReadPrec StartDocumentClassificationJob # readListPrec :: ReadPrec [StartDocumentClassificationJob] #
Show StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods showsPrec :: Int -> StartDocumentClassificationJob -> ShowS # show :: StartDocumentClassificationJob -> String # showList :: [StartDocumentClassificationJob] -> ShowS #
NFData StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods rnf :: StartDocumentClassificationJob -> () #
Eq StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods (==) :: StartDocumentClassificationJob -> StartDocumentClassificationJob -> Bool # (/=) :: StartDocumentClassificationJob -> StartDocumentClassificationJob -> Bool #
Hashable StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods hashWithSalt :: Int -> StartDocumentClassificationJob -> Int # hash :: StartDocumentClassificationJob -> Int #
type AWSResponse StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob type AWSResponse StartDocumentClassificationJob = StartDocumentClassificationJobResponse
type Rep StartDocumentClassificationJob Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob type Rep StartDocumentClassificationJob = D1 ('MetaData "StartDocumentClassificationJob" "Amazonka.Comprehend.StartDocumentClassificationJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StartDocumentClassificationJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :: S1 ('MetaSel ('Just "documentClassifierArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig) :: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig) :: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newStartDocumentClassificationJob Source #

Arguments

:: Text	`StartDocumentClassificationJob`
-> InputDataConfig	`StartDocumentClassificationJob`
-> OutputDataConfig	`StartDocumentClassificationJob`
-> Text	`StartDocumentClassificationJob`
-> StartDocumentClassificationJob

Create a value of StartDocumentClassificationJob 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:StartDocumentClassificationJob', startDocumentClassificationJob_clientRequestToken - A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

StartDocumentClassificationJob, startDocumentClassificationJob_jobName - The identifier of the job.

$sel:tags:StartDocumentClassificationJob', startDocumentClassificationJob_tags - Tags to be associated with the document classification 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.

StartDocumentClassificationJob, startDocumentClassificationJob_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"

StartDocumentClassificationJob, startDocumentClassificationJob_vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

StartDocumentClassificationJob, startDocumentClassificationJob_documentClassifierArn - The Amazon Resource Name (ARN) of the document classifier to use to process the job.

StartDocumentClassificationJob, startDocumentClassificationJob_inputDataConfig - Specifies the format and location of the input data for the job.

StartDocumentClassificationJob, startDocumentClassificationJob_outputDataConfig - Specifies where to send the output files.

StartDocumentClassificationJob, startDocumentClassificationJob_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.

Request Lenses

startDocumentClassificationJob_clientRequestToken :: Lens' StartDocumentClassificationJob (Maybe Text) Source #

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

startDocumentClassificationJob_jobName :: Lens' StartDocumentClassificationJob (Maybe Text) Source #

The identifier of the job.

startDocumentClassificationJob_tags :: Lens' StartDocumentClassificationJob (Maybe [Tag]) Source #

Tags to be associated with the document classification 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.

startDocumentClassificationJob_volumeKmsKeyId :: Lens' StartDocumentClassificationJob (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"

startDocumentClassificationJob_vpcConfig :: Lens' StartDocumentClassificationJob (Maybe VpcConfig) Source #

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

startDocumentClassificationJob_documentClassifierArn :: Lens' StartDocumentClassificationJob Text Source #

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

startDocumentClassificationJob_inputDataConfig :: Lens' StartDocumentClassificationJob InputDataConfig Source #

Specifies the format and location of the input data for the job.

startDocumentClassificationJob_outputDataConfig :: Lens' StartDocumentClassificationJob OutputDataConfig Source #

Specifies where to send the output files.

startDocumentClassificationJob_dataAccessRoleArn :: Lens' StartDocumentClassificationJob 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.

Destructuring the Response

data StartDocumentClassificationJobResponse Source #

See: newStartDocumentClassificationJobResponse smart constructor.

Constructors

StartDocumentClassificationJobResponse'

Fields

jobArn :: Maybe Text
The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job/<job-id>
```
The following is an example job ARN:
```
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
```
jobId :: Maybe Text
The identifier generated for the job. To get the status of the job, use this identifier with the operation.
jobStatus :: Maybe JobStatus
The status of the job:
- SUBMITTED - The job has been received and 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. For details, use the operation.
- STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
- STOPPED - The job was successfully stopped without completing.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StartDocumentClassificationJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Associated Types type Rep StartDocumentClassificationJobResponse :: Type -> Type # Methods from :: StartDocumentClassificationJobResponse -> Rep StartDocumentClassificationJobResponse x # to :: Rep StartDocumentClassificationJobResponse x -> StartDocumentClassificationJobResponse #
Read StartDocumentClassificationJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods readsPrec :: Int -> ReadS StartDocumentClassificationJobResponse # readList :: ReadS [StartDocumentClassificationJobResponse] # readPrec :: ReadPrec StartDocumentClassificationJobResponse # readListPrec :: ReadPrec [StartDocumentClassificationJobResponse] #
Show StartDocumentClassificationJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods showsPrec :: Int -> StartDocumentClassificationJobResponse -> ShowS # show :: StartDocumentClassificationJobResponse -> String # showList :: [StartDocumentClassificationJobResponse] -> ShowS #
NFData StartDocumentClassificationJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods rnf :: StartDocumentClassificationJobResponse -> () #
Eq StartDocumentClassificationJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob Methods (==) :: StartDocumentClassificationJobResponse -> StartDocumentClassificationJobResponse -> Bool # (/=) :: StartDocumentClassificationJobResponse -> StartDocumentClassificationJobResponse -> Bool #
type Rep StartDocumentClassificationJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartDocumentClassificationJob type Rep StartDocumentClassificationJobResponse = D1 ('MetaData "StartDocumentClassificationJobResponse" "Amazonka.Comprehend.StartDocumentClassificationJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StartDocumentClassificationJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartDocumentClassificationJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartDocumentClassificationJobResponse'`
-> StartDocumentClassificationJobResponse

Create a value of StartDocumentClassificationJobResponse 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:

StartDocumentClassificationJobResponse, startDocumentClassificationJobResponse_jobArn - The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

StartDocumentClassificationJobResponse, startDocumentClassificationJobResponse_jobId - The identifier generated for the job. To get the status of the job, use this identifier with the operation.

StartDocumentClassificationJobResponse, startDocumentClassificationJobResponse_jobStatus - The status of the job:

SUBMITTED - The job has been received and 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. For details, use the operation.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
STOPPED - The job was successfully stopped without completing.

$sel:httpStatus:StartDocumentClassificationJobResponse', startDocumentClassificationJobResponse_httpStatus - The response's http status code.

Response Lenses

startDocumentClassificationJobResponse_jobArn :: Lens' StartDocumentClassificationJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

startDocumentClassificationJobResponse_jobId :: Lens' StartDocumentClassificationJobResponse (Maybe Text) Source #

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

startDocumentClassificationJobResponse_jobStatus :: Lens' StartDocumentClassificationJobResponse (Maybe JobStatus) Source #

The status of the job:

SUBMITTED - The job has been received and 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. For details, use the operation.
STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
STOPPED - The job was successfully stopped without completing.

startDocumentClassificationJobResponse_httpStatus :: Lens' StartDocumentClassificationJobResponse Int Source #

The response's http status code.