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

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

-- |
-- Module      : Amazonka.SWF.StartWorkflowExecution
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Starts an execution of the workflow type in the specified domain using
-- the provided @workflowId@ and input data.
--
-- This action returns the newly started workflow execution.
--
-- __Access Control__
--
-- You can use IAM policies to control this action\'s access to Amazon SWF
-- resources as follows:
--
-- -   Use a @Resource@ element with the domain name to limit the action to
--     only specified domains.
--
-- -   Use an @Action@ element to allow or deny permission to call this
--     action.
--
-- -   Constrain the following parameters by using a @Condition@ element
--     with the appropriate keys.
--
--     -   @tagList.member.0@: The key is @swf:tagList.member.0@.
--
--     -   @tagList.member.1@: The key is @swf:tagList.member.1@.
--
--     -   @tagList.member.2@: The key is @swf:tagList.member.2@.
--
--     -   @tagList.member.3@: The key is @swf:tagList.member.3@.
--
--     -   @tagList.member.4@: The key is @swf:tagList.member.4@.
--
--     -   @taskList@: String constraint. The key is @swf:taskList.name@.
--
--     -   @workflowType.name@: String constraint. The key is
--         @swf:workflowType.name@.
--
--     -   @workflowType.version@: String constraint. The key is
--         @swf:workflowType.version@.
--
-- If the caller doesn\'t have sufficient permissions to invoke the action,
-- or the parameter values fall outside the specified constraints, the
-- action fails. The associated event attribute\'s @cause@ parameter is set
-- to @OPERATION_NOT_PERMITTED@. For details and example IAM policies, see
-- <https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html Using IAM to Manage Access to Amazon SWF Workflows>
-- in the /Amazon SWF Developer Guide/.
module Amazonka.SWF.StartWorkflowExecution
  ( -- * Creating a Request
    StartWorkflowExecution (..),
    newStartWorkflowExecution,

    -- * Request Lenses
    startWorkflowExecution_childPolicy,
    startWorkflowExecution_executionStartToCloseTimeout,
    startWorkflowExecution_input,
    startWorkflowExecution_lambdaRole,
    startWorkflowExecution_tagList,
    startWorkflowExecution_taskList,
    startWorkflowExecution_taskPriority,
    startWorkflowExecution_taskStartToCloseTimeout,
    startWorkflowExecution_domain,
    startWorkflowExecution_workflowId,
    startWorkflowExecution_workflowType,

    -- * Destructuring the Response
    StartWorkflowExecutionResponse (..),
    newStartWorkflowExecutionResponse,

    -- * Response Lenses
    startWorkflowExecutionResponse_runId,
    startWorkflowExecutionResponse_httpStatus,
  )
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 qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.SWF.Types

