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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get a step in the migration workflow.

Synopsis

data GetWorkflowStep = GetWorkflowStep' {
- workflowId :: Text
- stepGroupId :: Text
- id :: Text
}
newGetWorkflowStep :: Text -> Text -> Text -> GetWorkflowStep
getWorkflowStep_workflowId :: Lens' GetWorkflowStep Text
getWorkflowStep_stepGroupId :: Lens' GetWorkflowStep Text
getWorkflowStep_id :: Lens' GetWorkflowStep Text
data GetWorkflowStepResponse = GetWorkflowStepResponse' {
- creationTime :: Maybe POSIX
- description :: Maybe Text
- endTime :: Maybe POSIX
- lastStartTime :: Maybe POSIX
- name :: Maybe Text
- next :: Maybe [Text]
- noOfSrvCompleted :: Maybe Int
- noOfSrvFailed :: Maybe Int
- outputs :: Maybe [WorkflowStepOutput]
- owner :: Maybe Owner
- previous :: Maybe [Text]
- scriptOutputLocation :: Maybe Text
- status :: Maybe StepStatus
- statusMessage :: Maybe Text
- stepActionType :: Maybe StepActionType
- stepGroupId :: Maybe Text
- stepId :: Maybe Text
- stepTarget :: Maybe [Text]
- totalNoOfSrv :: Maybe Int
- workflowId :: Maybe Text
- workflowStepAutomationConfiguration :: Maybe WorkflowStepAutomationConfiguration
- httpStatus :: Int
}
newGetWorkflowStepResponse :: Int -> GetWorkflowStepResponse
getWorkflowStepResponse_creationTime :: Lens' GetWorkflowStepResponse (Maybe UTCTime)
getWorkflowStepResponse_description :: Lens' GetWorkflowStepResponse (Maybe Text)
getWorkflowStepResponse_endTime :: Lens' GetWorkflowStepResponse (Maybe UTCTime)
getWorkflowStepResponse_lastStartTime :: Lens' GetWorkflowStepResponse (Maybe UTCTime)
getWorkflowStepResponse_name :: Lens' GetWorkflowStepResponse (Maybe Text)
getWorkflowStepResponse_next :: Lens' GetWorkflowStepResponse (Maybe [Text])
getWorkflowStepResponse_noOfSrvCompleted :: Lens' GetWorkflowStepResponse (Maybe Int)
getWorkflowStepResponse_noOfSrvFailed :: Lens' GetWorkflowStepResponse (Maybe Int)
getWorkflowStepResponse_outputs :: Lens' GetWorkflowStepResponse (Maybe [WorkflowStepOutput])
getWorkflowStepResponse_owner :: Lens' GetWorkflowStepResponse (Maybe Owner)
getWorkflowStepResponse_previous :: Lens' GetWorkflowStepResponse (Maybe [Text])
getWorkflowStepResponse_scriptOutputLocation :: Lens' GetWorkflowStepResponse (Maybe Text)
getWorkflowStepResponse_status :: Lens' GetWorkflowStepResponse (Maybe StepStatus)
getWorkflowStepResponse_statusMessage :: Lens' GetWorkflowStepResponse (Maybe Text)
getWorkflowStepResponse_stepActionType :: Lens' GetWorkflowStepResponse (Maybe StepActionType)
getWorkflowStepResponse_stepGroupId :: Lens' GetWorkflowStepResponse (Maybe Text)
getWorkflowStepResponse_stepId :: Lens' GetWorkflowStepResponse (Maybe Text)
getWorkflowStepResponse_stepTarget :: Lens' GetWorkflowStepResponse (Maybe [Text])
getWorkflowStepResponse_totalNoOfSrv :: Lens' GetWorkflowStepResponse (Maybe Int)
getWorkflowStepResponse_workflowId :: Lens' GetWorkflowStepResponse (Maybe Text)
getWorkflowStepResponse_workflowStepAutomationConfiguration :: Lens' GetWorkflowStepResponse (Maybe WorkflowStepAutomationConfiguration)
getWorkflowStepResponse_httpStatus :: Lens' GetWorkflowStepResponse Int

Creating a Request

data GetWorkflowStep Source #

See: newGetWorkflowStep smart constructor.

Constructors

