Actions, resources, and condition keys for Amazon Kinesis Video Streams

Amazon Kinesis Video Streams (service prefix: kinesisvideo) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

• Learn how to configure this service.

• View a list of the API operations available for this service.

• Learn how to secure this service and its resources by using IAM permission policies.

Actions defined by Amazon Kinesis Video Streams

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions	Description	Access level	Resource types (*required)	Condition keys	Dependent actions
ConnectAsMaster	Grants permission to connect as a master to the signaling channel specified by the endpoint	Write	channel*
ConnectAsViewer	Grants permission to connect as a viewer to the signaling channel specified by the endpoint	Write	channel*
CreateSignalingChannel	Grants permission to create a signaling channel	Write	channel*
				aws:RequestTag/${TagKey} aws:TagKeys
CreateStream	Grants permission to create a Kinesis video stream	Write	stream*
				aws:RequestTag/${TagKey} aws:TagKeys
DeleteEdgeConfiguration	Grants permission to delete the edge configuration of your Kinesis Video Stream	Write	stream*
DeleteSignalingChannel	Grants permission to delete an existing signaling channel	Write	channel*
DeleteStream	Grants permission to delete an existing Kinesis video stream	Write	stream*
DescribeEdgeConfiguration	Grants permission to describe the edge configuration of your Kinesis Video Stream	Read	stream*
DescribeImageGenerationConfiguration	Grants permission to describe the image generation configuration of your Kinesis video stream	Read	stream*
DescribeMappedResourceConfiguration	Grants permission to describe the resource mapped to the Kinesis video stream	List	stream*
DescribeMediaStorageConfiguration	Grants permission to describe the media storage configuration of a signaling channel	Read	channel*
DescribeNotificationConfiguration	Grants permission to describe the notification configuration of your Kinesis video stream	Read	stream*
DescribeSignalingChannel	Grants permission to describe the specified signaling channel	List	channel*
DescribeStream	Grants permission to describe the specified Kinesis video stream	List	stream*
GetClip	Grants permission to get a media clip from a video stream	Read	stream*
GetDASHStreamingSessionURL	Grants permission to create a URL for MPEG-DASH video streaming	Read	stream*
GetDataEndpoint	Grants permission to get an endpoint for a specified stream for either reading or writing media data to Kinesis Video Streams	Read	stream*
GetHLSStreamingSessionURL	Grants permission to create a URL for HLS video streaming	Read	stream*
GetIceServerConfig	Grants permission to get the ICE server configuration	Read	channel*
GetImages	Grants permission to get generated images from your Kinesis video stream	Read	stream*
GetMedia	Grants permission to return media content of a Kinesis video stream	Read	stream*
GetMediaForFragmentList	Grants permission to read and return media data only from persisted storage	Read	stream*
GetSignalingChannelEndpoint	Grants permission to get endpoints for a specified combination of protocol and role for a signaling channel	Read	channel*
JoinStorageSession	Grants permission to join a storage session for a channel	Write	channel*
JoinStorageSessionAsViewer	Grants permission to join a storage session for a channel as viewer	Write	channel*
ListEdgeAgentConfigurations	Grants permission to list an edge agent configurations	List
ListFragments	Grants permission to list the fragments from archival storage based on the pagination token or selector type with range specified	List	stream*
ListSignalingChannels	Grants permission to list your signaling channels	List
ListStreams	Grants permission to list your Kinesis video streams	List
ListTagsForResource	Grants permission to fetch the tags associated with your resource	Read	channel
			stream
ListTagsForStream	Grants permission to fetch the tags associated with Kinesis video stream	Read	stream*
PutMedia	Grants permission to send media data to a Kinesis video stream	Write	stream*
SendAlexaOfferToMaster	Grants permission to send the Alexa SDP offer to the master	Write	channel*
StartEdgeConfigurationUpdate	Grants permission to start edge configuration update of your Kinesis Video Stream	Write	stream*
TagResource	Grants permission to attach set of tags to your resource	Tagging	channel
			stream
				aws:RequestTag/${TagKey} aws:TagKeys
TagStream	Grants permission to attach set of tags to your Kinesis video streams	Tagging	stream*
				aws:RequestTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to remove one or more tags from your resource	Tagging	channel
			stream
				aws:TagKeys
UntagStream	Grants permission to remove one or more tags from your Kinesis video streams	Tagging	stream*
				aws:TagKeys
UpdateDataRetention	Grants permission to update the data retention period of your Kinesis video stream	Write	stream*
UpdateImageGenerationConfiguration	Grants permission to update the image generation configuration of your Kinesis video stream	Write	stream*
UpdateMediaStorageConfiguration	Grants permission to create or update an mapping between a signaling channel and stream	Write	channel*
UpdateNotificationConfiguration	Grants permission to update the notification configuration of your Kinesis video stream	Write	stream*
UpdateSignalingChannel	Grants permission to update an existing signaling channel	Write	channel*
UpdateStream	Grants permission to update an existing Kinesis video stream	Write	stream*

Resource types defined by Amazon Kinesis Video Streams

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.

Resource types	ARN	Condition keys
stream	arn:${Partition}:kinesisvideo:${Region}:${Account}:stream/${StreamName}/${CreationTime}	aws:ResourceTag/${TagKey}
channel	arn:${Partition}:kinesisvideo:${Region}:${Account}:channel/${ChannelName}/${CreationTime}	aws:ResourceTag/${TagKey}

Condition keys for Amazon Kinesis Video Streams

Amazon Kinesis Video Streams defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys	Description	Type
aws:RequestTag/${TagKey}	Filters requests based on the allowed set of values for each of the tags	String
aws:ResourceTag/${TagKey}	Filters actions based on tag-value assoicated with the stream	String
aws:TagKeys	Filters requests based on the presence of mandatory tag keys in the request	ArrayOfString