Amazonka.IoT.Types.StepFunctionsAction

Documentation

data StepFunctionsAction

Starts execution of a Step Functions state machine.

See: newStepFunctionsAction smart constructor.

Constructors

StepFunctionsAction'

Fields

• executionNamePrefix :: Maybe Text

  (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

• stateMachineName :: Text

  The name of the Step Functions state machine whose execution will be started.

• roleArn :: Text

  The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

Instances

FromJSON StepFunctionsAction

Defined in Amazonka.IoT.Types.StepFunctionsAction

Methods

parseJSON :: Value -> Parser StepFunctionsAction

parseJSONList :: Value -> Parser [StepFunctionsAction]

ToJSON StepFunctionsAction

Defined in Amazonka.IoT.Types.StepFunctionsAction

Methods

toJSON :: StepFunctionsAction -> Value

toEncoding :: StepFunctionsAction -> Encoding

toJSONList :: [StepFunctionsAction] -> Value

toEncodingList :: [StepFunctionsAction] -> Encoding

Generic StepFunctionsAction

Defined in Amazonka.IoT.Types.StepFunctionsAction

Associated Types

type Rep StepFunctionsAction :: Type -> Type

Methods

from :: StepFunctionsAction -> Rep StepFunctionsAction x

to :: Rep StepFunctionsAction x -> StepFunctionsAction

Read StepFunctionsAction

Defined in Amazonka.IoT.Types.StepFunctionsAction

Methods

readsPrec :: Int -> ReadS StepFunctionsAction

readList :: ReadS [StepFunctionsAction]

readPrec :: ReadPrec StepFunctionsAction

readListPrec :: ReadPrec [StepFunctionsAction]

Show StepFunctionsAction

Defined in Amazonka.IoT.Types.StepFunctionsAction

Methods

showsPrec :: Int -> StepFunctionsAction -> ShowS

show :: StepFunctionsAction -> String

showList :: [StepFunctionsAction] -> ShowS

NFData StepFunctionsAction

Defined in Amazonka.IoT.Types.StepFunctionsAction

Methods

rnf :: StepFunctionsAction -> ()

Eq StepFunctionsAction

Defined in Amazonka.IoT.Types.StepFunctionsAction

Methods

(==) :: StepFunctionsAction -> StepFunctionsAction -> Bool

(/=) :: StepFunctionsAction -> StepFunctionsAction -> Bool

Hashable StepFunctionsAction

Defined in Amazonka.IoT.Types.StepFunctionsAction

Methods

hashWithSalt :: Int -> StepFunctionsAction -> Int

hash :: StepFunctionsAction -> Int

type Rep StepFunctionsAction

Defined in Amazonka.IoT.Types.StepFunctionsAction

type Rep StepFunctionsAction = D1 ('MetaData "StepFunctionsAction" "Amazonka.IoT.Types.StepFunctionsAction" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "StepFunctionsAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "executionNamePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stateMachineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStepFunctionsAction

Arguments

:: Text

$sel:stateMachineName:StepFunctionsAction'

-> Text

$sel:roleArn:StepFunctionsAction'

-> StepFunctionsAction

Create a value of StepFunctionsAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:executionNamePrefix:StepFunctionsAction', stepFunctionsAction_executionNamePrefix - (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

$sel:stateMachineName:StepFunctionsAction', stepFunctionsAction_stateMachineName - The name of the Step Functions state machine whose execution will be started.

$sel:roleArn:StepFunctionsAction', stepFunctionsAction_roleArn - The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

stepFunctionsAction_executionNamePrefix :: Lens' StepFunctionsAction (Maybe Text)

(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

stepFunctionsAction_stateMachineName :: Lens' StepFunctionsAction Text

The name of the Step Functions state machine whose execution will be started.

stepFunctionsAction_roleArn :: Lens' StepFunctionsAction Text

The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").