Menu
AWS Migration Hub
User Guide

NotifyApplicationState

Sets the migration state of an application. For a given application identified by the value passed to ApplicationId, its status is set or updated by passing one of three values to Status: NOT_STARTED | IN_PROGRESS | COMPLETED.

Request Syntax

{
   "ApplicationId": "string",
   "DryRun": boolean,
   "Status": "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

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

Status

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

Type: String

Valid Values: NOT_STARTED | IN_PROGRESS | COMPLETED

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

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

UnauthorizedOperation

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

HTTP Status Code: 400

Example

Notify the application state to Migration Hub

The following example communicates the migration status to Migration Hub using the values passed to the required parameters ApplicationId and Status.

Note

In this example, the DryRun parameter is used and set to "true" in order to show the output of the DryRunOperation when the user has appropriate permissions to execute the command.

Sample Request


{
   "ApplicationId": "d-application-0039038d504694533",
   "Status": "IN_PROGRESS"
   "DryRun": true
}

Sample Response


An error occurred (DryRunOperation) when calling the NotifyApplicationState operation: Dry Run was a success!
$

See Also

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