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 |
Synopsis
- data EntitiesDetectionJobProperties = EntitiesDetectionJobProperties' {
- dataAccessRoleArn :: Maybe Text
- endTime :: Maybe POSIX
- entityRecognizerArn :: Maybe Text
- inputDataConfig :: Maybe InputDataConfig
- jobArn :: Maybe Text
- jobId :: Maybe Text
- jobName :: Maybe Text
- jobStatus :: Maybe JobStatus
- languageCode :: Maybe LanguageCode
- message :: Maybe Text
- outputDataConfig :: Maybe OutputDataConfig
- submitTime :: Maybe POSIX
- volumeKmsKeyId :: Maybe Text
- vpcConfig :: Maybe VpcConfig
- newEntitiesDetectionJobProperties :: EntitiesDetectionJobProperties
- entitiesDetectionJobProperties_dataAccessRoleArn :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_endTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime)
- entitiesDetectionJobProperties_entityRecognizerArn :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_inputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe InputDataConfig)
- entitiesDetectionJobProperties_jobArn :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_jobId :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_jobName :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_jobStatus :: Lens' EntitiesDetectionJobProperties (Maybe JobStatus)
- entitiesDetectionJobProperties_languageCode :: Lens' EntitiesDetectionJobProperties (Maybe LanguageCode)
- entitiesDetectionJobProperties_message :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_outputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe OutputDataConfig)
- entitiesDetectionJobProperties_submitTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime)
- entitiesDetectionJobProperties_volumeKmsKeyId :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_vpcConfig :: Lens' EntitiesDetectionJobProperties (Maybe VpcConfig)
Documentation
data EntitiesDetectionJobProperties Source #
Provides information about an entities detection job.
See: newEntitiesDetectionJobProperties
smart constructor.
EntitiesDetectionJobProperties' | |
|
Instances
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:dataAccessRoleArn:EntitiesDetectionJobProperties'
, entitiesDetectionJobProperties_dataAccessRoleArn
- The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
$sel:endTime:EntitiesDetectionJobProperties'
, entitiesDetectionJobProperties_endTime
- The time that the entities detection job completed
$sel:entityRecognizerArn:EntitiesDetectionJobProperties'
, entitiesDetectionJobProperties_entityRecognizerArn
- The Amazon Resource Name (ARN) that identifies the entity recognizer.
$sel:inputDataConfig:EntitiesDetectionJobProperties'
, entitiesDetectionJobProperties_inputDataConfig
- The input data configuration that you supplied when you created 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:jobId:EntitiesDetectionJobProperties'
, entitiesDetectionJobProperties_jobId
- The identifier assigned to the entities detection job.
$sel:jobName:EntitiesDetectionJobProperties'
, entitiesDetectionJobProperties_jobName
- The name that you assigned the entities detection job.
$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:languageCode:EntitiesDetectionJobProperties'
, entitiesDetectionJobProperties_languageCode
- The language code of the input documents.
$sel:message:EntitiesDetectionJobProperties'
, entitiesDetectionJobProperties_message
- A description of the status of a job.
$sel:outputDataConfig:EntitiesDetectionJobProperties'
, entitiesDetectionJobProperties_outputDataConfig
- The output data configuration that you supplied when you created the
entities detection job.
$sel:submitTime:EntitiesDetectionJobProperties'
, entitiesDetectionJobProperties_submitTime
- The time that the entities detection job was submitted for processing.
$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: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.
entitiesDetectionJobProperties_dataAccessRoleArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
entitiesDetectionJobProperties_endTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) Source #
The time that the entities detection job completed
entitiesDetectionJobProperties_entityRecognizerArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the entity recognizer.
entitiesDetectionJobProperties_inputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created 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_jobId :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the entities detection job.
entitiesDetectionJobProperties_jobName :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The name that you assigned the entities detection job.
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_languageCode :: Lens' EntitiesDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents.
entitiesDetectionJobProperties_message :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
A description of the status of a job.
entitiesDetectionJobProperties_outputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the entities detection job.
entitiesDetectionJobProperties_submitTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) Source #
The time that the entities detection job was submitted for processing.
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_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.