{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Comprehend.Types.DocumentClassificationJobProperties
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Comprehend.Types.DocumentClassificationJobProperties where

import Amazonka.Comprehend.Types.InputDataConfig
import Amazonka.Comprehend.Types.JobStatus
import Amazonka.Comprehend.Types.OutputDataConfig
import Amazonka.Comprehend.Types.VpcConfig
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | Provides information about a document classification job.
--
-- /See:/ 'newDocumentClassificationJobProperties' smart constructor.
data DocumentClassificationJobProperties = DocumentClassificationJobProperties'
  { -- | The Amazon Resource Name (ARN) of the AWS identity and Access Management
    -- (IAM) role that grants Amazon Comprehend read access to your input data.
    DocumentClassificationJobProperties -> Maybe Text
dataAccessRoleArn :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) that identifies the document classifier.
    DocumentClassificationJobProperties -> Maybe Text
documentClassifierArn :: Prelude.Maybe Prelude.Text,
    -- | The time that the document classification job completed.
    DocumentClassificationJobProperties -> Maybe POSIX
endTime :: Prelude.Maybe Data.POSIX,
    -- | The input data configuration that you supplied when you created the
    -- document classification job.
    DocumentClassificationJobProperties -> Maybe InputDataConfig
inputDataConfig :: Prelude.Maybe InputDataConfig,
    -- | The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job\/\<job-id>@
    --
    -- The following is an example job ARN:
    --
    -- @arn:aws:comprehend:us-west-2:111122223333:document-classification-job\/1234abcd12ab34cd56ef1234567890ab@
    DocumentClassificationJobProperties -> Maybe Text
jobArn :: Prelude.Maybe Prelude.Text,
    -- | The identifier assigned to the document classification job.
    DocumentClassificationJobProperties -> Maybe Text
jobId :: Prelude.Maybe Prelude.Text,
    -- | The name that you assigned to the document classification job.
    DocumentClassificationJobProperties -> Maybe Text
jobName :: Prelude.Maybe Prelude.Text,
    -- | The current status of the document classification job. If the status is
    -- @FAILED@, the @Message@ field shows the reason for the failure.
    DocumentClassificationJobProperties -> Maybe JobStatus
jobStatus :: Prelude.Maybe JobStatus,
    -- | A description of the status of the job.
    DocumentClassificationJobProperties -> Maybe Text
message :: Prelude.Maybe Prelude.Text,
    -- | The output data configuration that you supplied when you created the
    -- document classification job.
    DocumentClassificationJobProperties -> Maybe OutputDataConfig
outputDataConfig :: Prelude.Maybe OutputDataConfig,
    -- | The time that the document classification job was submitted for
    -- processing.
    DocumentClassificationJobProperties -> Maybe POSIX
submitTime :: Prelude.Maybe Data.POSIX,
    -- | 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\"@
    DocumentClassificationJobProperties -> Maybe Text
volumeKmsKeyId :: Prelude.Maybe Prelude.Text,
    -- | Configuration parameters for a private Virtual Private Cloud (VPC)
    -- containing the resources you are using for your document classification
    -- job. For more information, see
    -- <https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html Amazon VPC>.
    DocumentClassificationJobProperties -> Maybe VpcConfig
vpcConfig :: Prelude.Maybe VpcConfig
  }
  deriving (DocumentClassificationJobProperties
-> DocumentClassificationJobProperties -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DocumentClassificationJobProperties
-> DocumentClassificationJobProperties -> Bool
$c/= :: DocumentClassificationJobProperties
-> DocumentClassificationJobProperties -> Bool
== :: DocumentClassificationJobProperties
-> DocumentClassificationJobProperties -> Bool
$c== :: DocumentClassificationJobProperties
-> DocumentClassificationJobProperties -> Bool
Prelude.Eq, ReadPrec [DocumentClassificationJobProperties]
ReadPrec DocumentClassificationJobProperties
Int -> ReadS DocumentClassificationJobProperties
ReadS [DocumentClassificationJobProperties]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DocumentClassificationJobProperties]
$creadListPrec :: ReadPrec [DocumentClassificationJobProperties]
readPrec :: ReadPrec DocumentClassificationJobProperties
$creadPrec :: ReadPrec DocumentClassificationJobProperties
readList :: ReadS [DocumentClassificationJobProperties]
$creadList :: ReadS [DocumentClassificationJobProperties]
readsPrec :: Int -> ReadS DocumentClassificationJobProperties
$creadsPrec :: Int -> ReadS DocumentClassificationJobProperties
Prelude.Read, Int -> DocumentClassificationJobProperties -> ShowS
[DocumentClassificationJobProperties] -> ShowS
DocumentClassificationJobProperties -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DocumentClassificationJobProperties] -> ShowS
$cshowList :: [DocumentClassificationJobProperties] -> ShowS
show :: DocumentClassificationJobProperties -> String
$cshow :: DocumentClassificationJobProperties -> String
showsPrec :: Int -> DocumentClassificationJobProperties -> ShowS
$cshowsPrec :: Int -> DocumentClassificationJobProperties -> ShowS
Prelude.Show, forall x.
Rep DocumentClassificationJobProperties x
-> DocumentClassificationJobProperties
forall x.
DocumentClassificationJobProperties
-> Rep DocumentClassificationJobProperties x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DocumentClassificationJobProperties x
-> DocumentClassificationJobProperties
$cfrom :: forall x.
DocumentClassificationJobProperties
-> Rep DocumentClassificationJobProperties x
Prelude.Generic)

