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 ComprehendMedicalAsyncJobProperties = ComprehendMedicalAsyncJobProperties' {
- dataAccessRoleArn :: Maybe Text
- endTime :: Maybe POSIX
- expirationTime :: Maybe POSIX
- inputDataConfig :: Maybe InputDataConfig
- jobId :: Maybe Text
- jobName :: Maybe Text
- jobStatus :: Maybe JobStatus
- kmsKey :: Maybe Text
- languageCode :: Maybe LanguageCode
- manifestFilePath :: Maybe Text
- message :: Maybe Text
- modelVersion :: Maybe Text
- outputDataConfig :: Maybe OutputDataConfig
- submitTime :: Maybe POSIX
- newComprehendMedicalAsyncJobProperties :: ComprehendMedicalAsyncJobProperties
- comprehendMedicalAsyncJobProperties_dataAccessRoleArn :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text)
- comprehendMedicalAsyncJobProperties_endTime :: Lens' ComprehendMedicalAsyncJobProperties (Maybe UTCTime)
- comprehendMedicalAsyncJobProperties_expirationTime :: Lens' ComprehendMedicalAsyncJobProperties (Maybe UTCTime)
- comprehendMedicalAsyncJobProperties_inputDataConfig :: Lens' ComprehendMedicalAsyncJobProperties (Maybe InputDataConfig)
- comprehendMedicalAsyncJobProperties_jobId :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text)
- comprehendMedicalAsyncJobProperties_jobName :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text)
- comprehendMedicalAsyncJobProperties_jobStatus :: Lens' ComprehendMedicalAsyncJobProperties (Maybe JobStatus)
- comprehendMedicalAsyncJobProperties_kmsKey :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text)
- comprehendMedicalAsyncJobProperties_languageCode :: Lens' ComprehendMedicalAsyncJobProperties (Maybe LanguageCode)
- comprehendMedicalAsyncJobProperties_manifestFilePath :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text)
- comprehendMedicalAsyncJobProperties_message :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text)
- comprehendMedicalAsyncJobProperties_modelVersion :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text)
- comprehendMedicalAsyncJobProperties_outputDataConfig :: Lens' ComprehendMedicalAsyncJobProperties (Maybe OutputDataConfig)
- comprehendMedicalAsyncJobProperties_submitTime :: Lens' ComprehendMedicalAsyncJobProperties (Maybe UTCTime)
Documentation
data ComprehendMedicalAsyncJobProperties Source #
Provides information about a detection job.
See: newComprehendMedicalAsyncJobProperties
smart constructor.
ComprehendMedicalAsyncJobProperties' | |
|
Instances
newComprehendMedicalAsyncJobProperties :: ComprehendMedicalAsyncJobProperties Source #
Create a value of ComprehendMedicalAsyncJobProperties
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:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_dataAccessRoleArn
- The Amazon Resource Name (ARN) that gives Comprehend Medical; read
access to your input data.
$sel:endTime:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_endTime
- The time that the detection job completed.
$sel:expirationTime:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_expirationTime
- The date and time that job metadata is deleted from the server. Output
files in your S3 bucket will not be deleted. After the metadata is
deleted, the job will no longer appear in the results of the
ListEntitiesDetectionV2Job
or the ListPHIDetectionJobs
operation.
$sel:inputDataConfig:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_inputDataConfig
- The input data configuration that you supplied when you created the
detection job.
$sel:jobId:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_jobId
- The identifier assigned to the detection job.
$sel:jobName:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_jobName
- The name that you assigned to the detection job.
$sel:jobStatus:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_jobStatus
- The current status of the detection job. If the status is FAILED
, the
Message
field shows the reason for the failure.
$sel:kmsKey:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_kmsKey
- The AWS Key Management Service key, if any, used to encrypt the output
files.
$sel:languageCode:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_languageCode
- The language code of the input documents.
$sel:manifestFilePath:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_manifestFilePath
- The path to the file that describes the results of a batch job.
$sel:message:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_message
- A description of the status of a job.
$sel:modelVersion:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_modelVersion
- The version of the model used to analyze the documents. The version
number looks like X.X.X. You can use this information to track the model
used for a particular batch of documents.
$sel:outputDataConfig:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_outputDataConfig
- The output data configuration that you supplied when you created the
detection job.
$sel:submitTime:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_submitTime
- The time that the detection job was submitted for processing.
comprehendMedicalAsyncJobProperties_dataAccessRoleArn :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.
comprehendMedicalAsyncJobProperties_endTime :: Lens' ComprehendMedicalAsyncJobProperties (Maybe UTCTime) Source #
The time that the detection job completed.
comprehendMedicalAsyncJobProperties_expirationTime :: Lens' ComprehendMedicalAsyncJobProperties (Maybe UTCTime) Source #
The date and time that job metadata is deleted from the server. Output
files in your S3 bucket will not be deleted. After the metadata is
deleted, the job will no longer appear in the results of the
ListEntitiesDetectionV2Job
or the ListPHIDetectionJobs
operation.
comprehendMedicalAsyncJobProperties_inputDataConfig :: Lens' ComprehendMedicalAsyncJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created the detection job.
comprehendMedicalAsyncJobProperties_jobId :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #
The identifier assigned to the detection job.
comprehendMedicalAsyncJobProperties_jobName :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #
The name that you assigned to the detection job.
comprehendMedicalAsyncJobProperties_jobStatus :: Lens' ComprehendMedicalAsyncJobProperties (Maybe JobStatus) Source #
The current status of the detection job. If the status is FAILED
, the
Message
field shows the reason for the failure.
comprehendMedicalAsyncJobProperties_kmsKey :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #
The AWS Key Management Service key, if any, used to encrypt the output files.
comprehendMedicalAsyncJobProperties_languageCode :: Lens' ComprehendMedicalAsyncJobProperties (Maybe LanguageCode) Source #
The language code of the input documents.
comprehendMedicalAsyncJobProperties_manifestFilePath :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #
The path to the file that describes the results of a batch job.
comprehendMedicalAsyncJobProperties_message :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #
A description of the status of a job.
comprehendMedicalAsyncJobProperties_modelVersion :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #
The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.
comprehendMedicalAsyncJobProperties_outputDataConfig :: Lens' ComprehendMedicalAsyncJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the detection job.
comprehendMedicalAsyncJobProperties_submitTime :: Lens' ComprehendMedicalAsyncJobProperties (Maybe UTCTime) Source #
The time that the detection job was submitted for processing.