Actions, resources, and condition keys for Amazon Interactive Video Service - Service Authorization Reference

# Actions, resources, and condition keys for Amazon Interactive Video Service

Amazon Interactive Video Service (service prefix: `ivs` ) 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.

###### Topics

- Actions defined by Amazon Interactive Video Service
- Resource types defined by Amazon Interactive Video Service
- Condition keys for Amazon Interactive Video Service

## Actions defined by Amazon Interactive Video Service

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
--- | --- | --- | --- | --- | ---
BatchGetChannel | Grants permission to get multiple channels simultaneously by channel ARN | Read | Channel* |  |
BatchGetStreamKey | Grants permission to get multiple stream keys simultaneously by stream key ARN | Read | Stream-Key* |  |
BatchStartViewerSessionRevocation | Grants permission to perform StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously | Write | Channel* |  |
CreateChannel | Grants permission to create a new channel and an associated stream key | Write | Channel* |  |
Stream-Key* |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
CreateEncoderConfiguration | Grants permission to create a new encoder configuration | Write | Encoder-Configuration* |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
CreateParticipantToken | Grants permission to create a participant token | Write | Stage* |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
CreatePlaybackRestrictionPolicy | Grants permission to create a playback restriction policy | Write | Playback-Restriction-Policy* |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
CreateRecordingConfiguration | Grants permission to create a a new recording configuration | Write | Recording-Configuration* |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
CreateStage | Grants permission to create a stage | Write | Stage* |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
CreateStorageConfiguration | Grants permission to create a new storage configuration | Write | Storage-Configuration* |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
CreateStreamKey | Grants permission to create a stream key | Write | Stream-Key* |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
DeleteChannel | Grants permission to delete a channel and channel's stream keys | Write | Channel* |  |
Stream-Key* |  |
DeleteEncoderConfiguration | Grants permission to delete an encoder configuration for the specified ARN | Write | Encoder-Configuration* |  |
DeletePlaybackKeyPair | Grants permission to delete the playback key pair for a specified ARN | Write | Playback-Key-Pair* |  |
DeletePlaybackRestrictionPolicy | Grants permission to delete the playback restriction policy for a specified ARN | Write | Playback-Restriction-Policy* |  |
DeleteRecordingConfiguration | Grants permission to delete a recording configuration for the specified ARN | Write | Recording-Configuration* |  |
DeleteStage | Grants permission to delete the stage for a specified ARN | Write | Stage* |  |
DeleteStorageConfiguration | Grants permission to delete an storage configuration for the specified ARN | Write | Storage-Configuration* |  |
DeleteStreamKey | Grants permission to delete the stream key for a specified ARN | Write | Stream-Key* |  |
DisconnectParticipant | Grants permission to disconnect a participant from for the specified stage ARN | Write | Stage* |  |
GetChannel | Grants permission to get the channel configuration for a specified channel ARN | Read | Channel* |  |
GetComposition | Grants permission to get the composition for the specified ARN | Read | Composition* |  |
GetEncoderConfiguration | Grants permission to get the encoder configuration for the specified ARN | Read | Encoder-Configuration* |  |
GetParticipant | Grants permission to get participant information for a specified stage ARN, session, and participant | Read | Stage* |  |
GetPlaybackKeyPair | Grants permission to get the playback keypair information for a specified ARN | Read | Playback-Key-Pair* |  |
GetPlaybackRestrictionPolicy | Grants permission to get the playback restriction policy for a specified ARN | Read | Playback-Restriction-Policy* |  |
GetRecordingConfiguration | Grants permission to get the recording configuration for the specified ARN | Read | Recording-Configuration* |  |
GetStage | Grants permission to get stage information for a specified ARN | Read | Stage* |  |
GetStageSession | Grants permission to get stage session information for a specified stage ARN and session | Read | Stage* |  |
GetStorageConfiguration | Grants permission to get the storage configuration for the specified ARN | Read | Storage-Configuration* |  |
GetStream | Grants permission to get information about the active (live) stream on a specified channel | Read | Channel* |  |
GetStreamKey | Grants permission to get stream-key information for a specified ARN | Read | Stream-Key* |  |
GetStreamSession | Grants permission to get information about the stream session on a specified channel | Read | Channel* |  |
ImportPlaybackKeyPair | Grants permission to import the public key | Write | Playback-Key-Pair* |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
ListChannels | Grants permission to get summary information about channels | List | Channel* |  |
ListCompositions | Grants permission to get summary information about compositions | List | Encoder-Configuration |  |
Stage |  |
ListEncoderConfigurations | Grants permission to get summary information about encoder configurations | List |  |  |
ListParticipantEvents | Grants permission to list participant events for a specified stage ARN, session, and participant | List | Stage* |  |
ListParticipants | Grants permission to list participants for a specified stage ARN and session | List | Stage* |  |
ListPlaybackKeyPairs | Grants permission to get summary information about playback key pairs | List | Playback-Key-Pair* |  |
ListPlaybackRestrictionPolicies | Grants permission to get summary information about playback restriction policies | List |  |  |
ListRecordingConfigurations | Grants permission to get summary information about recording configurations | List | Recording-Configuration* |  |
ListStageSessions | Grants permission to list stage sessions for a specified stage ARN | List | Stage* |  |
ListStages | Grants permission to get summary information about stages | List | Stage* |  |
ListStorageConfigurations | Grants permission to get summary information about storage configurations | List |  |  |
ListStreamKeys | Grants permission to get summary information about stream keys | List | Channel* |  |
Stream-Key* |  |
ListStreamSessions | Grants permission to get summary information about streams sessions on a specified channel | List | Channel* |  |
ListStreams | Grants permission to get summary information about live streams | List | Channel* |  |
ListTagsForResource | Grants permission to get information about the tags for a specified ARN | Read | Channel |  |
Composition |  |
Encoder-Configuration |  |
Playback-Key-Pair |  |
Playback-Restriction-Policy |  |
Recording-Configuration |  |
Stage |  |
Storage-Configuration |  |
Stream-Key |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
PutMetadata | Grants permission to insert metadata into an RTMP stream for a specified channel | Write | Channel* |  |
StartComposition | Grants permission to start a new composition | Write | Encoder-Configuration* |  |
Stage* |  |
Channel |  |
Storage-Configuration |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
StartViewerSessionRevocation | Grants permission to start the process of revoking the viewer session associated with a specified channel ARN and viewer ID | Write | Channel* |  |
StopComposition | Grants permission to stop the composition for the specified ARN | Write | Composition* |  |
StopStream | Grants permission to disconnect a streamer on a specified channel | Write | Channel* |  |
TagResource | Grants permission to add or update tags for a resource with a specified ARN | Tagging | Channel |  |
Composition |  |
Encoder-Configuration |  |
Playback-Key-Pair |  |
Playback-Restriction-Policy |  |
Recording-Configuration |  |
Stage |  |
Storage-Configuration |  |
Stream-Key |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
UntagResource | Grants permission to remove tags for a resource with a specified ARN | Tagging | Channel |  |
Composition |  |
Encoder-Configuration |  |
Playback-Key-Pair |  |
Playback-Restriction-Policy |  |
Recording-Configuration |  |
Stage |  |
Storage-Configuration |  |
Stream-Key |  |
| aws:TagKeys |
UpdateChannel | Grants permission to update a channel's configuration | Write | Channel* |  |
UpdatePlaybackRestrictionPolicy | Grants permission to update a playback restriction policy for a specified ARN | Write | Playback-Restriction-Policy* |  |
UpdateStage | Grants permission to update a stage's configuration | Write | Stage* |  |

