This is a paginated API that returns all the migration-task states for the specified
MigrationTaskName and ProgressUpdateStream.
Request Syntax
{
"MaxResults": number,
"MigrationTaskName": "string",
"NextToken": "string",
"ProgressUpdateStream": "string"
}Request Parameters
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of results to include in the response. If more results exist than the value that you specify here for
MaxResults, the response will include a token that you can use to retrieve the next set of results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- MigrationTaskName
-
A unique identifier that references the migration task. Do not include sensitive data in this field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^:|]+Required: Yes
- NextToken
-
If
NextTokenwas returned by a previous call, there are more results available. The value ofNextTokenis a unique pagination token for each page. To retrieve the next page of results, specify theNextTokenvalue that the previous call returned. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^[a-zA-Z0-9\/\+\=]{0,2048}$Required: No
- ProgressUpdateStream
-
The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
[^/:|\000-\037]+Required: Yes
Response Syntax
{
"MigrationTaskUpdateList": [
{
"MigrationTaskState": {
"ProgressPercent": number,
"Status": "string",
"StatusDetail": "string"
},
"UpdateDateTime": number,
"UpdateType": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- MigrationTaskUpdateList
-
The list of migration-task updates.
Type: Array of MigrationTaskUpdate objects
- NextToken
-
If the response includes a
NextTokenvalue, that means that there are more results available. The value ofNextTokenis a unique pagination token for each page. To retrieve the next page of results, call this API again and specify thisNextTokenvalue in the request. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^[a-zA-Z0-9\/\+\=]{0,2048}$
Errors
- AccessDeniedException
-
You do not have sufficient access to perform this action.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
