Copyright	(c) 2013-2021 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

Amazonka.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

data ListTagsForStream Source #

Represents the input for ListTagsForStream.

See: newListTagsForStream smart constructor.

Constructors

ListTagsForStream'

Fields

limit :: 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.
exclusiveStartTagKey :: 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.
streamName :: Text
The name of the stream.

Instances

Instances details

Eq ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods (==) :: ListTagsForStream -> ListTagsForStream -> Bool # (/=) :: ListTagsForStream -> ListTagsForStream -> Bool #
Read ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods readsPrec :: Int -> ReadS ListTagsForStream # readList :: ReadS [ListTagsForStream] # readPrec :: ReadPrec ListTagsForStream # readListPrec :: ReadPrec [ListTagsForStream] #
Show ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods showsPrec :: Int -> ListTagsForStream -> ShowS # show :: ListTagsForStream -> String # showList :: [ListTagsForStream] -> ShowS #
Generic ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Associated Types type Rep ListTagsForStream :: Type -> Type # Methods from :: ListTagsForStream -> Rep ListTagsForStream x # to :: Rep ListTagsForStream x -> ListTagsForStream #
NFData ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods rnf :: ListTagsForStream -> () #
Hashable ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods hashWithSalt :: Int -> ListTagsForStream -> Int # hash :: ListTagsForStream -> Int #
ToJSON ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods toJSON :: ListTagsForStream -> Value # toEncoding :: ListTagsForStream -> Encoding # toJSONList :: [ListTagsForStream] -> Value # toEncodingList :: [ListTagsForStream] -> Encoding #
AWSRequest ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Associated Types type AWSResponse ListTagsForStream # Methods request :: ListTagsForStream -> Request ListTagsForStream # response :: MonadResource m => Logger -> Service -> Proxy ListTagsForStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTagsForStream))) #
ToHeaders ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods toHeaders :: ListTagsForStream -> [Header] #
ToPath ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods toPath :: ListTagsForStream -> ByteString #
ToQuery ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods toQuery :: ListTagsForStream -> QueryString #
type Rep ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream type Rep ListTagsForStream = D1 ('MetaData "ListTagsForStream" "Amazonka.Kinesis.ListTagsForStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListTagsForStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "exclusiveStartTagKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListTagsForStream Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream type AWSResponse ListTagsForStream = ListTagsForStreamResponse

newListTagsForStream Source #

Arguments

:: Text	`$sel:streamName:ListTagsForStream'`
-> ListTagsForStream

Create a value of ListTagsForStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:ListTagsForStream', listTagsForStream_limit - 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.

$sel:exclusiveStartTagKey:ListTagsForStream', listTagsForStream_exclusiveStartTagKey - 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.

$sel:streamName:ListTagsForStream', listTagsForStream_streamName - The name of the stream.

Request Lenses

listTagsForStream_limit :: 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.

listTagsForStream_exclusiveStartTagKey :: 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.

listTagsForStream_streamName :: Lens' ListTagsForStream Text Source #

The name of the stream.

Destructuring the Response

data ListTagsForStreamResponse Source #

Represents the output for ListTagsForStream.

See: newListTagsForStreamResponse smart constructor.

Constructors

ListTagsForStreamResponse'
Fields httpStatus :: Int The response's http status code. tags :: [Tag] A list of tags associated with `StreamName`, starting with the first tag after `ExclusiveStartTagKey` and up to the specified `Limit`. hasMoreTags :: Bool If set to `true`, more tags are available. To request additional tags, set `ExclusiveStartTagKey` to the key of the last tag returned.

Instances

Instances details

Eq ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods (==) :: ListTagsForStreamResponse -> ListTagsForStreamResponse -> Bool # (/=) :: ListTagsForStreamResponse -> ListTagsForStreamResponse -> Bool #
Read ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods readsPrec :: Int -> ReadS ListTagsForStreamResponse # readList :: ReadS [ListTagsForStreamResponse] # readPrec :: ReadPrec ListTagsForStreamResponse # readListPrec :: ReadPrec [ListTagsForStreamResponse] #
Show ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods showsPrec :: Int -> ListTagsForStreamResponse -> ShowS # show :: ListTagsForStreamResponse -> String # showList :: [ListTagsForStreamResponse] -> ShowS #
Generic ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Associated Types type Rep ListTagsForStreamResponse :: Type -> Type # Methods from :: ListTagsForStreamResponse -> Rep ListTagsForStreamResponse x # to :: Rep ListTagsForStreamResponse x -> ListTagsForStreamResponse #
NFData ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream Methods rnf :: ListTagsForStreamResponse -> () #
type Rep ListTagsForStreamResponse Source #
Instance details Defined in Amazonka.Kinesis.ListTagsForStream type Rep ListTagsForStreamResponse = D1 ('MetaData "ListTagsForStreamResponse" "Amazonka.Kinesis.ListTagsForStream" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "ListTagsForStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag]) :: S1 ('MetaSel ('Just "hasMoreTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newListTagsForStreamResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListTagsForStreamResponse'`
-> Bool	`$sel:hasMoreTags:ListTagsForStreamResponse'`
-> ListTagsForStreamResponse

Create a value of ListTagsForStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:ListTagsForStreamResponse', listTagsForStreamResponse_httpStatus - The response's http status code.

$sel:tags:ListTagsForStreamResponse', listTagsForStreamResponse_tags - A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

$sel:hasMoreTags:ListTagsForStreamResponse', listTagsForStreamResponse_hasMoreTags - If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.

Response Lenses

listTagsForStreamResponse_httpStatus :: Lens' ListTagsForStreamResponse Int Source #

The response's http status code.

listTagsForStreamResponse_tags :: Lens' ListTagsForStreamResponse [Tag] Source #

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

listTagsForStreamResponse_hasMoreTags :: 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.