com.amazonaws.services.migrationhuborchestrator

Interface AWSMigrationHubOrchestrator

All Known Subinterfaces:

AWSMigrationHubOrchestratorAsync

All Known Implementing Classes:

AbstractAWSMigrationHubOrchestrator, AbstractAWSMigrationHubOrchestratorAsync, AWSMigrationHubOrchestratorAsyncClient, AWSMigrationHubOrchestratorClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMigrationHubOrchestrator

Interface for accessing AWS Migration Hub Orchestrator.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMigrationHubOrchestrator instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateTemplateResult	createTemplate(CreateTemplateRequest createTemplateRequest) Creates a migration workflow template.
CreateWorkflowResult	createWorkflow(CreateWorkflowRequest createWorkflowRequest) Create a workflow to orchestrate your migrations.
CreateWorkflowStepResult	createWorkflowStep(CreateWorkflowStepRequest createWorkflowStepRequest) Create a step in the migration workflow.
CreateWorkflowStepGroupResult	createWorkflowStepGroup(CreateWorkflowStepGroupRequest createWorkflowStepGroupRequest) Create a step group in a migration workflow.
DeleteTemplateResult	deleteTemplate(DeleteTemplateRequest deleteTemplateRequest) Deletes a migration workflow template.
DeleteWorkflowResult	deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest) Delete a migration workflow.
DeleteWorkflowStepResult	deleteWorkflowStep(DeleteWorkflowStepRequest deleteWorkflowStepRequest) Delete a step in a migration workflow.
DeleteWorkflowStepGroupResult	deleteWorkflowStepGroup(DeleteWorkflowStepGroupRequest deleteWorkflowStepGroupRequest) Delete a step group in a migration workflow.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetTemplateResult	getTemplate(GetTemplateRequest getTemplateRequest) Get the template you want to use for creating a migration workflow.
GetTemplateStepResult	getTemplateStep(GetTemplateStepRequest getTemplateStepRequest) Get a specific step in a template.
GetTemplateStepGroupResult	getTemplateStepGroup(GetTemplateStepGroupRequest getTemplateStepGroupRequest) Get a step group in a template.
GetWorkflowResult	getWorkflow(GetWorkflowRequest getWorkflowRequest) Get migration workflow.
GetWorkflowStepResult	getWorkflowStep(GetWorkflowStepRequest getWorkflowStepRequest) Get a step in the migration workflow.
GetWorkflowStepGroupResult	getWorkflowStepGroup(GetWorkflowStepGroupRequest getWorkflowStepGroupRequest) Get the step group of a migration workflow.
ListPluginsResult	listPlugins(ListPluginsRequest listPluginsRequest) List AWS Migration Hub Orchestrator plugins.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List the tags added to a resource.
ListTemplatesResult	listTemplates(ListTemplatesRequest listTemplatesRequest) List the templates available in Migration Hub Orchestrator to create a migration workflow.
ListTemplateStepGroupsResult	listTemplateStepGroups(ListTemplateStepGroupsRequest listTemplateStepGroupsRequest) List the step groups in a template.
ListTemplateStepsResult	listTemplateSteps(ListTemplateStepsRequest listTemplateStepsRequest) List the steps in a template.
ListWorkflowsResult	listWorkflows(ListWorkflowsRequest listWorkflowsRequest) List the migration workflows.
ListWorkflowStepGroupsResult	listWorkflowStepGroups(ListWorkflowStepGroupsRequest listWorkflowStepGroupsRequest) List the step groups in a migration workflow.
ListWorkflowStepsResult	listWorkflowSteps(ListWorkflowStepsRequest listWorkflowStepsRequest) List the steps in a workflow.
RetryWorkflowStepResult	retryWorkflowStep(RetryWorkflowStepRequest retryWorkflowStepRequest) Retry a failed step in a migration workflow.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartWorkflowResult	startWorkflow(StartWorkflowRequest startWorkflowRequest) Start a migration workflow.
StopWorkflowResult	stopWorkflow(StopWorkflowRequest stopWorkflowRequest) Stop an ongoing migration workflow.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Tag a resource by specifying its Amazon Resource Name (ARN).
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Deletes the tags for a resource.
UpdateTemplateResult	updateTemplate(UpdateTemplateRequest updateTemplateRequest) Updates a migration workflow template.
UpdateWorkflowResult	updateWorkflow(UpdateWorkflowRequest updateWorkflowRequest) Update a migration workflow.
UpdateWorkflowStepResult	updateWorkflowStep(UpdateWorkflowStepRequest updateWorkflowStepRequest) Update a step in a migration workflow.
UpdateWorkflowStepGroupResult	updateWorkflowStepGroup(UpdateWorkflowStepGroupRequest updateWorkflowStepGroupRequest) Update the step group in a migration workflow.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createTemplate

