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.StartKeyPhrasesDetectionJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

Synopsis

Creating a Request

data StartKeyPhrasesDetectionJob Source #

See: newStartKeyPhrasesDetectionJob smart constructor.

Constructors

StartKeyPhrasesDetectionJob'

Fields

clientRequestToken :: Maybe Text
A unique identifier for the request. If you don't 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 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.
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 key phrases detection job. For more information, see Amazon VPC.
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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
languageCode :: 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.

Instances

Instances details

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

newStartKeyPhrasesDetectionJob Source #

Arguments

:: InputDataConfig	`StartKeyPhrasesDetectionJob`
-> OutputDataConfig	`StartKeyPhrasesDetectionJob`
-> Text	`StartKeyPhrasesDetectionJob`
-> LanguageCode	`StartKeyPhrasesDetectionJob`
-> 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:clientRequestToken:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

StartKeyPhrasesDetectionJob, startKeyPhrasesDetectionJob_jobName - The identifier of the job.

$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.

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"

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.

StartKeyPhrasesDetectionJob, startKeyPhrasesDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.

StartKeyPhrasesDetectionJob, startKeyPhrasesDetectionJob_outputDataConfig - Specifies where to send the output files.

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.

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_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_jobName :: Lens' StartKeyPhrasesDetectionJob (Maybe Text) Source #

The identifier of the job.

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_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_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_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

jobArn :: Maybe Text
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
```
jobId :: Maybe Text
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
jobStatus :: Maybe 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 :: Int
The response's http status code.

Instances

Instances details

Generic StartKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob Associated Types type Rep StartKeyPhrasesDetectionJobResponse :: Type -> Type # Methods from :: StartKeyPhrasesDetectionJobResponse -> Rep StartKeyPhrasesDetectionJobResponse x # to :: Rep StartKeyPhrasesDetectionJobResponse x -> StartKeyPhrasesDetectionJobResponse #
Read StartKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob Methods readsPrec :: Int -> ReadS StartKeyPhrasesDetectionJobResponse # readList :: ReadS [StartKeyPhrasesDetectionJobResponse] # readPrec :: ReadPrec StartKeyPhrasesDetectionJobResponse # readListPrec :: ReadPrec [StartKeyPhrasesDetectionJobResponse] #
Show StartKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob Methods showsPrec :: Int -> StartKeyPhrasesDetectionJobResponse -> ShowS # show :: StartKeyPhrasesDetectionJobResponse -> String # showList :: [StartKeyPhrasesDetectionJobResponse] -> ShowS #
NFData StartKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob Methods rnf :: StartKeyPhrasesDetectionJobResponse -> () #
Eq StartKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob Methods (==) :: StartKeyPhrasesDetectionJobResponse -> StartKeyPhrasesDetectionJobResponse -> Bool # (/=) :: StartKeyPhrasesDetectionJobResponse -> StartKeyPhrasesDetectionJobResponse -> Bool #
type Rep StartKeyPhrasesDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartKeyPhrasesDetectionJob type Rep StartKeyPhrasesDetectionJobResponse = D1 ('MetaData "StartKeyPhrasesDetectionJobResponse" "Amazonka.Comprehend.StartKeyPhrasesDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StartKeyPhrasesDetectionJobResponse'" '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))))

newStartKeyPhrasesDetectionJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartKeyPhrasesDetectionJobResponse'`
-> 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:

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

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

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_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_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_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.