-- | /See:/ 'newStartWorkflowExecution' smart constructor.
data StartWorkflowExecution = StartWorkflowExecution'
  { -- | If set, specifies the policy to use for the child workflow executions of
    -- this workflow execution if it is terminated, by calling the
    -- TerminateWorkflowExecution action explicitly or due to an expired
    -- timeout. This policy overrides the default child policy specified when
    -- registering the workflow type using RegisterWorkflowType.
    --
    -- The supported child policies are:
    --
    -- -   @TERMINATE@ – The child executions are terminated.
    --
    -- -   @REQUEST_CANCEL@ – A request to cancel is attempted for each child
    --     execution by recording a @WorkflowExecutionCancelRequested@ event in
    --     its history. It is up to the decider to take appropriate actions
    --     when it receives an execution history with this event.
    --
    -- -   @ABANDON@ – No action is taken. The child executions continue to
    --     run.
    --
    -- A child policy for this workflow execution must be specified either as a
    -- default for the workflow type or through this parameter. If neither this
    -- parameter is set nor a default child policy was specified at
    -- registration time then a fault is returned.
    StartWorkflowExecution -> Maybe ChildPolicy
childPolicy :: Prelude.Maybe ChildPolicy,
    -- | The total duration for this workflow execution. This overrides the
    -- defaultExecutionStartToCloseTimeout specified when registering the
    -- workflow type.
    --
    -- The duration is specified in seconds; an integer greater than or equal
    -- to @0@. Exceeding this limit causes the workflow execution to time out.
    -- Unlike some of the other timeout parameters in Amazon SWF, you cannot
    -- specify a value of \"NONE\" for this timeout; there is a one-year max
    -- limit on the time that a workflow execution can run.
    --
    -- An execution start-to-close timeout must be specified either through
    -- this parameter or as a default when the workflow type is registered. If
    -- neither this parameter nor a default execution start-to-close timeout is
    -- specified, a fault is returned.
    StartWorkflowExecution -> Maybe Text
executionStartToCloseTimeout :: Prelude.Maybe Prelude.Text,
    -- | The input for the workflow execution. This is a free form string which
    -- should be meaningful to the workflow you are starting. This @input@ is
    -- made available to the new workflow execution in the
    -- @WorkflowExecutionStarted@ history event.
    StartWorkflowExecution -> Maybe Text
input :: Prelude.Maybe Prelude.Text,
    -- | The IAM role to attach to this workflow execution.
    --
    -- Executions of this workflow type need IAM roles to invoke Lambda
    -- functions. If you don\'t attach an IAM role, any attempt to schedule a
    -- Lambda task fails. This results in a @ScheduleLambdaFunctionFailed@
    -- history event. For more information, see
    -- <https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html>
    -- in the /Amazon SWF Developer Guide/.
    StartWorkflowExecution -> Maybe Text
lambdaRole :: Prelude.Maybe Prelude.Text,
    -- | The list of tags to associate with the workflow execution. You can
    -- specify a maximum of 5 tags. You can list workflow executions with a
    -- specific tag by calling ListOpenWorkflowExecutions or
    -- ListClosedWorkflowExecutions and specifying a TagFilter.
    StartWorkflowExecution -> Maybe [Text]
tagList :: Prelude.Maybe [Prelude.Text],
    -- | The task list to use for the decision tasks generated for this workflow
    -- execution. This overrides the @defaultTaskList@ specified when
    -- registering the workflow type.
    --
    -- A task list for this workflow execution must be specified either as a
    -- default for the workflow type or through this parameter. If neither this
    -- parameter is set nor a default task list was specified at registration
    -- time then a fault is returned.
    --
    -- The specified string must not start or end with whitespace. It must not
    -- contain a @:@ (colon), @\/@ (slash), @|@ (vertical bar), or any control
    -- characters (@\\u0000-\\u001f@ | @\\u007f-\\u009f@). Also, it must not
    -- /be/ the literal string @arn@.
    StartWorkflowExecution -> Maybe TaskList
taskList :: Prelude.Maybe TaskList,
    -- | The task priority to use for this workflow execution. This overrides any
    -- default priority that was assigned when the workflow type was
    -- registered. If not set, then the default task priority for the workflow
    -- type is used. Valid values are integers that range from Java\'s
    -- @Integer.MIN_VALUE@ (-2147483648) to @Integer.MAX_VALUE@ (2147483647).
    -- Higher numbers indicate higher priority.
    --
    -- For more information about setting task priority, see
    -- <https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html Setting Task Priority>
    -- in the /Amazon SWF Developer Guide/.
    StartWorkflowExecution -> Maybe Text
taskPriority :: Prelude.Maybe Prelude.Text,
    -- | Specifies the maximum duration of decision tasks for this workflow
    -- execution. This parameter overrides the @defaultTaskStartToCloseTimout@
    -- specified when registering the workflow type using RegisterWorkflowType.
    --
    -- The duration is specified in seconds, an integer greater than or equal
    -- to @0@. You can use @NONE@ to specify unlimited duration.
    --
    -- A task start-to-close timeout for this workflow execution must be
    -- specified either as a default for the workflow type or through this
    -- parameter. If neither this parameter is set nor a default task
    -- start-to-close timeout was specified at registration time then a fault
    -- is returned.
    StartWorkflowExecution -> Maybe Text
taskStartToCloseTimeout :: Prelude.Maybe Prelude.Text,
    -- | The name of the domain in which the workflow execution is created.
    StartWorkflowExecution -> Text
domain :: Prelude.Text,
    -- | The user defined identifier associated with the workflow execution. You
    -- can use this to associate a custom identifier with the workflow
    -- execution. You may specify the same identifier if a workflow execution
    -- is logically a /restart/ of a previous execution. You cannot have two
    -- open workflow executions with the same @workflowId@ at the same time
    -- within the same domain.
    --
    -- The specified string must not start or end with whitespace. It must not
    -- contain a @:@ (colon), @\/@ (slash), @|@ (vertical bar), or any control
    -- characters (@\\u0000-\\u001f@ | @\\u007f-\\u009f@). Also, it must not
    -- /be/ the literal string @arn@.
    StartWorkflowExecution -> Text
workflowId :: Prelude.Text,
    -- | The type of the workflow to start.
    StartWorkflowExecution -> WorkflowType
workflowType :: WorkflowType
  }
  deriving (StartWorkflowExecution -> StartWorkflowExecution -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StartWorkflowExecution -> StartWorkflowExecution -> Bool
$c/= :: StartWorkflowExecution -> StartWorkflowExecution -> Bool
== :: StartWorkflowExecution -> StartWorkflowExecution -> Bool
$c== :: StartWorkflowExecution -> StartWorkflowExecution -> Bool
Prelude.Eq, ReadPrec [StartWorkflowExecution]
ReadPrec StartWorkflowExecution
Int -> ReadS StartWorkflowExecution
ReadS [StartWorkflowExecution]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StartWorkflowExecution]
$creadListPrec :: ReadPrec [StartWorkflowExecution]
readPrec :: ReadPrec StartWorkflowExecution
$creadPrec :: ReadPrec StartWorkflowExecution
readList :: ReadS [StartWorkflowExecution]
$creadList :: ReadS [StartWorkflowExecution]
readsPrec :: Int -> ReadS StartWorkflowExecution
$creadsPrec :: Int -> ReadS StartWorkflowExecution
Prelude.Read, Int -> StartWorkflowExecution -> ShowS
[StartWorkflowExecution] -> ShowS
StartWorkflowExecution -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StartWorkflowExecution] -> ShowS
$cshowList :: [StartWorkflowExecution] -> ShowS
show :: StartWorkflowExecution -> String
$cshow :: StartWorkflowExecution -> String
showsPrec :: Int -> StartWorkflowExecution -> ShowS
$cshowsPrec :: Int -> StartWorkflowExecution -> ShowS
Prelude.Show, forall x. Rep StartWorkflowExecution x -> StartWorkflowExecution
forall x. StartWorkflowExecution -> Rep StartWorkflowExecution x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep StartWorkflowExecution x -> StartWorkflowExecution
$cfrom :: forall x. StartWorkflowExecution -> Rep StartWorkflowExecution x
Prelude.Generic)

