{-# 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-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)
--
-- 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_tagList,
    startWorkflowExecution_taskStartToCloseTimeout,
    startWorkflowExecution_lambdaRole,
    startWorkflowExecution_input,
    startWorkflowExecution_executionStartToCloseTimeout,
    startWorkflowExecution_taskList,
    startWorkflowExecution_taskPriority,
    startWorkflowExecution_childPolicy,
    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.Lens as Lens
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'
  { -- | 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],
    -- | 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 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 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 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 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,
    -- | 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 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
(StartWorkflowExecution -> StartWorkflowExecution -> Bool)
-> (StartWorkflowExecution -> StartWorkflowExecution -> Bool)
-> Eq StartWorkflowExecution
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]
(Int -> ReadS StartWorkflowExecution)
-> ReadS [StartWorkflowExecution]
-> ReadPrec StartWorkflowExecution
-> ReadPrec [StartWorkflowExecution]
-> Read 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
(Int -> StartWorkflowExecution -> ShowS)
-> (StartWorkflowExecution -> String)
-> ([StartWorkflowExecution] -> ShowS)
-> Show StartWorkflowExecution
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. StartWorkflowExecution -> Rep StartWorkflowExecution x)
-> (forall x.
    Rep StartWorkflowExecution x -> StartWorkflowExecution)
-> Generic StartWorkflowExecution
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:
--
-- '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.
--
-- '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.
--
-- '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/.
--
-- '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.
--
-- '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.
--
-- '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/.
--
-- '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.
--
-- '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' :: Maybe [Text]
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe TaskList
-> Maybe Text
-> Maybe ChildPolicy
-> Text
-> Text
-> WorkflowType
-> StartWorkflowExecution
StartWorkflowExecution'
      { $sel:tagList:StartWorkflowExecution' :: Maybe [Text]
tagList = Maybe [Text]
forall a. Maybe a
Prelude.Nothing,
        $sel:taskStartToCloseTimeout:StartWorkflowExecution' :: Maybe Text
taskStartToCloseTimeout = Maybe Text
forall a. Maybe a
Prelude.Nothing,
        $sel:lambdaRole:StartWorkflowExecution' :: Maybe Text
lambdaRole = Maybe Text
forall a. Maybe a
Prelude.Nothing,
        $sel:input:StartWorkflowExecution' :: Maybe Text
input = Maybe Text
forall a. Maybe a
Prelude.Nothing,
        $sel:executionStartToCloseTimeout:StartWorkflowExecution' :: Maybe Text
executionStartToCloseTimeout = Maybe Text
forall a. Maybe a
Prelude.Nothing,
        $sel:taskList:StartWorkflowExecution' :: Maybe TaskList
taskList = Maybe TaskList
forall a. Maybe a
Prelude.Nothing,
        $sel:taskPriority:StartWorkflowExecution' :: Maybe Text
taskPriority = Maybe Text
forall a. Maybe a
Prelude.Nothing,
        $sel:childPolicy:StartWorkflowExecution' :: Maybe ChildPolicy
childPolicy = Maybe ChildPolicy
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_
      }

-- | 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 :: (Maybe [Text] -> f (Maybe [Text]))
-> StartWorkflowExecution -> f StartWorkflowExecution
startWorkflowExecution_tagList = (StartWorkflowExecution -> Maybe [Text])
-> (StartWorkflowExecution
    -> Maybe [Text] -> StartWorkflowExecution)
-> Lens
     StartWorkflowExecution
     StartWorkflowExecution
     (Maybe [Text])
     (Maybe [Text])
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) ((Maybe [Text] -> f (Maybe [Text]))
 -> StartWorkflowExecution -> f StartWorkflowExecution)
-> ((Maybe [Text] -> f (Maybe [Text]))
    -> Maybe [Text] -> f (Maybe [Text]))
-> (Maybe [Text] -> f (Maybe [Text]))
-> StartWorkflowExecution
-> f StartWorkflowExecution
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso [Text] [Text] [Text] [Text]
-> Iso (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text])
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 [Text] [Text] [Text] [Text]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | 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 :: (Maybe Text -> f (Maybe Text))
-> StartWorkflowExecution -> f StartWorkflowExecution
startWorkflowExecution_taskStartToCloseTimeout = (StartWorkflowExecution -> Maybe Text)
-> (StartWorkflowExecution -> Maybe Text -> StartWorkflowExecution)
-> Lens
     StartWorkflowExecution
     StartWorkflowExecution
     (Maybe Text)
     (Maybe Text)
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 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 :: (Maybe Text -> f (Maybe Text))
-> StartWorkflowExecution -> f StartWorkflowExecution
startWorkflowExecution_lambdaRole = (StartWorkflowExecution -> Maybe Text)
-> (StartWorkflowExecution -> Maybe Text -> StartWorkflowExecution)
-> Lens
     StartWorkflowExecution
     StartWorkflowExecution
     (Maybe Text)
     (Maybe Text)
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 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 :: (Maybe Text -> f (Maybe Text))
-> StartWorkflowExecution -> f StartWorkflowExecution
startWorkflowExecution_input = (StartWorkflowExecution -> Maybe Text)
-> (StartWorkflowExecution -> Maybe Text -> StartWorkflowExecution)
-> Lens
     StartWorkflowExecution
     StartWorkflowExecution
     (Maybe Text)
     (Maybe Text)
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 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 :: (Maybe Text -> f (Maybe Text))
-> StartWorkflowExecution -> f StartWorkflowExecution
startWorkflowExecution_executionStartToCloseTimeout = (StartWorkflowExecution -> Maybe Text)
-> (StartWorkflowExecution -> Maybe Text -> StartWorkflowExecution)
-> Lens
     StartWorkflowExecution
     StartWorkflowExecution
     (Maybe Text)
     (Maybe Text)
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 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 :: (Maybe TaskList -> f (Maybe TaskList))
-> StartWorkflowExecution -> f StartWorkflowExecution
startWorkflowExecution_taskList = (StartWorkflowExecution -> Maybe TaskList)
-> (StartWorkflowExecution
    -> Maybe TaskList -> StartWorkflowExecution)
-> Lens
     StartWorkflowExecution
     StartWorkflowExecution
     (Maybe TaskList)
     (Maybe 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 :: (Maybe Text -> f (Maybe Text))
-> StartWorkflowExecution -> f StartWorkflowExecution
startWorkflowExecution_taskPriority = (StartWorkflowExecution -> Maybe Text)
-> (StartWorkflowExecution -> Maybe Text -> StartWorkflowExecution)
-> Lens
     StartWorkflowExecution
     StartWorkflowExecution
     (Maybe Text)
     (Maybe Text)
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)

-- | 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 :: (Maybe ChildPolicy -> f (Maybe ChildPolicy))
-> StartWorkflowExecution -> f StartWorkflowExecution
startWorkflowExecution_childPolicy = (StartWorkflowExecution -> Maybe ChildPolicy)
-> (StartWorkflowExecution
    -> Maybe ChildPolicy -> StartWorkflowExecution)
-> Lens
     StartWorkflowExecution
     StartWorkflowExecution
     (Maybe ChildPolicy)
     (Maybe 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 name of the domain in which the workflow execution is created.
startWorkflowExecution_domain :: Lens.Lens' StartWorkflowExecution Prelude.Text
startWorkflowExecution_domain :: (Text -> f Text)
-> StartWorkflowExecution -> f StartWorkflowExecution
startWorkflowExecution_domain = (StartWorkflowExecution -> Text)
-> (StartWorkflowExecution -> Text -> StartWorkflowExecution)
-> Lens StartWorkflowExecution StartWorkflowExecution Text Text
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 :: (Text -> f Text)
-> StartWorkflowExecution -> f StartWorkflowExecution
startWorkflowExecution_workflowId = (StartWorkflowExecution -> Text)
-> (StartWorkflowExecution -> Text -> StartWorkflowExecution)
-> Lens StartWorkflowExecution StartWorkflowExecution Text Text
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 :: (WorkflowType -> f WorkflowType)
-> StartWorkflowExecution -> f StartWorkflowExecution
startWorkflowExecution_workflowType = (StartWorkflowExecution -> WorkflowType)
-> (StartWorkflowExecution
    -> WorkflowType -> StartWorkflowExecution)
-> Lens
     StartWorkflowExecution
     StartWorkflowExecution
     WorkflowType
     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 :: StartWorkflowExecution -> Request StartWorkflowExecution
request = Service -> StartWorkflowExecution -> Request StartWorkflowExecution
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy StartWorkflowExecution
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse StartWorkflowExecution)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse StartWorkflowExecution))
-> Logger
-> Service
-> Proxy StartWorkflowExecution
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse StartWorkflowExecution)))
forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Text -> Int -> StartWorkflowExecutionResponse
StartWorkflowExecutionResponse'
            (Maybe Text -> Int -> StartWorkflowExecutionResponse)
-> Either String (Maybe Text)
-> Either String (Int -> StartWorkflowExecutionResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Either String (Maybe Text)
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"runId")
            Either String (Int -> StartWorkflowExecutionResponse)
-> Either String Int
-> Either String StartWorkflowExecutionResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Int -> Either String Int
forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (Int -> Int
forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable StartWorkflowExecution

instance Prelude.NFData StartWorkflowExecution

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

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

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

instance Core.ToQuery StartWorkflowExecution where
  toQuery :: StartWorkflowExecution -> QueryString
toQuery = QueryString -> StartWorkflowExecution -> QueryString
forall a b. a -> b -> a
Prelude.const QueryString
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
(StartWorkflowExecutionResponse
 -> StartWorkflowExecutionResponse -> Bool)
-> (StartWorkflowExecutionResponse
    -> StartWorkflowExecutionResponse -> Bool)
-> Eq StartWorkflowExecutionResponse
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]
(Int -> ReadS StartWorkflowExecutionResponse)
-> ReadS [StartWorkflowExecutionResponse]
-> ReadPrec StartWorkflowExecutionResponse
-> ReadPrec [StartWorkflowExecutionResponse]
-> Read 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
(Int -> StartWorkflowExecutionResponse -> ShowS)
-> (StartWorkflowExecutionResponse -> String)
-> ([StartWorkflowExecutionResponse] -> ShowS)
-> Show StartWorkflowExecutionResponse
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.
 StartWorkflowExecutionResponse
 -> Rep StartWorkflowExecutionResponse x)
-> (forall x.
    Rep StartWorkflowExecutionResponse x
    -> StartWorkflowExecutionResponse)
-> Generic StartWorkflowExecutionResponse
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' :: Maybe Text -> Int -> StartWorkflowExecutionResponse
StartWorkflowExecutionResponse'
    { $sel:runId:StartWorkflowExecutionResponse' :: Maybe Text
runId =
        Maybe Text
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 :: (Maybe Text -> f (Maybe Text))
-> StartWorkflowExecutionResponse
-> f StartWorkflowExecutionResponse
startWorkflowExecutionResponse_runId = (StartWorkflowExecutionResponse -> Maybe Text)
-> (StartWorkflowExecutionResponse
    -> Maybe Text -> StartWorkflowExecutionResponse)
-> Lens
     StartWorkflowExecutionResponse
     StartWorkflowExecutionResponse
     (Maybe Text)
     (Maybe Text)
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 :: (Int -> f Int)
-> StartWorkflowExecutionResponse
-> f StartWorkflowExecutionResponse
startWorkflowExecutionResponse_httpStatus = (StartWorkflowExecutionResponse -> Int)
-> (StartWorkflowExecutionResponse
    -> Int -> StartWorkflowExecutionResponse)
-> Lens
     StartWorkflowExecutionResponse
     StartWorkflowExecutionResponse
     Int
     Int
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