AddTagsToResource
Adds metadata tags to an Amazon DMS resource, including replication instance, endpoint,
subnet group, and migration task. These tags can also be used with cost allocation
reporting to track cost associated with DMS resources, or used in a Condition statement in
an IAM policy for DMS. For more information, see Tag
data type description.
Request Syntax
{
"ResourceArn": "string
",
"Tags": [
{
"Key": "string
",
"ResourceArn": "string
",
"Value": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ResourceArn
-
Identifies the Amazon DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).
For Amazon DMS, you can tag a replication instance, an endpoint, or a replication task.
Type: String
Required: Yes
- Tags
-
One or more tags to be assigned to the resource.
Type: Array of Tag objects
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidResourceStateFault
-
The resource is in a state that prevents it from being used for database migration.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of AddTagsToResource.
Sample Request
POST / HTTP/1.1
Host: dms.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AmazonDMSv20160101.AddTagsToResource
{
"ResourceArn":"arn:aws:dms:us-east-
1:123456789012:rep:PWEBBEUNOLU7VEB2OHTEH4I4GQ",
"Tags":[
{
"Key":"CostCenter",
"Value":"1234"
}
]
}
Sample Response
Empty
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: