{-# 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.TopicsDetectionJobProperties
-- 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)
module Amazonka.Comprehend.Types.TopicsDetectionJobProperties 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.Lens as Lens
import qualified Amazonka.Prelude as Prelude

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

-- |
-- Create a value of 'TopicsDetectionJobProperties' 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:
--
-- 'jobId', 'topicsDetectionJobProperties_jobId' - The identifier assigned to the topic detection job.
--
-- 'jobArn', 'topicsDetectionJobProperties_jobArn' - The Amazon Resource Name (ARN) of the topics 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>:topics-detection-job\/\<job-id>@
--
-- The following is an example job ARN:
--
-- @arn:aws:comprehend:us-west-2:111122223333:topics-detection-job\/1234abcd12ab34cd56ef1234567890ab@
--
-- 'jobName', 'topicsDetectionJobProperties_jobName' - The name of the topic detection job.
--
-- 'inputDataConfig', 'topicsDetectionJobProperties_inputDataConfig' - The input data configuration supplied when you created the topic
-- detection job.
--
-- 'vpcConfig', 'topicsDetectionJobProperties_vpcConfig' - Configuration parameters for a private Virtual Private Cloud (VPC)
-- containing the resources you are using for your topic detection job. For
-- more information, see
-- <https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html Amazon VPC>.
--
-- 'volumeKmsKeyId', 'topicsDetectionJobProperties_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\"@
--
-- 'endTime', 'topicsDetectionJobProperties_endTime' - The time that the topic detection job was completed.
--
-- 'outputDataConfig', 'topicsDetectionJobProperties_outputDataConfig' - The output data configuration supplied when you created the topic
-- detection job.
--
-- 'dataAccessRoleArn', 'topicsDetectionJobProperties_dataAccessRoleArn' - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
-- role that grants Amazon Comprehend read access to your job data.
--
-- 'numberOfTopics', 'topicsDetectionJobProperties_numberOfTopics' - The number of topics to detect supplied when you created the topic
-- detection job. The default is 10.
--
-- 'jobStatus', 'topicsDetectionJobProperties_jobStatus' - The current status of the topic detection job. If the status is
-- @Failed@, the reason for the failure is shown in the @Message@ field.
--
-- 'message', 'topicsDetectionJobProperties_message' - A description for the status of a job.
--
-- 'submitTime', 'topicsDetectionJobProperties_submitTime' - The time that the topic detection job was submitted for processing.
newTopicsDetectionJobProperties ::
  TopicsDetectionJobProperties
newTopicsDetectionJobProperties :: TopicsDetectionJobProperties
newTopicsDetectionJobProperties =
  TopicsDetectionJobProperties' :: Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe InputDataConfig
-> Maybe VpcConfig
-> Maybe Text
-> Maybe POSIX
-> Maybe OutputDataConfig
-> Maybe Text
-> Maybe Int
-> Maybe JobStatus
-> Maybe Text
-> Maybe POSIX
-> TopicsDetectionJobProperties
TopicsDetectionJobProperties'
    { $sel:jobId:TopicsDetectionJobProperties' :: Maybe Text
jobId =
        Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:jobArn:TopicsDetectionJobProperties' :: Maybe Text
jobArn = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:jobName:TopicsDetectionJobProperties' :: Maybe Text
jobName = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:inputDataConfig:TopicsDetectionJobProperties' :: Maybe InputDataConfig
inputDataConfig = Maybe InputDataConfig
forall a. Maybe a
Prelude.Nothing,
      $sel:vpcConfig:TopicsDetectionJobProperties' :: Maybe VpcConfig
vpcConfig = Maybe VpcConfig
forall a. Maybe a
Prelude.Nothing,
      $sel:volumeKmsKeyId:TopicsDetectionJobProperties' :: Maybe Text
volumeKmsKeyId = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:endTime:TopicsDetectionJobProperties' :: Maybe POSIX
endTime = Maybe POSIX
forall a. Maybe a
Prelude.Nothing,
      $sel:outputDataConfig:TopicsDetectionJobProperties' :: Maybe OutputDataConfig
outputDataConfig = Maybe OutputDataConfig
forall a. Maybe a
Prelude.Nothing,
      $sel:dataAccessRoleArn:TopicsDetectionJobProperties' :: Maybe Text
dataAccessRoleArn = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:numberOfTopics:TopicsDetectionJobProperties' :: Maybe Int
numberOfTopics = Maybe Int
forall a. Maybe a
Prelude.Nothing,
      $sel:jobStatus:TopicsDetectionJobProperties' :: Maybe JobStatus
jobStatus = Maybe JobStatus
forall a. Maybe a
Prelude.Nothing,
      $sel:message:TopicsDetectionJobProperties' :: Maybe Text
message = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:submitTime:TopicsDetectionJobProperties' :: Maybe POSIX
submitTime = Maybe POSIX
forall a. Maybe a
Prelude.Nothing
    }

