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

Description

Synopsis

Documentation

data EntitiesDetectionJobProperties Source #

Provides information about an entities detection job.

See: newEntitiesDetectionJobProperties smart constructor.

Constructors

EntitiesDetectionJobProperties'

Fields

languageCode :: Maybe LanguageCode
The language code of the input documents.
jobId :: Maybe Text
The identifier assigned to the entities detection job.
jobArn :: Maybe Text
The Amazon Resource Name (ARN) of the entities 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>:entities-detection-job/<job-id>
```
The following is an example job ARN:
```
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
```
entityRecognizerArn :: Maybe Text
The Amazon Resource Name (ARN) that identifies the entity recognizer.
jobName :: Maybe Text
The name that you assigned the entities detection job.
inputDataConfig :: Maybe InputDataConfig
The input data configuration that you supplied when you created the entities detection job.
vpcConfig :: Maybe VpcConfig
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
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"
endTime :: Maybe POSIX
The time that the entities detection job completed
outputDataConfig :: Maybe OutputDataConfig
The output data configuration that you supplied when you created the entities detection job.
dataAccessRoleArn :: Maybe Text
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
jobStatus :: Maybe JobStatus
The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
message :: Maybe Text
A description of the status of a job.
submitTime :: Maybe POSIX
The time that the entities detection job was submitted for processing.

Instances

Instances details

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

newEntitiesDetectionJobProperties :: EntitiesDetectionJobProperties Source #

Create a value of EntitiesDetectionJobProperties 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:languageCode:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_languageCode - The language code of the input documents.

$sel:jobId:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobId - The identifier assigned to the entities detection job.

$sel:jobArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the entities 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>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:entityRecognizerArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.

$sel:jobName:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobName - The name that you assigned the entities detection job.

$sel:inputDataConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the entities detection job.

$sel:vpcConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_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:endTime:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_endTime - The time that the entities detection job completed

$sel:outputDataConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the entities detection job.

$sel:dataAccessRoleArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

$sel:jobStatus:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobStatus - The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

$sel:message:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_message - A description of the status of a job.

$sel:submitTime:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_submitTime - The time that the entities detection job was submitted for processing.

entitiesDetectionJobProperties_languageCode :: Lens' EntitiesDetectionJobProperties (Maybe LanguageCode) Source #

The language code of the input documents.

entitiesDetectionJobProperties_jobId :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #

The identifier assigned to the entities detection job.

entitiesDetectionJobProperties_jobArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #

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

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

entitiesDetectionJobProperties_entityRecognizerArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #

The Amazon Resource Name (ARN) that identifies the entity recognizer.

entitiesDetectionJobProperties_jobName :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #

The name that you assigned the entities detection job.

entitiesDetectionJobProperties_inputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe InputDataConfig) Source #

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

entitiesDetectionJobProperties_vpcConfig :: Lens' EntitiesDetectionJobProperties (Maybe VpcConfig) Source #

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

entitiesDetectionJobProperties_volumeKmsKeyId :: Lens' EntitiesDetectionJobProperties (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"

entitiesDetectionJobProperties_endTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) Source #

The time that the entities detection job completed

entitiesDetectionJobProperties_outputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe OutputDataConfig) Source #

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

entitiesDetectionJobProperties_dataAccessRoleArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #

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

entitiesDetectionJobProperties_jobStatus :: Lens' EntitiesDetectionJobProperties (Maybe JobStatus) Source #

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

entitiesDetectionJobProperties_message :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #

A description of the status of a job.

entitiesDetectionJobProperties_submitTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) Source #

The time that the entities detection job was submitted for processing.