@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSMigrationHubOrchestratorClient extends AmazonWebServiceClient implements AWSMigrationHubOrchestrator
This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Migration Hub Orchestrator. The topic for each action shows the API request parameters and responses. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSMigrationHubOrchestratorClientBuilder builder()
public CreateTemplateResult createTemplate(CreateTemplateRequest request)
Creates a migration workflow template.
createTemplate in interface AWSMigrationHubOrchestratorcreateTemplateRequest - ThrottlingException - The request was denied due to request throttling.ConflictException - This exception is thrown when an attempt to update or delete a resource would cause an inconsistent
state.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.public CreateWorkflowResult createWorkflow(CreateWorkflowRequest request)
Create a workflow to orchestrate your migrations.
createWorkflow in interface AWSMigrationHubOrchestratorcreateWorkflowRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.public CreateWorkflowStepResult createWorkflowStep(CreateWorkflowStepRequest request)
Create a step in the migration workflow.
createWorkflowStep in interface AWSMigrationHubOrchestratorcreateWorkflowStepRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.public CreateWorkflowStepGroupResult createWorkflowStepGroup(CreateWorkflowStepGroupRequest request)
Create a step group in a migration workflow.
createWorkflowStepGroup in interface AWSMigrationHubOrchestratorcreateWorkflowStepGroupRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.public DeleteTemplateResult deleteTemplate(DeleteTemplateRequest request)
Deletes a migration workflow template.
deleteTemplate in interface AWSMigrationHubOrchestratordeleteTemplateRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest request)
Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.
deleteWorkflow in interface AWSMigrationHubOrchestratordeleteWorkflowRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public DeleteWorkflowStepResult deleteWorkflowStep(DeleteWorkflowStepRequest request)
Delete a step in a migration workflow. Pause the workflow to delete a running step.
deleteWorkflowStep in interface AWSMigrationHubOrchestratordeleteWorkflowStepRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public DeleteWorkflowStepGroupResult deleteWorkflowStepGroup(DeleteWorkflowStepGroupRequest request)
Delete a step group in a migration workflow.
deleteWorkflowStepGroup in interface AWSMigrationHubOrchestratordeleteWorkflowStepGroupRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public GetTemplateResult getTemplate(GetTemplateRequest request)
Get the template you want to use for creating a migration workflow.
getTemplate in interface AWSMigrationHubOrchestratorgetTemplateRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ResourceNotFoundException - The resource is not available.public GetTemplateStepResult getTemplateStep(GetTemplateStepRequest request)
Get a specific step in a template.
getTemplateStep in interface AWSMigrationHubOrchestratorgetTemplateStepRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public GetTemplateStepGroupResult getTemplateStepGroup(GetTemplateStepGroupRequest request)
Get a step group in a template.
getTemplateStepGroup in interface AWSMigrationHubOrchestratorgetTemplateStepGroupRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public GetWorkflowResult getWorkflow(GetWorkflowRequest request)
Get migration workflow.
getWorkflow in interface AWSMigrationHubOrchestratorgetWorkflowRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public GetWorkflowStepResult getWorkflowStep(GetWorkflowStepRequest request)
Get a step in the migration workflow.
getWorkflowStep in interface AWSMigrationHubOrchestratorgetWorkflowStepRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ResourceNotFoundException - The resource is not available.public GetWorkflowStepGroupResult getWorkflowStepGroup(GetWorkflowStepGroupRequest request)
Get the step group of a migration workflow.
getWorkflowStepGroup in interface AWSMigrationHubOrchestratorgetWorkflowStepGroupRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public ListPluginsResult listPlugins(ListPluginsRequest request)
List AWS Migration Hub Orchestrator plugins.
listPlugins in interface AWSMigrationHubOrchestratorlistPluginsRequest - AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List the tags added to a resource.
listTagsForResource in interface AWSMigrationHubOrchestratorlistTagsForResourceRequest - ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public ListTemplateStepGroupsResult listTemplateStepGroups(ListTemplateStepGroupsRequest request)
List the step groups in a template.
listTemplateStepGroups in interface AWSMigrationHubOrchestratorlistTemplateStepGroupsRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ResourceNotFoundException - The resource is not available.public ListTemplateStepsResult listTemplateSteps(ListTemplateStepsRequest request)
List the steps in a template.
listTemplateSteps in interface AWSMigrationHubOrchestratorlistTemplateStepsRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public ListTemplatesResult listTemplates(ListTemplatesRequest request)
List the templates available in Migration Hub Orchestrator to create a migration workflow.
listTemplates in interface AWSMigrationHubOrchestratorlistTemplatesRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.public ListWorkflowStepGroupsResult listWorkflowStepGroups(ListWorkflowStepGroupsRequest request)
List the step groups in a migration workflow.
listWorkflowStepGroups in interface AWSMigrationHubOrchestratorlistWorkflowStepGroupsRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public ListWorkflowStepsResult listWorkflowSteps(ListWorkflowStepsRequest request)
List the steps in a workflow.
listWorkflowSteps in interface AWSMigrationHubOrchestratorlistWorkflowStepsRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.public ListWorkflowsResult listWorkflows(ListWorkflowsRequest request)
List the migration workflows.
listWorkflows in interface AWSMigrationHubOrchestratorlistWorkflowsRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public RetryWorkflowStepResult retryWorkflowStep(RetryWorkflowStepRequest request)
Retry a failed step in a migration workflow.
retryWorkflowStep in interface AWSMigrationHubOrchestratorretryWorkflowStepRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ResourceNotFoundException - The resource is not available.public StartWorkflowResult startWorkflow(StartWorkflowRequest request)
Start a migration workflow.
startWorkflow in interface AWSMigrationHubOrchestratorstartWorkflowRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public StopWorkflowResult stopWorkflow(StopWorkflowRequest request)
Stop an ongoing migration workflow.
stopWorkflow in interface AWSMigrationHubOrchestratorstopWorkflowRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public TagResourceResult tagResource(TagResourceRequest request)
Tag a resource by specifying its Amazon Resource Name (ARN).
tagResource in interface AWSMigrationHubOrchestratortagResourceRequest - ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes the tags for a resource.
untagResource in interface AWSMigrationHubOrchestratoruntagResourceRequest - ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public UpdateTemplateResult updateTemplate(UpdateTemplateRequest request)
Updates a migration workflow template.
updateTemplate in interface AWSMigrationHubOrchestratorupdateTemplateRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public UpdateWorkflowResult updateWorkflow(UpdateWorkflowRequest request)
Update a migration workflow.
updateWorkflow in interface AWSMigrationHubOrchestratorupdateWorkflowRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public UpdateWorkflowStepResult updateWorkflowStep(UpdateWorkflowStepRequest request)
Update a step in a migration workflow.
updateWorkflowStep in interface AWSMigrationHubOrchestratorupdateWorkflowStepRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.public UpdateWorkflowStepGroupResult updateWorkflowStepGroup(UpdateWorkflowStepGroupRequest request)
Update the step group in a migration workflow.
updateWorkflowStepGroup in interface AWSMigrationHubOrchestratorupdateWorkflowStepGroupRequest - ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - An internal error has occurred.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - The resource is not available.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AWSMigrationHubOrchestratorrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSMigrationHubOrchestratorshutdown in class AmazonWebServiceClient