Menu
Amazon Kinesis Streams Service API Reference
API Reference (API Version 2013-12-02)

AddTagsToStream

Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 50 tags. However, each call to AddTagsToStream can take only up to 10 tags. Therefore, if you want to add more than 10 tags to your stream, you must call this API more than once. You can call it multiple times, but you can't have more than 50 tags on a stream at any given time.

If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.

Request Syntax

{
   "StreamName": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Request Parameters

The request accepts the following data in JSON format.

StreamName

The name of the stream.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

Tags

The set of key-value pairs to use to create the tags.

Type: String to string map

Length Constraints: Minimum length of 0. Maximum length of 256.

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.

InvalidArgumentException

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

HTTP Status Code: 400

LimitExceededException

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

HTTP Status Code: 400

ResourceInUseException

The resource is not available for this operation. For successful operation, the resource needs to be in the ACTIVE state.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource could not be found. The stream might not be specified correctly.

HTTP Status Code: 400

Example

To add tags to a stream

The following JSON example adds two tags to the specified stream.

Sample Request

Copy
POST / HTTP/1.1 Host: kinesis.<region>.<domain> Content-Length: <PayloadSizeBytes> User-Agent: <UserAgentString> Content-Type: application/x-amz-json-1.1 Authorization: <AuthParams> Connection: Keep-Alive X-Amz-Date: <Date> X-Amz-Target: Kinesis_20131202.AddTagsToStream { "StreamName": "exampleStreamName", "Tags": { "Project" : "myProject", "Environment" : "Production" } }

Sample Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date>

See Also

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