AssociateSourceResource
Associates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave.
Request Syntax
{
"DryRun": boolean
,
"MigrationTaskName": "string
",
"ProgressUpdateStream": "string
",
"SourceResource": {
"Description": "string
",
"Name": "string
",
"StatusDetail": "string
"
}
}
Request Parameters
The request accepts the following data in JSON format.
- DryRun
-
This is an optional parameter that you can use to test whether the call will succeed. Set this parameter to
true
to verify that you have the permissions that are required to make the call, and that you have specified the other parameters in the call correctly.Type: Boolean
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
- 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
- SourceResource
-
The source resource that you want to associate.
Type: SourceResource object
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 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
- UnauthorizedOperation
-
Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true".HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: