Actions, resources, and condition keys for Amazon Interactive Video Service
Amazon Interactive Video Service (service prefix: ivs) provides the following
service-specific operations, resources, actions, and condition 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.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon Interactive Video Service
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | SDK client | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|---|
|
BatchGetChannel |
ivs |
Read |
|||
|
BatchGetStreamKey |
ivs |
Read |
|||
|
BatchStartViewerSessionRevocation |
ivs |
Write |
|||
|
CreateAdConfiguration |
ivs |
Write |
|||
Tagging, Write |
|||||
|
CreateChannel |
ivs |
Write |
|||
Tagging, Write |
|||||
|
CreatePlaybackRestrictionPolicy |
ivs |
Write |
|||
Tagging, Write |
|||||
|
CreateRecordingConfiguration |
ivs |
Write |
|||
Tagging, Write |
|||||
|
CreateStreamKey |
ivs |
Write |
|||
Tagging, Write |
|||||
|
DeleteAdConfiguration |
ivs |
Write |
|||
|
DeleteChannel |
ivs |
Write |
|||
|
DeletePlaybackKeyPair |
ivs |
Write |
|||
|
DeletePlaybackRestrictionPolicy |
ivs |
Write |
|||
|
DeleteRecordingConfiguration |
ivs |
Write |
|||
|
DeleteStreamKey |
ivs |
Write |
|||
|
GetAdConfiguration |
ivs |
Read |
|||
|
GetChannel |
ivs |
Read |
|||
|
GetPlaybackKeyPair |
ivs |
Read |
|||
|
GetPlaybackRestrictionPolicy |
ivs |
Read |
|||
|
GetRecordingConfiguration |
ivs |
Read |
|||
|
GetStream |
ivs |
Read |
|||
|
GetStreamKey |
ivs |
Read |
|||
|
GetStreamSession |
ivs |
Read |
|||
|
ImportPlaybackKeyPair |
ivs |
Write |
|||
Tagging, Write |
|||||
|
InsertAdBreak |
ivs |
Write |
|||
|
ListAdConfigurations |
ivs |
List |
|||
|
ListChannels |
ivs |
List |
|||
|
ListPlaybackKeyPairs |
ivs |
List |
|||
|
ListPlaybackRestrictionPolicies |
ivs |
List |
|||
|
ListRecordingConfigurations |
ivs |
List |
|||
|
ListStreamKeys |
ivs |
List |
|||
|
ListStreamSessions |
ivs |
List |
|||
|
ListStreams |
ivs |
List |
|||
|
ListTagsForResource |
ivs |
Read |
|||
|
PutMetadata |
ivs |
Write |
|||
|
StartViewerSessionRevocation |
ivs |
Write |
|||
|
StopStream |
ivs |
Write |
|||
|
TagResource |
ivs |
Tagging, Write |
|||
|
UntagResource |
ivs |
Tagging, Write |
|||
|
UpdateAdConfiguration |
ivs |
Write |
|||
|
UpdateChannel |
ivs |
Write |
|||
|
UpdatePlaybackRestrictionPolicy |
ivs |
Write |
|||
|
CreateEncoderConfiguration |
ivs-realtime |
Write |
|||
Tagging, Write |
|||||
|
CreateIngestConfiguration |
ivs-realtime |
Write |
|||
Tagging, Write |
|||||
|
CreateParticipantToken |
ivs-realtime |
Write |
|||
|
CreateStage |
ivs-realtime |
Write |
|||
Tagging, Write |
|||||
|
CreateStorageConfiguration |
ivs-realtime |
Write |
|||
Tagging, Write |
|||||
|
DeleteEncoderConfiguration |
ivs-realtime |
Write |
|||
|
DeleteIngestConfiguration |
ivs-realtime |
Write |
|||
|
DeletePublicKey |
ivs-realtime |
Write |
|||
|
DeleteStage |
ivs-realtime |
Write |
|||
|
DeleteStorageConfiguration |
ivs-realtime |
Write |
|||
|
DisconnectParticipant |
ivs-realtime |
Write |
|||
|
GetComposition |
ivs-realtime |
Read |
|||
|
GetEncoderConfiguration |
ivs-realtime |
Read |
|||
|
GetIngestConfiguration |
ivs-realtime |
Read |
|||
|
GetParticipant |
ivs-realtime |
Read |
|||
|
GetPublicKey |
ivs-realtime |
Read |
|||
|
GetStage |
ivs-realtime |
Read |
|||
|
GetStageSession |
ivs-realtime |
Read |
|||
|
GetStorageConfiguration |
ivs-realtime |
Read |
|||
|
ImportPublicKey |
ivs-realtime |
Write |
|||
Tagging, Write |
|||||
|
ListCompositions |
ivs-realtime |
List |
|||
|
ListEncoderConfigurations |
ivs-realtime |
List |
|||
|
ListIngestConfigurations |
ivs-realtime |
List |
|||
|
ListParticipantEvents |
ivs-realtime |
List |
|||
|
ListParticipantReplicas |
ivs-realtime |
List |
|||
|
ListParticipants |
ivs-realtime |
List |
|||
|
ListPublicKeys |
ivs-realtime |
List |
|||
|
ListStageSessions |
ivs-realtime |
List |
|||
|
ListStages |
ivs-realtime |
List |
|||
|
ListStorageConfigurations |
ivs-realtime |
List |
|||
|
ListTagsForResource |
ivs-realtime |
Read |
|||
|
StartComposition |
ivs-realtime |
Write |
|||
Tagging, Write |
|||||
|
StartParticipantReplication |
ivs-realtime |
Write |
|||
|
StopComposition |
ivs-realtime |
Write |
|||
|
StopParticipantReplication |
ivs-realtime |
Write |
|||
|
TagResource |
ivs-realtime |
Tagging, Write |
|||
|
UntagResource |
ivs-realtime |
Tagging, Write |
|||
|
UpdateIngestConfiguration |
ivs-realtime |
Write |
|||
|
UpdateStage |
ivs-realtime |
Write |
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.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to get multiple channels simultaneously by channel ARN |
Read |
|||
Grants permission to get multiple stream keys simultaneously by stream key ARN |
Read |
|||
Grants permission to perform StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously |
Write |
|||
Grants permission to create a new ad configuration |
Write |
|||
Grants permission to create a new channel and an associated stream key |
Write |
|||
Grants permission to create a new encoder configuration |
Write |
|||
Grants permission to create a new ingest configuration |
Write |
|||
Grants permission to create a participant token |
Write |
|||
Grants permission to create a playback restriction policy |
Write |
|||
Grants permission to create a a new recording configuration |
Write |
|||
Grants permission to create a stage |
Write |
|||
Grants permission to create a new storage configuration |
Write |
|||
Grants permission to create a stream key |
Write |
|||
Grants permission to delete an ad configuration for the specified ARN |
Write |
|||
Grants permission to delete a channel and channel's stream keys |
Write |
|||
Grants permission to delete an encoder configuration for the specified ARN |
Write |
|||
Grants permission to delete an ingest configuration for the specified ARN |
Write |
|||
Grants permission to delete the playback key pair for a specified ARN |
Write |
|||
Grants permission to delete the playback restriction policy for a specified ARN |
Write |
|||
Grants permission to delete the public key for the specified ARN |
Write |
|||
Grants permission to delete a recording configuration for the specified ARN |
Write |
|||
Grants permission to delete the stage for a specified ARN |
Write |
|||
Grants permission to delete an storage configuration for the specified ARN |
Write |
|||
Grants permission to delete the stream key for a specified ARN |
Write |
|||
Grants permission to disconnect a participant from for the specified stage ARN |
Write |
|||
Grants permission to get the ad configuration for the specified ARN |
Read |
|||
Grants permission to get the channel configuration for a specified channel ARN |
Read |
|||
Grants permission to get the composition for the specified ARN |
Read |
|||
Grants permission to get the encoder configuration for the specified ARN |
Read |
|||
Grants permission to get the ingest configuration for the specified ARN |
Read |
|||
Grants permission to get participant information for a specified stage ARN, session, and participant |
Read |
|||
Grants permission to get the playback keypair information for a specified ARN |
Read |
|||
Grants permission to get the playback restriction policy for a specified ARN |
Read |
|||
Grants permission to get the public key for the specified ARN |
Read |
|||
Grants permission to get the recording configuration for the specified ARN |
Read |
|||
Grants permission to get stage information for a specified ARN |
Read |
|||
Grants permission to get stage session information for a specified stage ARN and session |
Read |
|||
Grants permission to get the storage configuration for the specified ARN |
Read |
|||
Grants permission to get information about the active (live) stream on a specified channel |
Read |
|||
Grants permission to get stream-key information for a specified ARN |
Read |
|||
Grants permission to get information about the stream session on a specified channel |
Read |
|||
Grants permission to import the public key |
Write |
|||
Grants permission to import a public key |
Write |
|||
Grants permission to request an ad insertion on a channel using an associated ad configuration |
Write |
|||
Grants permission to get summary information about ad configurations |
List |
|||
Grants permission to get summary information about channels |
List |
|||
Grants permission to get summary information about compositions |
List |
|||
Grants permission to get summary information about encoder configurations |
List |
|||
Grants permission to get summary information about ingest configurations |
List |
|||
Grants permission to list participant events for a specified stage ARN, session, and participant |
List |
|||
Grants permission to get summary information about participant replicas |
List |
|||
Grants permission to list participants for a specified stage ARN and session |
List |
|||
Grants permission to get summary information about playback key pairs |
List |
|||
Grants permission to get summary information about playback restriction policies |
List |
|||
Grants permission to get summary information about public keys |
List |
|||
Grants permission to get summary information about recording configurations |
List |
|||
Grants permission to list stage sessions for a specified stage ARN |
List |
|||
Grants permission to get summary information about stages |
List |
|||
Grants permission to get summary information about storage configurations |
List |
|||
Grants permission to get summary information about stream keys |
List |
|||
Grants permission to get summary information about streams sessions on a specified channel |
List |
|||
Grants permission to get summary information about live streams |
List |
|||
Grants permission to get information about the tags for a specified ARN |
Read |
|||
Grants permission to insert metadata into an RTMP stream for a specified channel |
Write |
|||
Grants permission to start a new composition |
Write |
|||
Grants permission to start a new participant replication |
Write |
|||
Grants permission to start the process of revoking the viewer session associated with a specified channel ARN and viewer ID |
Write |
|||
Grants permission to stop the composition for the specified ARN |
Write |
|||
Grants permission to stop the participant replication for the specified ARN |
Write |
|||
Grants permission to disconnect a streamer on a specified channel |
Write |
|||
Grants permission to add or update tags for a resource with a specified ARN |
Tagging, Write |
|||
Grants permission to remove tags for a resource with a specified ARN |
Tagging, Write |
|||
Grants permission to update an ad configuration |
Write |
|||
Grants permission to update a channel's configuration |
Write |
|||
Grants permission to update ingest configuration for a specified ARN |
Write |
|||
Grants permission to update a playback restriction policy for a specified ARN |
Write |
|||
Grants permission to update a stage's configuration |
Write |
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.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:ivs:${Region}:${Account}:ad-configuration/${ResourceId} |
||
arn:${Partition}:ivs:${Region}:${Account}:channel/${ResourceId} |
||
arn:${Partition}:ivs:${Region}:${Account}:composition/${ResourceId} |
||
arn:${Partition}:ivs:${Region}:${Account}:encoder-configuration/${ResourceId} |
||
arn:${Partition}:ivs:${Region}:${Account}:ingest-configuration/${ResourceId} |
||
arn:${Partition}:ivs:${Region}:${Account}:playback-key/${ResourceId} |
||
arn:${Partition}:ivs:${Region}:${Account}:playback-restriction-policy/${ResourceId} |
||
arn:${Partition}:ivs:${Region}:${Account}:public-key/${ResourceId} |
||
arn:${Partition}:ivs:${Region}:${Account}:recording-configuration/${ResourceId} |
||
arn:${Partition}:ivs:${Region}:${Account}:stage/${ResourceId} |
||
arn:${Partition}:ivs:${Region}:${Account}:storage-configuration/${ResourceId} |
||
arn:${Partition}:ivs:${Region}:${Account}:stream-key/${ResourceId} |
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.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the tags associated with the request |
String |
|
Filters access by the tags associated with the resource |
String |
|
Filters access by the tag keys that are passed in the request |
ArrayOfString |