amazonka-migrationhuborchestrator-2.0: Amazon Migration Hub Orchestrator SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MigrationHubOrchestrator.Lens

Description

 
Synopsis

Operations

CreateWorkflow

createWorkflow_description :: Lens' CreateWorkflow (Maybe Text) Source #

The description of the migration workflow.

createWorkflow_stepTargets :: Lens' CreateWorkflow (Maybe [Text]) Source #

The servers on which a step will be run.

createWorkflow_tags :: Lens' CreateWorkflow (Maybe (HashMap Text Text)) Source #

The tags to add on a migration workflow.

createWorkflow_name :: Lens' CreateWorkflow Text Source #

The name of the migration workflow.

createWorkflow_applicationConfigurationId :: Lens' CreateWorkflow Text Source #

The configuration ID of the application configured in Application Discovery Service.

createWorkflow_inputParameters :: Lens' CreateWorkflow (HashMap Text StepInput) Source #

The input parameters required to create a migration workflow.

createWorkflowResponse_adsApplicationConfigurationId :: Lens' CreateWorkflowResponse (Maybe Text) Source #

The configuration ID of the application configured in Application Discovery Service.

createWorkflowResponse_arn :: Lens' CreateWorkflowResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the migration workflow.

createWorkflowResponse_creationTime :: Lens' CreateWorkflowResponse (Maybe UTCTime) Source #

The time at which the migration workflow was created.

createWorkflowResponse_description :: Lens' CreateWorkflowResponse (Maybe Text) Source #

The description of the migration workflow.

createWorkflowResponse_stepTargets :: Lens' CreateWorkflowResponse (Maybe [Text]) Source #

The servers on which a step will be run.

createWorkflowResponse_tags :: Lens' CreateWorkflowResponse (Maybe (HashMap Text Text)) Source #

The tags to add on a migration workflow.

CreateWorkflowStep

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

The key value pairs added for the expected output.

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

The servers on which a step will be run.

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.

CreateWorkflowStepGroup

createWorkflowStepGroup_workflowId :: Lens' CreateWorkflowStepGroup Text Source #

The ID of the migration workflow that will contain the step group.

createWorkflowStepGroupResponse_tools :: Lens' CreateWorkflowStepGroupResponse (Maybe [Tool]) Source #

List of AWS services utilized in a migration workflow.

createWorkflowStepGroupResponse_workflowId :: Lens' CreateWorkflowStepGroupResponse (Maybe Text) Source #

The ID of the migration workflow that contains the step group.

DeleteWorkflow

deleteWorkflow_id :: Lens' DeleteWorkflow Text Source #

The ID of the migration workflow you want to delete.

deleteWorkflowResponse_arn :: Lens' DeleteWorkflowResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the migration workflow.

DeleteWorkflowStep

deleteWorkflowStep_id :: Lens' DeleteWorkflowStep Text Source #

The ID of the step you want to delete.

deleteWorkflowStep_stepGroupId :: Lens' DeleteWorkflowStep Text Source #

The ID of the step group that contains the step you want to delete.

DeleteWorkflowStepGroup

deleteWorkflowStepGroup_id :: Lens' DeleteWorkflowStepGroup Text Source #

The ID of the step group you want to delete.

GetTemplate

getTemplate_id :: Lens' GetTemplate Text Source #

The ID of the template.

getTemplateResponse_creationTime :: Lens' GetTemplateResponse (Maybe UTCTime) Source #

The time at which the template was last created.

getTemplateResponse_description :: Lens' GetTemplateResponse (Maybe Text) Source #

The time at which the template was last created.

getTemplateResponse_inputs :: Lens' GetTemplateResponse (Maybe [TemplateInput]) Source #

The inputs provided for the creation of the migration workflow.

getTemplateResponse_tools :: Lens' GetTemplateResponse (Maybe [Tool]) Source #

List of AWS services utilized in a migration workflow.

GetTemplateStep

getTemplateStepResponse_stepActionType :: Lens' GetTemplateStepResponse (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.

GetTemplateStepGroup

getTemplateStepGroupResponse_tools :: Lens' GetTemplateStepGroupResponse (Maybe [Tool]) Source #

List of AWS services utilized in a migration workflow.

GetWorkflow

getWorkflow_id :: Lens' GetWorkflow Text Source #

The ID of the migration workflow.

