AWS Elemental MediaLive API Reference API Reference

AWS Elemental

MediaLive API Reference

API Reference

AWS Elemental MediaLive API Reference: API Reference

Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

Table of Contents

What Is the AWS Elemental MediaLive API? ... 1

Resources ... 2

Batch Delete ... 3

URI ... 3

HTTP methods ... 3

Schemas ... 3

Properties ... 5

See also ... 8

Batch Start ... 8

URI ... 8

HTTP methods ... 8

Schemas ... 9

Properties ... 11

See also ... 13

Batch Stop ... 14

URI ... 14

HTTP methods ... 14

Schemas ... 14

Properties ... 16

See also ... 19

Channels ... 19

URI ... 19

HTTP methods ... 19

Schemas ... 20

Properties ... 55

See also ... 205

Channels channelId ... 206

URI ... 206

HTTP methods ... 206

Schemas ... 208

Properties ... 254

See also ... 401

Channels channelId ChannelClass ... 402

URI ... 402

HTTP methods ... 402

Schemas ... 403

Properties ... 420

See also ... 567

Channels channelId Schedule ... 567

URI ... 567

HTTP methods ... 567

Schemas ... 569

Properties ... 578

See also ... 597

Channels channelId Start ... 598

URI ... 598

HTTP methods ... 598

Schemas ... 599

Properties ... 615

See also ... 761

Channels channelId Stop ... 761

URI ... 761

HTTP methods ... 761

Schemas ... 762

Properties ... 778

See also ... 923

ClaimDevice ... 924

URI ... 924

HTTP methods ... 924

Schemas ... 924

Properties ... 926

See also ... 927

InputDevices ... 928

URI ... 928

HTTP methods ... 928

Schemas ... 928

Properties ... 930

See also ... 937

InputDevices inputDeviceId ... 937

URI ... 937

HTTP methods ... 938

Schemas ... 939

Properties ... 941

See also ... 949

InputDevices inputDeviceId Accept ... 950

URI ... 950

HTTP methods ... 950

Schemas ... 951

Properties ... 952

See also ... 953

InputDevices inputDeviceId Cancel ... 954

URI ... 954

HTTP methods ... 954

Schemas ... 954

Properties ... 956

See also ... 957

InputDevices inputDeviceId Reject ... 957

URI ... 957

HTTP methods ... 958

Schemas ... 958

Properties ... 959

See also ... 961

InputDevices inputDeviceId ThumbnailData ... 961

URI ... 961

HTTP methods ... 961

Schemas ... 962

Properties ... 963

See also ... 964

InputDevices inputDeviceId Transfer ... 965

URI ... 965

HTTP methods ... 965

Schemas ... 965

Properties ... 967

See also ... 969

InputDeviceTransfers ... 969

URI ... 969

HTTP methods ... 969

Schemas ... 970

Properties ... 971

See also ... 973

Inputs ... 974

URI ... 974

HTTP methods ... 974

Schemas ... 975

Properties ... 978

See also ... 987

Inputs inputId ... 988

URI ... 988

HTTP methods ... 988

Schemas ... 989

Properties ... 993

See also ... 1001

Inputs inputId Partners ... 1002

URI ... 1002

HTTP methods ... 1002

Schemas ... 1003

Properties ... 1005

See also ... 1011

InputSecurityGroups ... 1011

URI ... 1011

HTTP methods ... 1011

Schemas ... 1012

Properties ... 1014

See also ... 1017

InputSecurityGroups inputSecurityGroupId ... 1018

URI ... 1018

HTTP methods ... 1018

Schemas ... 1020

Properties ... 1022

See also ... 1025

Multiplexes ... 1026

URI ... 1026

HTTP methods ... 1026

Schemas ... 1027

Properties ... 1030

See also ... 1037

Multiplexes multiplexId ... 1037

URI ... 1037

HTTP methods ... 1038

Schemas ... 1039

Properties ... 1042

See also ... 1047

Multiplexes multiplexId Programs ... 1048

URI ... 1048

HTTP methods ... 1048

Schemas ... 1049

Properties ... 1052

See also ... 1059

Multiplexes multiplexId Programs programName ... 1060

URI ... 1060

HTTP methods ... 1060

Schemas ... 1062

Properties ... 1065

See also ... 1072

Multiplexes multiplexId Start ... 1073

URI ... 1073

HTTP methods ... 1073

Schemas ... 1074

Properties ... 1075

See also ... 1079

Multiplexes multiplexId Stop ... 1080

URI ... 1080

HTTP methods ... 1080

Schemas ... 1081

Properties ... 1082

See also ... 1086

Offerings ... 1087

URI ... 1087

HTTP methods ... 1087

Schemas ... 1088

Properties ... 1089

See also ... 1094

Offerings offeringId ... 1095

URI ... 1095

HTTP methods ... 1095

Schemas ... 1095

Properties ... 1097

See also ... 1102

Offerings offeringId Purchase ... 1102

URI ... 1102

HTTP methods ... 1102

Schemas ... 1103

Properties ... 1105

See also ... 1112

Reservations ... 1113

URI ... 1113

HTTP methods ... 1113

Schemas ... 1114

Properties ... 1115

See also ... 1122

Reservations reservationId ... 1122

URI ... 1122

HTTP methods ... 1122

Schemas ... 1124

Properties ... 1126

See also ... 1133

Tags resource-arn ... 1134

URI ... 1134

HTTP methods ... 1134

Schemas ... 1136

Properties ... 1137

See also ... 1137

Document History ... 1139

AWS glossary ... 1143

What Is the AWS Elemental MediaLive API?

This is the AWS Elemental MediaLive REST API Reference. It provides information on the URL, request contents, and response contents of each AWS Elemental MediaLive REST operation.

