stages

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

Overview

Name	stages
Type	Resource
Id	aws.ivs_realtime.stages

Fields

The following fields are returned by SELECT queries:

get_stage

Name	Datatype	Description
name	string	Stage name. (pattern: <code>[a-zA-Z0-9-_]*</code>)
active_session_id	string	ID of the active session within the stage. (pattern: <code>st-[a-zA-Z0-9]+</code>)
arn	string	Stage ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+</code>)
auto_participant_recording_configuration	object	Object specifying a configuration for individual participant recording.
endpoints	object	Summary information about various endpoints for a stage.
tags	object	Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

list_stages

Name	Datatype	Description
next_token	string	If there are more stages than maxResults, use nextToken in the request to get the next set. (pattern: <code>[a-zA-Z0-9+/=_-]*</code>)
stages	array	List of the matching stages (summary information only).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_stage	select	region		Gets information for the specified stage.
list_stages	select	region		Gets summary information about all stages in your account, in the AWS region where the API request is processed.
create_stage	insert	region		Creates a new stage (and optionally participant tokens).
update_stage	update	region, arn		Updates a stage’s configuration.
delete_stage	delete	region		Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.

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_stage

Gets information for the specified stage.

SELECT
name,
active_session_id,
arn,
auto_participant_recording_configuration,
endpoints,
tags
FROM aws.ivs_realtime.stages
WHERE region = '{{ region }}' -- required
;

list_stages

Gets summary information about all stages in your account, in the AWS region where the API request is processed.

SELECT
next_token,
stages
FROM aws.ivs_realtime.stages
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_stage

Creates a new stage (and optionally participant tokens).

INSERT INTO aws.ivs_realtime.stages (
name,
participantTokenConfigurations,
tags,
autoParticipantRecordingConfiguration,
region
)
SELECT 
'{{ name }}',
'{{ participantTokenConfigurations }}',
'{{ tags }}',
'{{ autoParticipantRecordingConfiguration }}',
'{{ region }}'
RETURNING
participant_tokens,
stage
;

Manifest

# Description fields are for documentation purposes
- name: stages
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the stages resource.
  - name: name
    value: "{{ name }}"
  - name: participantTokenConfigurations
    value:
      - duration: {{ duration }}
        userId: "{{ userId }}"
        attributes: "{{ attributes }}"
        capabilities: "{{ capabilities }}"
  - name: tags
    value: "{{ tags }}"
  - name: autoParticipantRecordingConfiguration
    description: |
      Object specifying a configuration for individual participant recording.
    value:
      storageConfigurationArn: "{{ storageConfigurationArn }}"
      mediaTypes:
        - "{{ mediaTypes }}"
      thumbnailConfiguration:
        targetIntervalSeconds: {{ targetIntervalSeconds }}
        storage:
          - "{{ storage }}"
        recordingMode: "{{ recordingMode }}"
      recordingReconnectWindowSeconds: {{ recordingReconnectWindowSeconds }}
      hlsConfiguration:
        targetSegmentDurationSeconds: {{ targetSegmentDurationSeconds }}
      recordParticipantReplicas: {{ recordParticipantReplicas }}

UPDATE examples

update_stage

Updates a stage’s configuration.

UPDATE aws.ivs_realtime.stages
SET 
arn = '{{ arn }}',
name = '{{ name }}',
autoParticipantRecordingConfiguration = '{{ autoParticipantRecordingConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required
RETURNING
stage;

DELETE examples

delete_stage

Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.

DELETE FROM aws.ivs_realtime.stages
WHERE region = '{{ region }}' --required
;