getWorkflowResponse_adsApplicationConfigurationId :: Lens' GetWorkflowResponse (Maybe Text) Source #

The configuration ID of the application configured in Application Discovery Service.

getWorkflowResponse_adsApplicationName :: Lens' GetWorkflowResponse (Maybe Text) Source #

The name of the application configured in Application Discovery Service.

getWorkflowResponse_arn :: Lens' GetWorkflowResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the migration workflow.

getWorkflowResponse_completedSteps :: Lens' GetWorkflowResponse (Maybe Int) Source #

Get a list of completed steps in the migration workflow.

getWorkflowResponse_creationTime :: Lens' GetWorkflowResponse (Maybe UTCTime) Source #

The time at which the migration workflow was created.

getWorkflowResponse_description :: Lens' GetWorkflowResponse (Maybe Text) Source #

The description of the migration workflow.

getWorkflowResponse_endTime :: Lens' GetWorkflowResponse (Maybe UTCTime) Source #

The time at which the migration workflow ended.

getWorkflowResponse_id :: Lens' GetWorkflowResponse (Maybe Text) Source #

The ID of the migration workflow.

getWorkflowResponse_lastModifiedTime :: Lens' GetWorkflowResponse (Maybe UTCTime) Source #

The time at which the migration workflow was last modified.

getWorkflowResponse_lastStartTime :: Lens' GetWorkflowResponse (Maybe UTCTime) Source #

The time at which the migration workflow was last started.

getWorkflowResponse_lastStopTime :: Lens' GetWorkflowResponse (Maybe UTCTime) Source #

The time at which the migration workflow was last stopped.

getWorkflowResponse_name :: Lens' GetWorkflowResponse (Maybe Text) Source #

The name of the migration workflow.

getWorkflowResponse_statusMessage :: Lens' GetWorkflowResponse (Maybe Text) Source #

The status message of the migration workflow.

getWorkflowResponse_tags :: Lens' GetWorkflowResponse (Maybe (HashMap Text Text)) Source #

The tags added to the migration workflow.

getWorkflowResponse_tools :: Lens' GetWorkflowResponse (Maybe [Tool]) Source #

List of AWS services utilized in a migration workflow.

getWorkflowResponse_totalSteps :: Lens' GetWorkflowResponse (Maybe Int) Source #

The total number of steps in the migration workflow.

getWorkflowResponse_workflowBucket :: Lens' GetWorkflowResponse (Maybe Text) Source #

The Amazon S3 bucket where the migration logs are stored.

getWorkflowResponse_workflowInputs :: Lens' GetWorkflowResponse (Maybe (HashMap Text StepInput)) Source #

The inputs required for creating the migration workflow.

GetWorkflowStep

getWorkflowStep_workflowId :: Lens' GetWorkflowStep Text Source #

The ID of the migration workflow.

getWorkflowStepResponse_lastStartTime :: Lens' GetWorkflowStepResponse (Maybe UTCTime) Source #

The time at which the workflow was last started.

getWorkflowStepResponse_noOfSrvCompleted :: Lens' GetWorkflowStepResponse (Maybe Int) Source #

The number of servers that have been migrated.

getWorkflowStepResponse_noOfSrvFailed :: Lens' GetWorkflowStepResponse (Maybe Int) Source #

The number of servers that have failed to migrate.

getWorkflowStepResponse_statusMessage :: Lens' GetWorkflowStepResponse (Maybe Text) Source #

The status message of the migration workflow.

getWorkflowStepResponse_stepActionType :: Lens' GetWorkflowStepResponse (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.

getWorkflowStepResponse_stepTarget :: Lens' GetWorkflowStepResponse (Maybe [Text]) Source #

The servers on which a step will be run.

getWorkflowStepResponse_totalNoOfSrv :: Lens' GetWorkflowStepResponse (Maybe Int) Source #

The total number of servers that have been migrated.

GetWorkflowStepGroup

getWorkflowStepGroupResponse_tools :: Lens' GetWorkflowStepGroupResponse (Maybe [Tool]) Source #

List of AWS services utilized in a migration workflow.

ListPlugins

listPlugins_maxResults :: Lens' ListPlugins (Maybe Natural) Source #

The maximum number of plugins that can be returned.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

ListTemplateStepGroups

listTemplateStepGroups_maxResults :: Lens' ListTemplateStepGroups (Maybe Natural) Source #

The maximum number of results that can be returned.

