Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.Kinesis.ListTagsForStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

listTagsForStream #

Arguments

:: Text	`ltfsStreamName`
-> 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:

ltfsLimit - 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 - 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 - The name of the stream.

data ListTagsForStream #

Represents the input for ListTagsForStream .

See: listTagsForStream smart constructor.

Instances

Eq ListTagsForStream #
Methods (==) :: ListTagsForStream -> ListTagsForStream -> Bool # (/=) :: ListTagsForStream -> ListTagsForStream -> Bool #
Data ListTagsForStream #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTagsForStream -> c ListTagsForStream # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTagsForStream # toConstr :: ListTagsForStream -> Constr # dataTypeOf :: ListTagsForStream -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ListTagsForStream) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTagsForStream) # gmapT :: (forall b. Data b => b -> b) -> ListTagsForStream -> ListTagsForStream # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTagsForStream -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTagsForStream -> r # gmapQ :: (forall d. Data d => d -> u) -> ListTagsForStream -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTagsForStream -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTagsForStream -> m ListTagsForStream # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTagsForStream -> m ListTagsForStream # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTagsForStream -> m ListTagsForStream #
Read ListTagsForStream #
Methods readsPrec :: Int -> ReadS ListTagsForStream # readList :: ReadS [ListTagsForStream] # readPrec :: ReadPrec ListTagsForStream # readListPrec :: ReadPrec [ListTagsForStream] #
Show ListTagsForStream #
Methods showsPrec :: Int -> ListTagsForStream -> ShowS # show :: ListTagsForStream -> String # showList :: [ListTagsForStream] -> ShowS #
Generic ListTagsForStream #
Associated Types type Rep ListTagsForStream :: * -> * # Methods from :: ListTagsForStream -> Rep ListTagsForStream x # to :: Rep ListTagsForStream x -> ListTagsForStream #
Hashable ListTagsForStream #
Methods hashWithSalt :: Int -> ListTagsForStream -> Int # hash :: ListTagsForStream -> Int #
ToJSON ListTagsForStream #
Methods toJSON :: ListTagsForStream -> Value # toEncoding :: ListTagsForStream -> Encoding # toJSONList :: [ListTagsForStream] -> Value # toEncodingList :: [ListTagsForStream] -> Encoding #
NFData ListTagsForStream #
Methods rnf :: ListTagsForStream -> () #
AWSRequest ListTagsForStream #
Associated Types type Rs ListTagsForStream :: * # Methods request :: ListTagsForStream -> Request ListTagsForStream # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListTagsForStream -> ClientResponse -> m (Response ListTagsForStream) #
ToHeaders ListTagsForStream #
Methods toHeaders :: ListTagsForStream -> [Header] #
ToPath ListTagsForStream #
Methods toPath :: ListTagsForStream -> ByteString #
ToQuery ListTagsForStream #
Methods toQuery :: ListTagsForStream -> QueryString #
type Rep ListTagsForStream #
type Rep ListTagsForStream = D1 * (MetaData "ListTagsForStream" "Network.AWS.Kinesis.ListTagsForStream" "amazonka-kinesis-1.6.0-AMlDcsmqKN4oWDRc0mjTF" False) (C1 * (MetaCons "ListTagsForStream'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_ltfsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) ((::) (S1 * (MetaSel (Just Symbol "_ltfsExclusiveStartTagKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ltfsStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))
type Rs ListTagsForStream #
type Rs ListTagsForStream = ListTagsForStreamResponse

Request Lenses

ltfsLimit :: Lens' ListTagsForStream (Maybe Natural) #

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) #

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 #

The name of the stream.

Destructuring the Response

listTagsForStreamResponse #

Arguments

:: Int	`ltfsrsResponseStatus`
-> Bool	`ltfsrsHasMoreTags`
-> 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:

ltfsrsResponseStatus - -- | The response status code.
ltfsrsTags - A list of tags associated with StreamName , starting with the first tag after ExclusiveStartTagKey and up to the specified Limit .
ltfsrsHasMoreTags - If set to true , more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.

data ListTagsForStreamResponse #

Represents the output for ListTagsForStream .

See: listTagsForStreamResponse smart constructor.

Instances

Eq ListTagsForStreamResponse #
Methods (==) :: ListTagsForStreamResponse -> ListTagsForStreamResponse -> Bool # (/=) :: ListTagsForStreamResponse -> ListTagsForStreamResponse -> Bool #
Data ListTagsForStreamResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTagsForStreamResponse -> c ListTagsForStreamResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTagsForStreamResponse # toConstr :: ListTagsForStreamResponse -> Constr # dataTypeOf :: ListTagsForStreamResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ListTagsForStreamResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTagsForStreamResponse) # gmapT :: (forall b. Data b => b -> b) -> ListTagsForStreamResponse -> ListTagsForStreamResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTagsForStreamResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTagsForStreamResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListTagsForStreamResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTagsForStreamResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTagsForStreamResponse -> m ListTagsForStreamResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTagsForStreamResponse -> m ListTagsForStreamResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTagsForStreamResponse -> m ListTagsForStreamResponse #
Read ListTagsForStreamResponse #
Methods readsPrec :: Int -> ReadS ListTagsForStreamResponse # readList :: ReadS [ListTagsForStreamResponse] # readPrec :: ReadPrec ListTagsForStreamResponse # readListPrec :: ReadPrec [ListTagsForStreamResponse] #
Show ListTagsForStreamResponse #
Methods showsPrec :: Int -> ListTagsForStreamResponse -> ShowS # show :: ListTagsForStreamResponse -> String # showList :: [ListTagsForStreamResponse] -> ShowS #
Generic ListTagsForStreamResponse #
Associated Types type Rep ListTagsForStreamResponse :: * -> * # Methods from :: ListTagsForStreamResponse -> Rep ListTagsForStreamResponse x # to :: Rep ListTagsForStreamResponse x -> ListTagsForStreamResponse #
NFData ListTagsForStreamResponse #
Methods rnf :: ListTagsForStreamResponse -> () #
type Rep ListTagsForStreamResponse #
type Rep ListTagsForStreamResponse = D1 * (MetaData "ListTagsForStreamResponse" "Network.AWS.Kinesis.ListTagsForStream" "amazonka-kinesis-1.6.0-AMlDcsmqKN4oWDRc0mjTF" False) (C1 * (MetaCons "ListTagsForStreamResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_ltfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) ((::) (S1 * (MetaSel (Just Symbol "_ltfsrsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Tag])) (S1 * (MetaSel (Just Symbol "_ltfsrsHasMoreTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Bool)))))

Response Lenses

ltfsrsResponseStatus :: Lens' ListTagsForStreamResponse Int #

- | The response status code.

ltfsrsTags :: Lens' ListTagsForStreamResponse [Tag] #

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

ltfsrsHasMoreTags :: Lens' ListTagsForStreamResponse Bool #

If set to true , more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.