-- |
-- Create a value of 'DocumentClassificationJobProperties' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'dataAccessRoleArn', 'documentClassificationJobProperties_dataAccessRoleArn' - The Amazon Resource Name (ARN) of the AWS identity and Access Management
-- (IAM) role that grants Amazon Comprehend read access to your input data.
--
-- 'documentClassifierArn', 'documentClassificationJobProperties_documentClassifierArn' - The Amazon Resource Name (ARN) that identifies the document classifier.
--
-- 'endTime', 'documentClassificationJobProperties_endTime' - The time that the document classification job completed.
--
-- 'inputDataConfig', 'documentClassificationJobProperties_inputDataConfig' - The input data configuration that you supplied when you created the
-- document classification job.
--
-- 'jobArn', 'documentClassificationJobProperties_jobArn' - The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job\/\<job-id>@
--
-- The following is an example job ARN:
--
-- @arn:aws:comprehend:us-west-2:111122223333:document-classification-job\/1234abcd12ab34cd56ef1234567890ab@
--
-- 'jobId', 'documentClassificationJobProperties_jobId' - The identifier assigned to the document classification job.
--
-- 'jobName', 'documentClassificationJobProperties_jobName' - The name that you assigned to the document classification job.
--
-- 'jobStatus', 'documentClassificationJobProperties_jobStatus' - The current status of the document classification job. If the status is
-- @FAILED@, the @Message@ field shows the reason for the failure.
--
-- 'message', 'documentClassificationJobProperties_message' - A description of the status of the job.
--
-- 'outputDataConfig', 'documentClassificationJobProperties_outputDataConfig' - The output data configuration that you supplied when you created the
-- document classification job.
--
-- 'submitTime', 'documentClassificationJobProperties_submitTime' - The time that the document classification job was submitted for
-- processing.
--
-- 'volumeKmsKeyId', 'documentClassificationJobProperties_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\"@
--
-- 'vpcConfig', 'documentClassificationJobProperties_vpcConfig' - Configuration parameters for a private Virtual Private Cloud (VPC)
-- containing the resources you are using for your document classification
-- job. For more information, see
-- <https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html Amazon VPC>.
newDocumentClassificationJobProperties ::
  DocumentClassificationJobProperties