-- |
-- Create a value of 'StartWorkflowExecution' 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:
--
-- 'childPolicy', 'startWorkflowExecution_childPolicy' - If set, specifies the policy to use for the child workflow executions of
-- this workflow execution if it is terminated, by calling the
-- TerminateWorkflowExecution action explicitly or due to an expired
-- timeout. This policy overrides the default child policy specified when
-- registering the workflow type using RegisterWorkflowType.
--
-- The supported child policies are:
--
-- -   @TERMINATE@ – The child executions are terminated.
--
-- -   @REQUEST_CANCEL@ – A request to cancel is attempted for each child
--     execution by recording a @WorkflowExecutionCancelRequested@ event in
--     its history. It is up to the decider to take appropriate actions
--     when it receives an execution history with this event.
--
-- -   @ABANDON@ – No action is taken. The child executions continue to
--     run.
--
-- A child policy for this workflow execution must be specified either as a
-- default for the workflow type or through this parameter. If neither this
-- parameter is set nor a default child policy was specified at
-- registration time then a fault is returned.
--
-- 'executionStartToCloseTimeout', 'startWorkflowExecution_executionStartToCloseTimeout' - The total duration for this workflow execution. This overrides the
-- defaultExecutionStartToCloseTimeout specified when registering the
-- workflow type.
--
-- The duration is specified in seconds; an integer greater than or equal
-- to @0@. Exceeding this limit causes the workflow execution to time out.
-- Unlike some of the other timeout parameters in Amazon SWF, you cannot
-- specify a value of \"NONE\" for this timeout; there is a one-year max
-- limit on the time that a workflow execution can run.
--
-- An execution start-to-close timeout must be specified either through
-- this parameter or as a default when the workflow type is registered. If
-- neither this parameter nor a default execution start-to-close timeout is
-- specified, a fault is returned.
--
-- 'input', 'startWorkflowExecution_input' - The input for the workflow execution. This is a free form string which
-- should be meaningful to the workflow you are starting. This @input@ is
-- made available to the new workflow execution in the
-- @WorkflowExecutionStarted@ history event.
--
-- 'lambdaRole', 'startWorkflowExecution_lambdaRole' - The IAM role to attach to this workflow execution.
--
-- Executions of this workflow type need IAM roles to invoke Lambda
-- functions. If you don\'t attach an IAM role, any attempt to schedule a
-- Lambda task fails. This results in a @ScheduleLambdaFunctionFailed@
-- history event. For more information, see
-- <https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html>
-- in the /Amazon SWF Developer Guide/.
--
-- 'tagList', 'startWorkflowExecution_tagList' - The list of tags to associate with the workflow execution. You can
-- specify a maximum of 5 tags. You can list workflow executions with a
-- specific tag by calling ListOpenWorkflowExecutions or
-- ListClosedWorkflowExecutions and specifying a TagFilter.
--
-- 'taskList', 'startWorkflowExecution_taskList' - The task list to use for the decision tasks generated for this workflow
-- execution. This overrides the @defaultTaskList@ specified when
-- registering the workflow type.
--
-- A task list for this workflow execution must be specified either as a
-- default for the workflow type or through this parameter. If neither this
-- parameter is set nor a default task list was specified at registration
-- time then a fault is returned.
--
-- The specified string must not start or end with whitespace. It must not
-- contain a @:@ (colon), @\/@ (slash), @|@ (vertical bar), or any control
-- characters (@\\u0000-\\u001f@ | @\\u007f-\\u009f@). Also, it must not
-- /be/ the literal string @arn@.
--
-- 'taskPriority', 'startWorkflowExecution_taskPriority' - The task priority to use for this workflow execution. This overrides any
-- default priority that was assigned when the workflow type was
-- registered. If not set, then the default task priority for the workflow
-- type is used. Valid values are integers that range from Java\'s
-- @Integer.MIN_VALUE@ (-2147483648) to @Integer.MAX_VALUE@ (2147483647).
-- Higher numbers indicate higher priority.
--
-- For more information about setting task priority, see
-- <https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html Setting Task Priority>
-- in the /Amazon SWF Developer Guide/.
--
-- 'taskStartToCloseTimeout', 'startWorkflowExecution_taskStartToCloseTimeout' - Specifies the maximum duration of decision tasks for this workflow
-- execution. This parameter overrides the @defaultTaskStartToCloseTimout@
-- specified when registering the workflow type using RegisterWorkflowType.
--
-- The duration is specified in seconds, an integer greater than or equal
-- to @0@. You can use @NONE@ to specify unlimited duration.
--
-- A task start-to-close timeout for this workflow execution must be
-- specified either as a default for the workflow type or through this
-- parameter. If neither this parameter is set nor a default task
-- start-to-close timeout was specified at registration time then a fault
-- is returned.
--
-- 'domain', 'startWorkflowExecution_domain' - The name of the domain in which the workflow execution is created.
--
-- 'workflowId', 'startWorkflowExecution_workflowId' - The user defined identifier associated with the workflow execution. You
-- can use this to associate a custom identifier with the workflow
-- execution. You may specify the same identifier if a workflow execution
-- is logically a /restart/ of a previous execution. You cannot have two
-- open workflow executions with the same @workflowId@ at the same time
-- within the same domain.
--
-- The specified string must not start or end with whitespace. It must not
-- contain a @:@ (colon), @\/@ (slash), @|@ (vertical bar), or any control
-- characters (@\\u0000-\\u001f@ | @\\u007f-\\u009f@). Also, it must not
-- /be/ the literal string @arn@.
--
-- 'workflowType', 'startWorkflowExecution_workflowType' - The type of the workflow to start.
newStartWorkflowExecution ::
  -- | 'domain'
  Prelude.Text ->
  -- | 'workflowId'
  Prelude.Text ->
  -- | 'workflowType'
  WorkflowType ->
  StartWorkflowExecution
