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

Amazonka.Kinesis.ListTagsForStream

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

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

Read ListTagsForStream Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

Show ListTagsForStream Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

Generic ListTagsForStream Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

Associated Types

type Rep ListTagsForStream :: Type -> Type #

NFData ListTagsForStream Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

Methods

rnf :: ListTagsForStream -> () #

Hashable ListTagsForStream Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

ToJSON ListTagsForStream Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

AWSRequest ListTagsForStream Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

Associated Types

type AWSResponse ListTagsForStream #

ToHeaders ListTagsForStream Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

ToPath ListTagsForStream Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

ToQuery ListTagsForStream Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

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

newListTagsForStream Source #

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.

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

Read ListTagsForStreamResponse Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

Show ListTagsForStreamResponse Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

Generic ListTagsForStreamResponse Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

Associated Types

type Rep ListTagsForStreamResponse :: Type -> Type #

NFData ListTagsForStreamResponse Source # 
Instance details

Defined in Amazonka.Kinesis.ListTagsForStream

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 #

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