newDocumentClassificationJobProperties :: DocumentClassificationJobProperties
newDocumentClassificationJobProperties =
  DocumentClassificationJobProperties'
    { $sel:dataAccessRoleArn:DocumentClassificationJobProperties' :: Maybe Text
dataAccessRoleArn =
        forall a. Maybe a
Prelude.Nothing,
      $sel:documentClassifierArn:DocumentClassificationJobProperties' :: Maybe Text
documentClassifierArn =
        forall a. Maybe a
Prelude.Nothing,
      $sel:endTime:DocumentClassificationJobProperties' :: Maybe POSIX
endTime = forall a. Maybe a
Prelude.Nothing,
      $sel:inputDataConfig:DocumentClassificationJobProperties' :: Maybe InputDataConfig
inputDataConfig = forall a. Maybe a
Prelude.Nothing,
      $sel:jobArn:DocumentClassificationJobProperties' :: Maybe Text
jobArn = forall a. Maybe a
Prelude.Nothing,
      $sel:jobId:DocumentClassificationJobProperties' :: Maybe Text
jobId = forall a. Maybe a
Prelude.Nothing,
      $sel:jobName:DocumentClassificationJobProperties' :: Maybe Text
jobName = forall a. Maybe a
Prelude.Nothing,
      $sel:jobStatus:DocumentClassificationJobProperties' :: Maybe JobStatus
jobStatus = forall a. Maybe a
Prelude.Nothing,
      $sel:message:DocumentClassificationJobProperties' :: Maybe Text
message = forall a. Maybe a
Prelude.Nothing,
      $sel:outputDataConfig:DocumentClassificationJobProperties' :: Maybe OutputDataConfig
outputDataConfig = forall a. Maybe a
Prelude.Nothing,
      $sel:submitTime:DocumentClassificationJobProperties' :: Maybe POSIX
submitTime = forall a. Maybe a
Prelude.Nothing,
      $sel:volumeKmsKeyId:DocumentClassificationJobProperties' :: Maybe Text
volumeKmsKeyId = forall a. Maybe a
Prelude.Nothing,
      $sel:vpcConfig:DocumentClassificationJobProperties' :: Maybe VpcConfig
vpcConfig = forall a. Maybe a
Prelude.Nothing
    }

-- | The Amazon Resource Name (ARN) of the AWS identity and Access Management
-- (IAM) role that grants Amazon Comprehend read access to your input data.
documentClassificationJobProperties_dataAccessRoleArn :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe Prelude.Text)
documentClassificationJobProperties_dataAccessRoleArn :: Lens' DocumentClassificationJobProperties (Maybe Text)
documentClassificationJobProperties_dataAccessRoleArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe Text
dataAccessRoleArn :: Maybe Text
$sel:dataAccessRoleArn:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
dataAccessRoleArn} -> Maybe Text
dataAccessRoleArn) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe Text
a -> DocumentClassificationJobProperties
s {$sel:dataAccessRoleArn:DocumentClassificationJobProperties' :: Maybe Text
dataAccessRoleArn = Maybe Text
a} :: DocumentClassificationJobProperties)

-- | The Amazon Resource Name (ARN) that identifies the document classifier.
documentClassificationJobProperties_documentClassifierArn :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe Prelude.Text)
documentClassificationJobProperties_documentClassifierArn :: Lens' DocumentClassificationJobProperties (Maybe Text)
documentClassificationJobProperties_documentClassifierArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe Text
documentClassifierArn :: Maybe Text
$sel:documentClassifierArn:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
documentClassifierArn} -> Maybe Text
documentClassifierArn) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe Text
a -> DocumentClassificationJobProperties
s {$sel:documentClassifierArn:DocumentClassificationJobProperties' :: Maybe Text
documentClassifierArn = Maybe Text
a} :: DocumentClassificationJobProperties)

