Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.StepFunctions.UpdateStateMachine

Contents

Description

Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.

Synopsis

Creating a Request

data UpdateStateMachine Source #

See: newUpdateStateMachine smart constructor.

Constructors

UpdateStateMachine'

Fields

definition :: Maybe (Sensitive Text)
The Amazon States Language definition of the state machine. See Amazon States Language.
loggingConfiguration :: Maybe LoggingConfiguration
The LoggingConfiguration data type is used to set CloudWatch Logs options.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of the IAM role of the state machine.
tracingConfiguration :: Maybe TracingConfiguration
Selects whether X-Ray tracing is enabled.
stateMachineArn :: Text
The Amazon Resource Name (ARN) of the state machine.

Instances

Instances details

ToJSON UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods toJSON :: UpdateStateMachine -> Value # toEncoding :: UpdateStateMachine -> Encoding # toJSONList :: [UpdateStateMachine] -> Value # toEncodingList :: [UpdateStateMachine] -> Encoding #
ToHeaders UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods toHeaders :: UpdateStateMachine -> [Header] #
ToPath UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods toPath :: UpdateStateMachine -> ByteString #
ToQuery UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods toQuery :: UpdateStateMachine -> QueryString #
AWSRequest UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Associated Types type AWSResponse UpdateStateMachine # Methods request :: (Service -> Service) -> UpdateStateMachine -> Request UpdateStateMachine # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateStateMachine -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateStateMachine))) #
Generic UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Associated Types type Rep UpdateStateMachine :: Type -> Type # Methods from :: UpdateStateMachine -> Rep UpdateStateMachine x # to :: Rep UpdateStateMachine x -> UpdateStateMachine #
Show UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods showsPrec :: Int -> UpdateStateMachine -> ShowS # show :: UpdateStateMachine -> String # showList :: [UpdateStateMachine] -> ShowS #
NFData UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods rnf :: UpdateStateMachine -> () #
Eq UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods (==) :: UpdateStateMachine -> UpdateStateMachine -> Bool # (/=) :: UpdateStateMachine -> UpdateStateMachine -> Bool #
Hashable UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods hashWithSalt :: Int -> UpdateStateMachine -> Int # hash :: UpdateStateMachine -> Int #
type AWSResponse UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine type AWSResponse UpdateStateMachine = UpdateStateMachineResponse
type Rep UpdateStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine type Rep UpdateStateMachine = D1 ('MetaData "UpdateStateMachine" "Amazonka.StepFunctions.UpdateStateMachine" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "UpdateStateMachine'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "loggingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfiguration))) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tracingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TracingConfiguration)) :: S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateStateMachine Source #

Arguments

:: Text	`UpdateStateMachine`
-> UpdateStateMachine

Create a value of UpdateStateMachine 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:definition:UpdateStateMachine', updateStateMachine_definition - The Amazon States Language definition of the state machine. See Amazon States Language.

$sel:loggingConfiguration:UpdateStateMachine', updateStateMachine_loggingConfiguration - The LoggingConfiguration data type is used to set CloudWatch Logs options.

UpdateStateMachine, updateStateMachine_roleArn - The Amazon Resource Name (ARN) of the IAM role of the state machine.

$sel:tracingConfiguration:UpdateStateMachine', updateStateMachine_tracingConfiguration - Selects whether X-Ray tracing is enabled.

UpdateStateMachine, updateStateMachine_stateMachineArn - The Amazon Resource Name (ARN) of the state machine.

Request Lenses

updateStateMachine_definition :: Lens' UpdateStateMachine (Maybe Text) Source #

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

updateStateMachine_loggingConfiguration :: Lens' UpdateStateMachine (Maybe LoggingConfiguration) Source #

The LoggingConfiguration data type is used to set CloudWatch Logs options.

updateStateMachine_roleArn :: Lens' UpdateStateMachine (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role of the state machine.

updateStateMachine_tracingConfiguration :: Lens' UpdateStateMachine (Maybe TracingConfiguration) Source #

Selects whether X-Ray tracing is enabled.

updateStateMachine_stateMachineArn :: Lens' UpdateStateMachine Text Source #

The Amazon Resource Name (ARN) of the state machine.

Destructuring the Response

data UpdateStateMachineResponse Source #

See: newUpdateStateMachineResponse smart constructor.

Constructors

UpdateStateMachineResponse'
Fields httpStatus :: Int The response's http status code. updateDate :: POSIX The date and time the state machine was updated.

Instances

Instances details

Generic UpdateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Associated Types type Rep UpdateStateMachineResponse :: Type -> Type # Methods from :: UpdateStateMachineResponse -> Rep UpdateStateMachineResponse x # to :: Rep UpdateStateMachineResponse x -> UpdateStateMachineResponse #
Read UpdateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods readsPrec :: Int -> ReadS UpdateStateMachineResponse # readList :: ReadS [UpdateStateMachineResponse] # readPrec :: ReadPrec UpdateStateMachineResponse # readListPrec :: ReadPrec [UpdateStateMachineResponse] #
Show UpdateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods showsPrec :: Int -> UpdateStateMachineResponse -> ShowS # show :: UpdateStateMachineResponse -> String # showList :: [UpdateStateMachineResponse] -> ShowS #
NFData UpdateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods rnf :: UpdateStateMachineResponse -> () #
Eq UpdateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine Methods (==) :: UpdateStateMachineResponse -> UpdateStateMachineResponse -> Bool # (/=) :: UpdateStateMachineResponse -> UpdateStateMachineResponse -> Bool #
type Rep UpdateStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.UpdateStateMachine type Rep UpdateStateMachineResponse = D1 ('MetaData "UpdateStateMachineResponse" "Amazonka.StepFunctions.UpdateStateMachine" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "UpdateStateMachineResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "updateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))

newUpdateStateMachineResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateStateMachineResponse'`
-> UTCTime	`$sel:updateDate:UpdateStateMachineResponse'`
-> UpdateStateMachineResponse

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

$sel:updateDate:UpdateStateMachineResponse', updateStateMachineResponse_updateDate - The date and time the state machine was updated.

Response Lenses

updateStateMachineResponse_httpStatus :: Lens' UpdateStateMachineResponse Int Source #

The response's http status code.

updateStateMachineResponse_updateDate :: Lens' UpdateStateMachineResponse UTCTime Source #

The date and time the state machine was updated.