encoder_configurations

Creates, updates, deletes, gets or lists an encoder_configurations resource.

Overview

Name	encoder_configurations
Type	Resource
Id	aws.ivs_realtime.encoder_configurations

Fields

The following fields are returned by SELECT queries:

get_encoder_configuration

Name	Datatype	Description
name	string	Optional name to identify the resource. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	ARN of the EncoderConfiguration resource. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:encoder-configuration/[a-zA-Z0-9-]+</code>)
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.
video	object	Settings for video.

list_encoder_configurations

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_encoder_configuration	select	region		Gets information about the specified EncoderConfiguration resource.
list_encoder_configurations	select	region		Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
create_encoder_configuration	insert	region		Creates an EncoderConfiguration object.
delete_encoder_configuration	delete	region		Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

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_encoder_configuration

Gets information about the specified EncoderConfiguration resource.

SELECT
name,
arn,
tags,
video
FROM aws.ivs_realtime.encoder_configurations
WHERE region = '{{ region }}' -- required
;

list_encoder_configurations

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

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

INSERT examples

create_encoder_configuration

Creates an EncoderConfiguration object.

INSERT INTO aws.ivs_realtime.encoder_configurations (
name,
video,
tags,
region
)
SELECT 
'{{ name }}',
'{{ video }}',
'{{ tags }}',
'{{ region }}'
RETURNING
encoder_configuration
;

Manifest

# Description fields are for documentation purposes
- name: encoder_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the encoder_configurations resource.
  - name: name
    value: "{{ name }}"
  - name: video
    description: |
      Settings for video.
    value:
      width: {{ width }}
      height: {{ height }}
      framerate: {{ framerate }}
      bitrate: {{ bitrate }}
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_encoder_configuration

Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

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