playback_key_pairs

Creates, updates, deletes, gets or lists a playback_key_pairs resource.

Overview

Name	playback_key_pairs
Type	Resource
Id	aws.ivs.playback_key_pairs

Fields

The following fields are returned by SELECT queries:

get_playback_key_pair

Name	Datatype	Description
name	string	Playback-key-pair name. The value does not need to be unique. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	Key-pair ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+</code>)
fingerprint	string	Key-pair identifier.
tags	object	Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

list_playback_key_pairs

Name	Datatype	Description
name	string	Playback-key-pair name. The value does not need to be unique. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	Key-pair ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+</code>)
tags	object	Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_playback_key_pair	select	region		Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
list_playback_key_pairs	select	region		Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
delete_playback_key_pair	delete	region		Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_playback_key_pair

Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

SELECT
name,
arn,
fingerprint,
tags
FROM aws.ivs.playback_key_pairs
WHERE region = '{{ region }}' -- required
;

list_playback_key_pairs

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

SELECT
name,
arn,
tags
FROM aws.ivs.playback_key_pairs
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_playback_key_pair

Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

DELETE FROM aws.ivs.playback_key_pairs
WHERE region = '{{ region }}' --required
;