{-# 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.StepFunctions.Types.ExecutionListItem
-- 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.StepFunctions.Types.ExecutionListItem where

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
import Amazonka.StepFunctions.Types.ExecutionStatus

-- | Contains details about an execution.
--
-- /See:/ 'newExecutionListItem' smart constructor.
data ExecutionListItem = ExecutionListItem'
  { -- | The total number of items processed in a child workflow execution. This
    -- field is returned only if @mapRunArn@ was specified in the
    -- @ListExecutions@ API action. If @stateMachineArn@ was specified in
    -- @ListExecutions@, the @itemCount@ field isn\'t returned.
    itemCount :: Prelude.Maybe Prelude.Natural,
    -- | The Amazon Resource Name (ARN) of a Map Run. This field is returned only
    -- if @mapRunArn@ was specified in the @ListExecutions@ API action. If
    -- @stateMachineArn@ was specified in @ListExecutions@, the @mapRunArn@
    -- isn\'t returned.
    mapRunArn :: Prelude.Maybe Prelude.Text,
    -- | If the execution already ended, the date the execution stopped.
    stopDate :: Prelude.Maybe Data.POSIX,
    -- | The Amazon Resource Name (ARN) that identifies the execution.
    executionArn :: Prelude.Text,
    -- | The Amazon Resource Name (ARN) of the executed state machine.
    stateMachineArn :: Prelude.Text,
    -- | The name of the execution.
    --
    -- A name must /not/ contain:
    --
    -- -   white space
    --
    -- -   brackets @\< > { } [ ]@
    --
    -- -   wildcard characters @? *@
    --
    -- -   special characters @\" # % \\ ^ | ~ \` $ & , ; : \/@
    --
    -- -   control characters (@U+0000-001F@, @U+007F-009F@)
    --
    -- To enable logging with CloudWatch Logs, the name should only contain
    -- 0-9, A-Z, a-z, - and _.
    name :: Prelude.Text,
    -- | The current status of the execution.
    status :: ExecutionStatus,
    -- | The date the execution started.
    startDate :: Data.POSIX
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'ExecutionListItem' 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:
--
-- 'itemCount', 'executionListItem_itemCount' - The total number of items processed in a child workflow execution. This
-- field is returned only if @mapRunArn@ was specified in the
-- @ListExecutions@ API action. If @stateMachineArn@ was specified in
-- @ListExecutions@, the @itemCount@ field isn\'t returned.
--
-- 'mapRunArn', 'executionListItem_mapRunArn' - The Amazon Resource Name (ARN) of a Map Run. This field is returned only
-- if @mapRunArn@ was specified in the @ListExecutions@ API action. If
-- @stateMachineArn@ was specified in @ListExecutions@, the @mapRunArn@
-- isn\'t returned.
--
-- 'stopDate', 'executionListItem_stopDate' - If the execution already ended, the date the execution stopped.
--
-- 'executionArn', 'executionListItem_executionArn' - The Amazon Resource Name (ARN) that identifies the execution.
--
-- 'stateMachineArn', 'executionListItem_stateMachineArn' - The Amazon Resource Name (ARN) of the executed state machine.
--
-- 'name', 'executionListItem_name' - The name of the execution.
--
-- A name must /not/ contain:
--
-- -   white space
--
-- -   brackets @\< > { } [ ]@
--
-- -   wildcard characters @? *@
--
-- -   special characters @\" # % \\ ^ | ~ \` $ & , ; : \/@
--
-- -   control characters (@U+0000-001F@, @U+007F-009F@)
--
-- To enable logging with CloudWatch Logs, the name should only contain
-- 0-9, A-Z, a-z, - and _.
--
-- 'status', 'executionListItem_status' - The current status of the execution.
--
-- 'startDate', 'executionListItem_startDate' - The date the execution started.
newExecutionListItem ::
  -- | 'executionArn'
  Prelude.Text ->
  -- | 'stateMachineArn'
  Prelude.Text ->
  -- | 'name'
  Prelude.Text ->
  -- | 'status'
  ExecutionStatus ->
  -- | 'startDate'
  Prelude.UTCTime ->
  ExecutionListItem
newExecutionListItem
  pExecutionArn_
  pStateMachineArn_
  pName_
  pStatus_
  pStartDate_ =
    ExecutionListItem'
      { itemCount = Prelude.Nothing,
        mapRunArn = Prelude.Nothing,
        stopDate = Prelude.Nothing,
        executionArn = pExecutionArn_,
        stateMachineArn = pStateMachineArn_,
        name = pName_,
        status = pStatus_,
        startDate = Data._Time Lens.# pStartDate_
      }

-- | The total number of items processed in a child workflow execution. This
-- field is returned only if @mapRunArn@ was specified in the
-- @ListExecutions@ API action. If @stateMachineArn@ was specified in
-- @ListExecutions@, the @itemCount@ field isn\'t returned.
executionListItem_itemCount :: Lens.Lens' ExecutionListItem (Prelude.Maybe Prelude.Natural)
executionListItem_itemCount = Lens.lens (\ExecutionListItem' {itemCount} -> itemCount) (\s@ExecutionListItem' {} a -> s {itemCount = a} :: ExecutionListItem)

-- | The Amazon Resource Name (ARN) of a Map Run. This field is returned only
-- if @mapRunArn@ was specified in the @ListExecutions@ API action. If
-- @stateMachineArn@ was specified in @ListExecutions@, the @mapRunArn@
-- isn\'t returned.
executionListItem_mapRunArn :: Lens.Lens' ExecutionListItem (Prelude.Maybe Prelude.Text)
executionListItem_mapRunArn = Lens.lens (\ExecutionListItem' {mapRunArn} -> mapRunArn) (\s@ExecutionListItem' {} a -> s {mapRunArn = a} :: ExecutionListItem)

-- | If the execution already ended, the date the execution stopped.
executionListItem_stopDate :: Lens.Lens' ExecutionListItem (Prelude.Maybe Prelude.UTCTime)
executionListItem_stopDate = Lens.lens (\ExecutionListItem' {stopDate} -> stopDate) (\s@ExecutionListItem' {} a -> s {stopDate = a} :: ExecutionListItem) Prelude.. Lens.mapping Data._Time

-- | The Amazon Resource Name (ARN) that identifies the execution.
executionListItem_executionArn :: Lens.Lens' ExecutionListItem Prelude.Text
executionListItem_executionArn = Lens.lens (\ExecutionListItem' {executionArn} -> executionArn) (\s@ExecutionListItem' {} a -> s {executionArn = a} :: ExecutionListItem)

-- | The Amazon Resource Name (ARN) of the executed state machine.
executionListItem_stateMachineArn :: Lens.Lens' ExecutionListItem Prelude.Text
executionListItem_stateMachineArn = Lens.lens (\ExecutionListItem' {stateMachineArn} -> stateMachineArn) (\s@ExecutionListItem' {} a -> s {stateMachineArn = a} :: ExecutionListItem)

-- | The name of the execution.
--
-- A name must /not/ contain:
--
-- -   white space
--
-- -   brackets @\< > { } [ ]@
--
-- -   wildcard characters @? *@
--
-- -   special characters @\" # % \\ ^ | ~ \` $ & , ; : \/@
--
-- -   control characters (@U+0000-001F@, @U+007F-009F@)
--
-- To enable logging with CloudWatch Logs, the name should only contain
-- 0-9, A-Z, a-z, - and _.
executionListItem_name :: Lens.Lens' ExecutionListItem Prelude.Text
executionListItem_name = Lens.lens (\ExecutionListItem' {name} -> name) (\s@ExecutionListItem' {} a -> s {name = a} :: ExecutionListItem)

-- | The current status of the execution.
executionListItem_status :: Lens.Lens' ExecutionListItem ExecutionStatus
executionListItem_status = Lens.lens (\ExecutionListItem' {status} -> status) (\s@ExecutionListItem' {} a -> s {status = a} :: ExecutionListItem)

-- | The date the execution started.
executionListItem_startDate :: Lens.Lens' ExecutionListItem Prelude.UTCTime
executionListItem_startDate = Lens.lens (\ExecutionListItem' {startDate} -> startDate) (\s@ExecutionListItem' {} a -> s {startDate = a} :: ExecutionListItem) Prelude.. Data._Time

instance Data.FromJSON ExecutionListItem where
  parseJSON =
    Data.withObject
      "ExecutionListItem"
      ( \x ->
          ExecutionListItem'
            Prelude.<$> (x Data..:? "itemCount")
            Prelude.<*> (x Data..:? "mapRunArn")
            Prelude.<*> (x Data..:? "stopDate")
            Prelude.<*> (x Data..: "executionArn")
            Prelude.<*> (x Data..: "stateMachineArn")
            Prelude.<*> (x Data..: "name")
            Prelude.<*> (x Data..: "status")
            Prelude.<*> (x Data..: "startDate")
      )

instance Prelude.Hashable ExecutionListItem where
  hashWithSalt _salt ExecutionListItem' {..} =
    _salt
      `Prelude.hashWithSalt` itemCount
      `Prelude.hashWithSalt` mapRunArn
      `Prelude.hashWithSalt` stopDate
      `Prelude.hashWithSalt` executionArn
      `Prelude.hashWithSalt` stateMachineArn
      `Prelude.hashWithSalt` name
      `Prelude.hashWithSalt` status
      `Prelude.hashWithSalt` startDate

instance Prelude.NFData ExecutionListItem where
  rnf ExecutionListItem' {..} =
    Prelude.rnf itemCount
      `Prelude.seq` Prelude.rnf mapRunArn
      `Prelude.seq` Prelude.rnf stopDate
      `Prelude.seq` Prelude.rnf executionArn
      `Prelude.seq` Prelude.rnf stateMachineArn
      `Prelude.seq` Prelude.rnf name
      `Prelude.seq` Prelude.rnf status
      `Prelude.seq` Prelude.rnf startDate