ListTemplateSteps

listTemplateSteps_maxResults :: Lens' ListTemplateSteps (Maybe Natural) Source #

The maximum number of results that can be returned.

ListTemplates

listTemplates_maxResults :: Lens' ListTemplates (Maybe Natural) Source #

The maximum number of results that can be returned.

listTemplates_name :: Lens' ListTemplates (Maybe Text) Source #

The name of the template.

ListWorkflowStepGroups

listWorkflowStepGroups_maxResults :: Lens' ListWorkflowStepGroups (Maybe Natural) Source #

The maximum number of results that can be returned.

ListWorkflowSteps

listWorkflowSteps_maxResults :: Lens' ListWorkflowSteps (Maybe Natural) Source #

The maximum number of results that can be returned.

listWorkflowSteps_workflowId :: Lens' ListWorkflowSteps Text Source #

The ID of the migration workflow.

ListWorkflows

listWorkflows_adsApplicationConfigurationName :: Lens' ListWorkflows (Maybe Text) Source #

The name of the application configured in Application Discovery Service.

listWorkflows_maxResults :: Lens' ListWorkflows (Maybe Natural) Source #

The maximum number of results that can be returned.

listWorkflows_name :: Lens' ListWorkflows (Maybe Text) Source #

The name of the migration workflow.

RetryWorkflowStep

retryWorkflowStep_workflowId :: Lens' RetryWorkflowStep Text Source #

The ID of the migration workflow.

StartWorkflow

startWorkflow_id :: Lens' StartWorkflow Text Source #

The ID of the migration workflow.

startWorkflowResponse_arn :: Lens' StartWorkflowResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the migration workflow.

startWorkflowResponse_id :: Lens' StartWorkflowResponse (Maybe Text) Source #

The ID of the migration workflow.

startWorkflowResponse_lastStartTime :: Lens' StartWorkflowResponse (Maybe UTCTime) Source #

The time at which the migration workflow was last started.

startWorkflowResponse_statusMessage :: Lens' StartWorkflowResponse (Maybe Text) Source #

The status message of the migration workflow.

StopWorkflow

stopWorkflow_id :: Lens' StopWorkflow Text Source #

The ID of the migration workflow.

stopWorkflowResponse_arn :: Lens' StopWorkflowResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the migration workflow.

stopWorkflowResponse_id :: Lens' StopWorkflowResponse (Maybe Text) Source #

The ID of the migration workflow.

stopWorkflowResponse_lastStopTime :: Lens' StopWorkflowResponse (Maybe UTCTime) Source #

The time at which the migration workflow was stopped.

stopWorkflowResponse_statusMessage :: Lens' StopWorkflowResponse (Maybe Text) Source #

The status message of the migration workflow.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource to which you want to add tags.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

A collection of labels, in the form of key:value pairs, that apply to this resource.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource from which you want to remove tags.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

One or more tag keys. Specify only the tag keys, not the tag values.

UpdateWorkflow

updateWorkflow_description :: Lens' UpdateWorkflow (Maybe Text) Source #

The description of the migration workflow.

updateWorkflow_inputParameters :: Lens' UpdateWorkflow (Maybe (HashMap Text StepInput)) Source #

The input parameters required to update a migration workflow.

updateWorkflow_name :: Lens' UpdateWorkflow (Maybe Text) Source #

The name of the migration workflow.

updateWorkflow_stepTargets :: Lens' UpdateWorkflow (Maybe [Text]) Source #

The servers on which a step will be run.

updateWorkflow_id :: Lens' UpdateWorkflow Text Source #

The ID of the migration workflow.

updateWorkflowResponse_adsApplicationConfigurationId :: Lens' UpdateWorkflowResponse (Maybe Text) Source #

The ID of the application configured in Application Discovery Service.

updateWorkflowResponse_arn :: Lens' UpdateWorkflowResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the migration workflow.

updateWorkflowResponse_creationTime :: Lens' UpdateWorkflowResponse (Maybe UTCTime) Source #

The time at which the migration workflow was created.

updateWorkflowResponse_description :: Lens' UpdateWorkflowResponse (Maybe Text) Source #

The description of the migration workflow.

updateWorkflowResponse_lastModifiedTime :: Lens' UpdateWorkflowResponse (Maybe UTCTime) Source #

The time at which the migration workflow was last modified.

