Amazonka.StepFunctions.CreateStateMachine

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration and TracingConfiguration. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

Creating a Request

data CreateStateMachine

See: newCreateStateMachine smart constructor.

Constructors

CreateStateMachine'

Fields

• loggingConfiguration :: Maybe LoggingConfiguration

  Defines what execution history events are logged and where they are logged.

  By default, the level is set to OFF. For more information see Log Levels in the Step Functions User Guide.

• tags :: Maybe [Tag]

  Tags to be added when creating a state machine.

  An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

  Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

• tracingConfiguration :: Maybe TracingConfiguration

  Selects whether X-Ray tracing is enabled.

• type' :: Maybe StateMachineType

  Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.

• name :: Text

  The name of the state machine.

  A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ & , ; : /
  • control characters (U+0000-001F, U+007F-009F)

  To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

• definition :: Sensitive Text

  The Amazon States Language definition of the state machine. See Amazon States Language.

• roleArn :: Text

  The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

Instances

ToJSON CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

toJSON :: CreateStateMachine -> Value

toEncoding :: CreateStateMachine -> Encoding

toJSONList :: [CreateStateMachine] -> Value

toEncodingList :: [CreateStateMachine] -> Encoding

ToHeaders CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

toHeaders :: CreateStateMachine -> [Header]

ToPath CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

toPath :: CreateStateMachine -> ByteString

ToQuery CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

toQuery :: CreateStateMachine -> QueryString

AWSRequest CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

Associated Types

type AWSResponse CreateStateMachine

Methods

request :: (Service -> Service) -> CreateStateMachine -> Request CreateStateMachine

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateStateMachine -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStateMachine)))

Generic CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

Associated Types

type Rep CreateStateMachine :: Type -> Type

Methods

from :: CreateStateMachine -> Rep CreateStateMachine x

to :: Rep CreateStateMachine x -> CreateStateMachine

Show CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

showsPrec :: Int -> CreateStateMachine -> ShowS

show :: CreateStateMachine -> String

showList :: [CreateStateMachine] -> ShowS

NFData CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

rnf :: CreateStateMachine -> ()

Eq CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

(==) :: CreateStateMachine -> CreateStateMachine -> Bool

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

Hashable CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

hashWithSalt :: Int -> CreateStateMachine -> Int

hash :: CreateStateMachine -> Int

type AWSResponse CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

type AWSResponse CreateStateMachine = CreateStateMachineResponse

type Rep CreateStateMachine

Defined in Amazonka.StepFunctions.CreateStateMachine

