libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose
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.Firehose.ListTagsForDeliveryStream

Description

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

Synopsis

Creating a Request

data ListTagsForDeliveryStream Source #

See: newListTagsForDeliveryStream smart constructor.

Constructors

ListTagsForDeliveryStream' 

Fields

  • limit :: Maybe Natural

    The number of tags to return. If this number is less than the total number of tags associated with the delivery stream, HasMoreTags is set to true in the response. 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 you set this parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey.

  • deliveryStreamName :: Text

    The name of the delivery stream whose tags you want to list.

Instances

Instances details
Eq ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

Read ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

Show ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

Generic ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

Associated Types

type Rep ListTagsForDeliveryStream :: Type -> Type #

NFData ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

Hashable ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

ToJSON ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

AWSRequest ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

ToHeaders ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

ToPath ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

ToQuery ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

type Rep ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

type Rep ListTagsForDeliveryStream = D1 ('MetaData "ListTagsForDeliveryStream" "Amazonka.Firehose.ListTagsForDeliveryStream" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "ListTagsForDeliveryStream'" '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 "deliveryStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListTagsForDeliveryStream Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

newListTagsForDeliveryStream Source #

Create a value of ListTagsForDeliveryStream 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:ListTagsForDeliveryStream', listTagsForDeliveryStream_limit - The number of tags to return. If this number is less than the total number of tags associated with the delivery stream, HasMoreTags is set to true in the response. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

$sel:exclusiveStartTagKey:ListTagsForDeliveryStream', listTagsForDeliveryStream_exclusiveStartTagKey - The key to use as the starting point for the list of tags. If you set this parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey.

$sel:deliveryStreamName:ListTagsForDeliveryStream', listTagsForDeliveryStream_deliveryStreamName - The name of the delivery stream whose tags you want to list.

Request Lenses

listTagsForDeliveryStream_limit :: Lens' ListTagsForDeliveryStream (Maybe Natural) Source #

The number of tags to return. If this number is less than the total number of tags associated with the delivery stream, HasMoreTags is set to true in the response. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

listTagsForDeliveryStream_exclusiveStartTagKey :: Lens' ListTagsForDeliveryStream (Maybe Text) Source #

The key to use as the starting point for the list of tags. If you set this parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey.

listTagsForDeliveryStream_deliveryStreamName :: Lens' ListTagsForDeliveryStream Text Source #

The name of the delivery stream whose tags you want to list.

Destructuring the Response

data ListTagsForDeliveryStreamResponse Source #

See: newListTagsForDeliveryStreamResponse smart constructor.

Constructors

ListTagsForDeliveryStreamResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • tags :: [Tag]

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

  • hasMoreTags :: Bool

    If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again.

Instances

Instances details
Eq ListTagsForDeliveryStreamResponse Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

Read ListTagsForDeliveryStreamResponse Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

Show ListTagsForDeliveryStreamResponse Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

Generic ListTagsForDeliveryStreamResponse Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

Associated Types

type Rep ListTagsForDeliveryStreamResponse :: Type -> Type #

NFData ListTagsForDeliveryStreamResponse Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

type Rep ListTagsForDeliveryStreamResponse Source # 
Instance details

Defined in Amazonka.Firehose.ListTagsForDeliveryStream

type Rep ListTagsForDeliveryStreamResponse = D1 ('MetaData "ListTagsForDeliveryStreamResponse" "Amazonka.Firehose.ListTagsForDeliveryStream" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "ListTagsForDeliveryStreamResponse'" '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))))

newListTagsForDeliveryStreamResponse Source #

Create a value of ListTagsForDeliveryStreamResponse 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:ListTagsForDeliveryStreamResponse', listTagsForDeliveryStreamResponse_httpStatus - The response's http status code.

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

$sel:hasMoreTags:ListTagsForDeliveryStreamResponse', listTagsForDeliveryStreamResponse_hasMoreTags - If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again.

Response Lenses

listTagsForDeliveryStreamResponse_tags :: Lens' ListTagsForDeliveryStreamResponse [Tag] Source #

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

listTagsForDeliveryStreamResponse_hasMoreTags :: Lens' ListTagsForDeliveryStreamResponse Bool Source #

If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again.