-- | The identifier assigned to the topic detection job.
topicsDetectionJobProperties_jobId :: Lens.Lens' TopicsDetectionJobProperties (Prelude.Maybe Prelude.Text)
topicsDetectionJobProperties_jobId :: (Maybe Text -> f (Maybe Text))
-> TopicsDetectionJobProperties -> f TopicsDetectionJobProperties
topicsDetectionJobProperties_jobId = (TopicsDetectionJobProperties -> Maybe Text)
-> (TopicsDetectionJobProperties
    -> Maybe Text -> TopicsDetectionJobProperties)
-> Lens
     TopicsDetectionJobProperties
     TopicsDetectionJobProperties
     (Maybe Text)
     (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TopicsDetectionJobProperties' {Maybe Text
jobId :: Maybe Text
$sel:jobId:TopicsDetectionJobProperties' :: TopicsDetectionJobProperties -> Maybe Text
jobId} -> Maybe Text
jobId) (\s :: TopicsDetectionJobProperties
s@TopicsDetectionJobProperties' {} Maybe Text
a -> TopicsDetectionJobProperties
s {$sel:jobId:TopicsDetectionJobProperties' :: Maybe Text
jobId = Maybe Text
a} :: TopicsDetectionJobProperties)

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

-- | The name of the topic detection job.
topicsDetectionJobProperties_jobName :: Lens.Lens' TopicsDetectionJobProperties (Prelude.Maybe Prelude.Text)
topicsDetectionJobProperties_jobName :: (Maybe Text -> f (Maybe Text))
-> TopicsDetectionJobProperties -> f TopicsDetectionJobProperties
topicsDetectionJobProperties_jobName = (TopicsDetectionJobProperties -> Maybe Text)
-> (TopicsDetectionJobProperties
    -> Maybe Text -> TopicsDetectionJobProperties)
-> Lens
     TopicsDetectionJobProperties
     TopicsDetectionJobProperties
     (Maybe Text)
     (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TopicsDetectionJobProperties' {Maybe Text
jobName :: Maybe Text
$sel:jobName:TopicsDetectionJobProperties' :: TopicsDetectionJobProperties -> Maybe Text
jobName} -> Maybe Text
jobName) (\s :: TopicsDetectionJobProperties
s@TopicsDetectionJobProperties' {} Maybe Text
a -> TopicsDetectionJobProperties
s {$sel:jobName:TopicsDetectionJobProperties' :: Maybe Text
jobName = Maybe Text
a} :: TopicsDetectionJobProperties)

-- | The input data configuration supplied when you created the topic
-- detection job.
topicsDetectionJobProperties_inputDataConfig :: Lens.Lens' TopicsDetectionJobProperties (Prelude.Maybe InputDataConfig)
topicsDetectionJobProperties_inputDataConfig :: (Maybe InputDataConfig -> f (Maybe InputDataConfig))
-> TopicsDetectionJobProperties -> f TopicsDetectionJobProperties
topicsDetectionJobProperties_inputDataConfig = (TopicsDetectionJobProperties -> Maybe InputDataConfig)
-> (TopicsDetectionJobProperties
    -> Maybe InputDataConfig -> TopicsDetectionJobProperties)
-> Lens
     TopicsDetectionJobProperties
     TopicsDetectionJobProperties
     (Maybe InputDataConfig)
     (Maybe InputDataConfig)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TopicsDetectionJobProperties' {Maybe InputDataConfig
inputDataConfig :: Maybe InputDataConfig
$sel:inputDataConfig:TopicsDetectionJobProperties' :: TopicsDetectionJobProperties -> Maybe InputDataConfig
inputDataConfig} -> Maybe InputDataConfig
inputDataConfig) (\s :: TopicsDetectionJobProperties
s@TopicsDetectionJobProperties' {} Maybe InputDataConfig
a -> TopicsDetectionJobProperties
s {$sel:inputDataConfig:TopicsDetectionJobProperties' :: Maybe InputDataConfig
inputDataConfig = Maybe InputDataConfig
a} :: TopicsDetectionJobProperties)

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

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

