multiplexes

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

Overview

Name	multiplexes
Type	Resource
Id	aws.medialive.multiplexes

Fields

The following fields are returned by SELECT queries:

describe_multiplex

Name	Datatype	Description
arn	string	Placeholder documentation for __string
availability_zones	array	Placeholder documentation for __listOf__string
destinations	array	A list of the multiplex output destinations.
id	string	Placeholder documentation for __string
multiplex_settings	object	Contains configuration for a Multiplex event
name	string	Placeholder documentation for __string
pipelines_running_count	integer	Placeholder documentation for __integer
program_count	integer	Placeholder documentation for __integer
state	string	The current state of the multiplex. (CREATING, CREATE_FAILED, IDLE, STARTING, RUNNING, RECOVERING, STOPPING, DELETING, DELETED)
tags	object	A collection of key-value pairs.

list_multiplexes

Name	Datatype	Description
arn	string	Placeholder documentation for __string
availability_zones	array	Placeholder documentation for __listOf__string
id	string	Placeholder documentation for __string
multiplex_settings	object	Configuration for a multiplex event.
name	string	Placeholder documentation for __string
pipelines_running_count	integer	The number of currently healthy pipelines.
program_count	integer	The number of programs in the multiplex.
state	string	The current state of the multiplex. (CREATING, CREATE_FAILED, IDLE, STARTING, RUNNING, RECOVERING, STOPPING, DELETING, DELETED)
tags	object	A collection of key-value pairs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_multiplex	select	multiplex_id, region		Gets details about a multiplex.
list_multiplexes	select	region	maxResults, nextToken	Retrieve a list of the existing multiplexes.
create_multiplex	insert	region, AvailabilityZones, MultiplexSettings, RequestId		Create a new multiplex.
update_multiplex	update	multiplex_id, region		Updates a multiplex.
delete_multiplex	delete	multiplex_id, region		Delete a multiplex. The multiplex must be idle.
start_multiplex	exec	multiplex_id, region		Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.
stop_multiplex	exec	multiplex_id, region		Stops a running multiplex. If the multiplex isn't running, this action has no effect.

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
multiplex_id	string	The ID of the multiplex.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of items to return.
nextToken	string	The token to retrieve the next page of results.

SELECT examples

describe_multiplex

Gets details about a multiplex.

SELECT
arn,
availability_zones,
destinations,
id,
multiplex_settings,
name,
pipelines_running_count,
program_count,
state,
tags
FROM aws.medialive.multiplexes
WHERE multiplex_id = '{{ multiplex_id }}' -- required
AND region = '{{ region }}' -- required
;

list_multiplexes

Retrieve a list of the existing multiplexes.

SELECT
arn,
availability_zones,
id,
multiplex_settings,
name,
pipelines_running_count,
program_count,
state,
tags
FROM aws.medialive.multiplexes
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_multiplex

Create a new multiplex.

INSERT INTO aws.medialive.multiplexes (
AvailabilityZones,
MultiplexSettings,
Name,
RequestId,
Tags,
region
)
SELECT 
'{{ AvailabilityZones }}' /* required */,
'{{ MultiplexSettings }}' /* required */,
'{{ Name }}',
'{{ RequestId }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
multiplex
;

Manifest

# Description fields are for documentation purposes
- name: multiplexes
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the multiplexes resource.
  - name: AvailabilityZones
    value:
      - "{{ AvailabilityZones }}"
    description: |
      Placeholder documentation for __listOf__string
  - name: MultiplexSettings
    description: |
      Contains configuration for a Multiplex event
    value:
      MaximumVideoBufferDelayMilliseconds: {{ MaximumVideoBufferDelayMilliseconds }}
      TransportStreamBitrate: {{ TransportStreamBitrate }}
      TransportStreamId: {{ TransportStreamId }}
      TransportStreamReservedBitrate: {{ TransportStreamReservedBitrate }}
  - name: Name
    value: "{{ Name }}"
    description: |
      Placeholder documentation for __string
  - name: RequestId
    value: "{{ RequestId }}"
    description: |
      Placeholder documentation for __string
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Placeholder documentation for Tags

UPDATE examples

update_multiplex

Updates a multiplex.

UPDATE aws.medialive.multiplexes
SET 
MultiplexSettings = '{{ MultiplexSettings }}',
Name = '{{ Name }}',
PacketIdentifiersMapping = '{{ PacketIdentifiersMapping }}'
WHERE 
multiplex_id = '{{ multiplex_id }}' --required
AND region = '{{ region }}' --required
RETURNING
multiplex;

DELETE examples

delete_multiplex

Delete a multiplex. The multiplex must be idle.

DELETE FROM aws.medialive.multiplexes
WHERE multiplex_id = '{{ multiplex_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

start_multiplex

Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.

EXEC aws.medialive.multiplexes.start_multiplex 
@multiplex_id='{{ multiplex_id }}' --required, 
@region='{{ region }}' --required
;

stop_multiplex

Stops a running multiplex. If the multiplex isn't running, this action has no effect.

EXEC aws.medialive.multiplexes.stop_multiplex 
@multiplex_id='{{ multiplex_id }}' --required, 
@region='{{ region }}' --required
;