POST

/tagStream

http://kinesisvideo.{region}.amazonaws.com/tagStream

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 Amazon Web Services 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 <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the Billing and Cost Management and Cost Management User Guide. You must provide either the <code>StreamName</code> or the <code>StreamARN</code>. This operation requires permission for the <code>KinesisVideo:TagStream</code> action. A Kinesis video stream can support up to 50 tags.

Access Token Required: API Key

Body Params

Tagsobjectrequired

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

StreamARNstring

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

StreamNamestring

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://kinesisvideo.{region}.amazonaws.com/tagStream' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}