-- | The time that the topic detection job was completed.
topicsDetectionJobProperties_endTime :: Lens.Lens' TopicsDetectionJobProperties (Prelude.Maybe Prelude.UTCTime)
topicsDetectionJobProperties_endTime :: (Maybe UTCTime -> f (Maybe UTCTime))
-> TopicsDetectionJobProperties -> f TopicsDetectionJobProperties
topicsDetectionJobProperties_endTime = (TopicsDetectionJobProperties -> Maybe POSIX)
-> (TopicsDetectionJobProperties
    -> Maybe POSIX -> TopicsDetectionJobProperties)
-> Lens
     TopicsDetectionJobProperties
     TopicsDetectionJobProperties
     (Maybe POSIX)
     (Maybe POSIX)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TopicsDetectionJobProperties' {Maybe POSIX
endTime :: Maybe POSIX
$sel:endTime:TopicsDetectionJobProperties' :: TopicsDetectionJobProperties -> Maybe POSIX
endTime} -> Maybe POSIX
endTime) (\s :: TopicsDetectionJobProperties
s@TopicsDetectionJobProperties' {} Maybe POSIX
a -> TopicsDetectionJobProperties
s {$sel:endTime:TopicsDetectionJobProperties' :: Maybe POSIX
endTime = Maybe POSIX
a} :: TopicsDetectionJobProperties) ((Maybe POSIX -> f (Maybe POSIX))
 -> TopicsDetectionJobProperties -> f TopicsDetectionJobProperties)
-> ((Maybe UTCTime -> f (Maybe UTCTime))
    -> Maybe POSIX -> f (Maybe POSIX))
-> (Maybe UTCTime -> f (Maybe UTCTime))
-> TopicsDetectionJobProperties
-> f TopicsDetectionJobProperties
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso POSIX POSIX UTCTime UTCTime
-> Iso (Maybe POSIX) (Maybe POSIX) (Maybe UTCTime) (Maybe UTCTime)
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 AnIso POSIX POSIX UTCTime UTCTime
forall (a :: Format). Iso' (Time a) UTCTime
Core._Time

-- | The output data configuration supplied when you created the topic
-- detection job.
topicsDetectionJobProperties_outputDataConfig :: Lens.Lens' TopicsDetectionJobProperties (Prelude.Maybe OutputDataConfig)
topicsDetectionJobProperties_outputDataConfig :: (Maybe OutputDataConfig -> f (Maybe OutputDataConfig))
-> TopicsDetectionJobProperties -> f TopicsDetectionJobProperties
topicsDetectionJobProperties_outputDataConfig = (TopicsDetectionJobProperties -> Maybe OutputDataConfig)
-> (TopicsDetectionJobProperties
    -> Maybe OutputDataConfig -> TopicsDetectionJobProperties)
-> Lens
     TopicsDetectionJobProperties
     TopicsDetectionJobProperties
     (Maybe OutputDataConfig)
     (Maybe OutputDataConfig)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TopicsDetectionJobProperties' {Maybe OutputDataConfig
outputDataConfig :: Maybe OutputDataConfig
$sel:outputDataConfig:TopicsDetectionJobProperties' :: TopicsDetectionJobProperties -> Maybe OutputDataConfig
outputDataConfig} -> Maybe OutputDataConfig
outputDataConfig) (\s :: TopicsDetectionJobProperties
s@TopicsDetectionJobProperties' {} Maybe OutputDataConfig
a -> TopicsDetectionJobProperties
s {$sel:outputDataConfig:TopicsDetectionJobProperties' :: Maybe OutputDataConfig
outputDataConfig = Maybe OutputDataConfig
a} :: TopicsDetectionJobProperties)

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

-- | The number of topics to detect supplied when you created the topic
-- detection job. The default is 10.
topicsDetectionJobProperties_numberOfTopics :: Lens.Lens' TopicsDetectionJobProperties (Prelude.Maybe Prelude.Int)
topicsDetectionJobProperties_numberOfTopics :: (Maybe Int -> f (Maybe Int))
-> TopicsDetectionJobProperties -> f TopicsDetectionJobProperties
topicsDetectionJobProperties_numberOfTopics = (TopicsDetectionJobProperties -> Maybe Int)
-> (TopicsDetectionJobProperties
    -> Maybe Int -> TopicsDetectionJobProperties)
