amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.Types.StepFunctionsAction

Description

 
Synopsis

Documentation

data StepFunctionsAction Source #

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

Instances details
FromJSON StepFunctionsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.StepFunctionsAction

ToJSON StepFunctionsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.StepFunctionsAction

Generic StepFunctionsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.StepFunctionsAction

Associated Types

type Rep StepFunctionsAction :: Type -> Type #

Read StepFunctionsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.StepFunctionsAction

Show StepFunctionsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.StepFunctionsAction

NFData StepFunctionsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.StepFunctionsAction

Methods

rnf :: StepFunctionsAction -> () #

Eq StepFunctionsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.StepFunctionsAction

Hashable StepFunctionsAction Source # 
Instance details

Defined in Amazonka.IoT.Types.StepFunctionsAction

type Rep StepFunctionsAction Source # 
Instance details

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 Source #

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) Source #

(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 Source #

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

stepFunctionsAction_roleArn :: Lens' StepFunctionsAction Text Source #

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