ImportMigrationTask
Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.
This API is a prerequisite to calling the NotifyMigrationTaskState
API as
the migration tool must first register the migration task with Migration Hub.
Request Syntax
{
"DryRun": boolean
,
"MigrationTaskName": "string
",
"ProgressUpdateStream": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- DryRun
-
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
Type: Boolean
Required: No
- MigrationTaskName
-
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: Yes
- ProgressUpdateStream
-
The name of the ProgressUpdateStream. >
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
[^/:|\000-\037]+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- DryRunOperation
-
Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true".HTTP Status Code: 400
- HomeRegionNotSetException
-
The home region is not set. Set the home region to continue.
HTTP Status Code: 400
- InternalServerError
-
Exception raised when an internal, configuration, or dependency error is encountered.
HTTP Status Code: 500
- InvalidInputException
-
Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
HTTP Status Code: 400
- ResourceNotFoundException
-
Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
HTTP Status Code: 400
- ServiceUnavailableException
-
Exception raised when there is an internal, configuration, or dependency error encountered.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- UnauthorizedOperation
-
Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true".HTTP Status Code: 400
Examples
Import a migration task to register it with Migration Hub
The following example registers a new migration task with Migration Hub identified
by the values passed to the required parameters MigrationTaskName
and
ProgressUpdateStreamName
in the request.
Sample Request
{
"MigrationTaskName": "sms-12de3cf1a",
"ProgressUpdateStream": "SMS"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: