AWS API Changes

2020/03/09 - AWS Elemental MediaLive - 4 updated api methods

Changes AWS Elemental MediaLive now supports the ability to configure the Preferred Channel Pipeline for channels contributing to a Multiplex.

CreateMultiplexProgram (updated)

Link ¶
Changes (request, response)
Request

{'MultiplexProgramSettings': {'PreferredChannelPipeline': 'CURRENTLY_ACTIVE | '
                                                          'PIPELINE_0 | '
                                                          'PIPELINE_1'}}

Response

{'MultiplexProgram': {'MultiplexProgramSettings': {'PreferredChannelPipeline': 'CURRENTLY_ACTIVE '
                                                                               '| '
                                                                               'PIPELINE_0 '
                                                                               '| '
                                                                               'PIPELINE_1'}}}

Create a new program in the multiplex.

See also: AWS API Documentation

Request Syntax

client.create_multiplex_program(
    MultiplexId='string',
    MultiplexProgramSettings={
        'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
        'ProgramNumber': 123,
        'ServiceDescriptor': {
            'ProviderName': 'string',
            'ServiceName': 'string'
        },
        'VideoSettings': {
            'ConstantBitrate': 123,
            'StatmuxSettings': {
                'MaximumBitrate': 123,
                'MinimumBitrate': 123
            }
        }
    },
    ProgramName='string',
    RequestId='string'
)

type MultiplexId

string

param MultiplexId

[REQUIRED] ID of the multiplex where the program is to be created.

type MultiplexProgramSettings

dict

param MultiplexProgramSettings

[REQUIRED] The settings for this multiplex program.

PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
ProgramNumber (integer) -- [REQUIRED] Unique program number.
ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
- ProviderName (string) -- [REQUIRED] Name of the provider.
- ServiceName (string) -- [REQUIRED] Name of the service.
VideoSettings (dict) -- Program video settings configuration.
- ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
- StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
  - MaximumBitrate (integer) -- Maximum statmux bitrate.
  - MinimumBitrate (integer) -- Minimum statmux bitrate.

type ProgramName

string

param ProgramName

[REQUIRED] Name of multiplex program.

type RequestId

string

param RequestId

[REQUIRED] Unique request ID. This prevents retries from creating multiple resources. This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'MultiplexProgram': {
        'ChannelId': 'string',
        'MultiplexProgramSettings': {
            'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
            'ProgramNumber': 123,
            'ServiceDescriptor': {
                'ProviderName': 'string',
                'ServiceName': 'string'
            },
            'VideoSettings': {
                'ConstantBitrate': 123,
                'StatmuxSettings': {
                    'MaximumBitrate': 123,
                    'MinimumBitrate': 123
                }
            }
        },
        'PacketIdentifiersMap': {
            'AudioPids': [
                123,
            ],
            'DvbSubPids': [
                123,
            ],
            'DvbTeletextPid': 123,
            'EtvPlatformPid': 123,
            'EtvSignalPid': 123,
            'KlvDataPids': [
                123,
            ],
            'PcrPid': 123,
            'PmtPid': 123,
            'PrivateMetadataPid': 123,
            'Scte27Pids': [
                123,
            ],
            'Scte35Pid': 123,
            'TimedMetadataPid': 123,
            'VideoPid': 123
        },
        'ProgramName': 'string'
    }
}

Response Structure

