Menu
AWS Migration Hub
User Guide

DescribeApplicationState

Gets the migration status of an application.

Request Syntax

{ "ApplicationId": "string" }

Request Parameters

The request accepts the following data in JSON format.

ApplicationId

The configurationId in ADS that uniquely identifies the grouped application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: Yes

Response Syntax

{ "ApplicationStatus": "string", "LastUpdatedTime": number }

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.

ApplicationStatus

Status of the application - Not Started, In-Progress, Complete.

Type: String

Valid Values: NOT_STARTED | IN_PROGRESS | COMPLETED

LastUpdatedTime

The timestamp when the application status was last updated.

Type: Timestamp

Errors

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerError

Exception raised when there is an internal, configuration, or dependency error 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

PolicyErrorException

Exception raised when there are problems accessing ADS (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

HTTP Status Code: 400

ResourceNotFoundException

Exception raised when the request references a resource (ADS configuration, update stream, migration task, etc.) that does not exist in ADS (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

Example

Describe a migration task by listing all associated attributes

The following example lists all of the attributes associated with the values passed to the required parameters of MigrationTaskName and ProgressUpdateStream.

Sample Request

{ "ApplicationId": "d-application-0039038d504694533" }

Sample Response

{ "ApplicationStatus": "IN_PROGRESS", "LastUpdatedTime": 1493405005.639 }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: