stream_keys

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

Overview

Name	stream_keys
Type	Resource
Id	aws.ivs.stream_keys

Fields

The following fields are returned by SELECT queries:

batch_get_stream_key

Name	Datatype	Description
access_control_allow_origin	string	See Access-Control-Allow-Origin in the MDN Web Docs.
access_control_expose_headers	string	See Access-Control-Expose-Headers in the MDN Web Docs.
cache_control	string	See Cache-Control in the MDN Web Docs.
content_security_policy	string	See Content-Security-Policy in the MDN Web Docs.
errors	array
stream_keys	array
strict_transport_security	string	See Strict-Transport-Security in the MDN Web Docs.
x_content_type_options	string	See X-Content-Type-Options in the MDN Web Docs.
x_frame_options	string	See X-Frame-Options in the MDN Web Docs.

get_stream_key

Name	Datatype	Description
arn	string	Stream-key ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+</code>)
channel_arn	string	Channel ARN for the stream. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[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.
value	string	Stream-key value.

list_stream_keys

Name	Datatype	Description
arn	string	Stream-key ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+</code>)
channel_arn	string	Channel ARN for the stream. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[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
batch_get_stream_key	select	region		Performs GetStreamKey on multiple ARNs simultaneously.
get_stream_key	select	region		Gets stream-key information for a specified ARN.
list_stream_keys	select	region		Gets summary information about stream keys for the specified channel.
create_stream_key	insert	region, channelArn		Creates a stream key, used to initiate a stream, for the specified channel ARN. Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.
delete_stream_key	delete	region		Deletes the stream key for the specified ARN, so it can no longer be used to stream.

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

batch_get_stream_key

Performs GetStreamKey on multiple ARNs simultaneously.

SELECT
access_control_allow_origin,
access_control_expose_headers,
cache_control,
content_security_policy,
errors,
stream_keys,
strict_transport_security,
x_content_type_options,
x_frame_options
FROM aws.ivs.stream_keys
WHERE region = '{{ region }}' -- required
;

get_stream_key

Gets stream-key information for a specified ARN.

SELECT
arn,
channel_arn,
tags,
value
FROM aws.ivs.stream_keys
WHERE region = '{{ region }}' -- required
;

list_stream_keys

Gets summary information about stream keys for the specified channel.

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

INSERT examples

create_stream_key

Creates a stream key, used to initiate a stream, for the specified channel ARN. Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

INSERT INTO aws.ivs.stream_keys (
channelArn,
tags,
region
)
SELECT 
'{{ channelArn }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
stream_key
;

Manifest

# Description fields are for documentation purposes
- name: stream_keys
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the stream_keys resource.
  - name: channelArn
    value: "{{ channelArn }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_stream_key

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

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