We assume that your IAM user credentials have the permissions needed to use AWS Elemental MediaLive via the REST API. We also assume that you are familiar with the features and operations of AWS

Elemental MediaLive, as described in the user guide.

For general information on the service, see the AWS Elemental MediaLive User Guide.

Resources

The AWS Elemental MediaLive REST API includes the following resources.

Topics

• Batch Delete (p. 3)

• Batch Start (p. 8)

• Batch Stop (p. 14)

• Channels (p. 19)

• Channels channelId (p. 206)

• Channels channelId ChannelClass (p. 402)

• Channels channelId Schedule (p. 567)

• Channels channelId Start (p. 598)

• Channels channelId Stop (p. 761)

• ClaimDevice (p. 924)

• InputDevices (p. 928)

• InputDevices inputDeviceId (p. 937)

• InputDevices inputDeviceId Accept (p. 950)

• InputDevices inputDeviceId Cancel (p. 954)

• InputDevices inputDeviceId Reject (p. 957)

• InputDevices inputDeviceId ThumbnailData (p. 961)

• InputDevices inputDeviceId Transfer (p. 965)

• InputDeviceTransfers (p. 969)

• Inputs (p. 974)

• Inputs inputId (p. 988)

• Inputs inputId Partners (p. 1002)

• InputSecurityGroups (p. 1011)

• InputSecurityGroups inputSecurityGroupId (p. 1018)

• Multiplexes (p. 1026)

• Multiplexes multiplexId (p. 1037)

• Multiplexes multiplexId Programs (p. 1048)

• Multiplexes multiplexId Programs programName (p. 1060)

• Multiplexes multiplexId Start (p. 1073)

• Multiplexes multiplexId Stop (p. 1080)

• Offerings (p. 1087)

• Offerings offeringId (p. 1095)

• Offerings offeringId Purchase (p. 1102)

• Reservations (p. 1113)

• Reservations reservationId (p. 1122)

• Tags resource-arn (p. 1134)

Batch Delete

URI

/prod/batch/delete

HTTP methods

POST

Operation ID: BatchDelete

Responses

Status code Response model Description

200 BatchDeleteResultModel (p. 4)200 response

400 InvalidRequest (p. 4) 400 response

403 AccessDenied (p. 4) 403 response

404 ResourceNotFound (p. 4) 404 response

409 ResourceConflict (p. 4) 409 response

429 LimitExceeded (p. 4) 429 response

500 InternalServiceError (p. 4)500 response

502 BadGatewayException (p. 5)502 response

504 GatewayTimeoutException (p. 5)504 response

Schemas

Request bodies

POST schema

{ "channelIds": [ "string"

], "inputIds": [ "string"

],

"inputSecurityGroupIds": [ "string"

],

"multiplexIds": [ "string"

]}

Response bodies

BatchDeleteResultModel schema

{ "successful": [ {

"id": "string", "arn": "string", "state": "string"

}

], "failed": [ {

"id": "string", "arn": "string", "code": "string", "message": "string"

} ]}

InvalidRequest schema

{ "message": "string"

}

AccessDenied schema

{ "message": "string"

}

ResourceNotFound schema

{

"message": "string"

}

ResourceConflict schema

{

"message": "string"

}

LimitExceeded schema

{

"message": "string"

}

InternalServiceError schema

{

"message": "string"

}

BadGatewayException schema

{

"message": "string"

}

GatewayTimeoutException schema

{ "message": "string"

}

Properties

AccessDenied

message

BadGatewayException

message

BatchDelete

Batch delete resource request

channelIds

List of channel IDs

Type: Array of type string Required: False

inputIds

Type: Array of type string Required: False

inputSecurityGroupIds

Type: Array of type string Required: False

multiplexIds

Type: Array of type string Required: False

BatchDeleteResultModel

Batch delete resource results

successful

List of successful operations

Type: Array of type BatchSuccessfulResultModel (p. 7) Required: False

failed

List of failed operations

Type: Array of type BatchFailedResultModel (p. 6) Required: False

BatchFailedResultModel

Details from a failed operation

id

ID of the resource Type: string Required: False

arn

ARN of the resource Type: string Required: False

code

Error code for the failed operation Type: string

Required: False

message

Error message for the failed operation Type: string

Required: False

BatchSuccessfulResultModel

Details from a successful operation

id

ID of the resource Type: string Required: False

arn

ARN of the resource Type: string Required: False

state

Current state of the resource Type: string

Required: False

GatewayTimeoutException

message

InternalServiceError

message

InvalidRequest

message

LimitExceeded

message

ResourceConflict

message

ResourceNotFound

message

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

BatchDelete

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

Batch Start

URI

/prod/batch/start

HTTP methods

POST

Operation ID: BatchStart

Responses

Status code Response model Description

200 BatchStartResultModel (p. 9)200 response

400 InvalidRequest (p. 10) 400 response

403 AccessDenied (p. 10) 403 response

404 ResourceNotFound (p. 10) 404 response

409 ResourceConflict (p. 10) 409 response

429 LimitExceeded (p. 10) 429 response

500 InternalServiceError (p. 10)500 response

502 BadGatewayException (p. 10)502 response

504 GatewayTimeoutException (p. 10)504 response

Schemas

Request bodies

POST schema

{ "channelIds": [ "string"

],

"multiplexIds": [ "string"

] }

Response bodies

BatchStartResultModel schema

{ "successful": [ {

"id": "string", "arn": "string", "state": "string"

}

], "failed": [ {

"id": "string", "arn": "string", "code": "string", "message": "string"

} ]}

InvalidRequest schema

{ "message": "string"

}

AccessDenied schema

