Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IVS.PutMetadata

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

Synopsis

data PutMetadata = PutMetadata' {
- channelArn :: Text
- metadata :: Sensitive Text
}
newPutMetadata :: Text -> Text -> PutMetadata
putMetadata_channelArn :: Lens' PutMetadata Text
putMetadata_metadata :: Lens' PutMetadata Text
data PutMetadataResponse = PutMetadataResponse' {
}
newPutMetadataResponse :: PutMetadataResponse

Creating a Request

data PutMetadata Source #

See: newPutMetadata smart constructor.

Constructors

PutMetadata'
Fields channelArn :: Text ARN of the channel into which metadata is inserted. This channel must have an active stream. metadata :: Sensitive Text Metadata to insert into the stream. Maximum: 1 KB per request.

Instances

Instances details

ToJSON PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods toJSON :: PutMetadata -> Value # toEncoding :: PutMetadata -> Encoding # toJSONList :: [PutMetadata] -> Value # toEncodingList :: [PutMetadata] -> Encoding #
ToHeaders PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods toHeaders :: PutMetadata -> [Header] #
ToPath PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods toPath :: PutMetadata -> ByteString #
ToQuery PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods toQuery :: PutMetadata -> QueryString #
AWSRequest PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata Associated Types type AWSResponse PutMetadata # Methods request :: (Service -> Service) -> PutMetadata -> Request PutMetadata # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutMetadata -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutMetadata))) #
Generic PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata Associated Types type Rep PutMetadata :: Type -> Type # Methods from :: PutMetadata -> Rep PutMetadata x # to :: Rep PutMetadata x -> PutMetadata #
Show PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods showsPrec :: Int -> PutMetadata -> ShowS # show :: PutMetadata -> String # showList :: [PutMetadata] -> ShowS #
NFData PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods rnf :: PutMetadata -> () #
Eq PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods (==) :: PutMetadata -> PutMetadata -> Bool # (/=) :: PutMetadata -> PutMetadata -> Bool #
Hashable PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods hashWithSalt :: Int -> PutMetadata -> Int # hash :: PutMetadata -> Int #
type AWSResponse PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata type AWSResponse PutMetadata = PutMetadataResponse
type Rep PutMetadata Source #
Instance details Defined in Amazonka.IVS.PutMetadata type Rep PutMetadata = D1 ('MetaData "PutMetadata" "Amazonka.IVS.PutMetadata" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "PutMetadata'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))

newPutMetadata Source #

Arguments

:: Text	`PutMetadata`
-> Text	`$sel:metadata:PutMetadata'`
-> PutMetadata

Create a value of PutMetadata 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:

PutMetadata, putMetadata_channelArn - ARN of the channel into which metadata is inserted. This channel must have an active stream.

$sel:metadata:PutMetadata', putMetadata_metadata - Metadata to insert into the stream. Maximum: 1 KB per request.

Request Lenses

putMetadata_channelArn :: Lens' PutMetadata Text Source #

ARN of the channel into which metadata is inserted. This channel must have an active stream.

putMetadata_metadata :: Lens' PutMetadata Text Source #

Metadata to insert into the stream. Maximum: 1 KB per request.

Destructuring the Response

data PutMetadataResponse Source #

See: newPutMetadataResponse smart constructor.

Constructors

PutMetadataResponse'

Instances

Instances details

Generic PutMetadataResponse Source #
Instance details Defined in Amazonka.IVS.PutMetadata Associated Types type Rep PutMetadataResponse :: Type -> Type # Methods from :: PutMetadataResponse -> Rep PutMetadataResponse x # to :: Rep PutMetadataResponse x -> PutMetadataResponse #
Read PutMetadataResponse Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods readsPrec :: Int -> ReadS PutMetadataResponse # readList :: ReadS [PutMetadataResponse] # readPrec :: ReadPrec PutMetadataResponse # readListPrec :: ReadPrec [PutMetadataResponse] #
Show PutMetadataResponse Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods showsPrec :: Int -> PutMetadataResponse -> ShowS # show :: PutMetadataResponse -> String # showList :: [PutMetadataResponse] -> ShowS #
NFData PutMetadataResponse Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods rnf :: PutMetadataResponse -> () #
Eq PutMetadataResponse Source #
Instance details Defined in Amazonka.IVS.PutMetadata Methods (==) :: PutMetadataResponse -> PutMetadataResponse -> Bool # (/=) :: PutMetadataResponse -> PutMetadataResponse -> Bool #
type Rep PutMetadataResponse Source #
Instance details Defined in Amazonka.IVS.PutMetadata type Rep PutMetadataResponse = D1 ('MetaData "PutMetadataResponse" "Amazonka.IVS.PutMetadata" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "PutMetadataResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutMetadataResponse :: PutMetadataResponse Source #

Create a value of PutMetadataResponse with all optional fields omitted.

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