PutMetadata
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.
Request Syntax
POST /PutMetadata HTTP/1.1
Content-type: application/json
{
"channelArn": "string",
"metadata": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- channelArn
-
ARN of the channel into which metadata is inserted. This channel must have an active stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+Required: Yes
- metadata
-
Metadata to insert into the stream. Maximum: 1 KB per request.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
Response Syntax
HTTP/1.1 204
Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
- accessControlAllowOrigin
- accessControlExposeHeaders
- cacheControl
- contentSecurityPolicy
- exceptionMessage
-
User does not have sufficient access to perform this action.
- strictTransportSecurity
- xAmznErrorType
- xContentTypeOptions
- xFrameOptions
HTTP Status Code: 403
- ChannelNotBroadcasting
-
- accessControlAllowOrigin
- accessControlExposeHeaders
- cacheControl
- contentSecurityPolicy
- exceptionMessage
-
The stream is offline for the given channel ARN.
- strictTransportSecurity
- xAmznErrorType
- xContentTypeOptions
- xFrameOptions
HTTP Status Code: 404
- ResourceNotFoundException
-
- accessControlAllowOrigin
- accessControlExposeHeaders
- cacheControl
- contentSecurityPolicy
- exceptionMessage
-
Request references a resource which does not exist.
- strictTransportSecurity
- xAmznErrorType
- xContentTypeOptions
- xFrameOptions
HTTP Status Code: 404
- ThrottlingException
-
- accessControlAllowOrigin
- accessControlExposeHeaders
- cacheControl
- contentSecurityPolicy
- exceptionMessage
-
Request was denied due to request throttling.
- strictTransportSecurity
- xAmznErrorType
- xContentTypeOptions
- xFrameOptions
HTTP Status Code: 429
- ValidationException
-
- accessControlAllowOrigin
- accessControlExposeHeaders
- cacheControl
- contentSecurityPolicy
- exceptionMessage
-
The input fails to satisfy the constraints specified by an AWS service.
- strictTransportSecurity
- xAmznErrorType
- xContentTypeOptions
- xFrameOptions
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