newStartWorkflowExecution :: Text -> Text -> WorkflowType -> StartWorkflowExecution
newStartWorkflowExecution
  Text
pDomain_
  Text
pWorkflowId_
  WorkflowType
pWorkflowType_ =
    StartWorkflowExecution'
      { $sel:childPolicy:StartWorkflowExecution' :: Maybe ChildPolicy
childPolicy =
          forall a. Maybe a
Prelude.Nothing,
        $sel:executionStartToCloseTimeout:StartWorkflowExecution' :: Maybe Text
executionStartToCloseTimeout = forall a. Maybe a
Prelude.Nothing,
        $sel:input:StartWorkflowExecution' :: Maybe Text
input = forall a. Maybe a
Prelude.Nothing,
        $sel:lambdaRole:StartWorkflowExecution' :: Maybe Text
lambdaRole = forall a. Maybe a
Prelude.Nothing,
        $sel:tagList:StartWorkflowExecution' :: Maybe [Text]
tagList = forall a. Maybe a
Prelude.Nothing,
        $sel:taskList:StartWorkflowExecution' :: Maybe TaskList
taskList = forall a. Maybe a
Prelude.Nothing,
        $sel:taskPriority:StartWorkflowExecution' :: Maybe Text
taskPriority = forall a. Maybe a
Prelude.Nothing,
        $sel:taskStartToCloseTimeout:StartWorkflowExecution' :: Maybe Text
taskStartToCloseTimeout = forall a. Maybe a
Prelude.Nothing,
        $sel:domain:StartWorkflowExecution' :: Text
domain = Text
pDomain_,
        $sel:workflowId:StartWorkflowExecution' :: Text
workflowId = Text
pWorkflowId_,
        $sel:workflowType:StartWorkflowExecution' :: WorkflowType
workflowType = WorkflowType
pWorkflowType_
      }

-- | If set, specifies the policy to use for the child workflow executions of
-- this workflow execution if it is terminated, by calling the
-- TerminateWorkflowExecution action explicitly or due to an expired
-- timeout. This policy overrides the default child policy specified when
-- registering the workflow type using RegisterWorkflowType.
--
-- The supported child policies are:
--
-- -   @TERMINATE@ – The child executions are terminated.
--
-- -   @REQUEST_CANCEL@ – A request to cancel is attempted for each child
--     execution by recording a @WorkflowExecutionCancelRequested@ event in
--     its history. It is up to the decider to take appropriate actions
--     when it receives an execution history with this event.
--
-- -   @ABANDON@ – No action is taken. The child executions continue to
--     run.
--
-- A child policy for this workflow execution must be specified either as a
-- default for the workflow type or through this parameter. If neither this
-- parameter is set nor a default child policy was specified at
-- registration time then a fault is returned.
startWorkflowExecution_childPolicy :: Lens.Lens' StartWorkflowExecution (Prelude.Maybe ChildPolicy)
startWorkflowExecution_childPolicy :: Lens' StartWorkflowExecution (Maybe ChildPolicy)
startWorkflowExecution_childPolicy = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecution' {Maybe ChildPolicy
childPolicy :: Maybe ChildPolicy
$sel:childPolicy:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe ChildPolicy
childPolicy} -> Maybe ChildPolicy
childPolicy) (\s :: StartWorkflowExecution
s@StartWorkflowExecution' {} Maybe ChildPolicy
a -> StartWorkflowExecution
s {$sel:childPolicy:StartWorkflowExecution' :: Maybe ChildPolicy
childPolicy = Maybe ChildPolicy
a} :: StartWorkflowExecution)

-- | The total duration for this workflow execution. This overrides the
-- defaultExecutionStartToCloseTimeout specified when registering the
-- workflow type.
--
-- The duration is specified in seconds; an integer greater than or equal
-- to @0@. Exceeding this limit causes the workflow execution to time out.
-- Unlike some of the other timeout parameters in Amazon SWF, you cannot
-- specify a value of \"NONE\" for this timeout; there is a one-year max
-- limit on the time that a workflow execution can run.
--
-- An execution start-to-close timeout must be specified either through
-- this parameter or as a default when the workflow type is registered. If
-- neither this parameter nor a default execution start-to-close timeout is
-- specified, a fault is returned.
startWorkflowExecution_executionStartToCloseTimeout :: Lens.Lens' StartWorkflowExecution (Prelude.Maybe Prelude.Text)
startWorkflowExecution_executionStartToCloseTimeout :: Lens' StartWorkflowExecution (Maybe Text)
startWorkflowExecution_executionStartToCloseTimeout = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecution' {Maybe Text
executionStartToCloseTimeout :: Maybe Text
$sel:executionStartToCloseTimeout:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
executionStartToCloseTimeout} -> Maybe Text
executionStartToCloseTimeout) (\s :: StartWorkflowExecution
s@StartWorkflowExecution' {} Maybe Text
a -> StartWorkflowExecution
s {$sel:executionStartToCloseTimeout:StartWorkflowExecution' :: Maybe Text
executionStartToCloseTimeout = Maybe Text
a} :: StartWorkflowExecution)