GetWorkflowStep'
Fields workflowId :: Text The ID of the migration workflow. stepGroupId :: Text desThe ID of the step group. id :: Text The ID of the step.

Instances

Instances details

ToHeaders GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods toHeaders :: GetWorkflowStep -> [Header] #
ToPath GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods toPath :: GetWorkflowStep -> ByteString #
ToQuery GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods toQuery :: GetWorkflowStep -> QueryString #
AWSRequest GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Associated Types type AWSResponse GetWorkflowStep # Methods request :: (Service -> Service) -> GetWorkflowStep -> Request GetWorkflowStep # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetWorkflowStep -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetWorkflowStep))) #
Generic GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Associated Types type Rep GetWorkflowStep :: Type -> Type # Methods from :: GetWorkflowStep -> Rep GetWorkflowStep x # to :: Rep GetWorkflowStep x -> GetWorkflowStep #
Read GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods readsPrec :: Int -> ReadS GetWorkflowStep # readList :: ReadS [GetWorkflowStep] # readPrec :: ReadPrec GetWorkflowStep # readListPrec :: ReadPrec [GetWorkflowStep] #
Show GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods showsPrec :: Int -> GetWorkflowStep -> ShowS # show :: GetWorkflowStep -> String # showList :: [GetWorkflowStep] -> ShowS #
NFData GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods rnf :: GetWorkflowStep -> () #
Eq GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods (==) :: GetWorkflowStep -> GetWorkflowStep -> Bool # (/=) :: GetWorkflowStep -> GetWorkflowStep -> Bool #
Hashable GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods hashWithSalt :: Int -> GetWorkflowStep -> Int # hash :: GetWorkflowStep -> Int #
type AWSResponse GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep type AWSResponse GetWorkflowStep = GetWorkflowStepResponse
type Rep GetWorkflowStep Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep type Rep GetWorkflowStep = D1 ('MetaData "GetWorkflowStep" "Amazonka.MigrationHubOrchestrator.GetWorkflowStep" "amazonka-migrationhuborchestrator-2.0-HQHMI3I3PjN4mnuoVSsX97" 'False) (C1 ('MetaCons "GetWorkflowStep'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "stepGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetWorkflowStep Source #

Arguments

:: Text	`GetWorkflowStep`
-> Text	`GetWorkflowStep`
-> Text	`GetWorkflowStep`
-> GetWorkflowStep

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

GetWorkflowStep, getWorkflowStep_workflowId - The ID of the migration workflow.

GetWorkflowStep, getWorkflowStep_stepGroupId - desThe ID of the step group.

GetWorkflowStep, getWorkflowStep_id - The ID of the step.

Request Lenses

getWorkflowStep_workflowId :: Lens' GetWorkflowStep Text Source #

The ID of the migration workflow.

getWorkflowStep_stepGroupId :: Lens' GetWorkflowStep Text Source #

desThe ID of the step group.

getWorkflowStep_id :: Lens' GetWorkflowStep Text Source #

The ID of the step.

Destructuring the Response

data GetWorkflowStepResponse Source #

See: newGetWorkflowStepResponse smart constructor.

Constructors

GetWorkflowStepResponse'

Fields

creationTime :: Maybe POSIX
The time at which the step was created.
description :: Maybe Text
The description of the step.
endTime :: Maybe POSIX
The time at which the step ended.
lastStartTime :: Maybe POSIX
The time at which the workflow was last started.
name :: Maybe Text
The name of the step.
next :: Maybe [Text]
The next step.
noOfSrvCompleted :: Maybe Int
The number of servers that have been migrated.
noOfSrvFailed :: Maybe Int
The number of servers that have failed to migrate.
outputs :: Maybe [WorkflowStepOutput]
The outputs of the step.
owner :: Maybe Owner
The owner of the step.
previous :: Maybe [Text]
The previous step.
scriptOutputLocation :: Maybe Text
The output location of the script.
status :: Maybe StepStatus
The status of the step.
statusMessage :: Maybe Text
The status message of the migration workflow.
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.
stepGroupId :: Maybe Text
The ID of the step group.
stepId :: Maybe Text
The ID of the step.
stepTarget :: Maybe [Text]
The servers on which a step will be run.
totalNoOfSrv :: Maybe Int
The total number of servers that have been migrated.
workflowId :: Maybe Text
The ID of the migration workflow.
workflowStepAutomationConfiguration :: Maybe WorkflowStepAutomationConfiguration
The custom script to run tests on source or target environments.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Associated Types type Rep GetWorkflowStepResponse :: Type -> Type # Methods from :: GetWorkflowStepResponse -> Rep GetWorkflowStepResponse x # to :: Rep GetWorkflowStepResponse x -> GetWorkflowStepResponse #
Read GetWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods readsPrec :: Int -> ReadS GetWorkflowStepResponse # readList :: ReadS [GetWorkflowStepResponse] # readPrec :: ReadPrec GetWorkflowStepResponse # readListPrec :: ReadPrec [GetWorkflowStepResponse] #
Show GetWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods showsPrec :: Int -> GetWorkflowStepResponse -> ShowS # show :: GetWorkflowStepResponse -> String # showList :: [GetWorkflowStepResponse] -> ShowS #
NFData GetWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods rnf :: GetWorkflowStepResponse -> () #
Eq GetWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep Methods (==) :: GetWorkflowStepResponse -> GetWorkflowStepResponse -> Bool # (/=) :: GetWorkflowStepResponse -> GetWorkflowStepResponse -> Bool #
type Rep GetWorkflowStepResponse Source #
Instance details Defined in Amazonka.MigrationHubOrchestrator.GetWorkflowStep type Rep GetWorkflowStepResponse = D1 ('MetaData "GetWorkflowStepResponse" "Amazonka.MigrationHubOrchestrator.GetWorkflowStep" "amazonka-migrationhuborchestrator-2.0-HQHMI3I3PjN4mnuoVSsX97" 'False) (C1 ('MetaCons "GetWorkflowStepResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "lastStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "noOfSrvCompleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "noOfSrvFailed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowStepOutput])) :: (S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Owner)) :: S1 ('MetaSel ('Just "previous") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))) :: (((S1 ('MetaSel ('Just "scriptOutputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StepStatus))) :: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stepActionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StepActionType)) :: S1 ('MetaSel ('Just "stepGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "stepId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stepTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "totalNoOfSrv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "workflowStepAutomationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowStepAutomationConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newGetWorkflowStepResponse Source #

Arguments

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

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

GetWorkflowStepResponse, getWorkflowStepResponse_creationTime - The time at which the step was created.

GetWorkflowStepResponse, getWorkflowStepResponse_description - The description of the step.

GetWorkflowStepResponse, getWorkflowStepResponse_endTime - The time at which the step ended.

$sel:lastStartTime:GetWorkflowStepResponse', getWorkflowStepResponse_lastStartTime - The time at which the workflow was last started.

GetWorkflowStepResponse, getWorkflowStepResponse_name - The name of the step.

GetWorkflowStepResponse, getWorkflowStepResponse_next - The next step.

GetWorkflowStepResponse, getWorkflowStepResponse_noOfSrvCompleted - The number of servers that have been migrated.

GetWorkflowStepResponse, getWorkflowStepResponse_noOfSrvFailed - The number of servers that have failed to migrate.

$sel:outputs:GetWorkflowStepResponse', getWorkflowStepResponse_outputs - The outputs of the step.

GetWorkflowStepResponse, getWorkflowStepResponse_owner - The owner of the step.

GetWorkflowStepResponse, getWorkflowStepResponse_previous - The previous step.

$sel:scriptOutputLocation:GetWorkflowStepResponse', getWorkflowStepResponse_scriptOutputLocation - The output location of the script.

GetWorkflowStepResponse, getWorkflowStepResponse_status - The status of the step.

GetWorkflowStepResponse, getWorkflowStepResponse_statusMessage - The status message of the migration workflow.

GetWorkflowStepResponse, getWorkflowStepResponse_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.

GetWorkflowStep, getWorkflowStepResponse_stepGroupId - The ID of the step group.

GetWorkflowStepResponse, getWorkflowStepResponse_stepId - The ID of the step.

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

GetWorkflowStepResponse, getWorkflowStepResponse_totalNoOfSrv - The total number of servers that have been migrated.

GetWorkflowStep, getWorkflowStepResponse_workflowId - The ID of the migration workflow.

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

$sel:httpStatus:GetWorkflowStepResponse', getWorkflowStepResponse_httpStatus - The response's http status code.