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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create a step in the migration workflow.

Synopsis

data CreateWorkflowStep = CreateWorkflowStep' {
- description :: Maybe Text
- next :: Maybe [Text]
- outputs :: Maybe [WorkflowStepOutput]
- previous :: Maybe [Text]
- stepTarget :: Maybe [Text]
- workflowStepAutomationConfiguration :: Maybe WorkflowStepAutomationConfiguration
- name :: Text
- stepGroupId :: Text
- workflowId :: Text
- stepActionType :: StepActionType
}
newCreateWorkflowStep :: Text -> Text -> Text -> StepActionType -> CreateWorkflowStep
createWorkflowStep_description :: Lens' CreateWorkflowStep (Maybe Text)
createWorkflowStep_next :: Lens' CreateWorkflowStep (Maybe [Text])
createWorkflowStep_outputs :: Lens' CreateWorkflowStep (Maybe [WorkflowStepOutput])
createWorkflowStep_previous :: Lens' CreateWorkflowStep (Maybe [Text])
createWorkflowStep_stepTarget :: Lens' CreateWorkflowStep (Maybe [Text])
createWorkflowStep_workflowStepAutomationConfiguration :: Lens' CreateWorkflowStep (Maybe WorkflowStepAutomationConfiguration)
createWorkflowStep_name :: Lens' CreateWorkflowStep Text
createWorkflowStep_stepGroupId :: Lens' CreateWorkflowStep Text
createWorkflowStep_workflowId :: Lens' CreateWorkflowStep Text
createWorkflowStep_stepActionType :: Lens' CreateWorkflowStep StepActionType
data CreateWorkflowStepResponse = CreateWorkflowStepResponse' {
- id :: Maybe Text
- name :: Maybe Text
- stepGroupId :: Maybe Text
- workflowId :: Maybe Text
- httpStatus :: Int
}
newCreateWorkflowStepResponse :: Int -> CreateWorkflowStepResponse
createWorkflowStepResponse_id :: Lens' CreateWorkflowStepResponse (Maybe Text)
createWorkflowStepResponse_name :: Lens' CreateWorkflowStepResponse (Maybe Text)
createWorkflowStepResponse_stepGroupId :: Lens' CreateWorkflowStepResponse (Maybe Text)
createWorkflowStepResponse_workflowId :: Lens' CreateWorkflowStepResponse (Maybe Text)
createWorkflowStepResponse_httpStatus :: Lens' CreateWorkflowStepResponse Int

Creating a Request

data CreateWorkflowStep Source #

See: newCreateWorkflowStep smart constructor.

Constructors

CreateWorkflowStep'

Fields

description :: Maybe Text
The description of the step.
next :: Maybe [Text]
The next step.
outputs :: Maybe [WorkflowStepOutput]
The key value pairs added for the expected output.
previous :: Maybe [Text]
The previous step.
stepTarget :: Maybe [Text]
The servers on which a step will be run.
workflowStepAutomationConfiguration :: Maybe WorkflowStepAutomationConfiguration
The custom script to run tests on source or target environments.
name :: Text
The name of the step.
stepGroupId :: Text
The ID of the step group.
workflowId :: Text
The ID of the migration workflow.
stepActionType :: 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.

Instances

Instances details

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

newCreateWorkflowStep Source #

Arguments

:: Text	`CreateWorkflowStep`
-> Text	`CreateWorkflowStep`
-> Text	`CreateWorkflowStep`
-> StepActionType	`CreateWorkflowStep`
-> CreateWorkflowStep

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

CreateWorkflowStep, createWorkflowStep_description - The description of the step.

CreateWorkflowStep, createWorkflowStep_next - The next step.

$sel:outputs:CreateWorkflowStep', createWorkflowStep_outputs - The key value pairs added for the expected output.

CreateWorkflowStep, createWorkflowStep_previous - The previous step.

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

$sel:workflowStepAutomationConfiguration:CreateWorkflowStep', createWorkflowStep_workflowStepAutomationConfiguration - The custom script to run tests on source or target environments.

CreateWorkflowStep, createWorkflowStep_name - The name of the step.

CreateWorkflowStep, createWorkflowStep_stepGroupId - The ID of the step group.

CreateWorkflowStep, createWorkflowStep_workflowId - The ID of the migration workflow.

CreateWorkflowStep, createWorkflowStep_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.

Request Lenses