(dict) -- Creation of the program is in progress.
- MultiplexProgram (dict) -- The newly created multiplex program.
  - ChannelId (string) -- The MediaLive channel associated with the program.
  - MultiplexProgramSettings (dict) -- The settings for this multiplex program.
    - PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
    - ProgramNumber (integer) -- Unique program number.
    - ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
      - ProviderName (string) -- Name of the provider.
      - ServiceName (string) -- Name of the service.
    - VideoSettings (dict) -- Program video settings configuration.
      - ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
      - StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
        
        MaximumBitrate (integer) -- Maximum statmux bitrate.
        
        MinimumBitrate (integer) -- Minimum statmux bitrate.
  - PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
    - AudioPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - DvbSubPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - DvbTeletextPid (integer) -- Placeholder documentation for __integer
    - EtvPlatformPid (integer) -- Placeholder documentation for __integer
    - EtvSignalPid (integer) -- Placeholder documentation for __integer
    - KlvDataPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - PcrPid (integer) -- Placeholder documentation for __integer
    - PmtPid (integer) -- Placeholder documentation for __integer
    - PrivateMetadataPid (integer) -- Placeholder documentation for __integer
    - Scte27Pids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - Scte35Pid (integer) -- Placeholder documentation for __integer
    - TimedMetadataPid (integer) -- Placeholder documentation for __integer
    - VideoPid (integer) -- Placeholder documentation for __integer
  - ProgramName (string) -- The name of the multiplex program.

DeleteMultiplexProgram (updated)

Link ¶
Changes (response)

{'MultiplexProgramSettings': {'PreferredChannelPipeline': 'CURRENTLY_ACTIVE | '
                                                          'PIPELINE_0 | '
                                                          'PIPELINE_1'}}

Delete a program from a multiplex.

See also: AWS API Documentation

Request Syntax

client.delete_multiplex_program(
    MultiplexId='string',
    ProgramName='string'
)

type MultiplexId

string

param MultiplexId

[REQUIRED] The ID of the multiplex that the program belongs to.

type ProgramName

string

param ProgramName

[REQUIRED] The multiplex program name.

rtype

dict

returns

Response Syntax

{
    'ChannelId': 'string',
    'MultiplexProgramSettings': {
        'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
        'ProgramNumber': 123,
        'ServiceDescriptor': {
            'ProviderName': 'string',
            'ServiceName': 'string'
        },
        'VideoSettings': {
            'ConstantBitrate': 123,
            'StatmuxSettings': {
                'MaximumBitrate': 123,
                'MinimumBitrate': 123
            }
        }
    },
    'PacketIdentifiersMap': {
        'AudioPids': [
            123,
        ],
        'DvbSubPids': [
            123,
        ],
        'DvbTeletextPid': 123,
        'EtvPlatformPid': 123,
        'EtvSignalPid': 123,
        'KlvDataPids': [
            123,
        ],
        'PcrPid': 123,
        'PmtPid': 123,
        'PrivateMetadataPid': 123,
        'Scte27Pids': [
            123,
        ],
        'Scte35Pid': 123,
        'TimedMetadataPid': 123,
        'VideoPid': 123
    },
    'ProgramName': 'string'
}

Response Structure

(dict) -- Deletion of the program is in progress.
- ChannelId (string) -- The MediaLive channel associated with the program.
- MultiplexProgramSettings (dict) -- The settings for this multiplex program.
  - PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
  - ProgramNumber (integer) -- Unique program number.
  - ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
    - ProviderName (string) -- Name of the provider.
    - ServiceName (string) -- Name of the service.
  - VideoSettings (dict) -- Program video settings configuration.
    - ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
    - StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
      - MaximumBitrate (integer) -- Maximum statmux bitrate.
      - MinimumBitrate (integer) -- Minimum statmux bitrate.
- PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
  - AudioPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - DvbSubPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - DvbTeletextPid (integer) -- Placeholder documentation for __integer
  - EtvPlatformPid (integer) -- Placeholder documentation for __integer
  - EtvSignalPid (integer) -- Placeholder documentation for __integer
  - KlvDataPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - PcrPid (integer) -- Placeholder documentation for __integer
  - PmtPid (integer) -- Placeholder documentation for __integer
  - PrivateMetadataPid (integer) -- Placeholder documentation for __integer
  - Scte27Pids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - Scte35Pid (integer) -- Placeholder documentation for __integer
  - TimedMetadataPid (integer) -- Placeholder documentation for __integer
  - VideoPid (integer) -- Placeholder documentation for __integer