## Resource types defined by Amazon Interactive Video Service

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
--- | --- | ---
Channel | `arn:$ { Partition}:ivs:$ { Region}:$ { Account}:channel/$ { ResourceId}` | aws:ResourceTag/${TagKey}
Stream-Key | `arn:$ { Partition}:ivs:$ { Region}:$ { Account}:stream-key/$ { ResourceId}` | aws:ResourceTag/${TagKey}
Playback-Key-Pair | `arn:$ { Partition}:ivs:$ { Region}:$ { Account}:playback-key/$ { ResourceId}` | aws:ResourceTag/${TagKey}
Playback-Restriction-Policy | `arn:$ { Partition}:ivs:$ { Region}:$ { Account}:playback-restriction-policy/$ { ResourceId}` | aws:ResourceTag/${TagKey}
Recording-Configuration | `arn:$ { Partition}:ivs:$ { Region}:$ { Account}:recording-configuration/$ { ResourceId}` | aws:ResourceTag/${TagKey}
Stage | `arn:$ { Partition}:ivs:$ { Region}:$ { Account}:stage/$ { ResourceId}` | aws:ResourceTag/${TagKey}
Composition | `arn:$ { Partition}:ivs:$ { Region}:$ { Account}:composition/$ { ResourceId}` | aws:ResourceTag/${TagKey}
Encoder-Configuration | `arn:$ { Partition}:ivs:$ { Region}:$ { Account}:encoder-configuration/$ { ResourceId}` | aws:ResourceTag/${TagKey}
Storage-Configuration | `arn:$ { Partition}:ivs:$ { Region}:$ { Account}:storage-configuration/$ { ResourceId}` | aws:ResourceTag/${TagKey}

## Condition keys for Amazon Interactive Video Service

Amazon Interactive Video Service 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 access by the tags associated with the request | String
aws:ResourceTag/${TagKey} | Filters access by the tags associated with the resource | String
aws:TagKeys | Filters access by the tag keys that are passed in the request | ArrayOfString

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.