CreateTemplateResult createTemplate(CreateTemplateRequest createTemplateRequest)

Creates a migration workflow template.

Parameters:

createTemplateRequest -

Returns:

Result of the CreateTemplate operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createWorkflow

CreateWorkflowResult createWorkflow(CreateWorkflowRequest createWorkflowRequest)

Create a workflow to orchestrate your migrations.

Parameters:

createWorkflowRequest -

Returns:

Result of the CreateWorkflow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createWorkflowStep

CreateWorkflowStepResult createWorkflowStep(CreateWorkflowStepRequest createWorkflowStepRequest)

Create a step in the migration workflow.

Parameters:

createWorkflowStepRequest -

Returns:

Result of the CreateWorkflowStep operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createWorkflowStepGroup

CreateWorkflowStepGroupResult createWorkflowStepGroup(CreateWorkflowStepGroupRequest createWorkflowStepGroupRequest)

Create a step group in a migration workflow.

Parameters:

createWorkflowStepGroupRequest -

Returns:

Result of the CreateWorkflowStepGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteTemplate

DeleteTemplateResult deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)

Deletes a migration workflow template.

Parameters:

deleteTemplateRequest -

Returns:

Result of the DeleteTemplate operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteWorkflow

DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)

Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.

Parameters:

deleteWorkflowRequest -

Returns:

Result of the DeleteWorkflow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteWorkflowStep

DeleteWorkflowStepResult deleteWorkflowStep(DeleteWorkflowStepRequest deleteWorkflowStepRequest)

Delete a step in a migration workflow. Pause the workflow to delete a running step.

Parameters:

deleteWorkflowStepRequest -

Returns:

Result of the DeleteWorkflowStep operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteWorkflowStepGroup

DeleteWorkflowStepGroupResult deleteWorkflowStepGroup(DeleteWorkflowStepGroupRequest deleteWorkflowStepGroupRequest)

Delete a step group in a migration workflow.

Parameters:

deleteWorkflowStepGroupRequest -

Returns:

Result of the DeleteWorkflowStepGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getTemplate

GetTemplateResult getTemplate(GetTemplateRequest getTemplateRequest)

Get the template you want to use for creating a migration workflow.

Parameters:

getTemplateRequest -

Returns:

Result of the GetTemplate operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getTemplateStep

GetTemplateStepResult getTemplateStep(GetTemplateStepRequest getTemplateStepRequest)

Get a specific step in a template.

Parameters:

getTemplateStepRequest -

Returns:

Result of the GetTemplateStep operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getTemplateStepGroup

GetTemplateStepGroupResult getTemplateStepGroup(GetTemplateStepGroupRequest getTemplateStepGroupRequest)

Get a step group in a template.

Parameters:

getTemplateStepGroupRequest -

Returns:

Result of the GetTemplateStepGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getWorkflow

GetWorkflowResult getWorkflow(GetWorkflowRequest getWorkflowRequest)

Get migration workflow.

Parameters:

getWorkflowRequest -

Returns:

Result of the GetWorkflow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getWorkflowStep

GetWorkflowStepResult getWorkflowStep(GetWorkflowStepRequest getWorkflowStepRequest)

Get a step in the migration workflow.

Parameters:

getWorkflowStepRequest -

Returns:

Result of the GetWorkflowStep operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getWorkflowStepGroup

GetWorkflowStepGroupResult getWorkflowStepGroup(GetWorkflowStepGroupRequest getWorkflowStepGroupRequest)

Get the step group of a migration workflow.