- ProgramName (string) -- The name of the multiplex program.

DescribeMultiplexProgram (updated)

Link ¶
Changes (response)

{'MultiplexProgramSettings': {'PreferredChannelPipeline': 'CURRENTLY_ACTIVE | '
                                                          'PIPELINE_0 | '
                                                          'PIPELINE_1'}}

Get the details for a program in a multiplex.

See also: AWS API Documentation

Request Syntax

client.describe_multiplex_program(
    MultiplexId='string',
    ProgramName='string'
)

type MultiplexId

string

param MultiplexId

[REQUIRED] The ID of the multiplex that the program belongs to.

type ProgramName

string

param ProgramName

[REQUIRED] The name of the program.

rtype

dict

returns

Response Syntax

{
    'ChannelId': 'string',
    'MultiplexProgramSettings': {
        'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
        'ProgramNumber': 123,
        'ServiceDescriptor': {
            'ProviderName': 'string',
            'ServiceName': 'string'
        },
        'VideoSettings': {
            'ConstantBitrate': 123,
            'StatmuxSettings': {
                'MaximumBitrate': 123,
                'MinimumBitrate': 123
            }
        }
    },
    'PacketIdentifiersMap': {
        'AudioPids': [
            123,
        ],
        'DvbSubPids': [
            123,
        ],
        'DvbTeletextPid': 123,
        'EtvPlatformPid': 123,
        'EtvSignalPid': 123,
        'KlvDataPids': [
            123,
        ],
        'PcrPid': 123,
        'PmtPid': 123,
        'PrivateMetadataPid': 123,
        'Scte27Pids': [
            123,
        ],
        'Scte35Pid': 123,
        'TimedMetadataPid': 123,
        'VideoPid': 123
    },
    'ProgramName': 'string'
}

Response Structure

(dict) -- The details of one program.
- ChannelId (string) -- The MediaLive channel associated with the program.
- MultiplexProgramSettings (dict) -- The settings for this multiplex program.
  - PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
  - ProgramNumber (integer) -- Unique program number.
  - ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
    - ProviderName (string) -- Name of the provider.
    - ServiceName (string) -- Name of the service.
  - VideoSettings (dict) -- Program video settings configuration.
    - ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
    - StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
      - MaximumBitrate (integer) -- Maximum statmux bitrate.
      - MinimumBitrate (integer) -- Minimum statmux bitrate.
- PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
  - AudioPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - DvbSubPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - DvbTeletextPid (integer) -- Placeholder documentation for __integer
  - EtvPlatformPid (integer) -- Placeholder documentation for __integer
  - EtvSignalPid (integer) -- Placeholder documentation for __integer
  - KlvDataPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - PcrPid (integer) -- Placeholder documentation for __integer
  - PmtPid (integer) -- Placeholder documentation for __integer
  - PrivateMetadataPid (integer) -- Placeholder documentation for __integer
  - Scte27Pids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - Scte35Pid (integer) -- Placeholder documentation for __integer
  - TimedMetadataPid (integer) -- Placeholder documentation for __integer
  - VideoPid (integer) -- Placeholder documentation for __integer
- ProgramName (string) -- The name of the multiplex program.

UpdateMultiplexProgram (updated)

Link ¶
Changes (request, response)
Request

{'MultiplexProgramSettings': {'PreferredChannelPipeline': 'CURRENTLY_ACTIVE | '
                                                          'PIPELINE_0 | '
                                                          'PIPELINE_1'}}

Response

{'MultiplexProgram': {'MultiplexProgramSettings': {'PreferredChannelPipeline': 'CURRENTLY_ACTIVE '
                                                                               '| '
                                                                               'PIPELINE_0 '
                                                                               '| '
                                                                               'PIPELINE_1'}}}