{

"message": "string"

}

ResourceNotFound schema

{ "message": "string"

}

ResourceConflict schema

{

"message": "string"

}

LimitExceeded schema

{

"message": "string"

}

InternalServiceError schema

{ "message": "string"

}

BadGatewayException schema

{

"message": "string"

}

GatewayTimeoutException schema

{ "message": "string"

}

Properties

AccessDenied

message

BadGatewayException

message

BatchFailedResultModel

Details from a failed operation

id

ID of the resource Type: string Required: False

arn

ARN of the resource Type: string Required: False

code

Error code for the failed operation Type: string

Required: False

message

Error message for the failed operation Type: string

Required: False

BatchStart

Batch start resource request

channelIds

Type: Array of type string Required: False

multiplexIds

Type: Array of type string Required: False

BatchStartResultModel

Batch start resource results

successful

List of successful operations

Type: Array of type BatchSuccessfulResultModel (p. 12) Required: False

failed

List of failed operations

Type: Array of type BatchFailedResultModel (p. 11) Required: False

BatchSuccessfulResultModel

Details from a successful operation

id

ID of the resource Type: string Required: False

arn

ARN of the resource Type: string Required: False

state

Current state of the resource Type: string

Required: False

GatewayTimeoutException

message

InternalServiceError

message

InvalidRequest

message

LimitExceeded

message

ResourceConflict

message

ResourceNotFound

message

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

BatchStart

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

Batch Stop

URI

/prod/batch/stop

HTTP methods

POST

Operation ID: BatchStop

Responses

Status code Response model Description

200 BatchStopResultModel (p. 15)200 response

400 InvalidRequest (p. 15) 400 response

403 AccessDenied (p. 15) 403 response

404 ResourceNotFound (p. 15) 404 response

409 ResourceConflict (p. 15) 409 response

429 LimitExceeded (p. 15) 429 response

500 InternalServiceError (p. 16)500 response

502 BadGatewayException (p. 16)502 response

504 GatewayTimeoutException (p. 16)504 response

Schemas

Request bodies

POST schema

{ "channelIds": [ "string"

],

"multiplexIds": [ "string"

]}

Response bodies

BatchStopResultModel schema

{

"successful": [ {

"id": "string", "arn": "string", "state": "string"

} ],

"failed": [ {

"id": "string", "arn": "string", "code": "string", "message": "string"

} ] }

InvalidRequest schema

{

"message": "string"

}

AccessDenied schema

{ "message": "string"

}

ResourceNotFound schema

{ "message": "string"

}

ResourceConflict schema

{ "message": "string"

}

LimitExceeded schema

{

"message": "string"

}

InternalServiceError schema

{ "message": "string"

}

BadGatewayException schema

{

"message": "string"

}

GatewayTimeoutException schema

{

"message": "string"

}

Properties

AccessDenied

message

BadGatewayException

message

BatchFailedResultModel

Details from a failed operation

id

ID of the resource Type: string Required: False

arn

ARN of the resource

Type: string Required: False

code

Error code for the failed operation Type: string

Required: False

message

Error message for the failed operation Type: string

Required: False

BatchStop

Batch stop resource request

channelIds

List of channel IDs

Type: Array of type string Required: False

multiplexIds

Type: Array of type string Required: False

BatchStopResultModel

Batch stop resource results

successful

List of successful operations

Type: Array of type BatchSuccessfulResultModel (p. 18) Required: False

failed

List of failed operations

Type: Array of type BatchFailedResultModel (p. 16) Required: False

BatchSuccessfulResultModel

Details from a successful operation

id

ID of the resource Type: string Required: False

arn

ARN of the resource Type: string Required: False

state

Current state of the resource Type: string

Required: False

GatewayTimeoutException

message

InternalServiceError

message

InvalidRequest

message

LimitExceeded

message

ResourceConflict

message

ResourceNotFound

message

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

BatchStop

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

Channels

URI

/prod/channels

HTTP methods

GET

Operation ID: ListChannels

Query parameters

Name Type Required Description

nextToken String False

Name Type Required Description

maxResults String False

Responses

Status code Response model Description

200 ListChannelsResultModel (p. 35)200 response

400 InvalidRequest (p. 54) 400 response

403 AccessDenied (p. 54) 403 response

429 LimitExceeded (p. 54) 429 response

500 InternalServiceError (p. 54)500 response

502 BadGatewayException (p. 54)502 response

504 GatewayTimeoutException (p. 55)504 response

POST

Operation ID: CreateChannel

Responses

Status code Response model Description

201 CreateChannelResultModel (p. 38)201 response

400 InvalidRequest (p. 54) 400 response

403 AccessDenied (p. 54) 403 response

409 ResourceConflict (p. 54) 409 response

422 ChannelConfigurationValidationError (p. 54)422 response

429 LimitExceeded (p. 54) 429 response

500 InternalServiceError (p. 54)500 response

502 BadGatewayException (p. 54)502 response

504 GatewayTimeoutException (p. 55)504 response

Schemas

Request bodies

POST schema

