amazonka-kinesis-1.6.1: Amazon Kinesis SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Kinesis.ListTagsForStream

Contents

Description

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

Synopsis

Creating a Request

listTagsForStream Source #

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

Represents the input for ListTagsForStream .

See: listTagsForStream smart constructor.

Instances
Eq ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

Data ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.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 Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

Show ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

Generic ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

Associated Types

type Rep ListTagsForStream :: Type -> Type #

Hashable ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

ToJSON ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

AWSRequest ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

Associated Types

type Rs ListTagsForStream :: Type #

ToHeaders ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

ToPath ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

ToQuery ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

NFData ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

Methods

rnf :: ListTagsForStream -> () #

type Rep ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

type Rep ListTagsForStream = D1 (MetaData "ListTagsForStream" "Network.AWS.Kinesis.ListTagsForStream" "amazonka-kinesis-1.6.1-DicNGWPqg566LpzNlyqosm" False) (C1 (MetaCons "ListTagsForStream'" PrefixI True) (S1 (MetaSel (Just "_ltfsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: (S1 (MetaSel (Just "_ltfsExclusiveStartTagKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ltfsStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs ListTagsForStream Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

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 .

Destructuring the Response

listTagsForStreamResponse Source #

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

Represents the output for ListTagsForStream .

See: listTagsForStreamResponse smart constructor.

Instances
Eq ListTagsForStreamResponse Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

Data ListTagsForStreamResponse Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

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 Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

Show ListTagsForStreamResponse Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

Generic ListTagsForStreamResponse Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

Associated Types

type Rep ListTagsForStreamResponse :: Type -> Type #

NFData ListTagsForStreamResponse Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

type Rep ListTagsForStreamResponse Source # 
Instance details

Defined in Network.AWS.Kinesis.ListTagsForStream

type Rep ListTagsForStreamResponse = D1 (MetaData "ListTagsForStreamResponse" "Network.AWS.Kinesis.ListTagsForStream" "amazonka-kinesis-1.6.1-DicNGWPqg566LpzNlyqosm" False) (C1 (MetaCons "ListTagsForStreamResponse'" PrefixI True) (S1 (MetaSel (Just "_ltfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: (S1 (MetaSel (Just "_ltfsrsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Tag]) :*: S1 (MetaSel (Just "_ltfsrsHasMoreTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))))

Response Lenses

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.