| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Kinesis.ListTagsForStream
Description
Lists the tags for the specified Amazon Kinesis stream.
See: AWS API Reference for ListTagsForStream.
- listTagsForStream :: Text -> ListTagsForStream
- data ListTagsForStream
- ltfsLimit :: Lens' ListTagsForStream (Maybe Natural)
- ltfsExclusiveStartTagKey :: Lens' ListTagsForStream (Maybe Text)
- ltfsStreamName :: Lens' ListTagsForStream Text
- listTagsForStreamResponse :: Int -> Bool -> ListTagsForStreamResponse
- data ListTagsForStreamResponse
- ltfsrsStatus :: Lens' ListTagsForStreamResponse Int
- ltfsrsTags :: Lens' ListTagsForStreamResponse [Tag]
- ltfsrsHasMoreTags :: Lens' ListTagsForStreamResponse Bool
Creating a Request
Arguments
| :: Text | |
| -> ListTagsForStream |
Creates a value of ListTagsForStream with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListTagsForStream Source
Represents the input for ListTagsForStream.
See: listTagsForStream smart constructor.
Instances
Request Lenses
ltfsLimit :: Lens' ListTagsForStream (Maybe Natural) Source
The number of tags to return. If this number is less than the total
number of tags associated with the stream, HasMoreTags is set to
true. To list additional tags, set ExclusiveStartTagKey to the last
key in the response.
ltfsExclusiveStartTagKey :: Lens' ListTagsForStream (Maybe Text) Source
The key to use as the starting point for the list of tags. If this
parameter is set, ListTagsForStream gets all tags that occur after
ExclusiveStartTagKey.
ltfsStreamName :: Lens' ListTagsForStream Text Source
The name of the stream.
Destructuring the Response
listTagsForStreamResponse Source
Arguments
| :: Int | |
| -> Bool | |
| -> ListTagsForStreamResponse |
Creates a value of ListTagsForStreamResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListTagsForStreamResponse Source
Represents the output for ListTagsForStream.
See: listTagsForStreamResponse smart constructor.
Response Lenses
ltfsrsStatus :: Lens' ListTagsForStreamResponse Int Source
The response status code.
ltfsrsTags :: Lens' ListTagsForStreamResponse [Tag] Source
A list of tags associated with StreamName, starting with the first tag
after ExclusiveStartTagKey and up to the specified Limit.
ltfsrsHasMoreTags :: Lens' ListTagsForStreamResponse Bool Source
If set to true, more tags are available. To request additional tags,
set ExclusiveStartTagKey to the key of the last tag returned.