{

"requestId": "string", "name": "string",

"inputAttachments": [ {

"inputId": "string",

"inputAttachmentName": "string", "inputSettings": {

"networkInputSettings": { "hlsInputSettings": { "bandwidth": integer, "retries": integer, "retryInterval": integer, "bufferSegments": integer, "scte35Source": enum },

"serverValidation": enum },

"sourceEndBehavior": enum, "inputFilter": enum, "filterStrength": integer, "deblockFilter": enum, "denoiseFilter": enum,

"smpte2038DataPreference": enum, "videoSelector": {

"selectorSettings": {

"videoSelectorProgramId": { "programId": integer },

"videoSelectorPid": { "pid": integer }

},

"colorSpace": enum, "colorSpaceUsage": enum, "colorSpaceSettings": { "hdr10Settings": { "maxCll": integer, "maxFall": integer }

} },

"audioSelectors": [ {

"name": "string", "selectorSettings": {

"audioHlsRenditionSelection": { "groupId": "string",

"name": "string"

},

"audioLanguageSelection": { "languageCode": "string", "languageSelectionPolicy": enum },

"audioPidSelection": { "pid": integer },

"audioTrackSelection": { "tracks": [

{

"track": integer }

] } } } ],

"captionSelectors": [ {

"selectorSettings": {

"embeddedSourceSettings": {

"source608ChannelNumber": integer, "source608TrackNumber": integer, "convert608To708": enum,

"scte20Detection": enum },

"teletextSourceSettings": { "pageNumber": "string", "outputRectangle": { "leftOffset": number, "width": number, "topOffset": number, "height": number }

},

"scte27SourceSettings": { "pid": integer,

"ocrLanguage": enum },

"scte20SourceSettings": {

"source608ChannelNumber": integer, "convert608To708": enum

},

"dvbSubSourceSettings": { "pid": integer,

"ocrLanguage": enum },

"ancillarySourceSettings": {

"sourceAncillaryChannelNumber": integer },

"aribSourceSettings": { }

},

"name": "string",

"languageCode": "string"

} ] },

"automaticInputFailoverSettings": { "secondaryInputId": "string", "inputPreference": enum, "errorClearTimeMsec": integer, "failoverConditions": [ {

"failoverConditionSettings": { "inputLossSettings": {

"inputLossThresholdMsec": integer },

"videoBlackSettings": {

"videoBlackThresholdMsec": integer, "blackDetectThreshold": number },

"audioSilenceSettings": {

"audioSilenceThresholdMsec": integer, "audioSelectorName": "string"

} } } ] } }

], "inputSpecification": { "codec": enum, "resolution": enum,

"maximumBitrate": enum }, "cdiInputSpecification": { "resolution": enum }, "destinations": [ {

"id": "string", "settings": [ {

"url": "string", "username": "string", "passwordParam": "string", "streamName": "string"

} ],

"mediaPackageSettings": [ {

"channelId": "string"

} ],

"multiplexSettings": { "multiplexId": "string", "programName": "string"

} }

], "encoderSettings": { "audioDescriptions": [ {

"audioSelectorName": "string", "audioType": enum,

"codecSettings": { "aacSettings": { "inputType": enum, "bitrate": number, "codingMode": enum, "rawFormat": enum, "spec": enum, "profile": enum,

"rateControlMode": enum, "sampleRate": number, "vbrQuality": enum },

"ac3Settings": { "bitrate": number, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "drcProfile": enum, "metadataControl": enum, "lfeFilter": enum

},

"eac3Settings": {

"attenuationControl": enum, "bitrate": number,

"bitstreamMode": enum, "codingMode": enum, "dcFilter": enum, "dialnorm": integer, "drcLine": enum, "drcRf": enum, "lfeControl": enum, "lfeFilter": enum, "metadataControl": enum, "loRoCenterMixLevel": number,

"loRoSurroundMixLevel": number, "ltRtCenterMixLevel": number, "ltRtSurroundMixLevel": number, "passthroughControl": enum, "phaseControl": enum, "stereoDownmix": enum, "surroundExMode": enum, "surroundMode": enum },

"mp2Settings": { "codingMode": enum, "bitrate": number, "sampleRate": number },

"passThroughSettings": { },

"wavSettings": { "codingMode": enum, "sampleRate": number, "bitDepth": number }

},

"audioTypeControl": enum, "languageCodeControl": enum, "languageCode": "string", "name": "string",

"remixSettings": { "channelsIn": integer, "channelsOut": integer, "channelMappings": [ {

"outputChannel": integer, "inputChannelLevels": [ {

"inputChannel": integer, "gain": integer

} ] } ] },

"streamName": "string", "audioWatermarkingSettings": { "nielsenWatermarksSettings": { "nielsenDistributionType": enum, "nielsenCbetSettings": {

"csid": "string",

"cbetCheckDigitString": "string", "cbetStepaside": enum

},

"nielsenNaesIiNwSettings": { "sid": number,

"checkDigitString": "string"

} } },

"audioNormalizationSettings": { "algorithm": enum,

"algorithmControl": enum, "targetLkfs": number }

} ],

"availBlanking": { "state": enum,

"availBlankingImage": {

"passwordParam": "string", "uri": "string",

"username": "string"

} },

"availConfiguration": { "availSettings": {

"scte35TimeSignalApos": {

"webDeliveryAllowedFlag": enum, "noRegionalBlackoutFlag": enum, "adAvailOffset": integer },

"scte35SpliceInsert": {

"webDeliveryAllowedFlag": enum, "noRegionalBlackoutFlag": enum, "adAvailOffset": integer }

} },

"blackoutSlate": { "state": enum,

"blackoutSlateImage": { "passwordParam": "string", "uri": "string",

"username": "string"

},

"networkEndBlackout": enum, "networkId": "string", "networkEndBlackoutImage": { "passwordParam": "string", "uri": "string",

"username": "string"

} },

"captionDescriptions": [ {

"name": "string",

"captionSelectorName": "string", "languageCode": "string", "destinationSettings": {

"dvbSubDestinationSettings": { "font": {

"passwordParam": "string", "uri": "string",

"username": "string"

},

"fontSize": "string", "fontResolution": integer, "alignment": enum,

"xPosition": integer, "yPosition": integer,

"teletextGridControl": enum, "fontColor": enum,

"fontOpacity": integer, "backgroundColor": enum, "backgroundOpacity": integer, "outlineSize": integer, "outlineColor": enum, "shadowColor": enum, "shadowOpacity": integer, "shadowXOffset": integer, "shadowYOffset": integer },

"burnInDestinationSettings": { "font": {

"passwordParam": "string",

"uri": "string", "username": "string"

},

"fontSize": "string", "fontResolution": integer, "alignment": enum,

"xPosition": integer, "yPosition": integer,

"teletextGridControl": enum, "fontColor": enum,

"fontOpacity": integer, "backgroundColor": enum, "backgroundOpacity": integer, "outlineSize": integer, "outlineColor": enum, "shadowColor": enum, "shadowOpacity": integer, "shadowXOffset": integer, "shadowYOffset": integer },

"ttmlDestinationSettings": { "styleControl": enum },

"webvttDestinationSettings": { "styleControl": enum

},

"ebuTtDDestinationSettings": { "styleControl": enum, "fillLineGap": enum, "fontFamily": "string", "copyrightHolder": "string"

},

"aribDestinationSettings": { },

"embeddedDestinationSettings": { },

"embeddedPlusScte20DestinationSettings": { },

"scte20PlusEmbeddedDestinationSettings": { },

"rtmpCaptionInfoDestinationSettings": { },

"smpteTtDestinationSettings": { },

"teletextDestinationSettings": { },

"scte27DestinationSettings": { }

},

"languageDescription": "string"

} ],

"globalConfiguration": { "initialAudioGain": integer, "supportLowFramerateInputs": enum, "inputEndAction": enum,

"outputTimingSource": enum, "inputLossBehavior": { "repeatFrameMsec": integer, "blackFrameMsec": integer, "inputLossImageType": enum, "inputLossImageColor": "string", "inputLossImageSlate": {

"passwordParam": "string", "uri": "string",

"username": "string"

} },

"outputLockingMode": enum },

"motionGraphicsConfiguration": { "motionGraphicsInsertion": enum, "motionGraphicsSettings": { "htmlMotionGraphicsSettings": { }

} },

"featureActivations": {

"inputPrepareScheduleActions": enum },

"outputGroups": [ {

"outputGroupSettings": { "msSmoothGroupSettings": { "inputLossAction": enum, "fragmentLength": integer, "eventId": "string", "eventIdMode": enum, "eventStopBehavior": enum, "streamManifestBehavior": enum, "timestampOffsetMode": enum, "timestampOffset": "string", "sparseTrackType": enum, "acquisitionPointId": "string", "connectionRetryInterval": integer, "destination": {

"destinationRefId": "string"

},

"certificateMode": enum, "numRetries": integer,

"filecacheDuration": integer, "restartDelay": integer, "segmentationMode": enum, "sendDelayMs": integer,

"audioOnlyTimecodeControl": enum },

"hlsGroupSettings": {

"incompleteSegmentBehavior": enum, "discontinuityTags": enum,

"keyProviderSettings": { "staticKeySettings": { "staticKeyValue": "string", "keyProviderServer": { "passwordParam": "string", "uri": "string",

"username": "string"

} } },

"adMarkers": [ enum

],

"baseUrlContent": "string", "baseUrlContent1": "string", "baseUrlManifest": "string", "baseUrlManifest1": "string", "captionLanguageSetting": enum, "captionLanguageMappings": [ {

"captionChannel": integer, "languageCode": "string", "languageDescription": "string"

} ],

"hlsCdnSettings": { "hlsBasicPutSettings": { "numRetries": integer,

"connectionRetryInterval": integer, "restartDelay": integer,

"filecacheDuration": integer },

"hlsMediaStoreSettings": { "numRetries": integer,

"connectionRetryInterval": integer, "restartDelay": integer,

"filecacheDuration": integer, "mediaStoreStorageClass": enum },

"hlsAkamaiSettings": { "numRetries": integer,

"connectionRetryInterval": integer, "restartDelay": integer,

"filecacheDuration": integer, "token": "string",

"salt": "string", "httpTransferMode": enum },

"hlsWebdavSettings": { "numRetries": integer,

"connectionRetryInterval": integer, "restartDelay": integer,

"filecacheDuration": integer, "httpTransferMode": enum },

"hlsS3Settings": { "logUploads": enum, "cannedAcl": enum }

},

"inputLossAction": enum, "manifestCompression": enum, "destination": {

"destinationRefId": "string"

},

"encryptionType": enum, "ivInManifest": enum, "ivSource": enum, "constantIv": "string", "clientCache": enum, "tsFileMode": enum,

"manifestDurationFormat": enum, "segmentationMode": enum, "redundantManifest": enum, "outputSelection": enum, "streamInfResolution": enum, "iFrameOnlyPlaylists": enum, "indexNSegments": integer, "programDateTime": enum,

"programDateTimePeriod": integer, "keepSegments": integer,

"keyFormat": "string",

"keyFormatVersions": "string", "minSegmentLength": integer, "segmentLength": integer, "timedMetadataId3Frame": enum, "timedMetadataId3Period": integer, "hlsId3SegmentTagging": enum,

"timestampDeltaMilliseconds": integer,

"codecSpecification": enum, "directoryStructure": enum,

"segmentsPerSubdirectory": integer, "mode": enum

},

"rtmpGroupSettings": {

"authenticationScheme": enum, "cacheLength": integer, "restartDelay": integer, "cacheFullBehavior": enum, "captionData": enum, "inputLossAction": enum, "adMarkers": [

enum ] },

"udpGroupSettings": { "inputLossAction": enum,

"timedMetadataId3Period": integer, "timedMetadataId3Frame": enum },

"archiveGroupSettings": { "destination": {

"destinationRefId": "string"

},

"rolloverInterval": integer, "archiveCdnSettings": { "archiveS3Settings": { "logUploads": enum, "cannedAcl": enum }

} },

"frameCaptureGroupSettings": { "destination": {

"destinationRefId": "string"

},

"frameCaptureCdnSettings": { "frameCaptureS3Settings": { "logUploads": enum, "cannedAcl": enum }

} },

"mediaPackageGroupSettings": { "destination": {

"destinationRefId": "string"

} },

"multiplexGroupSettings": { }

},

"name": "string", "outputs": [ {

"outputSettings": { "hlsOutputSettings": { "nameModifier": "string", "segmentModifier": "string", "hlsSettings": {

"standardHlsSettings": { "m3u8Settings": {

"audioFramesPerPes": integer, "audioPids": "string",

"ecmPid": "string",

"nielsenId3Behavior": enum,

"patInterval": integer, "pcrControl": enum, "pcrPid": "string", "pcrPeriod": integer, "pmtInterval": integer, "pmtPid": "string", "programNum": integer, "scte35Pid": "string", "scte35Behavior": enum, "timedMetadataPid": "string", "timedMetadataBehavior": enum, "transportStreamId": integer, "videoPid": "string"

},

"audioRenditionSets": "string"

},

"fmp4HlsSettings": {

"audioRenditionSets": "string", "timedMetadataBehavior": enum, "nielsenId3Behavior": enum },

"audioOnlyHlsSettings": { "audioOnlyImage": {

"passwordParam": "string", "uri": "string",

"username": "string"

},

"audioTrackType": enum, "audioGroupId": "string", "segmentType": enum },

"frameCaptureHlsSettings": { }

},

"h265PackagingType": enum },

"rtmpOutputSettings": { "destination": {

"destinationRefId": "string"

},

"connectionRetryInterval": integer, "numRetries": integer,

"certificateMode": enum },

"udpOutputSettings": { "destination": {

"destinationRefId": "string"

},

"bufferMsec": integer, "fecOutputSettings": { "includeFec": enum, "columnDepth": integer, "rowLength": integer },

"containerSettings": { "m2tsSettings": { "bitrate": integer, "ccDescriptor": enum, "ebif": enum,

"nielsenId3Behavior": enum, "programNum": integer, "patInterval": integer, "pmtInterval": integer, "pcrControl": enum, "pcrPeriod": integer,

"timedMetadataBehavior": enum,

"transportStreamId": integer, "bufferModel": enum,

"rateMode": enum,

"audioBufferModel": enum, "audioStreamType": enum, "nullPacketBitrate": number, "audioFramesPerPes": integer, "segmentationTime": number, "segmentationStyle": enum, "fragmentTime": number, "segmentationMarkers": enum, "ebpLookaheadMs": integer, "ebpPlacement": enum, "ebpAudioInterval": enum, "esRateInPes": enum, "arib": enum,

"aribCaptionsPidControl": enum, "absentInputAudioBehavior": enum, "dvbNitSettings": {

"repInterval": integer, "networkId": integer, "networkName": "string"

},

"dvbSdtSettings": { "outputSdt": enum, "repInterval": integer, "serviceName": "string",

"serviceProviderName": "string"

},

"dvbTdtSettings": { "repInterval": integer },

"pmtPid": "string", "pcrPid": "string", "videoPid": "string", "audioPids": "string", "dvbTeletextPid": "string", "dvbSubPids": "string", "scte27Pids": "string", "scte35Pid": "string", "scte35Control": enum, "klv": enum,

"klvDataPids": "string", "timedMetadataPid": "string", "etvPlatformPid": "string", "etvSignalPid": "string", "ecmPid": "string",

"aribCaptionsPid": "string"

} } },

"msSmoothOutputSettings": { "nameModifier": "string", "h265PackagingType": enum },

"archiveOutputSettings": { "nameModifier": "string", "extension": "string", "containerSettings": { "m2tsSettings": { "bitrate": integer, "ccDescriptor": enum, "ebif": enum,

"nielsenId3Behavior": enum, "programNum": integer, "patInterval": integer,

"pmtInterval": integer, "pcrControl": enum, "pcrPeriod": integer,

"timedMetadataBehavior": enum, "transportStreamId": integer, "bufferModel": enum,

"rateMode": enum,

"audioBufferModel": enum, "audioStreamType": enum, "nullPacketBitrate": number, "audioFramesPerPes": integer, "segmentationTime": number, "segmentationStyle": enum, "fragmentTime": number, "segmentationMarkers": enum, "ebpLookaheadMs": integer, "ebpPlacement": enum, "ebpAudioInterval": enum, "esRateInPes": enum, "arib": enum,

"aribCaptionsPidControl": enum, "absentInputAudioBehavior": enum, "dvbNitSettings": {

"repInterval": integer, "networkId": integer, "networkName": "string"

},

"dvbSdtSettings": { "outputSdt": enum, "repInterval": integer, "serviceName": "string",

"serviceProviderName": "string"

},

"dvbTdtSettings": { "repInterval": integer },

"pmtPid": "string", "pcrPid": "string", "videoPid": "string", "audioPids": "string", "dvbTeletextPid": "string", "dvbSubPids": "string", "scte27Pids": "string", "scte35Pid": "string", "scte35Control": enum, "klv": enum,

"klvDataPids": "string", "timedMetadataPid": "string", "etvPlatformPid": "string", "etvSignalPid": "string", "ecmPid": "string",

"aribCaptionsPid": "string"

},

"rawSettings": { }

} },

"frameCaptureOutputSettings": { "nameModifier": "string"

},

"mediaPackageOutputSettings": { },

"multiplexOutputSettings": { "destination": {

"destinationRefId": "string"

}

} },

"outputName": "string",

"videoDescriptionName": "string", "audioDescriptionNames": [ "string"

],

"captionDescriptionNames": [ "string"

] } ] } ],

"timecodeConfig": { "source": enum,

"syncThreshold": integer },

"nielsenConfiguration": { "distributorId": "string", "nielsenPcmToId3Tagging": enum },

"videoDescriptions": [ {

"codecSettings": { "h264Settings": { "afdSignaling": enum, "fixedAfd": enum, "colorSpaceSettings": {

"colorSpacePassthroughSettings": { },

"rec601Settings": { },

"rec709Settings": { }

},

"colorMetadata": enum, "adaptiveQuantization": enum, "bitrate": integer,

"bufSize": integer, "bufFillPct": integer, "entropyEncoding": enum, "filterSettings": {

"temporalFilterSettings": { "strength": enum,

"postFilterSharpening": enum }

},

"flickerAq": enum,

"forceFieldPictures": enum, "framerateControl": enum, "framerateNumerator": integer, "framerateDenominator": integer, "gopBReference": enum,

"gopClosedCadence": integer, "gopNumBFrames": integer, "gopSize": number, "gopSizeUnits": enum, "subgopLength": enum, "scanType": enum, "level": enum,

"lookAheadRateControl": enum, "maxBitrate": integer,

"minIInterval": integer, "numRefFrames": integer, "parControl": enum,

"parNumerator": integer, "parDenominator": integer, "profile": enum,

"qualityLevel": enum, "rateControlMode": enum, "qvbrQualityLevel": integer, "syntax": enum,

"sceneChangeDetect": enum, "slices": integer,

"softness": integer, "spatialAq": enum, "temporalAq": enum, "timecodeInsertion": enum },

"h265Settings": {

"parNumerator": integer, "parDenominator": integer, "afdSignaling": enum, "fixedAfd": enum, "colorSpaceSettings": { "hdr10Settings": { "maxCll": integer, "maxFall": integer },

"colorSpacePassthroughSettings": { },

"rec601Settings": { },

"rec709Settings": { }

},

"rateControlMode": enum, "bitrate": integer, "maxBitrate": integer, "bufSize": integer,

"qvbrQualityLevel": integer, "framerateNumerator": integer, "framerateDenominator": integer, "gopSize": number,

"gopSizeUnits": enum, "gopClosedCadence": integer, "sceneChangeDetect": enum, "minIInterval": integer, "profile": enum,

"tier": enum, "scanType": enum, "level": enum, "slices": integer,

"adaptiveQuantization": enum, "filterSettings": {

"temporalFilterSettings": { "strength": enum,

"postFilterSharpening": enum }

},

"flickerAq": enum, "colorMetadata": enum,

"alternativeTransferFunction": enum, "lookAheadRateControl": enum,

"timecodeInsertion": enum },

"mpeg2Settings": { "afdSignaling": enum, "fixedAfd": enum, "colorSpace": enum, "colorMetadata": enum,

"adaptiveQuantization": enum, "filterSettings": {

"temporalFilterSettings": { "strength": enum,

"postFilterSharpening": enum }

},

"framerateNumerator": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "gopNumBFrames": integer, "gopSize": number, "gopSizeUnits": enum, "subgopLength": enum, "scanType": enum,

"displayAspectRatio": enum, "timecodeInsertion": enum },

"frameCaptureSettings": { "captureInterval": integer, "captureIntervalUnits": enum }

},

"height": integer, "name": "string", "respondToAfd": enum, "sharpness": integer, "scalingBehavior": enum, "width": integer

} ]

}, "roleArn": "string", "reserved": "string", "logLevel": enum, "tags": {

}, "channelClass": enum, "vpc": {

"securityGroupIds": [ "string"

],

"subnetIds": [ "string"

],

"publicAddressAllocationIds": [ "string"

] } }

