CreateTags
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the Amazon Elastic Compute Cloud User Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- DryRun
-
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.Type: Boolean
Required: No
- ResourceId.N
-
The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
Type: Array of strings
Required: Yes
- Tag.N
-
The tags. The
value
parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.Type: Array of Tag objects
Required: Yes
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- return
-
Is
true
if the request succeeds, and an error otherwise.Type: Boolean
Errors
For information about the errors that are common to all actions, see Common client error codes.
Examples
Example
This example request adds (or overwrites) two tags for an AMI and an instance.
One of the tags is a key (webserver
), with no value (we set the
value to an empty string). The other tag consists of a key (stack
) and
value (Production
).
Sample Request
https://ec2.amazonaws.com/?Action=CreateTags
&ResourceId.1=ami-1a2b3c4d
&ResourceId.2=i-1234567890abcdef0
&Tag.1.Key=webserver
&Tag.1.Value=
&Tag.2.Key=stack
&Tag.2.Value=Production
&AUTHPARAMS
Sample Response
<CreateTagsResponse
xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
<return>true</return>
</CreateTagsResponse>
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: