Menu
AWS Migration Hub
User Guide

AssociateDiscoveredResource

Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.

Request Syntax

{
   "DiscoveredResource": { 
      "ConfigurationId": "string",
      "Description": "string"
   },
   "DryRun": boolean,
   "MigrationTaskName": "string",
   "ProgressUpdateStream": "string"
}

Request Parameters

The request accepts the following data in JSON format.

DiscoveredResource

Object representing a Resource.

Type: DiscoveredResource object

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

MigrationTaskName

The identifier given to the MigrationTask.

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

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

Associate a discovered resource

The following example associates an AWS Application Discovery Service (ADS) discovered resource specified by its configuration id and description to the migration task identified by the values passed to the required parameters of MigrationTaskName and ProgressUpdateStream in the request.

Sample Request


{
    "ProgressUpdateStream": "SMS", 
    "MigrationTaskName": "sms-12de3cf1a", 
    "DiscoveredResource": {
        "ConfigurationId": "d-server-0025db43a885966c8", 
        "Description": "Amazon Linux AMI release 2016.09"
    }
}

See Also

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