Amazon Kinesis Data Firehose API Reference
API Reference (API Version 2015-08-04)

ListTagsForDeliveryStream

Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.

Request Syntax

{ "DeliveryStreamName": "string", "ExclusiveStartTagKey": "string", "Limit": number }

Request Parameters

The request accepts the following data in JSON format.

DeliveryStreamName

The name of the delivery stream whose tags you want to list.

Type: String

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

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

Required: Yes

ExclusiveStartTagKey

The key to use as the starting point for the list of tags. If you set this parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey.

Type: String

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

Required: No

Limit

The number of tags to return. If this number is less than the total number of tags associated with the delivery stream, HasMoreTags is set to true in the response. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

Response Syntax

{ "HasMoreTags": boolean, "Tags": [ { "Key": "string", "Value": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

HasMoreTags

If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again.

Type: Boolean

Tags

A list of tags associated with DeliveryStreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidArgumentException

The specified input parameter has a value that is not valid.

HTTP Status Code: 400

LimitExceededException

You have already reached the limit for a requested resource.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 400

Example

To list the tags for a stream

The following JSON example lists the tags for the specified delivery stream.

Sample Request

POST / HTTP/1.1 Host: firehose.<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: Firehose_20150804.ListTagsForDeliveryStream { "DeliveryStreamName": "exampleDeliveryStreamName" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "HasMoreTags": "false", "Tags" : [ { "Key": "Project", "Value": "myProject" }, { "Key": "Environment", "Value": "Production" } ] }

See Also

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