amazonka-kinesis-video-2.0: Amazon Kinesis Video Streams SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.KinesisVideo.ListTagsForStream

Description

Returns a list of tags associated with the specified stream.

In the request, you must specify either the StreamName or the StreamARN.

Synopsis

Creating a Request

data ListTagsForStream Source #

See: newListTagsForStream smart constructor.

Constructors

ListTagsForStream' 

Fields

  • nextToken :: Maybe Text

    If you specify this parameter and the result of a ListTagsForStream call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.

  • streamARN :: Maybe Text

    The Amazon Resource Name (ARN) of the stream that you want to list tags for.

  • streamName :: Maybe Text

    The name of the stream that you want to list tags for.

Instances

Instances details
ToJSON ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

ToHeaders ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

ToPath ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

ToQuery ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

AWSRequest ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

Associated Types

type AWSResponse ListTagsForStream #

Generic ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

Associated Types

type Rep ListTagsForStream :: Type -> Type #

Read ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

Show ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

NFData ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

Methods

rnf :: ListTagsForStream -> () #

Eq ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

Hashable ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

type AWSResponse ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

type Rep ListTagsForStream Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

type Rep ListTagsForStream = D1 ('MetaData "ListTagsForStream" "Amazonka.KinesisVideo.ListTagsForStream" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "ListTagsForStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListTagsForStream :: ListTagsForStream 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:

ListTagsForStream, listTagsForStream_nextToken - If you specify this parameter and the result of a ListTagsForStream call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.

ListTagsForStream, listTagsForStream_streamARN - The Amazon Resource Name (ARN) of the stream that you want to list tags for.

ListTagsForStream, listTagsForStream_streamName - The name of the stream that you want to list tags for.

Request Lenses

listTagsForStream_nextToken :: Lens' ListTagsForStream (Maybe Text) Source #

If you specify this parameter and the result of a ListTagsForStream call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.

listTagsForStream_streamARN :: Lens' ListTagsForStream (Maybe Text) Source #

The Amazon Resource Name (ARN) of the stream that you want to list tags for.

listTagsForStream_streamName :: Lens' ListTagsForStream (Maybe Text) Source #

The name of the stream that you want to list tags for.

Destructuring the Response

data ListTagsForStreamResponse Source #

See: newListTagsForStreamResponse smart constructor.

Constructors

ListTagsForStreamResponse' 

Fields

  • nextToken :: Maybe Text

    If you specify this parameter and the result of a ListTags call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.

  • tags :: Maybe (HashMap Text Text)

    A map of tag keys and values associated with the specified stream.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListTagsForStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

Associated Types

type Rep ListTagsForStreamResponse :: Type -> Type #

Read ListTagsForStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

Show ListTagsForStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

NFData ListTagsForStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

Eq ListTagsForStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

type Rep ListTagsForStreamResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.ListTagsForStream

type Rep ListTagsForStreamResponse = D1 ('MetaData "ListTagsForStreamResponse" "Amazonka.KinesisVideo.ListTagsForStream" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "ListTagsForStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:

ListTagsForStream, listTagsForStreamResponse_nextToken - If you specify this parameter and the result of a ListTags call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.

$sel:tags:ListTagsForStreamResponse', listTagsForStreamResponse_tags - A map of tag keys and values associated with the specified stream.

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

Response Lenses

listTagsForStreamResponse_nextToken :: Lens' ListTagsForStreamResponse (Maybe Text) Source #

If you specify this parameter and the result of a ListTags call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.

listTagsForStreamResponse_tags :: Lens' ListTagsForStreamResponse (Maybe (HashMap Text Text)) Source #

A map of tag keys and values associated with the specified stream.