Update a program in a multiplex.

See also: AWS API Documentation

Request Syntax

client.update_multiplex_program(
    MultiplexId='string',
    MultiplexProgramSettings={
        'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
        'ProgramNumber': 123,
        'ServiceDescriptor': {
            'ProviderName': 'string',
            'ServiceName': 'string'
        },
        'VideoSettings': {
            'ConstantBitrate': 123,
            'StatmuxSettings': {
                'MaximumBitrate': 123,
                'MinimumBitrate': 123
            }
        }
    },
    ProgramName='string'
)

type MultiplexId

string

param MultiplexId

[REQUIRED] The ID of the multiplex of the program to update.

type MultiplexProgramSettings

dict

param MultiplexProgramSettings

The new settings for a multiplex program.

PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
ProgramNumber (integer) -- [REQUIRED] Unique program number.
ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
- ProviderName (string) -- [REQUIRED] Name of the provider.
- ServiceName (string) -- [REQUIRED] Name of the service.
VideoSettings (dict) -- Program video settings configuration.
- ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
- StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
  - MaximumBitrate (integer) -- Maximum statmux bitrate.
  - MinimumBitrate (integer) -- Minimum statmux bitrate.

type ProgramName

string

param ProgramName

[REQUIRED] The name of the program to update.

rtype

dict

returns

Response Syntax

{
    'MultiplexProgram': {
        'ChannelId': 'string',
        'MultiplexProgramSettings': {
            'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
            'ProgramNumber': 123,
            'ServiceDescriptor': {
                'ProviderName': 'string',
                'ServiceName': 'string'
            },
            'VideoSettings': {
                'ConstantBitrate': 123,
                'StatmuxSettings': {
                    'MaximumBitrate': 123,
                    'MinimumBitrate': 123
                }
            }
        },
        'PacketIdentifiersMap': {
            'AudioPids': [
                123,
            ],
            'DvbSubPids': [
                123,
            ],
            'DvbTeletextPid': 123,
            'EtvPlatformPid': 123,
            'EtvSignalPid': 123,
            'KlvDataPids': [
                123,
            ],
            'PcrPid': 123,
            'PmtPid': 123,
            'PrivateMetadataPid': 123,
            'Scte27Pids': [
                123,
            ],
            'Scte35Pid': 123,
            'TimedMetadataPid': 123,
            'VideoPid': 123
        },
        'ProgramName': 'string'
    }
}

Response Structure

(dict) -- The update to the program has succeeded.
- MultiplexProgram (dict) -- The updated multiplex program.
  - ChannelId (string) -- The MediaLive channel associated with the program.
  - MultiplexProgramSettings (dict) -- The settings for this multiplex program.
    - PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
    - ProgramNumber (integer) -- Unique program number.
    - ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
      - ProviderName (string) -- Name of the provider.
      - ServiceName (string) -- Name of the service.
    - VideoSettings (dict) -- Program video settings configuration.
      - ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
      - StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
        
        MaximumBitrate (integer) -- Maximum statmux bitrate.
        
        MinimumBitrate (integer) -- Minimum statmux bitrate.
  - PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
    - AudioPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - DvbSubPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - DvbTeletextPid (integer) -- Placeholder documentation for __integer
    - EtvPlatformPid (integer) -- Placeholder documentation for __integer
    - EtvSignalPid (integer) -- Placeholder documentation for __integer
    - KlvDataPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - PcrPid (integer) -- Placeholder documentation for __integer
    - PmtPid (integer) -- Placeholder documentation for __integer
    - PrivateMetadataPid (integer) -- Placeholder documentation for __integer
    - Scte27Pids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - Scte35Pid (integer) -- Placeholder documentation for __integer
    - TimedMetadataPid (integer) -- Placeholder documentation for __integer
    - VideoPid (integer) -- Placeholder documentation for __integer
  - ProgramName (string) -- The name of the multiplex program.