-- | The time that the document classification job completed.
documentClassificationJobProperties_endTime :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe Prelude.UTCTime)
documentClassificationJobProperties_endTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime)
documentClassificationJobProperties_endTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe POSIX
endTime :: Maybe POSIX
$sel:endTime:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe POSIX
endTime} -> Maybe POSIX
endTime) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe POSIX
a -> DocumentClassificationJobProperties
s {$sel:endTime:DocumentClassificationJobProperties' :: Maybe POSIX
endTime = Maybe POSIX
a} :: DocumentClassificationJobProperties) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The input data configuration that you supplied when you created the
-- document classification job.
documentClassificationJobProperties_inputDataConfig :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe InputDataConfig)
documentClassificationJobProperties_inputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe InputDataConfig)
documentClassificationJobProperties_inputDataConfig = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe InputDataConfig
inputDataConfig :: Maybe InputDataConfig
$sel:inputDataConfig:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe InputDataConfig
inputDataConfig} -> Maybe InputDataConfig
inputDataConfig) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe InputDataConfig
a -> DocumentClassificationJobProperties
s {$sel:inputDataConfig:DocumentClassificationJobProperties' :: Maybe InputDataConfig
inputDataConfig = Maybe InputDataConfig
a} :: DocumentClassificationJobProperties)

-- | The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job\/\<job-id>@
--
-- The following is an example job ARN:
--
-- @arn:aws:comprehend:us-west-2:111122223333:document-classification-job\/1234abcd12ab34cd56ef1234567890ab@
documentClassificationJobProperties_jobArn :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe Prelude.Text)
documentClassificationJobProperties_jobArn :: Lens' DocumentClassificationJobProperties (Maybe Text)
documentClassificationJobProperties_jobArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe Text
jobArn :: Maybe Text
$sel:jobArn:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
jobArn} -> Maybe Text
jobArn) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe Text
a -> DocumentClassificationJobProperties
s {$sel:jobArn:DocumentClassificationJobProperties' :: Maybe Text
jobArn = Maybe Text
a} :: DocumentClassificationJobProperties)

-- | The identifier assigned to the document classification job.
documentClassificationJobProperties_jobId :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe Prelude.Text)
documentClassificationJobProperties_jobId :: Lens' DocumentClassificationJobProperties (Maybe Text)
documentClassificationJobProperties_jobId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe Text
jobId :: Maybe Text
$sel:jobId:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
jobId} -> Maybe Text
jobId) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe Text
a -> DocumentClassificationJobProperties
s {$sel:jobId:DocumentClassificationJobProperties' :: Maybe Text
jobId = Maybe Text
a} :: DocumentClassificationJobProperties)

-- | The name that you assigned to the document classification job.
documentClassificationJobProperties_jobName :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe Prelude.Text)
documentClassificationJobProperties_jobName :: Lens' DocumentClassificationJobProperties (Maybe Text)
documentClassificationJobProperties_jobName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe Text
jobName :: Maybe Text
$sel:jobName:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
jobName} -> Maybe Text
jobName) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe Text
a -> DocumentClassificationJobProperties
s {$sel:jobName:DocumentClassificationJobProperties' :: Maybe Text
jobName = Maybe Text
a} :: DocumentClassificationJobProperties)

-- | The current status of the document classification job. If the status is
-- @FAILED@, the @Message@ field shows the reason for the failure.
documentClassificationJobProperties_jobStatus :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe JobStatus)
documentClassificationJobProperties_jobStatus :: Lens' DocumentClassificationJobProperties (Maybe JobStatus)
documentClassificationJobProperties_jobStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe JobStatus
jobStatus :: Maybe JobStatus
$sel:jobStatus:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe JobStatus
jobStatus} -> Maybe JobStatus
jobStatus) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe JobStatus
a -> DocumentClassificationJobProperties
s {$sel:jobStatus:DocumentClassificationJobProperties' :: Maybe JobStatus
jobStatus = Maybe JobStatus
a} :: DocumentClassificationJobProperties)

