Menu
AWS CodeDeploy
API Reference (API Version 2014-10-06)

AddTagsToOnPremisesInstances

Adds tags to on-premises instances.

Request Syntax

Copy
{ "instanceNames": [ "string" ], "tags": [ { "Key": "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.

instanceNames

The names of the on-premises instances to which to add tags.

Type: Array of strings

Required: Yes

tags

The tag key-value pairs to add to the on-premises instances.

Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.

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.

InstanceLimitExceededException

The maximum number of allowed on-premises instances in a single call was exceeded.

HTTP Status Code: 400

InstanceNameRequiredException

An on-premises instance name was not specified.

HTTP Status Code: 400

InstanceNotRegisteredException

The specified on-premises instance is not registered.

HTTP Status Code: 400

InvalidTagException

The specified tag was specified in an invalid format.

HTTP Status Code: 400

TagLimitExceededException

The maximum allowed number of tags was exceeded.

HTTP Status Code: 400

TagRequiredException

A tag was not specified.

HTTP Status Code: 400

Example

Sample Request

Copy
POST / HTTP/1.1 Host: codedeploy.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 105 X-Amz-Target: CodeDeploy_20141006.AddTagsToOnPremisesInstances X-Amz-Date: 20160707T225742Z User-Agent: aws-cli/1.10.6 Python/2.7.9 Windows/7 botocore/1.3.28 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20160707/us-east-1/codedeploy/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "instanceNames": [ "grp-b-inst-2", "grp-b-inst-1" ], "tags": [ { "Key": "Name", "Value": "Cost-Center-456" } ] }

Sample Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: 4ccc9cf0-88c9-11e5-8ce3-2704437d0309 Content-Type: application/x-amz-json-1.1 Content-Length: 0

See Also

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