type Rep CreateStateMachine = D1 ('MetaData "CreateStateMachine" "Amazonka.StepFunctions.CreateStateMachine" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "CreateStateMachine'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "loggingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfiguration)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "tracingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TracingConfiguration)))) :*: ((S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StateMachineType)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateStateMachine

Arguments

:: Text

CreateStateMachine

-> Text

$sel:definition:CreateStateMachine'

-> Text

CreateStateMachine

-> CreateStateMachine

Create a value of CreateStateMachine 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:loggingConfiguration:CreateStateMachine', createStateMachine_loggingConfiguration - Defines what execution history events are logged and where they are logged.

By default, the level is set to OFF. For more information see Log Levels in the Step Functions User Guide.

$sel:tags:CreateStateMachine', createStateMachine_tags - Tags to be added when creating a state machine.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

$sel:tracingConfiguration:CreateStateMachine', createStateMachine_tracingConfiguration - Selects whether X-Ray tracing is enabled.

CreateStateMachine, createStateMachine_type - Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.

CreateStateMachine, createStateMachine_name - The name of the state machine.

A name must not contain:

• white space
• brackets < > { } [ ]
• wildcard characters ? *
• special characters " # % \ ^ | ~ ` $ & , ; : /
• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

$sel:definition:CreateStateMachine', createStateMachine_definition - The Amazon States Language definition of the state machine. See Amazon States Language.

CreateStateMachine, createStateMachine_roleArn - The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

Request Lenses

createStateMachine_loggingConfiguration :: Lens' CreateStateMachine (Maybe LoggingConfiguration)

Defines what execution history events are logged and where they are logged.

By default, the level is set to OFF. For more information see Log Levels in the Step Functions User Guide.

createStateMachine_tags :: Lens' CreateStateMachine (Maybe [Tag])

Tags to be added when creating a state machine.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

createStateMachine_tracingConfiguration :: Lens' CreateStateMachine (Maybe TracingConfiguration)

Selects whether X-Ray tracing is enabled.

createStateMachine_type :: Lens' CreateStateMachine (Maybe StateMachineType)

Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.

createStateMachine_name :: Lens' CreateStateMachine Text

The name of the state machine.

A name must not contain:

• white space
• brackets < > { } [ ]
• wildcard characters ? *
• special characters " # % \ ^ | ~ ` $ & , ; : /
• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

createStateMachine_definition :: Lens' CreateStateMachine Text

The Amazon States Language definition of the state machine. See Amazon States Language.

createStateMachine_roleArn :: Lens' CreateStateMachine Text

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

Destructuring the Response

data CreateStateMachineResponse

See: newCreateStateMachineResponse smart constructor.

Constructors

CreateStateMachineResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• stateMachineArn :: Text

  The Amazon Resource Name (ARN) that identifies the created state machine.

• creationDate :: POSIX

  The date the state machine is created.

Instances

Generic CreateStateMachineResponse

Defined in Amazonka.StepFunctions.CreateStateMachine

Associated Types

type Rep CreateStateMachineResponse :: Type -> Type

Methods

from :: CreateStateMachineResponse -> Rep CreateStateMachineResponse x

to :: Rep CreateStateMachineResponse x -> CreateStateMachineResponse

Read CreateStateMachineResponse

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

readsPrec :: Int -> ReadS CreateStateMachineResponse

readList :: ReadS [CreateStateMachineResponse]

readPrec :: ReadPrec CreateStateMachineResponse

readListPrec :: ReadPrec [CreateStateMachineResponse]

Show CreateStateMachineResponse

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

showsPrec :: Int -> CreateStateMachineResponse -> ShowS

show :: CreateStateMachineResponse -> String

showList :: [CreateStateMachineResponse] -> ShowS

NFData CreateStateMachineResponse

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

rnf :: CreateStateMachineResponse -> ()

Eq CreateStateMachineResponse

Defined in Amazonka.StepFunctions.CreateStateMachine

Methods

(==) :: CreateStateMachineResponse -> CreateStateMachineResponse -> Bool

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

type Rep CreateStateMachineResponse

Defined in Amazonka.StepFunctions.CreateStateMachine

type Rep CreateStateMachineResponse = D1 ('MetaData "CreateStateMachineResponse" "Amazonka.StepFunctions.CreateStateMachine" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "CreateStateMachineResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newCreateStateMachineResponse

Arguments

:: Int

$sel:httpStatus:CreateStateMachineResponse'

-> Text

CreateStateMachineResponse

-> UTCTime

CreateStateMachineResponse

-> CreateStateMachineResponse

Create a value of CreateStateMachineResponse 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:httpStatus:CreateStateMachineResponse', createStateMachineResponse_httpStatus - The response's http status code.

CreateStateMachineResponse, createStateMachineResponse_stateMachineArn - The Amazon Resource Name (ARN) that identifies the created state machine.

CreateStateMachineResponse, createStateMachineResponse_creationDate - The date the state machine is created.

Response Lenses

createStateMachineResponse_httpStatus :: Lens' CreateStateMachineResponse Int

The response's http status code.

createStateMachineResponse_stateMachineArn :: Lens' CreateStateMachineResponse Text

The Amazon Resource Name (ARN) that identifies the created state machine.

createStateMachineResponse_creationDate :: Lens' CreateStateMachineResponse UTCTime

The date the state machine is created.