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.Types.KeyPhrasesDetectionJobProperties

Description

Synopsis

Documentation

data KeyPhrasesDetectionJobProperties Source #

Provides information about a key phrases detection job.

See: newKeyPhrasesDetectionJobProperties smart constructor.

Constructors

KeyPhrasesDetectionJobProperties'

Fields

dataAccessRoleArn :: Maybe Text
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
endTime :: Maybe POSIX
The time that the key phrases detection job completed.
inputDataConfig :: Maybe InputDataConfig
The input data configuration that you supplied when you created the key phrases detection job.
jobArn :: Maybe Text
The Amazon Resource Name (ARN) of the key phrases 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 assigned to the key phrases detection job.
jobName :: Maybe Text
The name that you assigned the key phrases detection job.
jobStatus :: Maybe JobStatus
The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.
languageCode :: Maybe LanguageCode
The language code of the input documents.
message :: Maybe Text
A description of the status of a job.
outputDataConfig :: Maybe OutputDataConfig
The output data configuration that you supplied when you created the key phrases detection job.
submitTime :: Maybe POSIX
The time that the key phrases detection job was submitted for processing.
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 a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.

Instances

Instances details

FromJSON KeyPhrasesDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties Methods parseJSON :: Value -> Parser KeyPhrasesDetectionJobProperties # parseJSONList :: Value -> Parser [KeyPhrasesDetectionJobProperties] #
Generic KeyPhrasesDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties Associated Types type Rep KeyPhrasesDetectionJobProperties :: Type -> Type # Methods from :: KeyPhrasesDetectionJobProperties -> Rep KeyPhrasesDetectionJobProperties x # to :: Rep KeyPhrasesDetectionJobProperties x -> KeyPhrasesDetectionJobProperties #
Read KeyPhrasesDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties Methods readsPrec :: Int -> ReadS KeyPhrasesDetectionJobProperties # readList :: ReadS [KeyPhrasesDetectionJobProperties] # readPrec :: ReadPrec KeyPhrasesDetectionJobProperties # readListPrec :: ReadPrec [KeyPhrasesDetectionJobProperties] #
Show KeyPhrasesDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties Methods showsPrec :: Int -> KeyPhrasesDetectionJobProperties -> ShowS # show :: KeyPhrasesDetectionJobProperties -> String # showList :: [KeyPhrasesDetectionJobProperties] -> ShowS #
NFData KeyPhrasesDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties Methods rnf :: KeyPhrasesDetectionJobProperties -> () #
Eq KeyPhrasesDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties Methods (==) :: KeyPhrasesDetectionJobProperties -> KeyPhrasesDetectionJobProperties -> Bool # (/=) :: KeyPhrasesDetectionJobProperties -> KeyPhrasesDetectionJobProperties -> Bool #
Hashable KeyPhrasesDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties Methods hashWithSalt :: Int -> KeyPhrasesDetectionJobProperties -> Int # hash :: KeyPhrasesDetectionJobProperties -> Int #
type Rep KeyPhrasesDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties type Rep KeyPhrasesDetectionJobProperties = D1 ('MetaData "KeyPhrasesDetectionJobProperties" "Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "KeyPhrasesDetectionJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)))) :: (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputDataConfig)) :: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)))))))

newKeyPhrasesDetectionJobProperties :: KeyPhrasesDetectionJobProperties Source #

Create a value of KeyPhrasesDetectionJobProperties 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:dataAccessRoleArn:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

$sel:endTime:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_endTime - The time that the key phrases detection job completed.

$sel:inputDataConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the key phrases detection job.

$sel:jobArn:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the key phrases 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:jobId:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobId - The identifier assigned to the key phrases detection job.

$sel:jobName:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobName - The name that you assigned the key phrases detection job.

$sel:jobStatus:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobStatus - The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

$sel:languageCode:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_languageCode - The language code of the input documents.

$sel:message:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_message - A description of the status of a job.

$sel:outputDataConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the key phrases detection job.

$sel:submitTime:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_submitTime - The time that the key phrases detection job was submitted for processing.

$sel:volumeKmsKeyId:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_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:vpcConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.

keyPhrasesDetectionJobProperties_dataAccessRoleArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

keyPhrasesDetectionJobProperties_endTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) Source #

The time that the key phrases detection job completed.

keyPhrasesDetectionJobProperties_inputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe InputDataConfig) Source #

The input data configuration that you supplied when you created the key phrases detection job.

keyPhrasesDetectionJobProperties_jobArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #

The Amazon Resource Name (ARN) of the key phrases 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

keyPhrasesDetectionJobProperties_jobId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #

The identifier assigned to the key phrases detection job.

keyPhrasesDetectionJobProperties_jobName :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #

The name that you assigned the key phrases detection job.

keyPhrasesDetectionJobProperties_jobStatus :: Lens' KeyPhrasesDetectionJobProperties (Maybe JobStatus) Source #

The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

keyPhrasesDetectionJobProperties_languageCode :: Lens' KeyPhrasesDetectionJobProperties (Maybe LanguageCode) Source #

The language code of the input documents.

keyPhrasesDetectionJobProperties_message :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #

A description of the status of a job.

keyPhrasesDetectionJobProperties_outputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe OutputDataConfig) Source #

The output data configuration that you supplied when you created the key phrases detection job.

keyPhrasesDetectionJobProperties_submitTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) Source #

The time that the key phrases detection job was submitted for processing.

keyPhrasesDetectionJobProperties_volumeKmsKeyId :: Lens' KeyPhrasesDetectionJobProperties (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"

keyPhrasesDetectionJobProperties_vpcConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe VpcConfig) Source #

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.