Response bodies

ListChannelsResultModel schema

{ "channels": [ {

"name": "string", "id": "string", "arn": "string", "inputAttachments": [ {

"inputId": "string",

"inputAttachmentName": "string", "inputSettings": {

"networkInputSettings": { "hlsInputSettings": { "bandwidth": integer, "retries": integer, "retryInterval": integer, "bufferSegments": integer, "scte35Source": enum },

"serverValidation": enum },

"sourceEndBehavior": enum, "inputFilter": enum, "filterStrength": integer, "deblockFilter": enum, "denoiseFilter": enum,

"smpte2038DataPreference": enum, "videoSelector": {

"selectorSettings": {

"videoSelectorProgramId": { "programId": integer },

"videoSelectorPid": { "pid": integer }

},

"colorSpace": enum, "colorSpaceUsage": enum, "colorSpaceSettings": { "hdr10Settings": { "maxCll": integer, "maxFall": integer }

} },

"audioSelectors": [ {

"name": "string", "selectorSettings": {

"audioHlsRenditionSelection": { "groupId": "string",

"name": "string"

},

"audioLanguageSelection": { "languageCode": "string", "languageSelectionPolicy": enum },

"audioPidSelection": { "pid": integer },

"audioTrackSelection": { "tracks": [

{

"track": integer }

] } } } ],

"captionSelectors": [ {

"selectorSettings": {

"embeddedSourceSettings": {

"source608ChannelNumber": integer,

"source608TrackNumber": integer, "convert608To708": enum,

"scte20Detection": enum },

"teletextSourceSettings": { "pageNumber": "string", "outputRectangle": { "leftOffset": number, "width": number, "topOffset": number, "height": number }

},

"scte27SourceSettings": { "pid": integer,

"ocrLanguage": enum },

"scte20SourceSettings": {

"source608ChannelNumber": integer, "convert608To708": enum

},

"dvbSubSourceSettings": { "pid": integer,

"ocrLanguage": enum },

"ancillarySourceSettings": {

"sourceAncillaryChannelNumber": integer },

"aribSourceSettings": { }

},

"name": "string", "languageCode": "string"

} ] },

"automaticInputFailoverSettings": { "secondaryInputId": "string", "inputPreference": enum, "errorClearTimeMsec": integer, "failoverConditions": [ {

"failoverConditionSettings": { "inputLossSettings": {

"inputLossThresholdMsec": integer },

"videoBlackSettings": {

"videoBlackThresholdMsec": integer, "blackDetectThreshold": number },

"audioSilenceSettings": {

"audioSilenceThresholdMsec": integer, "audioSelectorName": "string"

} } } ] } } ],

"state": enum,

"pipelinesRunningCount": integer, "destinations": [

{

"id": "string", "settings": [

{

"url": "string", "username": "string", "passwordParam": "string", "streamName": "string"

} ],

"mediaPackageSettings": [ {

"channelId": "string"

} ],

"multiplexSettings": { "multiplexId": "string", "programName": "string"

} } ],

"egressEndpoints": [ {

"sourceIp": "string"

} ],

"roleArn": "string", "inputSpecification": { "codec": enum, "resolution": enum, "maximumBitrate": enum },

"cdiInputSpecification": { "resolution": enum },

"logLevel": enum, "tags": {

},

"channelClass": enum, "vpc": {

"subnetIds": [ "string"

],

"availabilityZones": [ "string"

],

"networkInterfaceIds": [ "string"

],

"securityGroupIds": [ "string"

] } }

], "nextToken": "string"

}