-- | The input for the workflow execution. This is a free form string which
-- should be meaningful to the workflow you are starting. This @input@ is
-- made available to the new workflow execution in the
-- @WorkflowExecutionStarted@ history event.
startWorkflowExecution_input :: Lens.Lens' StartWorkflowExecution (Prelude.Maybe Prelude.Text)
startWorkflowExecution_input :: Lens' StartWorkflowExecution (Maybe Text)
startWorkflowExecution_input = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecution' {Maybe Text
input :: Maybe Text
$sel:input:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
input} -> Maybe Text
input) (\s :: StartWorkflowExecution
s@StartWorkflowExecution' {} Maybe Text
a -> StartWorkflowExecution
s {$sel:input:StartWorkflowExecution' :: Maybe Text
input = Maybe Text
a} :: StartWorkflowExecution)

-- | The IAM role to attach to this workflow execution.
--
-- Executions of this workflow type need IAM roles to invoke Lambda
-- functions. If you don\'t attach an IAM role, any attempt to schedule a
-- Lambda task fails. This results in a @ScheduleLambdaFunctionFailed@
-- history event. For more information, see
-- <https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html>
-- in the /Amazon SWF Developer Guide/.
startWorkflowExecution_lambdaRole :: Lens.Lens' StartWorkflowExecution (Prelude.Maybe Prelude.Text)
startWorkflowExecution_lambdaRole :: Lens' StartWorkflowExecution (Maybe Text)
startWorkflowExecution_lambdaRole = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecution' {Maybe Text
lambdaRole :: Maybe Text
$sel:lambdaRole:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
lambdaRole} -> Maybe Text
lambdaRole) (\s :: StartWorkflowExecution
s@StartWorkflowExecution' {} Maybe Text
a -> StartWorkflowExecution
s {$sel:lambdaRole:StartWorkflowExecution' :: Maybe Text
lambdaRole = Maybe Text
a} :: StartWorkflowExecution)

-- | The list of tags to associate with the workflow execution. You can
-- specify a maximum of 5 tags. You can list workflow executions with a
-- specific tag by calling ListOpenWorkflowExecutions or
-- ListClosedWorkflowExecutions and specifying a TagFilter.
startWorkflowExecution_tagList :: Lens.Lens' StartWorkflowExecution (Prelude.Maybe [Prelude.Text])
startWorkflowExecution_tagList :: Lens' StartWorkflowExecution (Maybe [Text])
startWorkflowExecution_tagList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecution' {Maybe [Text]
tagList :: Maybe [Text]
$sel:tagList:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe [Text]
tagList} -> Maybe [Text]
tagList) (\s :: StartWorkflowExecution
s@StartWorkflowExecution' {} Maybe [Text]
a -> StartWorkflowExecution
s {$sel:tagList:StartWorkflowExecution' :: Maybe [Text]
tagList = Maybe [Text]
a} :: StartWorkflowExecution) 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 s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The task list to use for the decision tasks generated for this workflow
-- execution. This overrides the @defaultTaskList@ specified when
-- registering the workflow type.
--
-- A task list for this workflow execution must be specified either as a
-- default for the workflow type or through this parameter. If neither this
-- parameter is set nor a default task list was specified at registration
-- time then a fault is returned.
--
-- The specified string must not start or end with whitespace. It must not
-- contain a @:@ (colon), @\/@ (slash), @|@ (vertical bar), or any control
-- characters (@\\u0000-\\u001f@ | @\\u007f-\\u009f@). Also, it must not
-- /be/ the literal string @arn@.
startWorkflowExecution_taskList :: Lens.Lens' StartWorkflowExecution (Prelude.Maybe TaskList)
startWorkflowExecution_taskList :: Lens' StartWorkflowExecution (Maybe TaskList)
startWorkflowExecution_taskList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecution' {Maybe TaskList
taskList :: Maybe TaskList
$sel:taskList:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe TaskList
taskList} -> Maybe TaskList
taskList) (\s :: StartWorkflowExecution
s@StartWorkflowExecution' {} Maybe TaskList
a -> StartWorkflowExecution
s {$sel:taskList:StartWorkflowExecution' :: Maybe TaskList
taskList = Maybe TaskList
a} :: StartWorkflowExecution)

-- | The task priority to use for this workflow execution. This overrides any
-- default priority that was assigned when the workflow type was
-- registered. If not set, then the default task priority for the workflow
-- type is used. Valid values are integers that range from Java\'s
-- @Integer.MIN_VALUE@ (-2147483648) to @Integer.MAX_VALUE@ (2147483647).
-- Higher numbers indicate higher priority.
--
-- For more information about setting task priority, see
-- <https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html Setting Task Priority>
-- in the /Amazon SWF Developer Guide/.
startWorkflowExecution_taskPriority :: Lens.Lens' StartWorkflowExecution (Prelude.Maybe Prelude.Text)
startWorkflowExecution_taskPriority :: Lens' StartWorkflowExecution (Maybe Text)
startWorkflowExecution_taskPriority = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecution' {Maybe Text
taskPriority :: Maybe Text
$sel:taskPriority:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
taskPriority} -> Maybe Text
taskPriority) (\s :: StartWorkflowExecution
s@StartWorkflowExecution' {} Maybe Text
a -> StartWorkflowExecution
s {$sel:taskPriority:StartWorkflowExecution' :: Maybe Text
taskPriority = Maybe Text
a} :: StartWorkflowExecution)