Parameters:

getWorkflowStepGroupRequest -

Returns:

Result of the GetWorkflowStepGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listPlugins

ListPluginsResult listPlugins(ListPluginsRequest listPluginsRequest)

List AWS Migration Hub Orchestrator plugins.

Parameters:

listPluginsRequest -

Returns:

Result of the ListPlugins operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

List the tags added to a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ResourceNotFoundException - The resource is not available.

See Also:

AWS API Documentation

listTemplateStepGroups

ListTemplateStepGroupsResult listTemplateStepGroups(ListTemplateStepGroupsRequest listTemplateStepGroupsRequest)

List the step groups in a template.

Parameters:

listTemplateStepGroupsRequest -

Returns:

Result of the ListTemplateStepGroups operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTemplateSteps

ListTemplateStepsResult listTemplateSteps(ListTemplateStepsRequest listTemplateStepsRequest)

List the steps in a template.

Parameters:

listTemplateStepsRequest -

Returns:

Result of the ListTemplateSteps operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTemplates

ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest)

List the templates available in Migration Hub Orchestrator to create a migration workflow.

Parameters:

listTemplatesRequest -

Returns:

Result of the ListTemplates operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listWorkflowStepGroups

ListWorkflowStepGroupsResult listWorkflowStepGroups(ListWorkflowStepGroupsRequest listWorkflowStepGroupsRequest)

List the step groups in a migration workflow.

Parameters:

listWorkflowStepGroupsRequest -

Returns:

Result of the ListWorkflowStepGroups operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listWorkflowSteps

ListWorkflowStepsResult listWorkflowSteps(ListWorkflowStepsRequest listWorkflowStepsRequest)

List the steps in a workflow.

Parameters:

listWorkflowStepsRequest -

Returns:

Result of the ListWorkflowSteps operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listWorkflows

ListWorkflowsResult listWorkflows(ListWorkflowsRequest listWorkflowsRequest)

List the migration workflows.

Parameters:

listWorkflowsRequest -

Returns:

Result of the ListWorkflows operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

retryWorkflowStep

RetryWorkflowStepResult retryWorkflowStep(RetryWorkflowStepRequest retryWorkflowStepRequest)

Retry a failed step in a migration workflow.

Parameters:

retryWorkflowStepRequest -

Returns:

Result of the RetryWorkflowStep operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startWorkflow

StartWorkflowResult startWorkflow(StartWorkflowRequest startWorkflowRequest)

Start a migration workflow.

Parameters:

startWorkflowRequest -

Returns:

Result of the StartWorkflow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

stopWorkflow

StopWorkflowResult stopWorkflow(StopWorkflowRequest stopWorkflowRequest)

Stop an ongoing migration workflow.

Parameters:

stopWorkflowRequest -

Returns:

Result of the StopWorkflow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Tag a resource by specifying its Amazon Resource Name (ARN).

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ResourceNotFoundException - The resource is not available.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Deletes the tags for a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ResourceNotFoundException - The resource is not available.

See Also:

AWS API Documentation

updateTemplate

UpdateTemplateResult updateTemplate(UpdateTemplateRequest updateTemplateRequest)

Updates a migration workflow template.

Parameters:

updateTemplateRequest -

Returns:

Result of the UpdateTemplate operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateWorkflow

UpdateWorkflowResult updateWorkflow(UpdateWorkflowRequest updateWorkflowRequest)

Update a migration workflow.

Parameters:

updateWorkflowRequest -

Returns:

Result of the UpdateWorkflow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateWorkflowStep

UpdateWorkflowStepResult updateWorkflowStep(UpdateWorkflowStepRequest updateWorkflowStepRequest)

Update a step in a migration workflow.

Parameters:

updateWorkflowStepRequest -

Returns:

Result of the UpdateWorkflowStep operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateWorkflowStepGroup

UpdateWorkflowStepGroupResult updateWorkflowStepGroup(UpdateWorkflowStepGroupRequest updateWorkflowStepGroupRequest)

Update the step group in a migration workflow.

Parameters:

updateWorkflowStepGroupRequest -

Returns:

Result of the UpdateWorkflowStepGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.