-- | A description of the status of the job.
documentClassificationJobProperties_message :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe Prelude.Text)
documentClassificationJobProperties_message :: Lens' DocumentClassificationJobProperties (Maybe Text)
documentClassificationJobProperties_message = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe Text
message :: Maybe Text
$sel:message:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
message} -> Maybe Text
message) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe Text
a -> DocumentClassificationJobProperties
s {$sel:message:DocumentClassificationJobProperties' :: Maybe Text
message = Maybe Text
a} :: DocumentClassificationJobProperties)

-- | The output data configuration that you supplied when you created the
-- document classification job.
documentClassificationJobProperties_outputDataConfig :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe OutputDataConfig)
documentClassificationJobProperties_outputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe OutputDataConfig)
documentClassificationJobProperties_outputDataConfig = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe OutputDataConfig
outputDataConfig :: Maybe OutputDataConfig
$sel:outputDataConfig:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe OutputDataConfig
outputDataConfig} -> Maybe OutputDataConfig
outputDataConfig) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe OutputDataConfig
a -> DocumentClassificationJobProperties
s {$sel:outputDataConfig:DocumentClassificationJobProperties' :: Maybe OutputDataConfig
outputDataConfig = Maybe OutputDataConfig
a} :: DocumentClassificationJobProperties)

-- | The time that the document classification job was submitted for
-- processing.
documentClassificationJobProperties_submitTime :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe Prelude.UTCTime)
documentClassificationJobProperties_submitTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime)
documentClassificationJobProperties_submitTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe POSIX
submitTime :: Maybe POSIX
$sel:submitTime:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe POSIX
submitTime} -> Maybe POSIX
submitTime) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe POSIX
a -> DocumentClassificationJobProperties
s {$sel:submitTime:DocumentClassificationJobProperties' :: Maybe POSIX
submitTime = Maybe POSIX
a} :: DocumentClassificationJobProperties) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | 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\"@
documentClassificationJobProperties_volumeKmsKeyId :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe Prelude.Text)
documentClassificationJobProperties_volumeKmsKeyId :: Lens' DocumentClassificationJobProperties (Maybe Text)
documentClassificationJobProperties_volumeKmsKeyId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe Text
volumeKmsKeyId :: Maybe Text
$sel:volumeKmsKeyId:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
volumeKmsKeyId} -> Maybe Text
volumeKmsKeyId) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe Text
a -> DocumentClassificationJobProperties
s {$sel:volumeKmsKeyId:DocumentClassificationJobProperties' :: Maybe Text
volumeKmsKeyId = Maybe Text
a} :: DocumentClassificationJobProperties)

-- | Configuration parameters for a private Virtual Private Cloud (VPC)
-- containing the resources you are using for your document classification
-- job. For more information, see
-- <https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html Amazon VPC>.
documentClassificationJobProperties_vpcConfig :: Lens.Lens' DocumentClassificationJobProperties (Prelude.Maybe VpcConfig)
documentClassificationJobProperties_vpcConfig :: Lens' DocumentClassificationJobProperties (Maybe VpcConfig)
documentClassificationJobProperties_vpcConfig = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobProperties' {Maybe VpcConfig
vpcConfig :: Maybe VpcConfig
$sel:vpcConfig:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe VpcConfig
vpcConfig} -> Maybe VpcConfig
vpcConfig) (\s :: DocumentClassificationJobProperties
s@DocumentClassificationJobProperties' {} Maybe VpcConfig
a -> DocumentClassificationJobProperties
s {$sel:vpcConfig:DocumentClassificationJobProperties' :: Maybe VpcConfig
vpcConfig = Maybe VpcConfig
a} :: DocumentClassificationJobProperties)