-- | Specifies the maximum duration of decision tasks for this workflow
-- execution. This parameter overrides the @defaultTaskStartToCloseTimout@
-- specified when registering the workflow type using RegisterWorkflowType.
--
-- The duration is specified in seconds, an integer greater than or equal
-- to @0@. You can use @NONE@ to specify unlimited duration.
--
-- A task start-to-close timeout for this workflow execution must be
-- specified either as a default for the workflow type or through this
-- parameter. If neither this parameter is set nor a default task
-- start-to-close timeout was specified at registration time then a fault
-- is returned.
startWorkflowExecution_taskStartToCloseTimeout :: Lens.Lens' StartWorkflowExecution (Prelude.Maybe Prelude.Text)
startWorkflowExecution_taskStartToCloseTimeout :: Lens' StartWorkflowExecution (Maybe Text)
startWorkflowExecution_taskStartToCloseTimeout = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecution' {Maybe Text
taskStartToCloseTimeout :: Maybe Text
$sel:taskStartToCloseTimeout:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
taskStartToCloseTimeout} -> Maybe Text
taskStartToCloseTimeout) (\s :: StartWorkflowExecution
s@StartWorkflowExecution' {} Maybe Text
a -> StartWorkflowExecution
s {$sel:taskStartToCloseTimeout:StartWorkflowExecution' :: Maybe Text
taskStartToCloseTimeout = Maybe Text
a} :: StartWorkflowExecution)

-- | The name of the domain in which the workflow execution is created.
startWorkflowExecution_domain :: Lens.Lens' StartWorkflowExecution Prelude.Text
startWorkflowExecution_domain :: Lens' StartWorkflowExecution Text
startWorkflowExecution_domain = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecution' {Text
domain :: Text
$sel:domain:StartWorkflowExecution' :: StartWorkflowExecution -> Text
domain} -> Text
domain) (\s :: StartWorkflowExecution
s@StartWorkflowExecution' {} Text
a -> StartWorkflowExecution
s {$sel:domain:StartWorkflowExecution' :: Text
domain = Text
a} :: StartWorkflowExecution)

-- | The user defined identifier associated with the workflow execution. You
-- can use this to associate a custom identifier with the workflow
-- execution. You may specify the same identifier if a workflow execution
-- is logically a /restart/ of a previous execution. You cannot have two
-- open workflow executions with the same @workflowId@ at the same time
-- within the same domain.
--
-- The specified string must not start or end with whitespace. It must not
-- contain a @:@ (colon), @\/@ (slash), @|@ (vertical bar), or any control
-- characters (@\\u0000-\\u001f@ | @\\u007f-\\u009f@). Also, it must not
-- /be/ the literal string @arn@.
startWorkflowExecution_workflowId :: Lens.Lens' StartWorkflowExecution Prelude.Text
startWorkflowExecution_workflowId :: Lens' StartWorkflowExecution Text
startWorkflowExecution_workflowId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecution' {Text
workflowId :: Text
$sel:workflowId:StartWorkflowExecution' :: StartWorkflowExecution -> Text
workflowId} -> Text
workflowId) (\s :: StartWorkflowExecution
s@StartWorkflowExecution' {} Text
a -> StartWorkflowExecution
s {$sel:workflowId:StartWorkflowExecution' :: Text
workflowId = Text
a} :: StartWorkflowExecution)

-- | The type of the workflow to start.
startWorkflowExecution_workflowType :: Lens.Lens' StartWorkflowExecution WorkflowType
startWorkflowExecution_workflowType :: Lens' StartWorkflowExecution WorkflowType
startWorkflowExecution_workflowType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecution' {WorkflowType
workflowType :: WorkflowType
$sel:workflowType:StartWorkflowExecution' :: StartWorkflowExecution -> WorkflowType
workflowType} -> WorkflowType
workflowType) (\s :: StartWorkflowExecution
s@StartWorkflowExecution' {} WorkflowType
a -> StartWorkflowExecution
s {$sel:workflowType:StartWorkflowExecution' :: WorkflowType
workflowType = WorkflowType
a} :: StartWorkflowExecution)

instance Core.AWSRequest StartWorkflowExecution where
  type
    AWSResponse StartWorkflowExecution =
      StartWorkflowExecutionResponse
  request :: (Service -> Service)
-> StartWorkflowExecution -> Request StartWorkflowExecution
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy StartWorkflowExecution
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse StartWorkflowExecution)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Text -> Int -> StartWorkflowExecutionResponse
StartWorkflowExecutionResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"runId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable StartWorkflowExecution where
  hashWithSalt :: Int -> StartWorkflowExecution -> Int