createWorkflowStep_description :: Lens' CreateWorkflowStep (Maybe Text) Source #

The description of the step.

createWorkflowStep_next :: Lens' CreateWorkflowStep (Maybe [Text]) Source #

The next step.

createWorkflowStep_outputs :: Lens' CreateWorkflowStep (Maybe [WorkflowStepOutput]) Source #

The key value pairs added for the expected output.

createWorkflowStep_previous :: Lens' CreateWorkflowStep (Maybe [Text]) Source #

The previous step.

createWorkflowStep_stepTarget :: Lens' CreateWorkflowStep (Maybe [Text]) Source #

The servers on which a step will be run.

createWorkflowStep_workflowStepAutomationConfiguration :: Lens' CreateWorkflowStep (Maybe WorkflowStepAutomationConfiguration) Source #

The custom script to run tests on source or target environments.

createWorkflowStep_name :: Lens' CreateWorkflowStep Text Source #

The name of the step.

createWorkflowStep_stepGroupId :: Lens' CreateWorkflowStep Text Source #

The ID of the step group.

createWorkflowStep_workflowId :: Lens' CreateWorkflowStep Text Source #

The ID of the migration workflow.

createWorkflowStep_stepActionType :: Lens' CreateWorkflowStep 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.

Destructuring the Response

data CreateWorkflowStepResponse Source #

See: newCreateWorkflowStepResponse smart constructor.

Constructors

CreateWorkflowStepResponse'
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 CreateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.CreateWorkflowStep Associated Types type Rep CreateWorkflowStepResponse :: Type -> Type # Methods from :: CreateWorkflowStepResponse -> Rep CreateWorkflowStepResponse x # to :: Rep CreateWorkflowStepResponse x -> CreateWorkflowStepResponse #
Read CreateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.CreateWorkflowStep Methods readsPrec :: Int -> ReadS CreateWorkflowStepResponse # readList :: ReadS [CreateWorkflowStepResponse] # readPrec :: ReadPrec CreateWorkflowStepResponse # readListPrec :: ReadPrec [CreateWorkflowStepResponse] #
Show CreateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.CreateWorkflowStep Methods showsPrec :: Int -> CreateWorkflowStepResponse -> ShowS # show :: CreateWorkflowStepResponse -> String # showList :: [CreateWorkflowStepResponse] -> ShowS #
NFData CreateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.CreateWorkflowStep Methods rnf :: CreateWorkflowStepResponse -> () #
Eq CreateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.CreateWorkflowStep Methods (==) :: CreateWorkflowStepResponse -> CreateWorkflowStepResponse -> Bool # (/=) :: CreateWorkflowStepResponse -> CreateWorkflowStepResponse -> Bool #
type Rep CreateWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.CreateWorkflowStep type Rep CreateWorkflowStepResponse = D1 ('MetaData "CreateWorkflowStepResponse" "Amazonka.MigrationHubOrchestrator.CreateWorkflowStep" "amazonka-migrationhuborchestrator-2.0-HQHMI3I3PjN4mnuoVSsX97" 'False) (C1 ('MetaCons "CreateWorkflowStepResponse'" '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)))))

newCreateWorkflowStepResponse Source #

Arguments

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

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

CreateWorkflowStepResponse, createWorkflowStepResponse_id - The ID of the step.

CreateWorkflowStep, createWorkflowStepResponse_name - The name of the step.

CreateWorkflowStep, createWorkflowStepResponse_stepGroupId - The ID of the step group.

CreateWorkflowStep, createWorkflowStepResponse_workflowId - The ID of the migration workflow.

$sel:httpStatus:CreateWorkflowStepResponse', createWorkflowStepResponse_httpStatus - The response's http status code.

Response Lenses

createWorkflowStepResponse_id :: Lens' CreateWorkflowStepResponse (Maybe Text) Source #

The ID of the step.

createWorkflowStepResponse_name :: Lens' CreateWorkflowStepResponse (Maybe Text) Source #

The name of the step.

createWorkflowStepResponse_stepGroupId :: Lens' CreateWorkflowStepResponse (Maybe Text) Source #

The ID of the step group.

createWorkflowStepResponse_workflowId :: Lens' CreateWorkflowStepResponse (Maybe Text) Source #

The ID of the migration workflow.

createWorkflowStepResponse_httpStatus :: Lens' CreateWorkflowStepResponse Int Source #

The response's http status code.