recording_configurations

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

Overview

Name	recording_configurations
Type	Resource
Id	aws.ivs.recording_configurations

Fields

The following fields are returned by SELECT queries:

get_recording_configuration

Name	Datatype	Description
name	string	Recording-configuration name. The value does not need to be unique. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	Recording-configuration ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+</code>)
destination_configuration	object	A complex type that describes a location where recorded videos will be stored. Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.
recording_reconnect_window_seconds	integer	If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
rendition_configuration	object	Object that describes which renditions should be recorded for a stream.
state	string	Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream. (CREATING, CREATE_FAILED, ACTIVE)
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.
thumbnail_configuration	object	An object representing a configuration of thumbnails for recorded video.

list_recording_configurations

Name	Datatype	Description
name	string	Recording-configuration name. The value does not need to be unique. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	Recording-configuration ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+</code>)
destination_configuration	object	A complex type that describes a location where recorded videos will be stored. Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.
state	string	Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream. (CREATING, CREATE_FAILED, ACTIVE)
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_recording_configuration	select	region		Gets the recording configuration for the specified ARN.
list_recording_configurations	select	region		Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
create_recording_configuration	insert	region, destinationConfiguration		Creates a new recording configuration, used to enable recording to Amazon S3. Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.) Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
delete_recording_configuration	delete	region		Deletes the recording configuration for the specified ARN. If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.

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_recording_configuration

Gets the recording configuration for the specified ARN.

SELECT
name,
arn,
destination_configuration,
recording_reconnect_window_seconds,
rendition_configuration,
state,
tags,
thumbnail_configuration
FROM aws.ivs.recording_configurations
WHERE region = '{{ region }}' -- required
;

list_recording_configurations

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

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

INSERT examples

create_recording_configuration

Creates a new recording configuration, used to enable recording to Amazon S3. Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.) Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

INSERT INTO aws.ivs.recording_configurations (
name,
destinationConfiguration,
tags,
thumbnailConfiguration,
recordingReconnectWindowSeconds,
renditionConfiguration,
region
)
SELECT 
'{{ name }}',
'{{ destinationConfiguration }}' /* required */,
'{{ tags }}',
'{{ thumbnailConfiguration }}',
{{ recordingReconnectWindowSeconds }},
'{{ renditionConfiguration }}',
'{{ region }}'
RETURNING
recording_configuration
;

Manifest

# Description fields are for documentation purposes
- name: recording_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the recording_configurations resource.
  - name: name
    value: "{{ name }}"
  - name: destinationConfiguration
    description: |
      A complex type that describes a location where recorded videos will be stored. Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.
    value:
      s3:
        bucketName: "{{ bucketName }}"
  - name: tags
    value: "{{ tags }}"
  - name: thumbnailConfiguration
    description: |
      An object representing a configuration of thumbnails for recorded video.
    value:
      recordingMode: "{{ recordingMode }}"
      targetIntervalSeconds: {{ targetIntervalSeconds }}
      resolution: "{{ resolution }}"
      storage:
        - "{{ storage }}"
  - name: recordingReconnectWindowSeconds
    value: {{ recordingReconnectWindowSeconds }}
  - name: renditionConfiguration
    description: |
      Object that describes which renditions should be recorded for a stream.
    value:
      renditionSelection: "{{ renditionSelection }}"
      renditions:
        - "{{ renditions }}"

DELETE examples

delete_recording_configuration

Deletes the recording configuration for the specified ARN. If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.

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