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.KinesisVideo.TagStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

Kinesis video streams support up to 50 tags.

Synopsis

data TagStream = TagStream' {
- streamARN :: Maybe Text
- streamName :: Maybe Text
- tags :: HashMap Text Text
}
newTagStream :: TagStream
tagStream_streamARN :: Lens' TagStream (Maybe Text)
tagStream_streamName :: Lens' TagStream (Maybe Text)
tagStream_tags :: Lens' TagStream (HashMap Text Text)
data TagStreamResponse = TagStreamResponse' {
- httpStatus :: Int
}
newTagStreamResponse :: Int -> TagStreamResponse
tagStreamResponse_httpStatus :: Lens' TagStreamResponse Int

Creating a Request

data TagStream Source #

See: newTagStream smart constructor.

Constructors

TagStream'
Fields streamARN :: Maybe Text The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to. streamName :: Maybe Text The name of the stream that you want to add the tag or tags to. tags :: HashMap Text Text A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Instances

Instances details

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

newTagStream :: TagStream Source #

Create a value of TagStream 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:streamARN:TagStream', tagStream_streamARN - The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.

$sel:streamName:TagStream', tagStream_streamName - The name of the stream that you want to add the tag or tags to.

$sel:tags:TagStream', tagStream_tags - A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Request Lenses

tagStream_streamARN :: Lens' TagStream (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.

tagStream_streamName :: Lens' TagStream (Maybe Text) Source #

The name of the stream that you want to add the tag or tags to.

tagStream_tags :: Lens' TagStream (HashMap Text Text) Source #

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Destructuring the Response

data TagStreamResponse Source #

See: newTagStreamResponse smart constructor.

Constructors

TagStreamResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newTagStreamResponse Source #

Arguments

:: Int	`$sel:httpStatus:TagStreamResponse'`
-> TagStreamResponse

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

Response Lenses

tagStreamResponse_httpStatus :: Lens' TagStreamResponse Int Source #

The response's http status code.