hashWithSalt Int
_salt StartWorkflowExecution' {Maybe [Text]
Maybe Text
Maybe ChildPolicy
Maybe TaskList
Text
WorkflowType
workflowType :: WorkflowType
workflowId :: Text
domain :: Text
taskStartToCloseTimeout :: Maybe Text
taskPriority :: Maybe Text
taskList :: Maybe TaskList
tagList :: Maybe [Text]
lambdaRole :: Maybe Text
input :: Maybe Text
executionStartToCloseTimeout :: Maybe Text
childPolicy :: Maybe ChildPolicy
$sel:workflowType:StartWorkflowExecution' :: StartWorkflowExecution -> WorkflowType
$sel:workflowId:StartWorkflowExecution' :: StartWorkflowExecution -> Text
$sel:domain:StartWorkflowExecution' :: StartWorkflowExecution -> Text
$sel:taskStartToCloseTimeout:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:taskPriority:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:taskList:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe TaskList
$sel:tagList:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe [Text]
$sel:lambdaRole:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:input:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:executionStartToCloseTimeout:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:childPolicy:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe ChildPolicy
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ChildPolicy
childPolicy
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
executionStartToCloseTimeout
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
input
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
lambdaRole
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
tagList
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TaskList
taskList
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
taskPriority
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
taskStartToCloseTimeout
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
domain
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
workflowId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` WorkflowType
workflowType

instance Prelude.NFData StartWorkflowExecution where
  rnf :: StartWorkflowExecution -> ()
rnf StartWorkflowExecution' {Maybe [Text]
Maybe Text
Maybe ChildPolicy
Maybe TaskList
Text
WorkflowType
workflowType :: WorkflowType
workflowId :: Text
domain :: Text
taskStartToCloseTimeout :: Maybe Text
taskPriority :: Maybe Text
taskList :: Maybe TaskList
tagList :: Maybe [Text]
lambdaRole :: Maybe Text
input :: Maybe Text
executionStartToCloseTimeout :: Maybe Text
childPolicy :: Maybe ChildPolicy
$sel:workflowType:StartWorkflowExecution' :: StartWorkflowExecution -> WorkflowType
$sel:workflowId:StartWorkflowExecution' :: StartWorkflowExecution -> Text
$sel:domain:StartWorkflowExecution' :: StartWorkflowExecution -> Text
$sel:taskStartToCloseTimeout:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:taskPriority:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:taskList:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe TaskList
$sel:tagList:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe [Text]
$sel:lambdaRole:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:input:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:executionStartToCloseTimeout:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:childPolicy:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe ChildPolicy
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ChildPolicy
childPolicy
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
executionStartToCloseTimeout
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
input
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
lambdaRole
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
tagList
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe TaskList
taskList
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
taskPriority
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
taskStartToCloseTimeout
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
domain
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
workflowId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf WorkflowType
workflowType

instance Data.ToHeaders StartWorkflowExecution where
  toHeaders :: StartWorkflowExecution -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"SimpleWorkflowService.StartWorkflowExecution" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.0" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON StartWorkflowExecution where
  toJSON :: StartWorkflowExecution -> Value
toJSON StartWorkflowExecution' {Maybe [Text]
Maybe Text
Maybe ChildPolicy
Maybe TaskList
Text
WorkflowType
workflowType :: WorkflowType
workflowId :: Text
domain :: Text
taskStartToCloseTimeout :: Maybe Text
taskPriority :: Maybe Text
taskList :: Maybe TaskList
tagList :: Maybe [Text]
lambdaRole :: Maybe Text
input :: Maybe Text
executionStartToCloseTimeout :: Maybe Text
childPolicy :: Maybe ChildPolicy
$sel:workflowType:StartWorkflowExecution' :: StartWorkflowExecution -> WorkflowType
$sel:workflowId:StartWorkflowExecution' :: StartWorkflowExecution -> Text
$sel:domain:StartWorkflowExecution' :: StartWorkflowExecution -> Text
$sel:taskStartToCloseTimeout:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:taskPriority:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:taskList:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe TaskList
$sel:tagList:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe [Text]
$sel:lambdaRole:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:input:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:executionStartToCloseTimeout:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe Text
$sel:childPolicy:StartWorkflowExecution' :: StartWorkflowExecution -> Maybe ChildPolicy
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"childPolicy" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe ChildPolicy
childPolicy,
            (Key
"executionStartToCloseTimeout" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
executionStartToCloseTimeout,
            (Key
"input" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
input,
            (Key
"lambdaRole" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
lambdaRole,
            (Key
"tagList" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
tagList,
            (Key
"taskList" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe TaskList
taskList,
            (Key
"taskPriority" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
taskPriority,
            (Key
"taskStartToCloseTimeout" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
taskStartToCloseTimeout,
            forall a. a -> Maybe a
Prelude.Just (Key
"domain" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
domain),
            forall a. a -> Maybe a
Prelude.Just (Key
"workflowId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
workflowId),
            forall a. a -> Maybe a
Prelude.Just (Key
"workflowType" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= WorkflowType
workflowType)
          ]
      )

instance Data.ToPath StartWorkflowExecution where
  toPath :: StartWorkflowExecution -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery StartWorkflowExecution where
  toQuery :: StartWorkflowExecution -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | Specifies the @runId@ of a workflow execution.
--
-- /See:/ 'newStartWorkflowExecutionResponse' smart constructor.
data StartWorkflowExecutionResponse = StartWorkflowExecutionResponse'
  { -- | The @runId@ of a workflow execution. This ID is generated by the service
    -- and can be used to uniquely identify the workflow execution within a
    -- domain.
    StartWorkflowExecutionResponse -> Maybe Text
runId :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    StartWorkflowExecutionResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (StartWorkflowExecutionResponse
-> StartWorkflowExecutionResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StartWorkflowExecutionResponse
-> StartWorkflowExecutionResponse -> Bool
$c/= :: StartWorkflowExecutionResponse
-> StartWorkflowExecutionResponse -> Bool
== :: StartWorkflowExecutionResponse
-> StartWorkflowExecutionResponse -> Bool
$c== :: StartWorkflowExecutionResponse
-> StartWorkflowExecutionResponse -> Bool
Prelude.Eq, ReadPrec [StartWorkflowExecutionResponse]
ReadPrec StartWorkflowExecutionResponse
Int -> ReadS StartWorkflowExecutionResponse
ReadS [StartWorkflowExecutionResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StartWorkflowExecutionResponse]
$creadListPrec :: ReadPrec [StartWorkflowExecutionResponse]
readPrec :: ReadPrec StartWorkflowExecutionResponse
$creadPrec :: ReadPrec StartWorkflowExecutionResponse
readList :: ReadS [StartWorkflowExecutionResponse]
$creadList :: ReadS [StartWorkflowExecutionResponse]
readsPrec :: Int -> ReadS StartWorkflowExecutionResponse
$creadsPrec :: Int -> ReadS StartWorkflowExecutionResponse
Prelude.Read, Int -> StartWorkflowExecutionResponse -> ShowS
[StartWorkflowExecutionResponse] -> ShowS
StartWorkflowExecutionResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StartWorkflowExecutionResponse] -> ShowS
$cshowList :: [StartWorkflowExecutionResponse] -> ShowS
show :: StartWorkflowExecutionResponse -> String
$cshow :: StartWorkflowExecutionResponse -> String
showsPrec :: Int -> StartWorkflowExecutionResponse -> ShowS
$cshowsPrec :: Int -> StartWorkflowExecutionResponse -> ShowS
Prelude.Show, forall x.
Rep StartWorkflowExecutionResponse x
-> StartWorkflowExecutionResponse
forall x.
StartWorkflowExecutionResponse
-> Rep StartWorkflowExecutionResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep StartWorkflowExecutionResponse x
-> StartWorkflowExecutionResponse
$cfrom :: forall x.
StartWorkflowExecutionResponse
-> Rep StartWorkflowExecutionResponse x
Prelude.Generic)

-- |
-- Create a value of 'StartWorkflowExecutionResponse' 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:
--
-- 'runId', 'startWorkflowExecutionResponse_runId' - The @runId@ of a workflow execution. This ID is generated by the service
-- and can be used to uniquely identify the workflow execution within a
-- domain.
--
-- 'httpStatus', 'startWorkflowExecutionResponse_httpStatus' - The response's http status code.
newStartWorkflowExecutionResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  StartWorkflowExecutionResponse
newStartWorkflowExecutionResponse :: Int -> StartWorkflowExecutionResponse
newStartWorkflowExecutionResponse Int
pHttpStatus_ =
  StartWorkflowExecutionResponse'
    { $sel:runId:StartWorkflowExecutionResponse' :: Maybe Text
runId =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:StartWorkflowExecutionResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The @runId@ of a workflow execution. This ID is generated by the service
-- and can be used to uniquely identify the workflow execution within a
-- domain.
startWorkflowExecutionResponse_runId :: Lens.Lens' StartWorkflowExecutionResponse (Prelude.Maybe Prelude.Text)
startWorkflowExecutionResponse_runId :: Lens' StartWorkflowExecutionResponse (Maybe Text)
startWorkflowExecutionResponse_runId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecutionResponse' {Maybe Text
runId :: Maybe Text
$sel:runId:StartWorkflowExecutionResponse' :: StartWorkflowExecutionResponse -> Maybe Text
runId} -> Maybe Text
runId) (\s :: StartWorkflowExecutionResponse
s@StartWorkflowExecutionResponse' {} Maybe Text
a -> StartWorkflowExecutionResponse
s {$sel:runId:StartWorkflowExecutionResponse' :: Maybe Text
runId = Maybe Text
a} :: StartWorkflowExecutionResponse)

-- | The response's http status code.
startWorkflowExecutionResponse_httpStatus :: Lens.Lens' StartWorkflowExecutionResponse Prelude.Int
startWorkflowExecutionResponse_httpStatus :: Lens' StartWorkflowExecutionResponse Int
startWorkflowExecutionResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartWorkflowExecutionResponse' {Int
httpStatus :: Int
$sel:httpStatus:StartWorkflowExecutionResponse' :: StartWorkflowExecutionResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: StartWorkflowExecutionResponse
s@StartWorkflowExecutionResponse' {} Int
a -> StartWorkflowExecutionResponse
s {$sel:httpStatus:StartWorkflowExecutionResponse' :: Int
httpStatus = Int
a} :: StartWorkflowExecutionResponse)

instance
  Prelude.NFData
    StartWorkflowExecutionResponse
  where
  rnf :: StartWorkflowExecutionResponse -> ()
rnf StartWorkflowExecutionResponse' {Int
Maybe Text
httpStatus :: Int
runId :: Maybe Text
$sel:httpStatus:StartWorkflowExecutionResponse' :: StartWorkflowExecutionResponse -> Int
$sel:runId:StartWorkflowExecutionResponse' :: StartWorkflowExecutionResponse -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
runId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus