multiplex_programs

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

Overview

Name	multiplex_programs
Type	Resource
Id	aws.medialive.multiplex_programs

Fields

The following fields are returned by SELECT queries:

describe_multiplex_program

Name	Datatype	Description
channel_id	string	Placeholder documentation for __string
multiplex_program_settings	object	Multiplex Program settings configuration.
packet_identifiers_map	object	The packet identifier map for this multiplex program.
pipeline_details	array	Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.
program_name	string	Placeholder documentation for __string

list_multiplex_programs

Name	Datatype	Description
channel_id	string	Placeholder documentation for __string
program_name	string	Placeholder documentation for __string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_multiplex_program	select	multiplex_id, program_name, region		Get the details for a program in a multiplex.
list_multiplex_programs	select	multiplex_id, region	maxResults, nextToken	List the programs that currently exist for a specific multiplex.
create_multiplex_program	insert	multiplex_id, region, MultiplexProgramSettings, ProgramName, RequestId		Create a new program in the multiplex.
update_multiplex_program	update	multiplex_id, program_name, region		Update a program in a multiplex.
delete_multiplex_program	delete	multiplex_id, program_name, region		Delete a program from a multiplex.

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 that the program belongs to.
program_name	string	The multiplex program name.
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_program

Get the details for a program in a multiplex.

SELECT
channel_id,
multiplex_program_settings,
packet_identifiers_map,
pipeline_details,
program_name
FROM aws.medialive.multiplex_programs
WHERE multiplex_id = '{{ multiplex_id }}' -- required
AND program_name = '{{ program_name }}' -- required
AND region = '{{ region }}' -- required
;

list_multiplex_programs

List the programs that currently exist for a specific multiplex.

SELECT
channel_id,
program_name
FROM aws.medialive.multiplex_programs
WHERE multiplex_id = '{{ multiplex_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_multiplex_program

Create a new program in the multiplex.

INSERT INTO aws.medialive.multiplex_programs (
MultiplexProgramSettings,
ProgramName,
RequestId,
multiplex_id,
region
)
SELECT 
'{{ MultiplexProgramSettings }}' /* required */,
'{{ ProgramName }}' /* required */,
'{{ RequestId }}' /* required */,
'{{ multiplex_id }}',
'{{ region }}'
RETURNING
multiplex_program
;

Manifest

# Description fields are for documentation purposes
- name: multiplex_programs
props:
  - name: multiplex_id
    value: "{{ multiplex_id }}"
    description: Required parameter for the multiplex_programs resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the multiplex_programs resource.
  - name: MultiplexProgramSettings
    description: |
      Multiplex Program settings configuration.
    value:
      PreferredChannelPipeline: "{{ PreferredChannelPipeline }}"
      ProgramNumber: {{ ProgramNumber }}
      ServiceDescriptor:
        ProviderName: "{{ ProviderName }}"
        ServiceName: "{{ ServiceName }}"
      VideoSettings:
        ConstantBitrate: {{ ConstantBitrate }}
        StatmuxSettings:
          MaximumBitrate: {{ MaximumBitrate }}
          MinimumBitrate: {{ MinimumBitrate }}
          Priority: {{ Priority }}
  - name: ProgramName
    value: "{{ ProgramName }}"
    description: |
      Placeholder documentation for __string
  - name: RequestId
    value: "{{ RequestId }}"
    description: |
      Placeholder documentation for __string

UPDATE examples

update_multiplex_program

Update a program in a multiplex.

UPDATE aws.medialive.multiplex_programs
SET 
MultiplexProgramSettings = '{{ MultiplexProgramSettings }}'
WHERE 
multiplex_id = '{{ multiplex_id }}' --required
AND program_name = '{{ program_name }}' --required
AND region = '{{ region }}' --required
RETURNING
multiplex_program;

DELETE examples

delete_multiplex_program

Delete a program from a multiplex.

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