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.MigrationHubOrchestrator.UpdateWorkflowStep

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Update a step in a migration workflow.

Synopsis

data UpdateWorkflowStep = UpdateWorkflowStep' {
- description :: Maybe Text
- name :: Maybe Text
- next :: Maybe [Text]
- outputs :: Maybe [WorkflowStepOutput]
- previous :: Maybe [Text]
- status :: Maybe StepStatus
- stepActionType :: Maybe StepActionType
- stepTarget :: Maybe [Text]
- workflowStepAutomationConfiguration :: Maybe WorkflowStepAutomationConfiguration
- id :: Text
- stepGroupId :: Text
- workflowId :: Text
}
newUpdateWorkflowStep :: Text -> Text -> Text -> UpdateWorkflowStep
updateWorkflowStep_description :: Lens' UpdateWorkflowStep (Maybe Text)
updateWorkflowStep_name :: Lens' UpdateWorkflowStep (Maybe Text)
updateWorkflowStep_next :: Lens' UpdateWorkflowStep (Maybe [Text])
updateWorkflowStep_outputs :: Lens' UpdateWorkflowStep (Maybe [WorkflowStepOutput])
updateWorkflowStep_previous :: Lens' UpdateWorkflowStep (Maybe [Text])
updateWorkflowStep_status :: Lens' UpdateWorkflowStep (Maybe StepStatus)
updateWorkflowStep_stepActionType :: Lens' UpdateWorkflowStep (Maybe StepActionType)
updateWorkflowStep_stepTarget :: Lens' UpdateWorkflowStep (Maybe [Text])
updateWorkflowStep_workflowStepAutomationConfiguration :: Lens' UpdateWorkflowStep (Maybe WorkflowStepAutomationConfiguration)
updateWorkflowStep_id :: Lens' UpdateWorkflowStep Text
updateWorkflowStep_stepGroupId :: Lens' UpdateWorkflowStep Text
updateWorkflowStep_workflowId :: Lens' UpdateWorkflowStep Text
data UpdateWorkflowStepResponse = UpdateWorkflowStepResponse' {
- id :: Maybe Text
- name :: Maybe Text
- stepGroupId :: Maybe Text
- workflowId :: Maybe Text
- httpStatus :: Int
}
newUpdateWorkflowStepResponse :: Int -> UpdateWorkflowStepResponse
updateWorkflowStepResponse_id :: Lens' UpdateWorkflowStepResponse (Maybe Text)
updateWorkflowStepResponse_name :: Lens' UpdateWorkflowStepResponse (Maybe Text)
updateWorkflowStepResponse_stepGroupId :: Lens' UpdateWorkflowStepResponse (Maybe Text)
updateWorkflowStepResponse_workflowId :: Lens' UpdateWorkflowStepResponse (Maybe Text)
updateWorkflowStepResponse_httpStatus :: Lens' UpdateWorkflowStepResponse Int

Creating a Request

data UpdateWorkflowStep Source #

See: newUpdateWorkflowStep smart constructor.

Constructors

UpdateWorkflowStep'

Fields

description :: Maybe Text
The description of the step.
name :: Maybe Text
The name of the step.
next :: Maybe [Text]
The next step.
outputs :: Maybe [WorkflowStepOutput]
The outputs of a step.
previous :: Maybe [Text]
The previous step.
status :: Maybe StepStatus
The status of the step.
stepActionType :: Maybe StepActionType
The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
stepTarget :: Maybe [Text]
The servers on which a step will be run.
workflowStepAutomationConfiguration :: Maybe WorkflowStepAutomationConfiguration
The custom script to run tests on the source and target environments.
id :: Text
The ID of the step.
stepGroupId :: Text
The ID of the step group.
workflowId :: Text
The ID of the migration workflow.

Instances

Instances details

