Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

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 Application Discovery Service that uniquely identifies the grouped application.

Type: String

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

Pattern: ^.{1,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

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

PolicyErrorException

Exception raised when there are problems accessing Application Discovery Service (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 (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.

Message: A message that provides information about the exception.
RetryAfterSeconds: The number of seconds the caller should wait before retrying.

HTTP Status Code: 400

Examples

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
}