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.ComprehendMedical.Types.ComprehendMedicalAsyncJobProperties

Description

Synopsis

Documentation

data ComprehendMedicalAsyncJobProperties Source #

Provides information about a detection job.

See: newComprehendMedicalAsyncJobProperties smart constructor.

Constructors

ComprehendMedicalAsyncJobProperties'

Fields

languageCode :: Maybe LanguageCode
The language code of the input documents.
kmsKey :: Maybe Text
The AWS Key Management Service key, if any, used to encrypt the output files.
jobId :: Maybe Text
The identifier assigned to the detection job.
jobName :: Maybe Text
The name that you assigned to the detection job.
manifestFilePath :: Maybe Text
The path to the file that describes the results of a batch job.
inputDataConfig :: Maybe InputDataConfig
The input data configuration that you supplied when you created the detection job.
endTime :: Maybe POSIX
The time that the detection job completed.
outputDataConfig :: Maybe OutputDataConfig
The output data configuration that you supplied when you created the detection job.
modelVersion :: Maybe Text
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.
dataAccessRoleArn :: Maybe Text
The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.
jobStatus :: Maybe JobStatus
The current status of the 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.
expirationTime :: Maybe POSIX
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.
submitTime :: Maybe POSIX
The time that the detection job was submitted for processing.

Instances

Instances details

Eq ComprehendMedicalAsyncJobProperties Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.ComprehendMedicalAsyncJobProperties Methods (==) :: ComprehendMedicalAsyncJobProperties -> ComprehendMedicalAsyncJobProperties -> Bool # (/=) :: ComprehendMedicalAsyncJobProperties -> ComprehendMedicalAsyncJobProperties -> Bool #
Read ComprehendMedicalAsyncJobProperties Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.ComprehendMedicalAsyncJobProperties Methods readsPrec :: Int -> ReadS ComprehendMedicalAsyncJobProperties # readList :: ReadS [ComprehendMedicalAsyncJobProperties] # readPrec :: ReadPrec ComprehendMedicalAsyncJobProperties # readListPrec :: ReadPrec [ComprehendMedicalAsyncJobProperties] #
Show ComprehendMedicalAsyncJobProperties Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.ComprehendMedicalAsyncJobProperties Methods showsPrec :: Int -> ComprehendMedicalAsyncJobProperties -> ShowS # show :: ComprehendMedicalAsyncJobProperties -> String # showList :: [ComprehendMedicalAsyncJobProperties] -> ShowS #
Generic ComprehendMedicalAsyncJobProperties Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.ComprehendMedicalAsyncJobProperties Associated Types type Rep ComprehendMedicalAsyncJobProperties :: Type -> Type # Methods from :: ComprehendMedicalAsyncJobProperties -> Rep ComprehendMedicalAsyncJobProperties x # to :: Rep ComprehendMedicalAsyncJobProperties x -> ComprehendMedicalAsyncJobProperties #
NFData ComprehendMedicalAsyncJobProperties Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.ComprehendMedicalAsyncJobProperties Methods rnf :: ComprehendMedicalAsyncJobProperties -> () #
Hashable ComprehendMedicalAsyncJobProperties Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.ComprehendMedicalAsyncJobProperties Methods hashWithSalt :: Int -> ComprehendMedicalAsyncJobProperties -> Int # hash :: ComprehendMedicalAsyncJobProperties -> Int #
FromJSON ComprehendMedicalAsyncJobProperties Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.ComprehendMedicalAsyncJobProperties Methods parseJSON :: Value -> Parser ComprehendMedicalAsyncJobProperties # parseJSONList :: Value -> Parser [ComprehendMedicalAsyncJobProperties] #
type Rep ComprehendMedicalAsyncJobProperties Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.ComprehendMedicalAsyncJobProperties type Rep ComprehendMedicalAsyncJobProperties = D1 ('MetaData "ComprehendMedicalAsyncJobProperties" "Amazonka.ComprehendMedical.Types.ComprehendMedicalAsyncJobProperties" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "ComprehendMedicalAsyncJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :: (S1 ('MetaSel ('Just "kmsKey") '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 "manifestFilePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputDataConfig)) :: (S1 ('MetaSel ('Just "modelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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 "expirationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

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:languageCode:ComprehendMedicalAsyncJobProperties', comprehendMedicalAsyncJobProperties_languageCode - The language code of the input documents.

$sel:kmsKey:ComprehendMedicalAsyncJobProperties', comprehendMedicalAsyncJobProperties_kmsKey - The AWS Key Management Service key, if any, used to encrypt the output files.

$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:manifestFilePath:ComprehendMedicalAsyncJobProperties', comprehendMedicalAsyncJobProperties_manifestFilePath - The path to the file that describes the results of a batch job.

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

$sel:endTime:ComprehendMedicalAsyncJobProperties', comprehendMedicalAsyncJobProperties_endTime - The time that the detection job completed.

$sel:outputDataConfig:ComprehendMedicalAsyncJobProperties', comprehendMedicalAsyncJobProperties_outputDataConfig - The output data configuration that you supplied when you created the detection 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:dataAccessRoleArn:ComprehendMedicalAsyncJobProperties', comprehendMedicalAsyncJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

$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:message:ComprehendMedicalAsyncJobProperties', comprehendMedicalAsyncJobProperties_message - A description of the status of a job.

$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:submitTime:ComprehendMedicalAsyncJobProperties', comprehendMedicalAsyncJobProperties_submitTime - The time that the detection job was submitted for processing.

comprehendMedicalAsyncJobProperties_languageCode :: Lens' ComprehendMedicalAsyncJobProperties (Maybe LanguageCode) Source #

The language code of the input documents.

comprehendMedicalAsyncJobProperties_kmsKey :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #

The AWS Key Management Service key, if any, used to encrypt the output files.

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_manifestFilePath :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #

The path to the file that describes the results of a batch job.

comprehendMedicalAsyncJobProperties_inputDataConfig :: Lens' ComprehendMedicalAsyncJobProperties (Maybe InputDataConfig) Source #

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

comprehendMedicalAsyncJobProperties_endTime :: Lens' ComprehendMedicalAsyncJobProperties (Maybe UTCTime) Source #

The time that the detection job completed.

comprehendMedicalAsyncJobProperties_outputDataConfig :: Lens' ComprehendMedicalAsyncJobProperties (Maybe OutputDataConfig) Source #

The output data configuration that you supplied when you created the detection 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_dataAccessRoleArn :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #

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

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_message :: Lens' ComprehendMedicalAsyncJobProperties (Maybe Text) Source #

A description of the status of a job.

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_submitTime :: Lens' ComprehendMedicalAsyncJobProperties (Maybe UTCTime) Source #

The time that the detection job was submitted for processing.