CreateChannelResultModel schema

{ "channel": { "name": "string", "id": "string", "arn": "string", "inputAttachments": [ {

"inputId": "string",

"inputAttachmentName": "string", "inputSettings": {

"networkInputSettings": { "hlsInputSettings": { "bandwidth": integer, "retries": integer, "retryInterval": integer, "bufferSegments": integer, "scte35Source": enum },

"serverValidation": enum },

"sourceEndBehavior": enum, "inputFilter": enum, "filterStrength": integer, "deblockFilter": enum, "denoiseFilter": enum,

"smpte2038DataPreference": enum, "videoSelector": {

"selectorSettings": {

"videoSelectorProgramId": { "programId": integer },

"videoSelectorPid": { "pid": integer }

},

"colorSpace": enum, "colorSpaceUsage": enum, "colorSpaceSettings": { "hdr10Settings": { "maxCll": integer, "maxFall": integer }

} },

"audioSelectors": [ {

"name": "string", "selectorSettings": {

"audioHlsRenditionSelection": { "groupId": "string",

"name": "string"

},

"audioLanguageSelection": { "languageCode": "string", "languageSelectionPolicy": enum },

"audioPidSelection": { "pid": integer },

"audioTrackSelection": { "tracks": [

{

"track": integer }

] } } } ],

"captionSelectors": [ {

"selectorSettings": {

"embeddedSourceSettings": {

"source608ChannelNumber": integer, "source608TrackNumber": integer, "convert608To708": enum,

"scte20Detection": enum },

"teletextSourceSettings": { "pageNumber": "string", "outputRectangle": { "leftOffset": number, "width": number, "topOffset": number, "height": number }

},

"scte27SourceSettings": { "pid": integer,

"ocrLanguage": enum },

"scte20SourceSettings": {

"source608ChannelNumber": integer, "convert608To708": enum

},

"dvbSubSourceSettings": { "pid": integer,

"ocrLanguage": enum },

"ancillarySourceSettings": {

"sourceAncillaryChannelNumber": integer },

"aribSourceSettings": { }

},

"name": "string", "languageCode": "string"

} ] },

"automaticInputFailoverSettings": { "secondaryInputId": "string", "inputPreference": enum, "errorClearTimeMsec": integer, "failoverConditions": [ {

"failoverConditionSettings": { "inputLossSettings": {

"inputLossThresholdMsec": integer },

"videoBlackSettings": {

"videoBlackThresholdMsec": integer, "blackDetectThreshold": number },

"audioSilenceSettings": {

"audioSilenceThresholdMsec": integer, "audioSelectorName": "string"

} } } ] } } ],

"state": enum,

"pipelinesRunningCount": integer, "destinations": [

{

"id": "string",

"settings": [ {

"url": "string", "username": "string", "passwordParam": "string", "streamName": "string"

} ],

"mediaPackageSettings": [ {

"channelId": "string"

} ],

"multiplexSettings": { "multiplexId": "string", "programName": "string"

} } ],

"egressEndpoints": [ {

"sourceIp": "string"

} ],

"encoderSettings": { "audioDescriptions": [ {

"audioSelectorName": "string", "audioType": enum,

"codecSettings": { "aacSettings": { "inputType": enum, "bitrate": number, "codingMode": enum, "rawFormat": enum, "spec": enum, "profile": enum,

"rateControlMode": enum, "sampleRate": number, "vbrQuality": enum },

"ac3Settings": { "bitrate": number, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "drcProfile": enum, "metadataControl": enum, "lfeFilter": enum

},

"eac3Settings": {

"attenuationControl": enum, "bitrate": number,

"bitstreamMode": enum, "codingMode": enum, "dcFilter": enum, "dialnorm": integer, "drcLine": enum, "drcRf": enum, "lfeControl": enum, "lfeFilter": enum, "metadataControl": enum, "loRoCenterMixLevel": number, "loRoSurroundMixLevel": number, "ltRtCenterMixLevel": number, "ltRtSurroundMixLevel": number,