updateWorkflowResponse_stepTargets :: Lens' UpdateWorkflowResponse (Maybe [Text]) Source #

The servers on which a step will be run.

updateWorkflowResponse_tags :: Lens' UpdateWorkflowResponse (Maybe (HashMap Text Text)) Source #

The tags added to the migration workflow.

updateWorkflowResponse_workflowInputs :: Lens' UpdateWorkflowResponse (Maybe (HashMap Text StepInput)) Source #

The inputs required to update a migration workflow.

UpdateWorkflowStep

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.

UpdateWorkflowStepGroup

updateWorkflowStepGroupResponse_tools :: Lens' UpdateWorkflowStepGroupResponse (Maybe [Tool]) Source #

List of AWS services utilized in a migration workflow.

Types

MigrationWorkflowSummary

migrationWorkflowSummary_adsApplicationConfigurationName :: Lens' MigrationWorkflowSummary (Maybe Text) Source #

The name of the application configured in Application Discovery Service.

migrationWorkflowSummary_completedSteps :: Lens' MigrationWorkflowSummary (Maybe Int) Source #

The steps completed in the migration workflow.

migrationWorkflowSummary_creationTime :: Lens' MigrationWorkflowSummary (Maybe UTCTime) Source #

The time at which the migration workflow was created.

migrationWorkflowSummary_endTime :: Lens' MigrationWorkflowSummary (Maybe UTCTime) Source #

The time at which the migration workflow ended.

migrationWorkflowSummary_statusMessage :: Lens' MigrationWorkflowSummary (Maybe Text) Source #

The status message of the migration workflow.

PlatformCommand

PlatformScriptKey

platformScriptKey_linux :: Lens' PlatformScriptKey (Maybe Text) Source #

The script location for Linux.

platformScriptKey_windows :: Lens' PlatformScriptKey (Maybe Text) Source #

The script location for Windows.

PluginSummary

pluginSummary_ipAddress :: Lens' PluginSummary (Maybe Text) Source #

The IP address at which the plugin is located.

pluginSummary_registeredTime :: Lens' PluginSummary (Maybe Text) Source #

The time at which the plugin was registered.

pluginSummary_version :: Lens' PluginSummary (Maybe Text) Source #

The version of the plugin.

StepAutomationConfiguration

StepInput

stepInput_integerValue :: Lens' StepInput (Maybe Int) Source #

The value of the integer.

StepOutput

stepOutput_dataType :: Lens' StepOutput (Maybe DataType) Source #

The data type of the step output.

stepOutput_name :: Lens' StepOutput (Maybe Text) Source #

The name of the step.

stepOutput_required :: Lens' StepOutput (Maybe Bool) Source #

Determine if an output is required from a step.

TemplateInput

templateInput_dataType :: Lens' TemplateInput (Maybe DataType) Source #

The data type of the template input.

templateInput_required :: Lens' TemplateInput (Maybe Bool) Source #

Determine if an input is required from the template.

TemplateStepGroupSummary

TemplateStepSummary

templateStepSummary_stepActionType :: Lens' TemplateStepSummary (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.

TemplateSummary

templateSummary_arn :: Lens' TemplateSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the template.

templateSummary_description :: Lens' TemplateSummary (Maybe Text) Source #

The description of the template.

Tool

tool_name :: Lens' Tool (Maybe Text) Source #

The name of an AWS service.

tool_url :: Lens' Tool (Maybe Text) Source #

The URL of an AWS service.

WorkflowStepAutomationConfiguration

WorkflowStepGroupSummary

WorkflowStepOutput

workflowStepOutput_required :: Lens' WorkflowStepOutput (Maybe Bool) Source #

Determine if an output is required from a step.

WorkflowStepOutputUnion

WorkflowStepSummary

workflowStepSummary_noOfSrvCompleted :: Lens' WorkflowStepSummary (Maybe Int) Source #

The number of servers that have been migrated.

workflowStepSummary_noOfSrvFailed :: Lens' WorkflowStepSummary (Maybe Int) Source #

The number of servers that have failed to migrate.

workflowStepSummary_statusMessage :: Lens' WorkflowStepSummary (Maybe Text) Source #

The status message of the migration workflow.

workflowStepSummary_stepActionType :: Lens' WorkflowStepSummary (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.

workflowStepSummary_totalNoOfSrv :: Lens' WorkflowStepSummary (Maybe Int) Source #

The total number of servers that have been migrated.