-> Lens
     TopicsDetectionJobProperties
     TopicsDetectionJobProperties
     (Maybe Int)
     (Maybe Int)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TopicsDetectionJobProperties' {Maybe Int
numberOfTopics :: Maybe Int
$sel:numberOfTopics:TopicsDetectionJobProperties' :: TopicsDetectionJobProperties -> Maybe Int
numberOfTopics} -> Maybe Int
numberOfTopics) (\s :: TopicsDetectionJobProperties
s@TopicsDetectionJobProperties' {} Maybe Int
a -> TopicsDetectionJobProperties
s {$sel:numberOfTopics:TopicsDetectionJobProperties' :: Maybe Int
numberOfTopics = Maybe Int
a} :: TopicsDetectionJobProperties)

-- | The current status of the topic detection job. If the status is
-- @Failed@, the reason for the failure is shown in the @Message@ field.
topicsDetectionJobProperties_jobStatus :: Lens.Lens' TopicsDetectionJobProperties (Prelude.Maybe JobStatus)
topicsDetectionJobProperties_jobStatus :: (Maybe JobStatus -> f (Maybe JobStatus))
-> TopicsDetectionJobProperties -> f TopicsDetectionJobProperties
topicsDetectionJobProperties_jobStatus = (TopicsDetectionJobProperties -> Maybe JobStatus)
-> (TopicsDetectionJobProperties
    -> Maybe JobStatus -> TopicsDetectionJobProperties)
-> Lens
     TopicsDetectionJobProperties
     TopicsDetectionJobProperties
     (Maybe JobStatus)
     (Maybe JobStatus)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TopicsDetectionJobProperties' {Maybe JobStatus
jobStatus :: Maybe JobStatus
$sel:jobStatus:TopicsDetectionJobProperties' :: TopicsDetectionJobProperties -> Maybe JobStatus
jobStatus} -> Maybe JobStatus
jobStatus) (\s :: TopicsDetectionJobProperties
s@TopicsDetectionJobProperties' {} Maybe JobStatus
a -> TopicsDetectionJobProperties
s {$sel:jobStatus:TopicsDetectionJobProperties' :: Maybe JobStatus
jobStatus = Maybe JobStatus
a} :: TopicsDetectionJobProperties)

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

-- | The time that the topic detection job was submitted for processing.
topicsDetectionJobProperties_submitTime :: Lens.Lens' TopicsDetectionJobProperties (Prelude.Maybe Prelude.UTCTime)
topicsDetectionJobProperties_submitTime :: (Maybe UTCTime -> f (Maybe UTCTime))
-> TopicsDetectionJobProperties -> f TopicsDetectionJobProperties
topicsDetectionJobProperties_submitTime = (TopicsDetectionJobProperties -> Maybe POSIX)
-> (TopicsDetectionJobProperties
    -> Maybe POSIX -> TopicsDetectionJobProperties)
-> Lens
     TopicsDetectionJobProperties
     TopicsDetectionJobProperties
     (Maybe POSIX)
     (Maybe POSIX)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TopicsDetectionJobProperties' {Maybe POSIX
submitTime :: Maybe POSIX
$sel:submitTime:TopicsDetectionJobProperties' :: TopicsDetectionJobProperties -> Maybe POSIX
submitTime} -> Maybe POSIX
submitTime) (\s :: TopicsDetectionJobProperties
s@TopicsDetectionJobProperties' {} Maybe POSIX
a -> TopicsDetectionJobProperties
s {$sel:submitTime:TopicsDetectionJobProperties' :: Maybe POSIX
submitTime = Maybe POSIX
a} :: TopicsDetectionJobProperties) ((Maybe POSIX -> f (Maybe POSIX))
 -> TopicsDetectionJobProperties -> f TopicsDetectionJobProperties)
-> ((Maybe UTCTime -> f (Maybe UTCTime))
    -> Maybe POSIX -> f (Maybe POSIX))
-> (Maybe UTCTime -> f (Maybe UTCTime))
-> TopicsDetectionJobProperties
-> f TopicsDetectionJobProperties
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso POSIX POSIX UTCTime UTCTime
-> Iso (Maybe POSIX) (Maybe POSIX) (Maybe UTCTime) (Maybe UTCTime)
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 AnIso POSIX POSIX UTCTime UTCTime
forall (a :: Format). Iso' (Time a) UTCTime
Core._Time

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

instance
  Prelude.Hashable
    TopicsDetectionJobProperties

instance Prelude.NFData TopicsDetectionJobProperties