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)
Safe Haskell	None

Amazonka.StepFunctions.CreateStateMachine

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 AWS 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.

Synopsis

data CreateStateMachine = CreateStateMachine' {
- tracingConfiguration :: Maybe TracingConfiguration
- type' :: Maybe StateMachineType
- loggingConfiguration :: Maybe LoggingConfiguration
- tags :: Maybe [Tag]
- name :: Text
- definition :: Sensitive Text
- roleArn :: Text
}
newCreateStateMachine :: Text -> Text -> Text -> CreateStateMachine
createStateMachine_tracingConfiguration :: Lens' CreateStateMachine (Maybe TracingConfiguration)
createStateMachine_type :: Lens' CreateStateMachine (Maybe StateMachineType)
createStateMachine_loggingConfiguration :: Lens' CreateStateMachine (Maybe LoggingConfiguration)
createStateMachine_tags :: Lens' CreateStateMachine (Maybe [Tag])
createStateMachine_name :: Lens' CreateStateMachine Text
createStateMachine_definition :: Lens' CreateStateMachine Text
createStateMachine_roleArn :: Lens' CreateStateMachine Text
data CreateStateMachineResponse = CreateStateMachineResponse' {
- httpStatus :: Int
- stateMachineArn :: Text
- creationDate :: POSIX
}
newCreateStateMachineResponse :: Int -> Text -> UTCTime -> CreateStateMachineResponse
createStateMachineResponse_httpStatus :: Lens' CreateStateMachineResponse Int
createStateMachineResponse_stateMachineArn :: Lens' CreateStateMachineResponse Text
createStateMachineResponse_creationDate :: Lens' CreateStateMachineResponse UTCTime

Creating a Request

data CreateStateMachine Source #

See: newCreateStateMachine smart constructor.

Constructors

CreateStateMachine'

Fields

tracingConfiguration :: Maybe TracingConfiguration
Selects whether AWS 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.
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 AWS 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 AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
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

Instances details

Eq CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods (==) :: CreateStateMachine -> CreateStateMachine -> Bool # (/=) :: CreateStateMachine -> CreateStateMachine -> Bool #
Show CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods showsPrec :: Int -> CreateStateMachine -> ShowS # show :: CreateStateMachine -> String # showList :: [CreateStateMachine] -> ShowS #
Generic CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Associated Types type Rep CreateStateMachine :: Type -> Type # Methods from :: CreateStateMachine -> Rep CreateStateMachine x # to :: Rep CreateStateMachine x -> CreateStateMachine #
NFData CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods rnf :: CreateStateMachine -> () #
Hashable CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods hashWithSalt :: Int -> CreateStateMachine -> Int # hash :: CreateStateMachine -> Int #
ToJSON CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods toJSON :: CreateStateMachine -> Value # toEncoding :: CreateStateMachine -> Encoding # toJSONList :: [CreateStateMachine] -> Value # toEncodingList :: [CreateStateMachine] -> Encoding #
AWSRequest CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Associated Types type AWSResponse CreateStateMachine # Methods request :: CreateStateMachine -> Request CreateStateMachine # response :: MonadResource m => Logger -> Service -> Proxy CreateStateMachine -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStateMachine))) #
ToHeaders CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods toHeaders :: CreateStateMachine -> [Header] #
ToPath CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods toPath :: CreateStateMachine -> ByteString #
ToQuery CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods toQuery :: CreateStateMachine -> QueryString #
type Rep CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine type Rep CreateStateMachine = D1 ('MetaData "CreateStateMachine" "Amazonka.StepFunctions.CreateStateMachine" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "CreateStateMachine'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tracingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TracingConfiguration)) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StateMachineType)) :: S1 ('MetaSel ('Just "loggingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfiguration)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: 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)))))
type AWSResponse CreateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine type AWSResponse CreateStateMachine = CreateStateMachineResponse

newCreateStateMachine Source #

Arguments

:: Text	`$sel:name:CreateStateMachine'`
-> Text	`$sel:definition:CreateStateMachine'`
-> Text	`$sel:roleArn: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:tracingConfiguration:CreateStateMachine', createStateMachine_tracingConfiguration - Selects whether AWS X-Ray tracing is enabled.

$sel:type':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.

$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 AWS 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 AWS 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:name: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.

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

Request Lenses

createStateMachine_tracingConfiguration :: Lens' CreateStateMachine (Maybe TracingConfiguration) Source #

Selects whether AWS X-Ray tracing is enabled.

createStateMachine_type :: Lens' CreateStateMachine (Maybe StateMachineType) Source #

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_loggingConfiguration :: Lens' CreateStateMachine (Maybe LoggingConfiguration) Source #

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 AWS Step Functions User Guide.

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

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 AWS 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_name :: Lens' CreateStateMachine Text Source #

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

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

createStateMachine_roleArn :: Lens' CreateStateMachine Text Source #

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

Destructuring the Response

data CreateStateMachineResponse Source #

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

Instances details

Eq CreateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods (==) :: CreateStateMachineResponse -> CreateStateMachineResponse -> Bool # (/=) :: CreateStateMachineResponse -> CreateStateMachineResponse -> Bool #
Read CreateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods readsPrec :: Int -> ReadS CreateStateMachineResponse # readList :: ReadS [CreateStateMachineResponse] # readPrec :: ReadPrec CreateStateMachineResponse # readListPrec :: ReadPrec [CreateStateMachineResponse] #
Show CreateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods showsPrec :: Int -> CreateStateMachineResponse -> ShowS # show :: CreateStateMachineResponse -> String # showList :: [CreateStateMachineResponse] -> ShowS #
Generic CreateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Associated Types type Rep CreateStateMachineResponse :: Type -> Type # Methods from :: CreateStateMachineResponse -> Rep CreateStateMachineResponse x # to :: Rep CreateStateMachineResponse x -> CreateStateMachineResponse #
NFData CreateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine Methods rnf :: CreateStateMachineResponse -> () #
type Rep CreateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.CreateStateMachine type Rep CreateStateMachineResponse = D1 ('MetaData "CreateStateMachineResponse" "Amazonka.StepFunctions.CreateStateMachine" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" '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 Source #

Arguments

:: Int	`$sel:httpStatus:CreateStateMachineResponse'`
-> Text	`$sel:stateMachineArn:CreateStateMachineResponse'`
-> UTCTime	`$sel:creationDate: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.

$sel:stateMachineArn:CreateStateMachineResponse', createStateMachineResponse_stateMachineArn - The Amazon Resource Name (ARN) that identifies the created state machine.

$sel:creationDate:CreateStateMachineResponse', createStateMachineResponse_creationDate - The date the state machine is created.

Response Lenses

createStateMachineResponse_httpStatus :: Lens' CreateStateMachineResponse Int Source #

The response's http status code.

createStateMachineResponse_stateMachineArn :: Lens' CreateStateMachineResponse Text Source #

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

createStateMachineResponse_creationDate :: Lens' CreateStateMachineResponse UTCTime Source #

The date the state machine is created.