AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Transform](https://aws.amazon.com/transform).

# Data Types
<a name="API_Types"></a>

The following data types are supported:
+  [ApplicationState](API_ApplicationState.md) 
+  [CreatedArtifact](API_CreatedArtifact.md) 
+  [DiscoveredResource](API_DiscoveredResource.md) 
+  [MigrationTask](API_MigrationTask.md) 
+  [MigrationTaskSummary](API_MigrationTaskSummary.md) 
+  [MigrationTaskUpdate](API_MigrationTaskUpdate.md) 
+  [ProgressUpdateStreamSummary](API_ProgressUpdateStreamSummary.md) 
+  [ResourceAttribute](API_ResourceAttribute.md) 
+  [SourceResource](API_SourceResource.md) 
+  [Task](API_Task.md) 

# ApplicationState
<a name="API_ApplicationState"></a>

The state of an application discovered through Migration Hub import, the AWS Agentless Discovery Connector, or the AWS Application Discovery Agent.

## Contents
<a name="API_ApplicationState_Contents"></a>

 ** ApplicationId **   <a name="migrationhub-Type-ApplicationState-ApplicationId"></a>
The configurationId from the Application Discovery Service that uniquely identifies an application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^.{1,1600}$`   
Required: No

 ** ApplicationStatus **   <a name="migrationhub-Type-ApplicationState-ApplicationStatus"></a>
The current status of an application.  
Type: String  
Valid Values: `NOT_STARTED | IN_PROGRESS | COMPLETED`   
Required: No

 ** LastUpdatedTime **   <a name="migrationhub-Type-ApplicationState-LastUpdatedTime"></a>
The timestamp when the application status was last updated.  
Type: Timestamp  
Required: No

## See Also
<a name="API_ApplicationState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWSMigrationHub-2017-05-31/ApplicationState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWSMigrationHub-2017-05-31/ApplicationState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWSMigrationHub-2017-05-31/ApplicationState) 

# CreatedArtifact
<a name="API_CreatedArtifact"></a>

An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 instance, RDS instance, etc.).

## Contents
<a name="API_CreatedArtifact_Contents"></a>

 ** Name **   <a name="migrationhub-Type-CreatedArtifact-Name"></a>
An ARN that uniquely identifies the result of a migration task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `arn:[a-z-]+:[a-z0-9-]+:(?:[a-z0-9-]+|):(?:[0-9]{12}|):.*`   
Required: Yes

 ** Description **   <a name="migrationhub-Type-CreatedArtifact-Description"></a>
A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `^.{0,500}$`   
Required: No

## See Also
<a name="API_CreatedArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWSMigrationHub-2017-05-31/CreatedArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWSMigrationHub-2017-05-31/CreatedArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWSMigrationHub-2017-05-31/CreatedArtifact) 

# DiscoveredResource
<a name="API_DiscoveredResource"></a>

Object representing the on-premises resource being migrated.

## Contents
<a name="API_DiscoveredResource_Contents"></a>

 ** ConfigurationId **   <a name="migrationhub-Type-DiscoveredResource-ConfigurationId"></a>
The configurationId in Application Discovery Service that uniquely identifies the on-premise resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^.{1,1600}$`   
Required: Yes

 ** Description **   <a name="migrationhub-Type-DiscoveredResource-Description"></a>
A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `^.{0,500}$`   
Required: No

## See Also
<a name="API_DiscoveredResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWSMigrationHub-2017-05-31/DiscoveredResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWSMigrationHub-2017-05-31/DiscoveredResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWSMigrationHub-2017-05-31/DiscoveredResource) 

# MigrationTask
<a name="API_MigrationTask"></a>

Represents a migration task in a migration tool.

## Contents
<a name="API_MigrationTask_Contents"></a>

 ** MigrationTaskName **   <a name="migrationhub-Type-MigrationTask-MigrationTaskName"></a>
Unique identifier that references the migration task. *Do not store personal data in this field.*   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^:|]+`   
Required: No

 ** ProgressUpdateStream **   <a name="migrationhub-Type-MigrationTask-ProgressUpdateStream"></a>
A name that identifies the vendor of the migration tool being used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[^/:|\000-\037]+`   
Required: No

 ** ResourceAttributeList **   <a name="migrationhub-Type-MigrationTask-ResourceAttributeList"></a>
Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.  
Type: Array of [ResourceAttribute](API_ResourceAttribute.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

 ** Task **   <a name="migrationhub-Type-MigrationTask-Task"></a>
Task object encapsulating task information.  
Type: [Task](API_Task.md) object  
Required: No

 ** UpdateDateTime **   <a name="migrationhub-Type-MigrationTask-UpdateDateTime"></a>
The timestamp when the task was gathered.  
Type: Timestamp  
Required: No

## See Also
<a name="API_MigrationTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWSMigrationHub-2017-05-31/MigrationTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWSMigrationHub-2017-05-31/MigrationTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWSMigrationHub-2017-05-31/MigrationTask) 

# MigrationTaskSummary
<a name="API_MigrationTaskSummary"></a>

MigrationTaskSummary includes `MigrationTaskName`, `ProgressPercent`, `ProgressUpdateStream`, `Status`, and `UpdateDateTime` for each task.

## Contents
<a name="API_MigrationTaskSummary_Contents"></a>

 ** MigrationTaskName **   <a name="migrationhub-Type-MigrationTaskSummary-MigrationTaskName"></a>
Unique identifier that references the migration task. *Do not store personal data in this field.*   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^:|]+`   
Required: No

 ** ProgressPercent **   <a name="migrationhub-Type-MigrationTaskSummary-ProgressPercent"></a>
Indication of the percentage completion of the task.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** ProgressUpdateStream **   <a name="migrationhub-Type-MigrationTaskSummary-ProgressUpdateStream"></a>
An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all updates made by the tool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[^/:|\000-\037]+`   
Required: No

 ** Status **   <a name="migrationhub-Type-MigrationTaskSummary-Status"></a>
Status of the task.  
Type: String  
Valid Values: `NOT_STARTED | IN_PROGRESS | FAILED | COMPLETED`   
Required: No

 ** StatusDetail **   <a name="migrationhub-Type-MigrationTaskSummary-StatusDetail"></a>
Detail information of what is being done within the overall status state.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2500.  
Pattern: `^.{0,2500}$`   
Required: No

 ** UpdateDateTime **   <a name="migrationhub-Type-MigrationTaskSummary-UpdateDateTime"></a>
The timestamp when the task was gathered.  
Type: Timestamp  
Required: No

## See Also
<a name="API_MigrationTaskSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWSMigrationHub-2017-05-31/MigrationTaskSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWSMigrationHub-2017-05-31/MigrationTaskSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWSMigrationHub-2017-05-31/MigrationTaskSummary) 

# MigrationTaskUpdate
<a name="API_MigrationTaskUpdate"></a>

A migration-task progress update.

## Contents
<a name="API_MigrationTaskUpdate_Contents"></a>

 ** MigrationTaskState **   <a name="migrationhub-Type-MigrationTaskUpdate-MigrationTaskState"></a>
Task object encapsulating task information.  
Type: [Task](API_Task.md) object  
Required: No

 ** UpdateDateTime **   <a name="migrationhub-Type-MigrationTaskUpdate-UpdateDateTime"></a>
The timestamp for the update.  
Type: Timestamp  
Required: No

 ** UpdateType **   <a name="migrationhub-Type-MigrationTaskUpdate-UpdateType"></a>
The type of the update.  
Type: String  
Valid Values: `MIGRATION_TASK_STATE_UPDATED`   
Required: No

## See Also
<a name="API_MigrationTaskUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWSMigrationHub-2017-05-31/MigrationTaskUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWSMigrationHub-2017-05-31/MigrationTaskUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWSMigrationHub-2017-05-31/MigrationTaskUpdate) 

# ProgressUpdateStreamSummary
<a name="API_ProgressUpdateStreamSummary"></a>

Summary of the AWS resource used for access control that is implicitly linked to your AWS account.

## Contents
<a name="API_ProgressUpdateStreamSummary_Contents"></a>

 ** ProgressUpdateStreamName **   <a name="migrationhub-Type-ProgressUpdateStreamSummary-ProgressUpdateStreamName"></a>
The name of the ProgressUpdateStream. *Do not store personal data in this field.*   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[^/:|\000-\037]+`   
Required: No

## See Also
<a name="API_ProgressUpdateStreamSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWSMigrationHub-2017-05-31/ProgressUpdateStreamSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWSMigrationHub-2017-05-31/ProgressUpdateStreamSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWSMigrationHub-2017-05-31/ProgressUpdateStreamSummary) 

# ResourceAttribute
<a name="API_ResourceAttribute"></a>

Attribute associated with a resource.

Note the corresponding format required per type listed below:

IPV4  
 `x.x.x.x`   
 *where x is an integer in the range [0,255]* 

IPV6  
 `y : y : y : y : y : y : y : y`   
 *where y is a hexadecimal between 0 and FFFF. [0, FFFF]* 

MAC\$1ADDRESS  
 `^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$` 

FQDN  
 `^[^<>{}\\\\/?,=\\p{Cntrl}]{1,256}$` 

## Contents
<a name="API_ResourceAttribute_Contents"></a>

 ** Type **   <a name="migrationhub-Type-ResourceAttribute-Type"></a>
Type of resource.  
Type: String  
Valid Values: `IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER`   
Required: Yes

 ** Value **   <a name="migrationhub-Type-ResourceAttribute-Value"></a>
Value of the resource type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^.{1,256}$`   
Required: Yes

## See Also
<a name="API_ResourceAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWSMigrationHub-2017-05-31/ResourceAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWSMigrationHub-2017-05-31/ResourceAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWSMigrationHub-2017-05-31/ResourceAttribute) 

# SourceResource
<a name="API_SourceResource"></a>

A source resource can be a source server, a migration wave, an application, or any other resource that you track.

## Contents
<a name="API_SourceResource_Contents"></a>

 ** Name **   <a name="migrationhub-Type-SourceResource-Name"></a>
This is the name that you want to use to identify the resource. If the resource is an AWS resource, we recommend that you set this parameter to the ARN of the resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: Yes

 ** Description **   <a name="migrationhub-Type-SourceResource-Description"></a>
A description that can be free-form text to record additional detail about the resource for clarity or later reference.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `^.{0,500}$`   
Required: No

 ** StatusDetail **   <a name="migrationhub-Type-SourceResource-StatusDetail"></a>
A free-form description of the status of the resource.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2500.  
Pattern: `^.{0,2500}$`   
Required: No

## See Also
<a name="API_SourceResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWSMigrationHub-2017-05-31/SourceResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWSMigrationHub-2017-05-31/SourceResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWSMigrationHub-2017-05-31/SourceResource) 

# Task
<a name="API_Task"></a>

Task object encapsulating task information.

## Contents
<a name="API_Task_Contents"></a>

 ** Status **   <a name="migrationhub-Type-Task-Status"></a>
Status of the task - Not Started, In-Progress, Complete.  
Type: String  
Valid Values: `NOT_STARTED | IN_PROGRESS | FAILED | COMPLETED`   
Required: Yes

 ** ProgressPercent **   <a name="migrationhub-Type-Task-ProgressPercent"></a>
Indication of the percentage completion of the task.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** StatusDetail **   <a name="migrationhub-Type-Task-StatusDetail"></a>
Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2500.  
Pattern: `^.{0,2500}$`   
Required: No

## See Also
<a name="API_Task_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWSMigrationHub-2017-05-31/Task) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWSMigrationHub-2017-05-31/Task) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWSMigrationHub-2017-05-31/Task)