instance
  Data.FromJSON
    DocumentClassificationJobProperties
  where
  parseJSON :: Value -> Parser DocumentClassificationJobProperties
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DocumentClassificationJobProperties"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> Maybe POSIX
-> Maybe InputDataConfig
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe JobStatus
-> Maybe Text
-> Maybe OutputDataConfig
-> Maybe POSIX
-> Maybe Text
-> Maybe VpcConfig
-> DocumentClassificationJobProperties
DocumentClassificationJobProperties'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"DataAccessRoleArn")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"DocumentClassifierArn")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"EndTime")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"InputDataConfig")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"JobArn")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"JobId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"JobName")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"JobStatus")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Message")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"OutputDataConfig")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"SubmitTime")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"VolumeKmsKeyId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"VpcConfig")
      )

instance
  Prelude.Hashable
    DocumentClassificationJobProperties
  where
  hashWithSalt :: Int -> DocumentClassificationJobProperties -> Int
hashWithSalt
    Int
_salt
    DocumentClassificationJobProperties' {Maybe Text
Maybe POSIX
Maybe InputDataConfig
Maybe JobStatus
Maybe OutputDataConfig
Maybe VpcConfig
vpcConfig :: Maybe VpcConfig
volumeKmsKeyId :: Maybe Text
submitTime :: Maybe POSIX
outputDataConfig :: Maybe OutputDataConfig
message :: Maybe Text
jobStatus :: Maybe JobStatus
jobName :: Maybe Text
jobId :: Maybe Text
jobArn :: Maybe Text
inputDataConfig :: Maybe InputDataConfig
endTime :: Maybe POSIX
documentClassifierArn :: Maybe Text
dataAccessRoleArn :: Maybe Text
$sel:vpcConfig:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe VpcConfig
$sel:volumeKmsKeyId:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:submitTime:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe POSIX
$sel:outputDataConfig:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe OutputDataConfig
$sel:message:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:jobStatus:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe JobStatus
$sel:jobName:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:jobId:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:jobArn:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:inputDataConfig:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe InputDataConfig
$sel:endTime:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe POSIX
$sel:documentClassifierArn:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:dataAccessRoleArn:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
dataAccessRoleArn
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
documentClassifierArn
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
endTime
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe InputDataConfig
inputDataConfig
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
jobArn
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
jobId
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
jobName
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe JobStatus
jobStatus
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
message
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe OutputDataConfig
outputDataConfig
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
submitTime
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
volumeKmsKeyId
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe VpcConfig
vpcConfig

instance
  Prelude.NFData
    DocumentClassificationJobProperties
  where
  rnf :: DocumentClassificationJobProperties -> ()
rnf DocumentClassificationJobProperties' {Maybe Text
Maybe POSIX
Maybe InputDataConfig
Maybe JobStatus
Maybe OutputDataConfig
Maybe VpcConfig
vpcConfig :: Maybe VpcConfig
volumeKmsKeyId :: Maybe Text
submitTime :: Maybe POSIX
outputDataConfig :: Maybe OutputDataConfig
message :: Maybe Text
jobStatus :: Maybe JobStatus
jobName :: Maybe Text
jobId :: Maybe Text
jobArn :: Maybe Text
inputDataConfig :: Maybe InputDataConfig
endTime :: Maybe POSIX
documentClassifierArn :: Maybe Text
dataAccessRoleArn :: Maybe Text
$sel:vpcConfig:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe VpcConfig
$sel:volumeKmsKeyId:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:submitTime:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe POSIX
$sel:outputDataConfig:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe OutputDataConfig
$sel:message:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:jobStatus:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe JobStatus
$sel:jobName:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:jobId:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:jobArn:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:inputDataConfig:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe InputDataConfig
$sel:endTime:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe POSIX
$sel:documentClassifierArn:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
$sel:dataAccessRoleArn:DocumentClassificationJobProperties' :: DocumentClassificationJobProperties -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
dataAccessRoleArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
documentClassifierArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
endTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe InputDataConfig
inputDataConfig
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
jobArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
jobId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
jobName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe JobStatus
jobStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
message
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe OutputDataConfig
outputDataConfig
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
submitTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
volumeKmsKeyId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe VpcConfig
vpcConfig