ToJSON UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods toJSON :: UpdateWorkflowStep -> Value # toEncoding :: UpdateWorkflowStep -> Encoding # toJSONList :: [UpdateWorkflowStep] -> Value # toEncodingList :: [UpdateWorkflowStep] -> Encoding #
ToHeaders UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods toHeaders :: UpdateWorkflowStep -> [Header] #
ToPath UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods toPath :: UpdateWorkflowStep -> ByteString #
ToQuery UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods toQuery :: UpdateWorkflowStep -> QueryString #
AWSRequest UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Associated Types type AWSResponse UpdateWorkflowStep # Methods request :: (Service -> Service) -> UpdateWorkflowStep -> Request UpdateWorkflowStep # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateWorkflowStep -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateWorkflowStep))) #
Generic UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Associated Types type Rep UpdateWorkflowStep :: Type -> Type # Methods from :: UpdateWorkflowStep -> Rep UpdateWorkflowStep x # to :: Rep UpdateWorkflowStep x -> UpdateWorkflowStep #
Read UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods readsPrec :: Int -> ReadS UpdateWorkflowStep # readList :: ReadS [UpdateWorkflowStep] # readPrec :: ReadPrec UpdateWorkflowStep # readListPrec :: ReadPrec [UpdateWorkflowStep] #
Show UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods showsPrec :: Int -> UpdateWorkflowStep -> ShowS # show :: UpdateWorkflowStep -> String # showList :: [UpdateWorkflowStep] -> ShowS #
NFData UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods rnf :: UpdateWorkflowStep -> () #
Eq UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods (==) :: UpdateWorkflowStep -> UpdateWorkflowStep -> Bool # (/=) :: UpdateWorkflowStep -> UpdateWorkflowStep -> Bool #
Hashable UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods hashWithSalt :: Int -> UpdateWorkflowStep -> Int # hash :: UpdateWorkflowStep -> Int #
type AWSResponse UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep type AWSResponse UpdateWorkflowStep = UpdateWorkflowStepResponse
type Rep UpdateWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep type Rep UpdateWorkflowStep = D1 ('MetaData "UpdateWorkflowStep" "Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep" "amazonka-migrationhuborchestrator-2.0-HQHMI3I3PjN4mnuoVSsX97" 'False) (C1 ('MetaCons "UpdateWorkflowStep'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowStepOutput])) :: (S1 ('MetaSel ('Just "previous") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StepStatus))))) :: ((S1 ('MetaSel ('Just "stepActionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StepActionType)) :: (S1 ('MetaSel ('Just "stepTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "workflowStepAutomationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowStepAutomationConfiguration)))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "stepGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateWorkflowStep Source #

Arguments

:: Text	`UpdateWorkflowStep`
-> Text	`UpdateWorkflowStep`
-> Text	`UpdateWorkflowStep`
-> UpdateWorkflowStep

Create a value of UpdateWorkflowStep 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:

UpdateWorkflowStep, updateWorkflowStep_description - The description of the step.

UpdateWorkflowStep, updateWorkflowStep_name - The name of the step.

UpdateWorkflowStep, updateWorkflowStep_next - The next step.

$sel:outputs:UpdateWorkflowStep', updateWorkflowStep_outputs - The outputs of a step.

UpdateWorkflowStep, updateWorkflowStep_previous - The previous step.

UpdateWorkflowStep, updateWorkflowStep_status - The status of the step.

UpdateWorkflowStep, updateWorkflowStep_stepActionType - The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

$sel:stepTarget:UpdateWorkflowStep', updateWorkflowStep_stepTarget - The servers on which a step will be run.

$sel:workflowStepAutomationConfiguration:UpdateWorkflowStep', updateWorkflowStep_workflowStepAutomationConfiguration - The custom script to run tests on the source and target environments.

UpdateWorkflowStep, updateWorkflowStep_id - The ID of the step.

UpdateWorkflowStep, updateWorkflowStep_stepGroupId - The ID of the step group.

UpdateWorkflowStep, updateWorkflowStep_workflowId - The ID of the migration workflow.

Request Lenses

updateWorkflowStep_description :: Lens' UpdateWorkflowStep (Maybe Text) Source #

The description of the step.

updateWorkflowStep_name :: Lens' UpdateWorkflowStep (Maybe Text) Source #

The name of the step.

updateWorkflowStep_next :: Lens' UpdateWorkflowStep (Maybe [Text]) Source #

The next step.

updateWorkflowStep_outputs :: Lens' UpdateWorkflowStep (Maybe [WorkflowStepOutput]) Source #

The outputs of a step.

updateWorkflowStep_previous :: Lens' UpdateWorkflowStep (Maybe [Text]) Source #

The previous step.

updateWorkflowStep_status :: Lens' UpdateWorkflowStep (Maybe StepStatus) Source #

The status of the step.

updateWorkflowStep_stepActionType :: Lens' UpdateWorkflowStep (Maybe StepActionType) Source #

The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

updateWorkflowStep_stepTarget :: Lens' UpdateWorkflowStep (Maybe [Text]) Source #

The servers on which a step will be run.

updateWorkflowStep_workflowStepAutomationConfiguration :: Lens' UpdateWorkflowStep (Maybe WorkflowStepAutomationConfiguration) Source #

The custom script to run tests on the source and target environments.

updateWorkflowStep_id :: Lens' UpdateWorkflowStep Text Source #

The ID of the step.

updateWorkflowStep_stepGroupId :: Lens' UpdateWorkflowStep Text Source #

The ID of the step group.

updateWorkflowStep_workflowId :: Lens' UpdateWorkflowStep Text Source #

The ID of the migration workflow.

Destructuring the Response

data UpdateWorkflowStepResponse Source #

See: newUpdateWorkflowStepResponse smart constructor.

Constructors

UpdateWorkflowStepResponse'
Fields id :: Maybe Text The ID of the step. name :: Maybe Text The name of the step. stepGroupId :: Maybe Text The ID of the step group. workflowId :: Maybe Text The ID of the migration workflow. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Associated Types type Rep UpdateWorkflowStepResponse :: Type -> Type # Methods from :: UpdateWorkflowStepResponse -> Rep UpdateWorkflowStepResponse x # to :: Rep UpdateWorkflowStepResponse x -> UpdateWorkflowStepResponse #
Read UpdateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods readsPrec :: Int -> ReadS UpdateWorkflowStepResponse # readList :: ReadS [UpdateWorkflowStepResponse] # readPrec :: ReadPrec UpdateWorkflowStepResponse # readListPrec :: ReadPrec [UpdateWorkflowStepResponse] #
Show UpdateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods showsPrec :: Int -> UpdateWorkflowStepResponse -> ShowS # show :: UpdateWorkflowStepResponse -> String # showList :: [UpdateWorkflowStepResponse] -> ShowS #
NFData UpdateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods rnf :: UpdateWorkflowStepResponse -> () #
Eq UpdateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep Methods (==) :: UpdateWorkflowStepResponse -> UpdateWorkflowStepResponse -> Bool # (/=) :: UpdateWorkflowStepResponse -> UpdateWorkflowStepResponse -> Bool #
type Rep UpdateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep type Rep UpdateWorkflowStepResponse = D1 ('MetaData "UpdateWorkflowStepResponse" "Amazonka.MigrationHubOrchestrator.UpdateWorkflowStep" "amazonka-migrationhuborchestrator-2.0-HQHMI3I3PjN4mnuoVSsX97" 'False) (C1 ('MetaCons "UpdateWorkflowStepResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stepGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newUpdateWorkflowStepResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateWorkflowStepResponse'`
-> UpdateWorkflowStepResponse

Create a value of UpdateWorkflowStepResponse 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:

UpdateWorkflowStep, updateWorkflowStepResponse_id - The ID of the step.

UpdateWorkflowStep, updateWorkflowStepResponse_name - The name of the step.

UpdateWorkflowStep, updateWorkflowStepResponse_stepGroupId - The ID of the step group.

UpdateWorkflowStep, updateWorkflowStepResponse_workflowId - The ID of the migration workflow.

$sel:httpStatus:UpdateWorkflowStepResponse', updateWorkflowStepResponse_httpStatus - The response's http status code.

Response Lenses

updateWorkflowStepResponse_id :: Lens' UpdateWorkflowStepResponse (Maybe Text) Source #

The ID of the step.

updateWorkflowStepResponse_name :: Lens' UpdateWorkflowStepResponse (Maybe Text) Source #

The name of the step.

updateWorkflowStepResponse_stepGroupId :: Lens' UpdateWorkflowStepResponse (Maybe Text) Source #

The ID of the step group.

updateWorkflowStepResponse_workflowId :: Lens' UpdateWorkflowStepResponse (Maybe Text) Source #

The ID of the migration workflow.

updateWorkflowStepResponse_httpStatus :: Lens' UpdateWorkflowStepResponse Int Source #

The response's http status code.