SDK for PHP 3.x
AWS Elemental MediaLive 2017-10-14
- Client: Aws\MediaLive\MediaLiveClient
- Service ID: medialive
- Version: 2017-10-14
This page describes the parameters and results for the operations of the AWS Elemental MediaLive (2017-10-14), and shows how to use the Aws\MediaLive\MediaLiveClient object to call the described operations. This documentation is specific to the 2017-10-14 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AcceptInputDeviceTransfer ( array $params = [] )
- Accept an incoming input device transfer.
- BatchDelete ( array $params = [] )
- Starts delete of resources.
- BatchStart ( array $params = [] )
- Starts existing resources
- BatchStop ( array $params = [] )
- Stops running resources
- BatchUpdateSchedule ( array $params = [] )
- Update a channel schedule
- CancelInputDeviceTransfer ( array $params = [] )
- Cancel an input device transfer that you have requested.
- ClaimDevice ( array $params = [] )
- Send a request to claim an AWS Elemental device that you have purchased from a third-party vendor.
- CreateChannel ( array $params = [] )
- Creates a new channel
- CreateChannelPlacementGroup ( array $params = [] )
- Create a ChannelPlacementGroup in the specified Cluster.
- CreateCloudWatchAlarmTemplate ( array $params = [] )
- Creates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.
- CreateCloudWatchAlarmTemplateGroup ( array $params = [] )
- Creates a cloudwatch alarm template group to group your cloudwatch alarm templates and to attach to signal maps for dynamically creating alarms.
- CreateCluster ( array $params = [] )
- Create a new Cluster.
- CreateEventBridgeRuleTemplate ( array $params = [] )
- Creates an eventbridge rule template to monitor events and send notifications to your targeted resources.
- CreateEventBridgeRuleTemplateGroup ( array $params = [] )
- Creates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.
- CreateInput ( array $params = [] )
- Create an input
- CreateInputSecurityGroup ( array $params = [] )
- Creates a Input Security Group
- CreateMultiplex ( array $params = [] )
- Create a new multiplex.
- CreateMultiplexProgram ( array $params = [] )
- Create a new program in the multiplex.
- CreateNetwork ( array $params = [] )
- Create as many Networks as you need.
- CreateNode ( array $params = [] )
- Create a Node in the specified Cluster.
- CreateNodeRegistrationScript ( array $params = [] )
- Create the Register Node script for all the nodes intended for a specific Cluster.
- CreatePartnerInput ( array $params = [] )
- Create a partner input
- CreateSignalMap ( array $params = [] )
- Initiates the creation of a new signal map.
- CreateTags ( array $params = [] )
- Create tags for a resource
- DeleteChannel ( array $params = [] )
- Starts deletion of channel.
- DeleteChannelPlacementGroup ( array $params = [] )
- Delete the specified ChannelPlacementGroup that exists in the specified Cluster.
- DeleteCloudWatchAlarmTemplate ( array $params = [] )
- Deletes a cloudwatch alarm template.
- DeleteCloudWatchAlarmTemplateGroup ( array $params = [] )
- Deletes a cloudwatch alarm template group.
- DeleteCluster ( array $params = [] )
- Delete a Cluster.
- DeleteEventBridgeRuleTemplate ( array $params = [] )
- Deletes an eventbridge rule template.
- DeleteEventBridgeRuleTemplateGroup ( array $params = [] )
- Deletes an eventbridge rule template group.
- DeleteInput ( array $params = [] )
- Deletes the input end point
- DeleteInputSecurityGroup ( array $params = [] )
- Deletes an Input Security Group
- DeleteMultiplex ( array $params = [] )
- Delete a multiplex.
- DeleteMultiplexProgram ( array $params = [] )
- Delete a program from a multiplex.
- DeleteNetwork ( array $params = [] )
- Delete a Network.
- DeleteNode ( array $params = [] )
- Delete a Node.
- DeleteReservation ( array $params = [] )
- Delete an expired reservation.
- DeleteSchedule ( array $params = [] )
- Delete all schedule actions on a channel.
- DeleteSignalMap ( array $params = [] )
- Deletes the specified signal map.
- DeleteTags ( array $params = [] )
- Removes tags for a resource
- DescribeAccountConfiguration ( array $params = [] )
- Describe account configuration
- DescribeChannel ( array $params = [] )
- Gets details about a channel
- DescribeChannelPlacementGroup ( array $params = [] )
- Get details about a ChannelPlacementGroup.
- DescribeCluster ( array $params = [] )
- Get details about a Cluster.
- DescribeInput ( array $params = [] )
- Produces details about an input
- DescribeInputDevice ( array $params = [] )
- Gets the details for the input device
- DescribeInputDeviceThumbnail ( array $params = [] )
- Get the latest thumbnail data for the input device.
- DescribeInputSecurityGroup ( array $params = [] )
- Produces a summary of an Input Security Group
- DescribeMultiplex ( array $params = [] )
- Gets details about a multiplex.
- DescribeMultiplexProgram ( array $params = [] )
- Get the details for a program in a multiplex.
- DescribeNetwork ( array $params = [] )
- Get details about a Network.
- DescribeNode ( array $params = [] )
- Get details about a Node in the specified Cluster.
- DescribeOffering ( array $params = [] )
- Get details for an offering.
- DescribeReservation ( array $params = [] )
- Get details for a reservation.
- DescribeSchedule ( array $params = [] )
- Get a channel schedule
- DescribeThumbnails ( array $params = [] )
- Describe the latest thumbnails data.
- GetCloudWatchAlarmTemplate ( array $params = [] )
- Retrieves the specified cloudwatch alarm template.
- GetCloudWatchAlarmTemplateGroup ( array $params = [] )
- Retrieves the specified cloudwatch alarm template group.
- GetEventBridgeRuleTemplate ( array $params = [] )
- Retrieves the specified eventbridge rule template.
- GetEventBridgeRuleTemplateGroup ( array $params = [] )
- Retrieves the specified eventbridge rule template group.
- GetSignalMap ( array $params = [] )
- Retrieves the specified signal map.
- ListChannelPlacementGroups ( array $params = [] )
- Retrieve the list of ChannelPlacementGroups in the specified Cluster.
- ListChannels ( array $params = [] )
- Produces list of channels that have been created
- ListCloudWatchAlarmTemplateGroups ( array $params = [] )
- Lists cloudwatch alarm template groups.
- ListCloudWatchAlarmTemplates ( array $params = [] )
- Lists cloudwatch alarm templates.
- ListClusters ( array $params = [] )
- Retrieve the list of Clusters.
- ListEventBridgeRuleTemplateGroups ( array $params = [] )
- Lists eventbridge rule template groups.
- ListEventBridgeRuleTemplates ( array $params = [] )
- Lists eventbridge rule templates.
- ListInputDeviceTransfers ( array $params = [] )
- List input devices that are currently being transferred.
- ListInputDevices ( array $params = [] )
- List input devices
- ListInputSecurityGroups ( array $params = [] )
- Produces a list of Input Security Groups for an account
- ListInputs ( array $params = [] )
- Produces list of inputs that have been created
- ListMultiplexPrograms ( array $params = [] )
- List the programs that currently exist for a specific multiplex.
- ListMultiplexes ( array $params = [] )
- Retrieve a list of the existing multiplexes.
- ListNetworks ( array $params = [] )
- Retrieve the list of Networks.
- ListNodes ( array $params = [] )
- Retrieve the list of Nodes.
- ListOfferings ( array $params = [] )
- List offerings available for purchase.
- ListReservations ( array $params = [] )
- List purchased reservations.
- ListSignalMaps ( array $params = [] )
- Lists signal maps.
- ListTagsForResource ( array $params = [] )
- Produces list of tags that have been created for a resource
- PurchaseOffering ( array $params = [] )
- Purchase an offering and create a reservation.
- RebootInputDevice ( array $params = [] )
- Send a reboot command to the specified input device.
- RejectInputDeviceTransfer ( array $params = [] )
- Reject the transfer of the specified input device to your AWS account.
- RestartChannelPipelines ( array $params = [] )
- Restart pipelines in one channel that is currently running.
- StartChannel ( array $params = [] )
- Starts an existing channel
- StartDeleteMonitorDeployment ( array $params = [] )
- Initiates a deployment to delete the monitor of the specified signal map.
- StartInputDevice ( array $params = [] )
- Start an input device that is attached to a MediaConnect flow.
- StartInputDeviceMaintenanceWindow ( array $params = [] )
- Start a maintenance window for the specified input device.
- StartMonitorDeployment ( array $params = [] )
- Initiates a deployment to deploy the latest monitor of the specified signal map.
- StartMultiplex ( array $params = [] )
- Start (run) the multiplex.
- StartUpdateSignalMap ( array $params = [] )
- Initiates an update for the specified signal map.
- StopChannel ( array $params = [] )
- Stops a running channel
- StopInputDevice ( array $params = [] )
- Stop an input device that is attached to a MediaConnect flow.
- StopMultiplex ( array $params = [] )
- Stops a running multiplex.
- TransferInputDevice ( array $params = [] )
- Start an input device transfer to another AWS account.
- UpdateAccountConfiguration ( array $params = [] )
- Update account configuration
- UpdateChannel ( array $params = [] )
- Updates a channel.
- UpdateChannelClass ( array $params = [] )
- Changes the class of the channel.
- UpdateChannelPlacementGroup ( array $params = [] )
- Change the settings for a ChannelPlacementGroup.
- UpdateCloudWatchAlarmTemplate ( array $params = [] )
- Updates the specified cloudwatch alarm template.
- UpdateCloudWatchAlarmTemplateGroup ( array $params = [] )
- Updates the specified cloudwatch alarm template group.
- UpdateCluster ( array $params = [] )
- Change the settings for a Cluster.
- UpdateEventBridgeRuleTemplate ( array $params = [] )
- Updates the specified eventbridge rule template.
- UpdateEventBridgeRuleTemplateGroup ( array $params = [] )
- Updates the specified eventbridge rule template group.
- UpdateInput ( array $params = [] )
- Updates an input.
- UpdateInputDevice ( array $params = [] )
- Updates the parameters for the input device.
- UpdateInputSecurityGroup ( array $params = [] )
- Update an Input Security Group's Whilelists.
- UpdateMultiplex ( array $params = [] )
- Updates a multiplex.
- UpdateMultiplexProgram ( array $params = [] )
- Update a program in a multiplex.
- UpdateNetwork ( array $params = [] )
- Change the settings for a Network.
- UpdateNode ( array $params = [] )
- Change the settings for a Node.
- UpdateNodeState ( array $params = [] )
- Update the state of a node.
- UpdateReservation ( array $params = [] )
- Update reservation.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- DescribeSchedule
- ListChannels
- ListInputSecurityGroups
- ListInputs
- ListOfferings
- ListReservations
- ListMultiplexPrograms
- ListMultiplexes
- ListInputDevices
- ListInputDeviceTransfers
- ListSignalMaps
- ListCloudWatchAlarmTemplates
- ListCloudWatchAlarmTemplateGroups
- ListEventBridgeRuleTemplates
- ListEventBridgeRuleTemplateGroups
- ListNodes
- ListClusters
- ListChannelPlacementGroups
- ListNetworks
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
| Waiter name | API Operation | Delay | Max Attempts |
|---|---|---|---|
| ChannelCreated | DescribeChannel | 3 | 5 |
| ChannelRunning | DescribeChannel | 5 | 120 |
| ChannelStopped | DescribeChannel | 5 | 60 |
| ChannelDeleted | DescribeChannel | 5 | 84 |
| InputAttached | DescribeInput | 5 | 20 |
| InputDetached | DescribeInput | 5 | 84 |
| InputDeleted | DescribeInput | 5 | 20 |
| MultiplexCreated | DescribeMultiplex | 3 | 5 |
| MultiplexRunning | DescribeMultiplex | 5 | 120 |
| MultiplexStopped | DescribeMultiplex | 5 | 28 |
| MultiplexDeleted | DescribeMultiplex | 5 | 20 |
| SignalMapCreated | GetSignalMap | 5 | 60 |
| SignalMapMonitorDeleted | GetSignalMap | 5 | 120 |
| SignalMapMonitorDeployed | GetSignalMap | 5 | 120 |
| SignalMapUpdated | GetSignalMap | 5 | 60 |
| ClusterCreated | DescribeCluster | 3 | 5 |
| ClusterDeleted | DescribeCluster | 5 | 20 |
| NodeRegistered | DescribeNode | 3 | 5 |
| NodeDeregistered | DescribeNode | 5 | 20 |
| ChannelPlacementGroupAssigned | DescribeChannelPlacementGroup | 3 | 5 |
| ChannelPlacementGroupUnassigned | DescribeChannelPlacementGroup | 5 | 20 |
| ChannelPlacementGroupDeleted | DescribeChannelPlacementGroup | 5 | 20 |
Operations
AcceptInputDeviceTransfer
$result = $client->acceptInputDeviceTransfer([/* ... */]); $promise = $client->acceptInputDeviceTransferAsync([/* ... */]);
Accept an incoming input device transfer. The ownership of the device will transfer to your AWS account.
Parameter Syntax
$result = $client->acceptInputDeviceTransfer([
'InputDeviceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InputDeviceId
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
BatchDelete
$result = $client->batchDelete([/* ... */]); $promise = $client->batchDeleteAsync([/* ... */]);
Starts delete of resources.
Parameter Syntax
$result = $client->batchDelete([
'ChannelIds' => ['<string>', ...],
'InputIds' => ['<string>', ...],
'InputSecurityGroupIds' => ['<string>', ...],
'MultiplexIds' => ['<string>', ...],
]);
Parameter Details
Members
- ChannelIds
-
- Type: Array of strings
- InputIds
-
- Type: Array of strings
- InputSecurityGroupIds
-
- Type: Array of strings
- MultiplexIds
-
- Type: Array of strings
Result Syntax
[
'Failed' => [
[
'Arn' => '<string>',
'Code' => '<string>',
'Id' => '<string>',
'Message' => '<string>',
],
// ...
],
'Successful' => [
[
'Arn' => '<string>',
'Id' => '<string>',
'State' => '<string>',
],
// ...
],
]
Result Details
Members
- Failed
-
- Type: Array of BatchFailedResultModel structures
- Successful
-
- Type: Array of BatchSuccessfulResultModel structures
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
BatchStart
$result = $client->batchStart([/* ... */]); $promise = $client->batchStartAsync([/* ... */]);
Starts existing resources
Parameter Syntax
$result = $client->batchStart([
'ChannelIds' => ['<string>', ...],
'MultiplexIds' => ['<string>', ...],
]);
Parameter Details
Members
- ChannelIds
-
- Type: Array of strings
- MultiplexIds
-
- Type: Array of strings
Result Syntax
[
'Failed' => [
[
'Arn' => '<string>',
'Code' => '<string>',
'Id' => '<string>',
'Message' => '<string>',
],
// ...
],
'Successful' => [
[
'Arn' => '<string>',
'Id' => '<string>',
'State' => '<string>',
],
// ...
],
]
Result Details
Members
- Failed
-
- Type: Array of BatchFailedResultModel structures
- Successful
-
- Type: Array of BatchSuccessfulResultModel structures
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
BatchStop
$result = $client->batchStop([/* ... */]); $promise = $client->batchStopAsync([/* ... */]);
Stops running resources
Parameter Syntax
$result = $client->batchStop([
'ChannelIds' => ['<string>', ...],
'MultiplexIds' => ['<string>', ...],
]);
Parameter Details
Members
- ChannelIds
-
- Type: Array of strings
- MultiplexIds
-
- Type: Array of strings
Result Syntax
[
'Failed' => [
[
'Arn' => '<string>',
'Code' => '<string>',
'Id' => '<string>',
'Message' => '<string>',
],
// ...
],
'Successful' => [
[
'Arn' => '<string>',
'Id' => '<string>',
'State' => '<string>',
],
// ...
],
]
Result Details
Members
- Failed
-
- Type: Array of BatchFailedResultModel structures
- Successful
-
- Type: Array of BatchSuccessfulResultModel structures
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
BatchUpdateSchedule
$result = $client->batchUpdateSchedule([/* ... */]); $promise = $client->batchUpdateScheduleAsync([/* ... */]);
Update a channel schedule
Parameter Syntax
$result = $client->batchUpdateSchedule([
'ChannelId' => '<string>', // REQUIRED
'Creates' => [
'ScheduleActions' => [ // REQUIRED
[
'ActionName' => '<string>', // REQUIRED
'ScheduleActionSettings' => [ // REQUIRED
'HlsId3SegmentTaggingSettings' => [
'Id3' => '<string>',
'Tag' => '<string>',
],
'HlsTimedMetadataSettings' => [
'Id3' => '<string>', // REQUIRED
],
'InputPrepareSettings' => [
'InputAttachmentNameReference' => '<string>',
'InputClippingSettings' => [
'InputTimecodeSource' => 'ZEROBASED|EMBEDDED', // REQUIRED
'StartTimecode' => [
'Timecode' => '<string>',
],
'StopTimecode' => [
'LastFrameClippingBehavior' => 'EXCLUDE_LAST_FRAME|INCLUDE_LAST_FRAME',
'Timecode' => '<string>',
],
],
'UrlPath' => ['<string>', ...],
],
'InputSwitchSettings' => [
'InputAttachmentNameReference' => '<string>', // REQUIRED
'InputClippingSettings' => [
'InputTimecodeSource' => 'ZEROBASED|EMBEDDED', // REQUIRED
'StartTimecode' => [
'Timecode' => '<string>',
],
'StopTimecode' => [
'LastFrameClippingBehavior' => 'EXCLUDE_LAST_FRAME|INCLUDE_LAST_FRAME',
'Timecode' => '<string>',
],
],
'UrlPath' => ['<string>', ...],
],
'MotionGraphicsImageActivateSettings' => [
'Duration' => <integer>,
'PasswordParam' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
'MotionGraphicsImageDeactivateSettings' => [
],
'PauseStateSettings' => [
'Pipelines' => [
[
'PipelineId' => 'PIPELINE_0|PIPELINE_1', // REQUIRED
],
// ...
],
],
'Scte35InputSettings' => [
'InputAttachmentNameReference' => '<string>',
'Mode' => 'FIXED|FOLLOW_ACTIVE', // REQUIRED
],
'Scte35ReturnToNetworkSettings' => [
'SpliceEventId' => <integer>, // REQUIRED
],
'Scte35SpliceInsertSettings' => [
'Duration' => <integer>,
'SpliceEventId' => <integer>, // REQUIRED
],
'Scte35TimeSignalSettings' => [
'Scte35Descriptors' => [ // REQUIRED
[
'Scte35DescriptorSettings' => [ // REQUIRED
'SegmentationDescriptorScte35DescriptorSettings' => [ // REQUIRED
'DeliveryRestrictions' => [
'ArchiveAllowedFlag' => 'ARCHIVE_NOT_ALLOWED|ARCHIVE_ALLOWED', // REQUIRED
'DeviceRestrictions' => 'NONE|RESTRICT_GROUP0|RESTRICT_GROUP1|RESTRICT_GROUP2', // REQUIRED
'NoRegionalBlackoutFlag' => 'REGIONAL_BLACKOUT|NO_REGIONAL_BLACKOUT', // REQUIRED
'WebDeliveryAllowedFlag' => 'WEB_DELIVERY_NOT_ALLOWED|WEB_DELIVERY_ALLOWED', // REQUIRED
],
'SegmentNum' => <integer>,
'SegmentationCancelIndicator' => 'SEGMENTATION_EVENT_NOT_CANCELED|SEGMENTATION_EVENT_CANCELED', // REQUIRED
'SegmentationDuration' => <integer>,
'SegmentationEventId' => <integer>, // REQUIRED
'SegmentationTypeId' => <integer>,
'SegmentationUpid' => '<string>',
'SegmentationUpidType' => <integer>,
'SegmentsExpected' => <integer>,
'SubSegmentNum' => <integer>,
'SubSegmentsExpected' => <integer>,
],
],
],
// ...
],
],
'StaticImageActivateSettings' => [
'Duration' => <integer>,
'FadeIn' => <integer>,
'FadeOut' => <integer>,
'Height' => <integer>,
'Image' => [ // REQUIRED
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'ImageX' => <integer>,
'ImageY' => <integer>,
'Layer' => <integer>,
'Opacity' => <integer>,
'Width' => <integer>,
],
'StaticImageDeactivateSettings' => [
'FadeOut' => <integer>,
'Layer' => <integer>,
],
'StaticImageOutputActivateSettings' => [
'Duration' => <integer>,
'FadeIn' => <integer>,
'FadeOut' => <integer>,
'Height' => <integer>,
'Image' => [ // REQUIRED
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'ImageX' => <integer>,
'ImageY' => <integer>,
'Layer' => <integer>,
'Opacity' => <integer>,
'OutputNames' => ['<string>', ...], // REQUIRED
'Width' => <integer>,
],
'StaticImageOutputDeactivateSettings' => [
'FadeOut' => <integer>,
'Layer' => <integer>,
'OutputNames' => ['<string>', ...], // REQUIRED
],
],
'ScheduleActionStartSettings' => [ // REQUIRED
'FixedModeScheduleActionStartSettings' => [
'Time' => '<string>', // REQUIRED
],
'FollowModeScheduleActionStartSettings' => [
'FollowPoint' => 'END|START', // REQUIRED
'ReferenceActionName' => '<string>', // REQUIRED
],
'ImmediateModeScheduleActionStartSettings' => [
],
],
],
// ...
],
],
'Deletes' => [
'ActionNames' => ['<string>', ...], // REQUIRED
],
]);
Parameter Details
Members
- ChannelId
-
- Required: Yes
- Type: string
- Creates
-
- Type: BatchScheduleActionCreateRequest structure
Schedule actions to create in the schedule. - Deletes
-
- Type: BatchScheduleActionDeleteRequest structure
Schedule actions to delete from the schedule.
Result Syntax
[
'Creates' => [
'ScheduleActions' => [
[
'ActionName' => '<string>',
'ScheduleActionSettings' => [
'HlsId3SegmentTaggingSettings' => [
'Id3' => '<string>',
'Tag' => '<string>',
],
'HlsTimedMetadataSettings' => [
'Id3' => '<string>',
],
'InputPrepareSettings' => [
'InputAttachmentNameReference' => '<string>',
'InputClippingSettings' => [
'InputTimecodeSource' => 'ZEROBASED|EMBEDDED',
'StartTimecode' => [
'Timecode' => '<string>',
],
'StopTimecode' => [
'LastFrameClippingBehavior' => 'EXCLUDE_LAST_FRAME|INCLUDE_LAST_FRAME',
'Timecode' => '<string>',
],
],
'UrlPath' => ['<string>', ...],
],
'InputSwitchSettings' => [
'InputAttachmentNameReference' => '<string>',
'InputClippingSettings' => [
'InputTimecodeSource' => 'ZEROBASED|EMBEDDED',
'StartTimecode' => [
'Timecode' => '<string>',
],
'StopTimecode' => [
'LastFrameClippingBehavior' => 'EXCLUDE_LAST_FRAME|INCLUDE_LAST_FRAME',
'Timecode' => '<string>',
],
],
'UrlPath' => ['<string>', ...],
],
'MotionGraphicsImageActivateSettings' => [
'Duration' => <integer>,
'PasswordParam' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
'MotionGraphicsImageDeactivateSettings' => [
],
'PauseStateSettings' => [
'Pipelines' => [
[
'PipelineId' => 'PIPELINE_0|PIPELINE_1',
],
// ...
],
],
'Scte35InputSettings' => [
'InputAttachmentNameReference' => '<string>',
'Mode' => 'FIXED|FOLLOW_ACTIVE',
],
'Scte35ReturnToNetworkSettings' => [
'SpliceEventId' => <integer>,
],
'Scte35SpliceInsertSettings' => [
'Duration' => <integer>,
'SpliceEventId' => <integer>,
],
'Scte35TimeSignalSettings' => [
'Scte35Descriptors' => [
[
'Scte35DescriptorSettings' => [
'SegmentationDescriptorScte35DescriptorSettings' => [
'DeliveryRestrictions' => [
'ArchiveAllowedFlag' => 'ARCHIVE_NOT_ALLOWED|ARCHIVE_ALLOWED',
'DeviceRestrictions' => 'NONE|RESTRICT_GROUP0|RESTRICT_GROUP1|RESTRICT_GROUP2',
'NoRegionalBlackoutFlag' => 'REGIONAL_BLACKOUT|NO_REGIONAL_BLACKOUT',
'WebDeliveryAllowedFlag' => 'WEB_DELIVERY_NOT_ALLOWED|WEB_DELIVERY_ALLOWED',
],
'SegmentNum' => <integer>,
'SegmentationCancelIndicator' => 'SEGMENTATION_EVENT_NOT_CANCELED|SEGMENTATION_EVENT_CANCELED',
'SegmentationDuration' => <integer>,
'SegmentationEventId' => <integer>,
'SegmentationTypeId' => <integer>,
'SegmentationUpid' => '<string>',
'SegmentationUpidType' => <integer>,
'SegmentsExpected' => <integer>,
'SubSegmentNum' => <integer>,
'SubSegmentsExpected' => <integer>,
],
],
],
// ...
],
],
'StaticImageActivateSettings' => [
'Duration' => <integer>,
'FadeIn' => <integer>,
'FadeOut' => <integer>,
'Height' => <integer>,
'Image' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'ImageX' => <integer>,
'ImageY' => <integer>,
'Layer' => <integer>,
'Opacity' => <integer>,
'Width' => <integer>,
],
'StaticImageDeactivateSettings' => [
'FadeOut' => <integer>,
'Layer' => <integer>,
],
'StaticImageOutputActivateSettings' => [
'Duration' => <integer>,
'FadeIn' => <integer>,
'FadeOut' => <integer>,
'Height' => <integer>,
'Image' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'ImageX' => <integer>,
'ImageY' => <integer>,
'Layer' => <integer>,
'Opacity' => <integer>,
'OutputNames' => ['<string>', ...],
'Width' => <integer>,
],
'StaticImageOutputDeactivateSettings' => [
'FadeOut' => <integer>,
'Layer' => <integer>,
'OutputNames' => ['<string>', ...],
],
],
'ScheduleActionStartSettings' => [
'FixedModeScheduleActionStartSettings' => [
'Time' => '<string>',
],
'FollowModeScheduleActionStartSettings' => [
'FollowPoint' => 'END|START',
'ReferenceActionName' => '<string>',
],
'ImmediateModeScheduleActionStartSettings' => [
],
],
],
// ...
],
],
'Deletes' => [
'ScheduleActions' => [
[
'ActionName' => '<string>',
'ScheduleActionSettings' => [
'HlsId3SegmentTaggingSettings' => [
'Id3' => '<string>',
'Tag' => '<string>',
],
'HlsTimedMetadataSettings' => [
'Id3' => '<string>',
],
'InputPrepareSettings' => [
'InputAttachmentNameReference' => '<string>',
'InputClippingSettings' => [
'InputTimecodeSource' => 'ZEROBASED|EMBEDDED',
'StartTimecode' => [
'Timecode' => '<string>',
],
'StopTimecode' => [
'LastFrameClippingBehavior' => 'EXCLUDE_LAST_FRAME|INCLUDE_LAST_FRAME',
'Timecode' => '<string>',
],
],
'UrlPath' => ['<string>', ...],
],
'InputSwitchSettings' => [
'InputAttachmentNameReference' => '<string>',
'InputClippingSettings' => [
'InputTimecodeSource' => 'ZEROBASED|EMBEDDED',
'StartTimecode' => [
'Timecode' => '<string>',
],
'StopTimecode' => [
'LastFrameClippingBehavior' => 'EXCLUDE_LAST_FRAME|INCLUDE_LAST_FRAME',
'Timecode' => '<string>',
],
],
'UrlPath' => ['<string>', ...],
],
'MotionGraphicsImageActivateSettings' => [
'Duration' => <integer>,
'PasswordParam' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
'MotionGraphicsImageDeactivateSettings' => [
],
'PauseStateSettings' => [
'Pipelines' => [
[
'PipelineId' => 'PIPELINE_0|PIPELINE_1',
],
// ...
],
],
'Scte35InputSettings' => [
'InputAttachmentNameReference' => '<string>',
'Mode' => 'FIXED|FOLLOW_ACTIVE',
],
'Scte35ReturnToNetworkSettings' => [
'SpliceEventId' => <integer>,
],
'Scte35SpliceInsertSettings' => [
'Duration' => <integer>,
'SpliceEventId' => <integer>,
],
'Scte35TimeSignalSettings' => [
'Scte35Descriptors' => [
[
'Scte35DescriptorSettings' => [
'SegmentationDescriptorScte35DescriptorSettings' => [
'DeliveryRestrictions' => [
'ArchiveAllowedFlag' => 'ARCHIVE_NOT_ALLOWED|ARCHIVE_ALLOWED',
'DeviceRestrictions' => 'NONE|RESTRICT_GROUP0|RESTRICT_GROUP1|RESTRICT_GROUP2',
'NoRegionalBlackoutFlag' => 'REGIONAL_BLACKOUT|NO_REGIONAL_BLACKOUT',
'WebDeliveryAllowedFlag' => 'WEB_DELIVERY_NOT_ALLOWED|WEB_DELIVERY_ALLOWED',
],
'SegmentNum' => <integer>,
'SegmentationCancelIndicator' => 'SEGMENTATION_EVENT_NOT_CANCELED|SEGMENTATION_EVENT_CANCELED',
'SegmentationDuration' => <integer>,
'SegmentationEventId' => <integer>,
'SegmentationTypeId' => <integer>,
'SegmentationUpid' => '<string>',
'SegmentationUpidType' => <integer>,
'SegmentsExpected' => <integer>,
'SubSegmentNum' => <integer>,
'SubSegmentsExpected' => <integer>,
],
],
],
// ...
],
],
'StaticImageActivateSettings' => [
'Duration' => <integer>,
'FadeIn' => <integer>,
'FadeOut' => <integer>,
'Height' => <integer>,
'Image' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'ImageX' => <integer>,
'ImageY' => <integer>,
'Layer' => <integer>,
'Opacity' => <integer>,
'Width' => <integer>,
],
'StaticImageDeactivateSettings' => [
'FadeOut' => <integer>,
'Layer' => <integer>,
],
'StaticImageOutputActivateSettings' => [
'Duration' => <integer>,
'FadeIn' => <integer>,
'FadeOut' => <integer>,
'Height' => <integer>,
'Image' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'ImageX' => <integer>,
'ImageY' => <integer>,
'Layer' => <integer>,
'Opacity' => <integer>,
'OutputNames' => ['<string>', ...],
'Width' => <integer>,
],
'StaticImageOutputDeactivateSettings' => [
'FadeOut' => <integer>,
'Layer' => <integer>,
'OutputNames' => ['<string>', ...],
],
],
'ScheduleActionStartSettings' => [
'FixedModeScheduleActionStartSettings' => [
'Time' => '<string>',
],
'FollowModeScheduleActionStartSettings' => [
'FollowPoint' => 'END|START',
'ReferenceActionName' => '<string>',
],
'ImmediateModeScheduleActionStartSettings' => [
],
],
],
// ...
],
],
]
Result Details
Members
- Creates
-
- Type: BatchScheduleActionCreateResult structure
List of actions that have been created in the schedule. - Deletes
-
- Type: BatchScheduleActionDeleteResult structure
List of actions that have been deleted from the schedule.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
CancelInputDeviceTransfer
$result = $client->cancelInputDeviceTransfer([/* ... */]); $promise = $client->cancelInputDeviceTransferAsync([/* ... */]);
Cancel an input device transfer that you have requested.
Parameter Syntax
$result = $client->cancelInputDeviceTransfer([
'InputDeviceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InputDeviceId
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
ClaimDevice
$result = $client->claimDevice([/* ... */]); $promise = $client->claimDeviceAsync([/* ... */]);
Send a request to claim an AWS Elemental device that you have purchased from a third-party vendor. After the request succeeds, you will own the device.
Parameter Syntax
$result = $client->claimDevice([
'Id' => '<string>',
]);
Parameter Details
Members
- Id
-
- Type: string
The id of the device you want to claim.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
CreateChannel
$result = $client->createChannel([/* ... */]); $promise = $client->createChannelAsync([/* ... */]);
Creates a new channel
Parameter Syntax
$result = $client->createChannel([
'AnywhereSettings' => [
'ChannelPlacementGroupId' => '<string>',
'ClusterId' => '<string>',
],
'CdiInputSpecification' => [
'Resolution' => 'SD|HD|FHD|UHD',
],
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
'EncoderSettings' => [
'AudioDescriptions' => [ // REQUIRED
[
'AudioDashRoles' => ['<string>', ...],
'AudioNormalizationSettings' => [
'Algorithm' => 'ITU_1770_1|ITU_1770_2',
'AlgorithmControl' => 'CORRECT_AUDIO',
'TargetLkfs' => <float>,
],
'AudioSelectorName' => '<string>', // REQUIRED
'AudioType' => 'CLEAN_EFFECTS|HEARING_IMPAIRED|UNDEFINED|VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'AudioWatermarkingSettings' => [
'NielsenWatermarksSettings' => [
'NielsenCbetSettings' => [
'CbetCheckDigitString' => '<string>', // REQUIRED
'CbetStepaside' => 'DISABLED|ENABLED', // REQUIRED
'Csid' => '<string>', // REQUIRED
],
'NielsenDistributionType' => 'FINAL_DISTRIBUTOR|PROGRAM_CONTENT',
'NielsenNaesIiNwSettings' => [
'CheckDigitString' => '<string>', // REQUIRED
'Sid' => <float>, // REQUIRED
'Timezone' => 'AMERICA_PUERTO_RICO|US_ALASKA|US_ARIZONA|US_CENTRAL|US_EASTERN|US_HAWAII|US_MOUNTAIN|US_PACIFIC|US_SAMOA|UTC',
],
],
],
'CodecSettings' => [
'AacSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'AD_RECEIVER_MIX|CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_5_1',
'InputType' => 'BROADCASTER_MIXED_AD|NORMAL',
'Profile' => 'HEV1|HEV2|LC',
'RateControlMode' => 'CBR|VBR',
'RawFormat' => 'LATM_LOAS|NONE',
'SampleRate' => <float>,
'Spec' => 'MPEG2|MPEG4',
'VbrQuality' => 'HIGH|LOW|MEDIUM_HIGH|MEDIUM_LOW',
],
'Ac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|DIALOGUE|EMERGENCY|HEARING_IMPAIRED|MUSIC_AND_EFFECTS|VISUALLY_IMPAIRED|VOICE_OVER',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_3_2_LFE',
'Dialnorm' => <integer>,
'DrcProfile' => 'FILM_STANDARD|NONE',
'LfeFilter' => 'DISABLED|ENABLED',
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
],
'Eac3AtmosSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_5_1_4|CODING_MODE_7_1_4|CODING_MODE_9_1_6',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'HeightTrim' => <float>,
'SurroundTrim' => <float>,
],
'Eac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|EMERGENCY|HEARING_IMPAIRED|VISUALLY_IMPAIRED',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_3_2',
'DcFilter' => 'DISABLED|ENABLED',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'LfeControl' => 'LFE|NO_LFE',
'LfeFilter' => 'DISABLED|ENABLED',
'LoRoCenterMixLevel' => <float>,
'LoRoSurroundMixLevel' => <float>,
'LtRtCenterMixLevel' => <float>,
'LtRtSurroundMixLevel' => <float>,
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'PassthroughControl' => 'NO_PASSTHROUGH|WHEN_POSSIBLE',
'PhaseControl' => 'NO_SHIFT|SHIFT_90_DEGREES',
'StereoDownmix' => 'DPL2|LO_RO|LT_RT|NOT_INDICATED',
'SurroundExMode' => 'DISABLED|ENABLED|NOT_INDICATED',
'SurroundMode' => 'DISABLED|ENABLED|NOT_INDICATED',
],
'Mp2Settings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0',
'SampleRate' => <float>,
],
'PassThroughSettings' => [
],
'WavSettings' => [
'BitDepth' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_4_0|CODING_MODE_8_0',
'SampleRate' => <float>,
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageCodeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'Name' => '<string>', // REQUIRED
'RemixSettings' => [
'ChannelMappings' => [ // REQUIRED
[
'InputChannelLevels' => [ // REQUIRED
[
'Gain' => <integer>, // REQUIRED
'InputChannel' => <integer>, // REQUIRED
],
// ...
],
'OutputChannel' => <integer>, // REQUIRED
],
// ...
],
'ChannelsIn' => <integer>,
'ChannelsOut' => <integer>,
],
'StreamName' => '<string>',
],
// ...
],
'AvailBlanking' => [
'AvailBlankingImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'State' => 'DISABLED|ENABLED',
],
'AvailConfiguration' => [
'AvailSettings' => [
'Esam' => [
'AcquisitionPointId' => '<string>', // REQUIRED
'AdAvailOffset' => <integer>,
'PasswordParam' => '<string>',
'PoisEndpoint' => '<string>', // REQUIRED
'Username' => '<string>',
'ZoneIdentity' => '<string>',
],
'Scte35SpliceInsert' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
'Scte35TimeSignalApos' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
],
'Scte35SegmentationScope' => 'ALL_OUTPUT_GROUPS|SCTE35_ENABLED_OUTPUT_GROUPS',
],
'BlackoutSlate' => [
'BlackoutSlateImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'NetworkEndBlackout' => 'DISABLED|ENABLED',
'NetworkEndBlackoutImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'NetworkId' => '<string>',
'State' => 'DISABLED|ENABLED',
],
'CaptionDescriptions' => [
[
'Accessibility' => 'DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES|IMPLEMENTS_ACCESSIBILITY_FEATURES',
'CaptionDashRoles' => ['<string>', ...],
'CaptionSelectorName' => '<string>', // REQUIRED
'DestinationSettings' => [
'AribDestinationSettings' => [
],
'BurnInDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'DvbSubDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'EbuTtDDestinationSettings' => [
'CopyrightHolder' => '<string>',
'FillLineGap' => 'DISABLED|ENABLED',
'FontFamily' => '<string>',
'StyleControl' => 'EXCLUDE|INCLUDE',
],
'EmbeddedDestinationSettings' => [
],
'EmbeddedPlusScte20DestinationSettings' => [
],
'RtmpCaptionInfoDestinationSettings' => [
],
'Scte20PlusEmbeddedDestinationSettings' => [
],
'Scte27DestinationSettings' => [
],
'SmpteTtDestinationSettings' => [
],
'TeletextDestinationSettings' => [
],
'TtmlDestinationSettings' => [
'StyleControl' => 'PASSTHROUGH|USE_CONFIGURED',
],
'WebvttDestinationSettings' => [
'StyleControl' => 'NO_STYLE_DATA|PASSTHROUGH',
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
'Name' => '<string>', // REQUIRED
],
// ...
],
'ColorCorrectionSettings' => [
'GlobalColorCorrections' => [ // REQUIRED
[
'InputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709', // REQUIRED
'OutputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709', // REQUIRED
'Uri' => '<string>', // REQUIRED
],
// ...
],
],
'FeatureActivations' => [
'InputPrepareScheduleActions' => 'DISABLED|ENABLED',
'OutputStaticImageOverlayScheduleActions' => 'DISABLED|ENABLED',
],
'GlobalConfiguration' => [
'InitialAudioGain' => <integer>,
'InputEndAction' => 'NONE|SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior' => [
'BlackFrameMsec' => <integer>,
'InputLossImageColor' => '<string>',
'InputLossImageSlate' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'InputLossImageType' => 'COLOR|SLATE',
'RepeatFrameMsec' => <integer>,
],
'OutputLockingMode' => 'EPOCH_LOCKING|PIPELINE_LOCKING',
'OutputLockingSettings' => [
'EpochLockingSettings' => [
'CustomEpoch' => '<string>',
'JamSyncTime' => '<string>',
],
'PipelineLockingSettings' => [
],
],
'OutputTimingSource' => 'INPUT_CLOCK|SYSTEM_CLOCK',
'SupportLowFramerateInputs' => 'DISABLED|ENABLED',
],
'MotionGraphicsConfiguration' => [
'MotionGraphicsInsertion' => 'DISABLED|ENABLED',
'MotionGraphicsSettings' => [ // REQUIRED
'HtmlMotionGraphicsSettings' => [
],
],
],
'NielsenConfiguration' => [
'DistributorId' => '<string>',
'NielsenPcmToId3Tagging' => 'DISABLED|ENABLED',
],
'OutputGroups' => [ // REQUIRED
[
'Name' => '<string>',
'OutputGroupSettings' => [ // REQUIRED
'ArchiveGroupSettings' => [
'ArchiveCdnSettings' => [
'ArchiveS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'RolloverInterval' => <integer>,
],
'CmafIngestGroupSettings' => [
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvNameModifier' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NielsenId3NameModifier' => '<string>',
'Scte35NameModifier' => '<string>',
'Scte35Type' => 'NONE|SCTE_35_WITHOUT_SEGMENTATION',
'SegmentLength' => <integer>,
'SegmentLengthUnits' => 'MILLISECONDS|SECONDS',
'SendDelayMs' => <integer>,
],
'FrameCaptureGroupSettings' => [
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'FrameCaptureCdnSettings' => [
'FrameCaptureS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
],
'HlsGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'BaseUrlContent' => '<string>',
'BaseUrlContent1' => '<string>',
'BaseUrlManifest' => '<string>',
'BaseUrlManifest1' => '<string>',
'CaptionLanguageMappings' => [
[
'CaptionChannel' => <integer>, // REQUIRED
'LanguageCode' => '<string>', // REQUIRED
'LanguageDescription' => '<string>', // REQUIRED
],
// ...
],
'CaptionLanguageSetting' => 'INSERT|NONE|OMIT',
'ClientCache' => 'DISABLED|ENABLED',
'CodecSpecification' => 'RFC_4281|RFC_6381',
'ConstantIv' => '<string>',
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'DirectoryStructure' => 'SINGLE_DIRECTORY|SUBDIRECTORY_PER_STREAM',
'DiscontinuityTags' => 'INSERT|NEVER_INSERT',
'EncryptionType' => 'AES128|SAMPLE_AES',
'HlsCdnSettings' => [
'HlsAkamaiSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'Salt' => '<string>',
'Token' => '<string>',
],
'HlsBasicPutSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsMediaStoreSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'MediaStoreStorageClass' => 'TEMPORAL',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
'HlsWebdavSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
],
'HlsId3SegmentTagging' => 'DISABLED|ENABLED',
'IFrameOnlyPlaylists' => 'DISABLED|STANDARD',
'IncompleteSegmentBehavior' => 'AUTO|SUPPRESS',
'IndexNSegments' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'IvInManifest' => 'EXCLUDE|INCLUDE',
'IvSource' => 'EXPLICIT|FOLLOWS_SEGMENT_NUMBER',
'KeepSegments' => <integer>,
'KeyFormat' => '<string>',
'KeyFormatVersions' => '<string>',
'KeyProviderSettings' => [
'StaticKeySettings' => [
'KeyProviderServer' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'StaticKeyValue' => '<string>', // REQUIRED
],
],
'ManifestCompression' => 'GZIP|NONE',
'ManifestDurationFormat' => 'FLOATING_POINT|INTEGER',
'MinSegmentLength' => <integer>,
'Mode' => 'LIVE|VOD',
'OutputSelection' => 'MANIFESTS_AND_SEGMENTS|SEGMENTS_ONLY|VARIANT_MANIFESTS_AND_SEGMENTS',
'ProgramDateTime' => 'EXCLUDE|INCLUDE',
'ProgramDateTimeClock' => 'INITIALIZE_FROM_OUTPUT_TIMECODE|SYSTEM_CLOCK',
'ProgramDateTimePeriod' => <integer>,
'RedundantManifest' => 'DISABLED|ENABLED',
'SegmentLength' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory' => <integer>,
'StreamInfResolution' => 'EXCLUDE|INCLUDE',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
'TimestampDeltaMilliseconds' => <integer>,
'TsFileMode' => 'SEGMENTED_FILES|SINGLE_FILE',
],
'MediaPackageGroupSettings' => [
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
],
'MsSmoothGroupSettings' => [
'AcquisitionPointId' => '<string>',
'AudioOnlyTimecodeControl' => 'PASSTHROUGH|USE_CONFIGURED_CLOCK',
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'EventId' => '<string>',
'EventIdMode' => 'NO_EVENT_ID|USE_CONFIGURED|USE_TIMESTAMP',
'EventStopBehavior' => 'NONE|SEND_EOS',
'FilecacheDuration' => <integer>,
'FragmentLength' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SendDelayMs' => <integer>,
'SparseTrackType' => 'NONE|SCTE_35|SCTE_35_WITHOUT_SEGMENTATION',
'StreamManifestBehavior' => 'DO_NOT_SEND|SEND',
'TimestampOffset' => '<string>',
'TimestampOffsetMode' => 'USE_CONFIGURED_OFFSET|USE_EVENT_START_DATE',
],
'MultiplexGroupSettings' => [
],
'RtmpGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'AuthenticationScheme' => 'AKAMAI|COMMON',
'CacheFullBehavior' => 'DISCONNECT_IMMEDIATELY|WAIT_FOR_SERVER',
'CacheLength' => <integer>,
'CaptionData' => 'ALL|FIELD1_608|FIELD1_AND_FIELD2_608',
'IncludeFillerNalUnits' => 'AUTO|DROP|INCLUDE',
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'RestartDelay' => <integer>,
],
'SrtGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
],
'UdpGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
],
],
'Outputs' => [ // REQUIRED
[
'AudioDescriptionNames' => ['<string>', ...],
'CaptionDescriptionNames' => ['<string>', ...],
'OutputName' => '<string>',
'OutputSettings' => [ // REQUIRED
'ArchiveOutputSettings' => [
'ContainerSettings' => [ // REQUIRED
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>, // REQUIRED
'NetworkName' => '<string>', // REQUIRED
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
'RawSettings' => [
],
],
'Extension' => '<string>',
'NameModifier' => '<string>',
],
'CmafIngestOutputSettings' => [
'NameModifier' => '<string>',
],
'FrameCaptureOutputSettings' => [
'NameModifier' => '<string>',
],
'HlsOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'HlsSettings' => [ // REQUIRED
'AudioOnlyHlsSettings' => [
'AudioGroupId' => '<string>',
'AudioOnlyImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'AudioTrackType' => 'ALTERNATE_AUDIO_AUTO_SELECT|ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT|ALTERNATE_AUDIO_NOT_AUTO_SELECT|AUDIO_ONLY_VARIANT_STREAM',
'SegmentType' => 'AAC|FMP4',
],
'Fmp4HlsSettings' => [
'AudioRenditionSets' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
],
'FrameCaptureHlsSettings' => [
],
'StandardHlsSettings' => [
'AudioRenditionSets' => '<string>',
'M3u8Settings' => [ // REQUIRED
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'EcmPid' => '<string>',
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'Scte35Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'Scte35Pid' => '<string>',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
],
'NameModifier' => '<string>',
'SegmentModifier' => '<string>',
],
'MediaPackageOutputSettings' => [
],
'MsSmoothOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'NameModifier' => '<string>',
],
'MultiplexOutputSettings' => [
'ContainerSettings' => [
'MultiplexM2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioStreamType' => 'ATSC|DVB',
'CcDescriptor' => 'DISABLED|ENABLED',
'Ebif' => 'NONE|PASSTHROUGH',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'Klv' => 'NONE|PASSTHROUGH',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35PrerollPullupMilliseconds' => <float>,
],
],
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
],
'RtmpOutputSettings' => [
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'NumRetries' => <integer>,
],
'SrtOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [ // REQUIRED
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>, // REQUIRED
'NetworkName' => '<string>', // REQUIRED
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'EncryptionType' => 'AES128|AES192|AES256',
'Latency' => <integer>,
],
'UdpOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [ // REQUIRED
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>, // REQUIRED
'NetworkName' => '<string>', // REQUIRED
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'FecOutputSettings' => [
'ColumnDepth' => <integer>,
'IncludeFec' => 'COLUMN|COLUMN_AND_ROW',
'RowLength' => <integer>,
],
],
],
'VideoDescriptionName' => '<string>',
],
// ...
],
],
// ...
],
'ThumbnailConfiguration' => [
'State' => 'AUTO|DISABLED', // REQUIRED
],
'TimecodeConfig' => [ // REQUIRED
'Source' => 'EMBEDDED|SYSTEMCLOCK|ZEROBASED', // REQUIRED
'SyncThreshold' => <integer>,
],
'VideoDescriptions' => [ // REQUIRED
[
'CodecSettings' => [
'Av1Settings' => [
'AfdSignaling' => 'AUTO|FIXED|NONE',
'BufSize' => <integer>,
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>, // REQUIRED
'FramerateNumerator' => <integer>, // REQUIRED
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'AV1_LEVEL_2|AV1_LEVEL_2_1|AV1_LEVEL_3|AV1_LEVEL_3_1|AV1_LEVEL_4|AV1_LEVEL_4_1|AV1_LEVEL_5|AV1_LEVEL_5_1|AV1_LEVEL_5_2|AV1_LEVEL_5_3|AV1_LEVEL_6|AV1_LEVEL_6_1|AV1_LEVEL_6_2|AV1_LEVEL_6_3|AV1_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'QvbrQualityLevel' => <integer>,
'SceneChangeDetect' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16', // REQUIRED
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT', // REQUIRED
'Prefix' => '<string>',
],
],
'FrameCaptureSettings' => [
'CaptureInterval' => <integer>,
'CaptureIntervalUnits' => 'MILLISECONDS|SECONDS',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16', // REQUIRED
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT', // REQUIRED
'Prefix' => '<string>',
],
],
'H264Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'Bitrate' => <integer>,
'BufFillPct' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'EntropyEncoding' => 'CABAC|CAVLC',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'ForceFieldPictures' => 'DISABLED|ENABLED',
'FramerateControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopBReference' => 'DISABLED|ENABLED',
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H264_LEVEL_1|H264_LEVEL_1_1|H264_LEVEL_1_2|H264_LEVEL_1_3|H264_LEVEL_2|H264_LEVEL_2_1|H264_LEVEL_2_2|H264_LEVEL_3|H264_LEVEL_3_1|H264_LEVEL_3_2|H264_LEVEL_4|H264_LEVEL_4_1|H264_LEVEL_4_2|H264_LEVEL_5|H264_LEVEL_5_1|H264_LEVEL_5_2|H264_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'NumRefFrames' => <integer>,
'ParControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'BASELINE|HIGH|HIGH_10BIT|HIGH_422|HIGH_422_10BIT|MAIN',
'QualityLevel' => 'ENHANCED_QUALITY|STANDARD_QUALITY',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR|VBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Softness' => <integer>,
'SpatialAq' => 'DISABLED|ENABLED',
'SubgopLength' => 'DYNAMIC|FIXED',
'Syntax' => 'DEFAULT|RP2027',
'TemporalAq' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16', // REQUIRED
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT', // REQUIRED
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
],
'H265Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'AlternativeTransferFunction' => 'INSERT|OMIT',
'Bitrate' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'DolbyVision81Settings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'Deblocking' => 'DISABLED|ENABLED',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'FramerateDenominator' => <integer>, // REQUIRED
'FramerateNumerator' => <integer>, // REQUIRED
'GopClosedCadence' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H265_LEVEL_1|H265_LEVEL_2|H265_LEVEL_2_1|H265_LEVEL_3|H265_LEVEL_3_1|H265_LEVEL_4|H265_LEVEL_4_1|H265_LEVEL_5|H265_LEVEL_5_1|H265_LEVEL_5_2|H265_LEVEL_6|H265_LEVEL_6_1|H265_LEVEL_6_2|H265_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'MvOverPictureBoundaries' => 'DISABLED|ENABLED',
'MvTemporalPredictor' => 'DISABLED|ENABLED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'MAIN|MAIN_10BIT',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Tier' => 'HIGH|MAIN',
'TileHeight' => <integer>,
'TilePadding' => 'NONE|PADDED',
'TileWidth' => <integer>,
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16', // REQUIRED
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT', // REQUIRED
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
'TreeblockSize' => 'AUTO|TREE_SIZE_32X32',
],
'Mpeg2Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|LOW|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpace' => 'AUTO|PASSTHROUGH',
'DisplayAspectRatio' => 'DISPLAYRATIO16X9|DISPLAYRATIO4X3',
'FilterSettings' => [
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>, // REQUIRED
'FramerateNumerator' => <integer>, // REQUIRED
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SubgopLength' => 'DYNAMIC|FIXED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16', // REQUIRED
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT', // REQUIRED
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|GOP_TIMECODE',
],
],
'Height' => <integer>,
'Name' => '<string>', // REQUIRED
'RespondToAfd' => 'NONE|PASSTHROUGH|RESPOND',
'ScalingBehavior' => 'DEFAULT|STRETCH_TO_OUTPUT',
'Sharpness' => <integer>,
'Width' => <integer>,
],
// ...
],
],
'InputAttachments' => [
[
'AutomaticInputFailoverSettings' => [
'ErrorClearTimeMsec' => <integer>,
'FailoverConditions' => [
[
'FailoverConditionSettings' => [
'AudioSilenceSettings' => [
'AudioSelectorName' => '<string>', // REQUIRED
'AudioSilenceThresholdMsec' => <integer>,
],
'InputLossSettings' => [
'InputLossThresholdMsec' => <integer>,
],
'VideoBlackSettings' => [
'BlackDetectThreshold' => <float>,
'VideoBlackThresholdMsec' => <integer>,
],
],
],
// ...
],
'InputPreference' => 'EQUAL_INPUT_PREFERENCE|PRIMARY_INPUT_PREFERRED',
'SecondaryInputId' => '<string>', // REQUIRED
],
'InputAttachmentName' => '<string>',
'InputId' => '<string>',
'InputSettings' => [
'AudioSelectors' => [
[
'Name' => '<string>', // REQUIRED
'SelectorSettings' => [
'AudioHlsRenditionSelection' => [
'GroupId' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
],
'AudioLanguageSelection' => [
'LanguageCode' => '<string>', // REQUIRED
'LanguageSelectionPolicy' => 'LOOSE|STRICT',
],
'AudioPidSelection' => [
'Pid' => <integer>, // REQUIRED
],
'AudioTrackSelection' => [
'DolbyEDecode' => [
'ProgramSelection' => 'ALL_CHANNELS|PROGRAM_1|PROGRAM_2|PROGRAM_3|PROGRAM_4|PROGRAM_5|PROGRAM_6|PROGRAM_7|PROGRAM_8', // REQUIRED
],
'Tracks' => [ // REQUIRED
[
'Track' => <integer>, // REQUIRED
],
// ...
],
],
],
],
// ...
],
'CaptionSelectors' => [
[
'LanguageCode' => '<string>',
'Name' => '<string>', // REQUIRED
'SelectorSettings' => [
'AncillarySourceSettings' => [
'SourceAncillaryChannelNumber' => <integer>,
],
'AribSourceSettings' => [
],
'DvbSubSourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'EmbeddedSourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Scte20Detection' => 'AUTO|OFF',
'Source608ChannelNumber' => <integer>,
'Source608TrackNumber' => <integer>,
],
'Scte20SourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Source608ChannelNumber' => <integer>,
],
'Scte27SourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'TeletextSourceSettings' => [
'OutputRectangle' => [
'Height' => <float>, // REQUIRED
'LeftOffset' => <float>, // REQUIRED
'TopOffset' => <float>, // REQUIRED
'Width' => <float>, // REQUIRED
],
'PageNumber' => '<string>',
],
],
],
// ...
],
'DeblockFilter' => 'DISABLED|ENABLED',
'DenoiseFilter' => 'DISABLED|ENABLED',
'FilterStrength' => <integer>,
'InputFilter' => 'AUTO|DISABLED|FORCED',
'NetworkInputSettings' => [
'HlsInputSettings' => [
'Bandwidth' => <integer>,
'BufferSegments' => <integer>,
'Retries' => <integer>,
'RetryInterval' => <integer>,
'Scte35Source' => 'MANIFEST|SEGMENTS',
],
'MulticastInputSettings' => [
'SourceIpAddress' => '<string>',
],
'ServerValidation' => 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME|CHECK_CRYPTOGRAPHY_ONLY',
],
'Scte35Pid' => <integer>,
'Smpte2038DataPreference' => 'IGNORE|PREFER',
'SourceEndBehavior' => 'CONTINUE|LOOP',
'VideoSelector' => [
'ColorSpace' => 'FOLLOW|HDR10|HLG_2020|REC_601|REC_709',
'ColorSpaceSettings' => [
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
],
'ColorSpaceUsage' => 'FALLBACK|FORCE',
'SelectorSettings' => [
'VideoSelectorPid' => [
'Pid' => <integer>,
],
'VideoSelectorProgramId' => [
'ProgramId' => <integer>,
],
],
],
],
'LogicalInterfaceNames' => ['<string>', ...],
],
// ...
],
'InputSpecification' => [
'Codec' => 'MPEG2|AVC|HEVC',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'Resolution' => 'SD|HD|UHD',
],
'LogLevel' => 'ERROR|WARNING|INFO|DEBUG|DISABLED',
'Maintenance' => [
'MaintenanceDay' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'MaintenanceStartTime' => '<string>',
],
'Name' => '<string>',
'RequestId' => '<string>',
'Reserved' => '<string>',
'RoleArn' => '<string>',
'Tags' => ['<string>', ...],
'Vpc' => [
'PublicAddressAllocationIds' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...], // REQUIRED
],
]);
Parameter Details
Members
- AnywhereSettings
-
- Type: AnywhereSettings structure
Elemental anywhere settings - CdiInputSpecification
-
- Type: CdiInputSpecification structure
- ChannelClass
-
- Type: string
A standard channel has two encoding pipelines and a single pipeline channel only has one. - Destinations
-
- Type: Array of OutputDestination structures
- EncoderSettings
-
- Type: EncoderSettings structure
Encoder Settings - InputAttachments
-
- Type: Array of InputAttachment structures
- InputSpecification
-
- Type: InputSpecification structure
- LogLevel
-
- Type: string
The log level the user wants for their channel. - Maintenance
-
- Type: MaintenanceCreateSettings structure
- Name
-
- Type: string
- RequestId
-
- Type: string
- Reserved
-
- Type: string
- RoleArn
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Vpc
-
- Type: VpcOutputSettings structure
The properties for a private VPC OutputWhen this property is specified, the output egress addresses will be created in a user specified VPC
Result Syntax
[
'Channel' => [
'AnywhereSettings' => [
'ChannelPlacementGroupId' => '<string>',
'ClusterId' => '<string>',
],
'Arn' => '<string>',
'CdiInputSpecification' => [
'Resolution' => 'SD|HD|FHD|UHD',
],
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
'EgressEndpoints' => [
[
'SourceIp' => '<string>',
],
// ...
],
'EncoderSettings' => [
'AudioDescriptions' => [
[
'AudioDashRoles' => ['<string>', ...],
'AudioNormalizationSettings' => [
'Algorithm' => 'ITU_1770_1|ITU_1770_2',
'AlgorithmControl' => 'CORRECT_AUDIO',
'TargetLkfs' => <float>,
],
'AudioSelectorName' => '<string>',
'AudioType' => 'CLEAN_EFFECTS|HEARING_IMPAIRED|UNDEFINED|VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'AudioWatermarkingSettings' => [
'NielsenWatermarksSettings' => [
'NielsenCbetSettings' => [
'CbetCheckDigitString' => '<string>',
'CbetStepaside' => 'DISABLED|ENABLED',
'Csid' => '<string>',
],
'NielsenDistributionType' => 'FINAL_DISTRIBUTOR|PROGRAM_CONTENT',
'NielsenNaesIiNwSettings' => [
'CheckDigitString' => '<string>',
'Sid' => <float>,
'Timezone' => 'AMERICA_PUERTO_RICO|US_ALASKA|US_ARIZONA|US_CENTRAL|US_EASTERN|US_HAWAII|US_MOUNTAIN|US_PACIFIC|US_SAMOA|UTC',
],
],
],
'CodecSettings' => [
'AacSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'AD_RECEIVER_MIX|CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_5_1',
'InputType' => 'BROADCASTER_MIXED_AD|NORMAL',
'Profile' => 'HEV1|HEV2|LC',
'RateControlMode' => 'CBR|VBR',
'RawFormat' => 'LATM_LOAS|NONE',
'SampleRate' => <float>,
'Spec' => 'MPEG2|MPEG4',
'VbrQuality' => 'HIGH|LOW|MEDIUM_HIGH|MEDIUM_LOW',
],
'Ac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|DIALOGUE|EMERGENCY|HEARING_IMPAIRED|MUSIC_AND_EFFECTS|VISUALLY_IMPAIRED|VOICE_OVER',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_3_2_LFE',
'Dialnorm' => <integer>,
'DrcProfile' => 'FILM_STANDARD|NONE',
'LfeFilter' => 'DISABLED|ENABLED',
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
],
'Eac3AtmosSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_5_1_4|CODING_MODE_7_1_4|CODING_MODE_9_1_6',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'HeightTrim' => <float>,
'SurroundTrim' => <float>,
],
'Eac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|EMERGENCY|HEARING_IMPAIRED|VISUALLY_IMPAIRED',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_3_2',
'DcFilter' => 'DISABLED|ENABLED',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'LfeControl' => 'LFE|NO_LFE',
'LfeFilter' => 'DISABLED|ENABLED',
'LoRoCenterMixLevel' => <float>,
'LoRoSurroundMixLevel' => <float>,
'LtRtCenterMixLevel' => <float>,
'LtRtSurroundMixLevel' => <float>,
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'PassthroughControl' => 'NO_PASSTHROUGH|WHEN_POSSIBLE',
'PhaseControl' => 'NO_SHIFT|SHIFT_90_DEGREES',
'StereoDownmix' => 'DPL2|LO_RO|LT_RT|NOT_INDICATED',
'SurroundExMode' => 'DISABLED|ENABLED|NOT_INDICATED',
'SurroundMode' => 'DISABLED|ENABLED|NOT_INDICATED',
],
'Mp2Settings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0',
'SampleRate' => <float>,
],
'PassThroughSettings' => [
],
'WavSettings' => [
'BitDepth' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_4_0|CODING_MODE_8_0',
'SampleRate' => <float>,
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageCodeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'Name' => '<string>',
'RemixSettings' => [
'ChannelMappings' => [
[
'InputChannelLevels' => [
[
'Gain' => <integer>,
'InputChannel' => <integer>,
],
// ...
],
'OutputChannel' => <integer>,
],
// ...
],
'ChannelsIn' => <integer>,
'ChannelsOut' => <integer>,
],
'StreamName' => '<string>',
],
// ...
],
'AvailBlanking' => [
'AvailBlankingImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'State' => 'DISABLED|ENABLED',
],
'AvailConfiguration' => [
'AvailSettings' => [
'Esam' => [
'AcquisitionPointId' => '<string>',
'AdAvailOffset' => <integer>,
'PasswordParam' => '<string>',
'PoisEndpoint' => '<string>',
'Username' => '<string>',
'ZoneIdentity' => '<string>',
],
'Scte35SpliceInsert' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
'Scte35TimeSignalApos' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
],
'Scte35SegmentationScope' => 'ALL_OUTPUT_GROUPS|SCTE35_ENABLED_OUTPUT_GROUPS',
],
'BlackoutSlate' => [
'BlackoutSlateImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkEndBlackout' => 'DISABLED|ENABLED',
'NetworkEndBlackoutImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkId' => '<string>',
'State' => 'DISABLED|ENABLED',
],
'CaptionDescriptions' => [
[
'Accessibility' => 'DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES|IMPLEMENTS_ACCESSIBILITY_FEATURES',
'CaptionDashRoles' => ['<string>', ...],
'CaptionSelectorName' => '<string>',
'DestinationSettings' => [
'AribDestinationSettings' => [
],
'BurnInDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'DvbSubDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'EbuTtDDestinationSettings' => [
'CopyrightHolder' => '<string>',
'FillLineGap' => 'DISABLED|ENABLED',
'FontFamily' => '<string>',
'StyleControl' => 'EXCLUDE|INCLUDE',
],
'EmbeddedDestinationSettings' => [
],
'EmbeddedPlusScte20DestinationSettings' => [
],
'RtmpCaptionInfoDestinationSettings' => [
],
'Scte20PlusEmbeddedDestinationSettings' => [
],
'Scte27DestinationSettings' => [
],
'SmpteTtDestinationSettings' => [
],
'TeletextDestinationSettings' => [
],
'TtmlDestinationSettings' => [
'StyleControl' => 'PASSTHROUGH|USE_CONFIGURED',
],
'WebvttDestinationSettings' => [
'StyleControl' => 'NO_STYLE_DATA|PASSTHROUGH',
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
'Name' => '<string>',
],
// ...
],
'ColorCorrectionSettings' => [
'GlobalColorCorrections' => [
[
'InputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'OutputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'Uri' => '<string>',
],
// ...
],
],
'FeatureActivations' => [
'InputPrepareScheduleActions' => 'DISABLED|ENABLED',
'OutputStaticImageOverlayScheduleActions' => 'DISABLED|ENABLED',
],
'GlobalConfiguration' => [
'InitialAudioGain' => <integer>,
'InputEndAction' => 'NONE|SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior' => [
'BlackFrameMsec' => <integer>,
'InputLossImageColor' => '<string>',
'InputLossImageSlate' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'InputLossImageType' => 'COLOR|SLATE',
'RepeatFrameMsec' => <integer>,
],
'OutputLockingMode' => 'EPOCH_LOCKING|PIPELINE_LOCKING',
'OutputLockingSettings' => [
'EpochLockingSettings' => [
'CustomEpoch' => '<string>',
'JamSyncTime' => '<string>',
],
'PipelineLockingSettings' => [
],
],
'OutputTimingSource' => 'INPUT_CLOCK|SYSTEM_CLOCK',
'SupportLowFramerateInputs' => 'DISABLED|ENABLED',
],
'MotionGraphicsConfiguration' => [
'MotionGraphicsInsertion' => 'DISABLED|ENABLED',
'MotionGraphicsSettings' => [
'HtmlMotionGraphicsSettings' => [
],
],
],
'NielsenConfiguration' => [
'DistributorId' => '<string>',
'NielsenPcmToId3Tagging' => 'DISABLED|ENABLED',
],
'OutputGroups' => [
[
'Name' => '<string>',
'OutputGroupSettings' => [
'ArchiveGroupSettings' => [
'ArchiveCdnSettings' => [
'ArchiveS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'RolloverInterval' => <integer>,
],
'CmafIngestGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvNameModifier' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NielsenId3NameModifier' => '<string>',
'Scte35NameModifier' => '<string>',
'Scte35Type' => 'NONE|SCTE_35_WITHOUT_SEGMENTATION',
'SegmentLength' => <integer>,
'SegmentLengthUnits' => 'MILLISECONDS|SECONDS',
'SendDelayMs' => <integer>,
],
'FrameCaptureGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'FrameCaptureCdnSettings' => [
'FrameCaptureS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
],
'HlsGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'BaseUrlContent' => '<string>',
'BaseUrlContent1' => '<string>',
'BaseUrlManifest' => '<string>',
'BaseUrlManifest1' => '<string>',
'CaptionLanguageMappings' => [
[
'CaptionChannel' => <integer>,
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
],
// ...
],
'CaptionLanguageSetting' => 'INSERT|NONE|OMIT',
'ClientCache' => 'DISABLED|ENABLED',
'CodecSpecification' => 'RFC_4281|RFC_6381',
'ConstantIv' => '<string>',
'Destination' => [
'DestinationRefId' => '<string>',
],
'DirectoryStructure' => 'SINGLE_DIRECTORY|SUBDIRECTORY_PER_STREAM',
'DiscontinuityTags' => 'INSERT|NEVER_INSERT',
'EncryptionType' => 'AES128|SAMPLE_AES',
'HlsCdnSettings' => [
'HlsAkamaiSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'Salt' => '<string>',
'Token' => '<string>',
],
'HlsBasicPutSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsMediaStoreSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'MediaStoreStorageClass' => 'TEMPORAL',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
'HlsWebdavSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
],
'HlsId3SegmentTagging' => 'DISABLED|ENABLED',
'IFrameOnlyPlaylists' => 'DISABLED|STANDARD',
'IncompleteSegmentBehavior' => 'AUTO|SUPPRESS',
'IndexNSegments' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'IvInManifest' => 'EXCLUDE|INCLUDE',
'IvSource' => 'EXPLICIT|FOLLOWS_SEGMENT_NUMBER',
'KeepSegments' => <integer>,
'KeyFormat' => '<string>',
'KeyFormatVersions' => '<string>',
'KeyProviderSettings' => [
'StaticKeySettings' => [
'KeyProviderServer' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'StaticKeyValue' => '<string>',
],
],
'ManifestCompression' => 'GZIP|NONE',
'ManifestDurationFormat' => 'FLOATING_POINT|INTEGER',
'MinSegmentLength' => <integer>,
'Mode' => 'LIVE|VOD',
'OutputSelection' => 'MANIFESTS_AND_SEGMENTS|SEGMENTS_ONLY|VARIANT_MANIFESTS_AND_SEGMENTS',
'ProgramDateTime' => 'EXCLUDE|INCLUDE',
'ProgramDateTimeClock' => 'INITIALIZE_FROM_OUTPUT_TIMECODE|SYSTEM_CLOCK',
'ProgramDateTimePeriod' => <integer>,
'RedundantManifest' => 'DISABLED|ENABLED',
'SegmentLength' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory' => <integer>,
'StreamInfResolution' => 'EXCLUDE|INCLUDE',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
'TimestampDeltaMilliseconds' => <integer>,
'TsFileMode' => 'SEGMENTED_FILES|SINGLE_FILE',
],
'MediaPackageGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'MsSmoothGroupSettings' => [
'AcquisitionPointId' => '<string>',
'AudioOnlyTimecodeControl' => 'PASSTHROUGH|USE_CONFIGURED_CLOCK',
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'EventId' => '<string>',
'EventIdMode' => 'NO_EVENT_ID|USE_CONFIGURED|USE_TIMESTAMP',
'EventStopBehavior' => 'NONE|SEND_EOS',
'FilecacheDuration' => <integer>,
'FragmentLength' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SendDelayMs' => <integer>,
'SparseTrackType' => 'NONE|SCTE_35|SCTE_35_WITHOUT_SEGMENTATION',
'StreamManifestBehavior' => 'DO_NOT_SEND|SEND',
'TimestampOffset' => '<string>',
'TimestampOffsetMode' => 'USE_CONFIGURED_OFFSET|USE_EVENT_START_DATE',
],
'MultiplexGroupSettings' => [
],
'RtmpGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'AuthenticationScheme' => 'AKAMAI|COMMON',
'CacheFullBehavior' => 'DISCONNECT_IMMEDIATELY|WAIT_FOR_SERVER',
'CacheLength' => <integer>,
'CaptionData' => 'ALL|FIELD1_608|FIELD1_AND_FIELD2_608',
'IncludeFillerNalUnits' => 'AUTO|DROP|INCLUDE',
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'RestartDelay' => <integer>,
],
'SrtGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
],
'UdpGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
],
],
'Outputs' => [
[
'AudioDescriptionNames' => ['<string>', ...],
'CaptionDescriptionNames' => ['<string>', ...],
'OutputName' => '<string>',
'OutputSettings' => [
'ArchiveOutputSettings' => [
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
'RawSettings' => [
],
],
'Extension' => '<string>',
'NameModifier' => '<string>',
],
'CmafIngestOutputSettings' => [
'NameModifier' => '<string>',
],
'FrameCaptureOutputSettings' => [
'NameModifier' => '<string>',
],
'HlsOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'HlsSettings' => [
'AudioOnlyHlsSettings' => [
'AudioGroupId' => '<string>',
'AudioOnlyImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'AudioTrackType' => 'ALTERNATE_AUDIO_AUTO_SELECT|ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT|ALTERNATE_AUDIO_NOT_AUTO_SELECT|AUDIO_ONLY_VARIANT_STREAM',
'SegmentType' => 'AAC|FMP4',
],
'Fmp4HlsSettings' => [
'AudioRenditionSets' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
],
'FrameCaptureHlsSettings' => [
],
'StandardHlsSettings' => [
'AudioRenditionSets' => '<string>',
'M3u8Settings' => [
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'EcmPid' => '<string>',
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'Scte35Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'Scte35Pid' => '<string>',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
],
'NameModifier' => '<string>',
'SegmentModifier' => '<string>',
],
'MediaPackageOutputSettings' => [
],
'MsSmoothOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'NameModifier' => '<string>',
],
'MultiplexOutputSettings' => [
'ContainerSettings' => [
'MultiplexM2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioStreamType' => 'ATSC|DVB',
'CcDescriptor' => 'DISABLED|ENABLED',
'Ebif' => 'NONE|PASSTHROUGH',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'Klv' => 'NONE|PASSTHROUGH',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35PrerollPullupMilliseconds' => <float>,
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'RtmpOutputSettings' => [
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'NumRetries' => <integer>,
],
'SrtOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'EncryptionType' => 'AES128|AES192|AES256',
'Latency' => <integer>,
],
'UdpOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'FecOutputSettings' => [
'ColumnDepth' => <integer>,
'IncludeFec' => 'COLUMN|COLUMN_AND_ROW',
'RowLength' => <integer>,
],
],
],
'VideoDescriptionName' => '<string>',
],
// ...
],
],
// ...
],
'ThumbnailConfiguration' => [
'State' => 'AUTO|DISABLED',
],
'TimecodeConfig' => [
'Source' => 'EMBEDDED|SYSTEMCLOCK|ZEROBASED',
'SyncThreshold' => <integer>,
],
'VideoDescriptions' => [
[
'CodecSettings' => [
'Av1Settings' => [
'AfdSignaling' => 'AUTO|FIXED|NONE',
'BufSize' => <integer>,
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'AV1_LEVEL_2|AV1_LEVEL_2_1|AV1_LEVEL_3|AV1_LEVEL_3_1|AV1_LEVEL_4|AV1_LEVEL_4_1|AV1_LEVEL_5|AV1_LEVEL_5_1|AV1_LEVEL_5_2|AV1_LEVEL_5_3|AV1_LEVEL_6|AV1_LEVEL_6_1|AV1_LEVEL_6_2|AV1_LEVEL_6_3|AV1_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'QvbrQualityLevel' => <integer>,
'SceneChangeDetect' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'FrameCaptureSettings' => [
'CaptureInterval' => <integer>,
'CaptureIntervalUnits' => 'MILLISECONDS|SECONDS',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'H264Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'Bitrate' => <integer>,
'BufFillPct' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'EntropyEncoding' => 'CABAC|CAVLC',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'ForceFieldPictures' => 'DISABLED|ENABLED',
'FramerateControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopBReference' => 'DISABLED|ENABLED',
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H264_LEVEL_1|H264_LEVEL_1_1|H264_LEVEL_1_2|H264_LEVEL_1_3|H264_LEVEL_2|H264_LEVEL_2_1|H264_LEVEL_2_2|H264_LEVEL_3|H264_LEVEL_3_1|H264_LEVEL_3_2|H264_LEVEL_4|H264_LEVEL_4_1|H264_LEVEL_4_2|H264_LEVEL_5|H264_LEVEL_5_1|H264_LEVEL_5_2|H264_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'NumRefFrames' => <integer>,
'ParControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'BASELINE|HIGH|HIGH_10BIT|HIGH_422|HIGH_422_10BIT|MAIN',
'QualityLevel' => 'ENHANCED_QUALITY|STANDARD_QUALITY',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR|VBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Softness' => <integer>,
'SpatialAq' => 'DISABLED|ENABLED',
'SubgopLength' => 'DYNAMIC|FIXED',
'Syntax' => 'DEFAULT|RP2027',
'TemporalAq' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
],
'H265Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'AlternativeTransferFunction' => 'INSERT|OMIT',
'Bitrate' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'DolbyVision81Settings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'Deblocking' => 'DISABLED|ENABLED',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H265_LEVEL_1|H265_LEVEL_2|H265_LEVEL_2_1|H265_LEVEL_3|H265_LEVEL_3_1|H265_LEVEL_4|H265_LEVEL_4_1|H265_LEVEL_5|H265_LEVEL_5_1|H265_LEVEL_5_2|H265_LEVEL_6|H265_LEVEL_6_1|H265_LEVEL_6_2|H265_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'MvOverPictureBoundaries' => 'DISABLED|ENABLED',
'MvTemporalPredictor' => 'DISABLED|ENABLED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'MAIN|MAIN_10BIT',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Tier' => 'HIGH|MAIN',
'TileHeight' => <integer>,
'TilePadding' => 'NONE|PADDED',
'TileWidth' => <integer>,
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
'TreeblockSize' => 'AUTO|TREE_SIZE_32X32',
],
'Mpeg2Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|LOW|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpace' => 'AUTO|PASSTHROUGH',
'DisplayAspectRatio' => 'DISPLAYRATIO16X9|DISPLAYRATIO4X3',
'FilterSettings' => [
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SubgopLength' => 'DYNAMIC|FIXED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|GOP_TIMECODE',
],
],
'Height' => <integer>,
'Name' => '<string>',
'RespondToAfd' => 'NONE|PASSTHROUGH|RESPOND',
'ScalingBehavior' => 'DEFAULT|STRETCH_TO_OUTPUT',
'Sharpness' => <integer>,
'Width' => <integer>,
],
// ...
],
],
'Id' => '<string>',
'InputAttachments' => [
[
'AutomaticInputFailoverSettings' => [
'ErrorClearTimeMsec' => <integer>,
'FailoverConditions' => [
[
'FailoverConditionSettings' => [
'AudioSilenceSettings' => [
'AudioSelectorName' => '<string>',
'AudioSilenceThresholdMsec' => <integer>,
],
'InputLossSettings' => [
'InputLossThresholdMsec' => <integer>,
],
'VideoBlackSettings' => [
'BlackDetectThreshold' => <float>,
'VideoBlackThresholdMsec' => <integer>,
],
],
],
// ...
],
'InputPreference' => 'EQUAL_INPUT_PREFERENCE|PRIMARY_INPUT_PREFERRED',
'SecondaryInputId' => '<string>',
],
'InputAttachmentName' => '<string>',
'InputId' => '<string>',
'InputSettings' => [
'AudioSelectors' => [
[
'Name' => '<string>',
'SelectorSettings' => [
'AudioHlsRenditionSelection' => [
'GroupId' => '<string>',
'Name' => '<string>',
],
'AudioLanguageSelection' => [
'LanguageCode' => '<string>',
'LanguageSelectionPolicy' => 'LOOSE|STRICT',
],
'AudioPidSelection' => [
'Pid' => <integer>,
],
'AudioTrackSelection' => [
'DolbyEDecode' => [
'ProgramSelection' => 'ALL_CHANNELS|PROGRAM_1|PROGRAM_2|PROGRAM_3|PROGRAM_4|PROGRAM_5|PROGRAM_6|PROGRAM_7|PROGRAM_8',
],
'Tracks' => [
[
'Track' => <integer>,
],
// ...
],
],
],
],
// ...
],
'CaptionSelectors' => [
[
'LanguageCode' => '<string>',
'Name' => '<string>',
'SelectorSettings' => [
'AncillarySourceSettings' => [
'SourceAncillaryChannelNumber' => <integer>,
],
'AribSourceSettings' => [
],
'DvbSubSourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'EmbeddedSourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Scte20Detection' => 'AUTO|OFF',
'Source608ChannelNumber' => <integer>,
'Source608TrackNumber' => <integer>,
],
'Scte20SourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Source608ChannelNumber' => <integer>,
],
'Scte27SourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'TeletextSourceSettings' => [
'OutputRectangle' => [
'Height' => <float>,
'LeftOffset' => <float>,
'TopOffset' => <float>,
'Width' => <float>,
],
'PageNumber' => '<string>',
],
],
],
// ...
],
'DeblockFilter' => 'DISABLED|ENABLED',
'DenoiseFilter' => 'DISABLED|ENABLED',
'FilterStrength' => <integer>,
'InputFilter' => 'AUTO|DISABLED|FORCED',
'NetworkInputSettings' => [
'HlsInputSettings' => [
'Bandwidth' => <integer>,
'BufferSegments' => <integer>,
'Retries' => <integer>,
'RetryInterval' => <integer>,
'Scte35Source' => 'MANIFEST|SEGMENTS',
],
'MulticastInputSettings' => [
'SourceIpAddress' => '<string>',
],
'ServerValidation' => 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME|CHECK_CRYPTOGRAPHY_ONLY',
],
'Scte35Pid' => <integer>,
'Smpte2038DataPreference' => 'IGNORE|PREFER',
'SourceEndBehavior' => 'CONTINUE|LOOP',
'VideoSelector' => [
'ColorSpace' => 'FOLLOW|HDR10|HLG_2020|REC_601|REC_709',
'ColorSpaceSettings' => [
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
],
'ColorSpaceUsage' => 'FALLBACK|FORCE',
'SelectorSettings' => [
'VideoSelectorPid' => [
'Pid' => <integer>,
],
'VideoSelectorProgramId' => [
'ProgramId' => <integer>,
],
],
],
],
'LogicalInterfaceNames' => ['<string>', ...],
],
// ...
],
'InputSpecification' => [
'Codec' => 'MPEG2|AVC|HEVC',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'Resolution' => 'SD|HD|UHD',
],
'LogLevel' => 'ERROR|WARNING|INFO|DEBUG|DISABLED',
'Maintenance' => [
'MaintenanceDay' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartTime' => '<string>',
],
'Name' => '<string>',
'PipelineDetails' => [
[
'ActiveInputAttachmentName' => '<string>',
'ActiveInputSwitchActionName' => '<string>',
'ActiveMotionGraphicsActionName' => '<string>',
'ActiveMotionGraphicsUri' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'PipelinesRunningCount' => <integer>,
'RoleArn' => '<string>',
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED|UPDATING|UPDATE_FAILED',
'Tags' => ['<string>', ...],
'Vpc' => [
'AvailabilityZones' => ['<string>', ...],
'NetworkInterfaceIds' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
],
]
Result Details
Members
- Channel
-
- Type: Channel structure
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
CreateChannelPlacementGroup
$result = $client->createChannelPlacementGroup([/* ... */]); $promise = $client->createChannelPlacementGroupAsync([/* ... */]);
Create a ChannelPlacementGroup in the specified Cluster. As part of the create operation, you specify the Nodes to attach the group to.After you create a ChannelPlacementGroup, you add Channels to the group (you do this by modifying the Channels to add them to a specific group). You now have an association of Channels to ChannelPlacementGroup, and ChannelPlacementGroup to Nodes. This association means that all the Channels in the group are able to run on any of the Nodes associated with the group.
Parameter Syntax
$result = $client->createChannelPlacementGroup([
'ClusterId' => '<string>', // REQUIRED
'Name' => '<string>',
'Nodes' => ['<string>', ...],
'RequestId' => '<string>',
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
- Name
-
- Type: string
Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive. - Nodes
-
- Type: Array of strings
An array of one ID for the Node that you want to associate with the ChannelPlacementGroup. (You can't associate more than one Node with the ChannelPlacementGroup.) The Node and the ChannelPlacementGroup must be in the same Cluster. - RequestId
-
- Type: string
An ID that you assign to a create request. This ID ensures idempotency when creating resources. the request. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs.
Result Syntax
[
'Arn' => '<string>',
'Channels' => ['<string>', ...],
'ClusterId' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Nodes' => ['<string>', ...],
'State' => 'UNASSIGNED|ASSIGNING|ASSIGNED|DELETING|DELETE_FAILED|DELETED|UNASSIGNING',
]
Result Details
Members
- Arn
-
- Type: string
- Channels
-
- Type: Array of strings
- ClusterId
-
- Type: string
- Id
-
- Type: string
- Name
-
- Type: string
- Nodes
-
- Type: Array of strings
- State
-
- Type: string
Used in DescribeChannelPlacementGroupResult
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
CreateCloudWatchAlarmTemplate
$result = $client->createCloudWatchAlarmTemplate([/* ... */]); $promise = $client->createCloudWatchAlarmTemplateAsync([/* ... */]);
Creates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.
Parameter Syntax
$result = $client->createCloudWatchAlarmTemplate([
'ComparisonOperator' => 'GreaterThanOrEqualToThreshold|GreaterThanThreshold|LessThanThreshold|LessThanOrEqualToThreshold', // REQUIRED
'DatapointsToAlarm' => <integer>,
'Description' => '<string>',
'EvaluationPeriods' => <integer>, // REQUIRED
'GroupIdentifier' => '<string>', // REQUIRED
'MetricName' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'Period' => <integer>, // REQUIRED
'Statistic' => 'SampleCount|Average|Sum|Minimum|Maximum', // REQUIRED
'Tags' => ['<string>', ...],
'TargetResourceType' => 'CLOUDFRONT_DISTRIBUTION|MEDIALIVE_MULTIPLEX|MEDIALIVE_CHANNEL|MEDIALIVE_INPUT_DEVICE|MEDIAPACKAGE_CHANNEL|MEDIAPACKAGE_ORIGIN_ENDPOINT|MEDIACONNECT_FLOW|S3_BUCKET', // REQUIRED
'Threshold' => <float>, // REQUIRED
'TreatMissingData' => 'notBreaching|breaching|ignore|missing', // REQUIRED
]);
Parameter Details
Members
- ComparisonOperator
-
- Required: Yes
- Type: string
The comparison operator used to compare the specified statistic and the threshold. - DatapointsToAlarm
-
- Type: int
- Description
-
- Type: string
- EvaluationPeriods
-
- Required: Yes
- Type: int
- GroupIdentifier
-
- Required: Yes
- Type: string
- MetricName
-
- Required: Yes
- Type: string
- Name
-
- Required: Yes
- Type: string
- Period
-
- Required: Yes
- Type: int
- Statistic
-
- Required: Yes
- Type: string
The statistic to apply to the alarm's metric data. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource. - TargetResourceType
-
- Required: Yes
- Type: string
The resource type this template should dynamically generate cloudwatch metric alarms for. - Threshold
-
- Required: Yes
- Type: double
- TreatMissingData
-
- Required: Yes
- Type: string
Specifies how missing data points are treated when evaluating the alarm's condition.
Result Syntax
[
'Arn' => '<string>',
'ComparisonOperator' => 'GreaterThanOrEqualToThreshold|GreaterThanThreshold|LessThanThreshold|LessThanOrEqualToThreshold',
'CreatedAt' => <DateTime>,
'DatapointsToAlarm' => <integer>,
'Description' => '<string>',
'EvaluationPeriods' => <integer>,
'GroupId' => '<string>',
'Id' => '<string>',
'MetricName' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Period' => <integer>,
'Statistic' => 'SampleCount|Average|Sum|Minimum|Maximum',
'Tags' => ['<string>', ...],
'TargetResourceType' => 'CLOUDFRONT_DISTRIBUTION|MEDIALIVE_MULTIPLEX|MEDIALIVE_CHANNEL|MEDIALIVE_INPUT_DEVICE|MEDIAPACKAGE_CHANNEL|MEDIAPACKAGE_ORIGIN_ENDPOINT|MEDIACONNECT_FLOW|S3_BUCKET',
'Threshold' => <float>,
'TreatMissingData' => 'notBreaching|breaching|ignore|missing',
]
Result Details
Members
- Arn
-
- Type: string
- ComparisonOperator
-
- Type: string
The comparison operator used to compare the specified statistic and the threshold. - CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DatapointsToAlarm
-
- Type: int
- Description
-
- Type: string
- EvaluationPeriods
-
- Type: int
- GroupId
-
- Type: string
- Id
-
- Type: string
- MetricName
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Period
-
- Type: int
- Statistic
-
- Type: string
The statistic to apply to the alarm's metric data. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource. - TargetResourceType
-
- Type: string
The resource type this template should dynamically generate cloudwatch metric alarms for. - Threshold
-
- Type: double
- TreatMissingData
-
- Type: string
Specifies how missing data points are treated when evaluating the alarm's condition.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
CreateCloudWatchAlarmTemplateGroup
$result = $client->createCloudWatchAlarmTemplateGroup([/* ... */]); $promise = $client->createCloudWatchAlarmTemplateGroupAsync([/* ... */]);
Creates a cloudwatch alarm template group to group your cloudwatch alarm templates and to attach to signal maps for dynamically creating alarms.
Parameter Syntax
$result = $client->createCloudWatchAlarmTemplateGroup([
'Description' => '<string>',
'Name' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- Description
-
- Type: string
- Name
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Result Syntax
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- Id
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
CreateCluster
$result = $client->createCluster([/* ... */]); $promise = $client->createClusterAsync([/* ... */]);
Create a new Cluster.
Parameter Syntax
$result = $client->createCluster([
'ClusterType' => 'ON_PREMISES',
'InstanceRoleArn' => '<string>',
'Name' => '<string>',
'NetworkSettings' => [
'DefaultRoute' => '<string>',
'InterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkId' => '<string>',
],
// ...
],
],
'RequestId' => '<string>',
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- ClusterType
-
- Type: string
Specify a type. All the Nodes that you later add to this Cluster must be this type of hardware. One Cluster instance can't contain different hardware types. You won't be able to change this parameter after you create the Cluster. - InstanceRoleArn
-
- Type: string
The ARN of the IAM role for the Node in this Cluster. The role must include all the operations that you expect these Node to perform. If necessary, create a role in IAM, then attach it here. - Name
-
- Type: string
Specify a name that is unique in the AWS account. We recommend that you assign a name that hints at the types of Nodes in the Cluster. Names are case-sensitive. - NetworkSettings
-
- Type: ClusterNetworkSettingsCreateRequest structure
Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with. - RequestId
-
- Type: string
The unique ID of the request. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs.
Result Syntax
[
'Arn' => '<string>',
'ChannelIds' => ['<string>', ...],
'ClusterType' => 'ON_PREMISES',
'Id' => '<string>',
'InstanceRoleArn' => '<string>',
'Name' => '<string>',
'NetworkSettings' => [
'DefaultRoute' => '<string>',
'InterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkId' => '<string>',
],
// ...
],
],
'State' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETE_FAILED|DELETED',
]
Result Details
Members
- Arn
-
- Type: string
- ChannelIds
-
- Type: Array of strings
- ClusterType
-
- Type: string
Used in CreateClusterSummary, DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult. - Id
-
- Type: string
- InstanceRoleArn
-
- Type: string
- Name
-
- Type: string
- NetworkSettings
-
- Type: ClusterNetworkSettings structure
Used in DescribeClusterResult, DescribeClusterSummary, UpdateClusterResult. - State
-
- Type: string
Used in DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
CreateEventBridgeRuleTemplate
$result = $client->createEventBridgeRuleTemplate([/* ... */]); $promise = $client->createEventBridgeRuleTemplateAsync([/* ... */]);
Creates an eventbridge rule template to monitor events and send notifications to your targeted resources.
Parameter Syntax
$result = $client->createEventBridgeRuleTemplate([
'Description' => '<string>',
'EventTargets' => [
[
'Arn' => '<string>', // REQUIRED
],
// ...
],
'EventType' => 'MEDIALIVE_MULTIPLEX_ALERT|MEDIALIVE_MULTIPLEX_STATE_CHANGE|MEDIALIVE_CHANNEL_ALERT|MEDIALIVE_CHANNEL_INPUT_CHANGE|MEDIALIVE_CHANNEL_STATE_CHANGE|MEDIAPACKAGE_INPUT_NOTIFICATION|MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION|MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION|SIGNAL_MAP_ACTIVE_ALARM|MEDIACONNECT_ALERT|MEDIACONNECT_SOURCE_HEALTH|MEDIACONNECT_OUTPUT_HEALTH|MEDIACONNECT_FLOW_STATUS_CHANGE', // REQUIRED
'GroupIdentifier' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- Description
-
- Type: string
- EventTargets
-
- Type: Array of EventBridgeRuleTemplateTarget structures
- EventType
-
- Required: Yes
- Type: string
The type of event to match with the rule. - GroupIdentifier
-
- Required: Yes
- Type: string
- Name
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Result Syntax
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'EventTargets' => [
[
'Arn' => '<string>',
],
// ...
],
'EventType' => 'MEDIALIVE_MULTIPLEX_ALERT|MEDIALIVE_MULTIPLEX_STATE_CHANGE|MEDIALIVE_CHANNEL_ALERT|MEDIALIVE_CHANNEL_INPUT_CHANGE|MEDIALIVE_CHANNEL_STATE_CHANGE|MEDIAPACKAGE_INPUT_NOTIFICATION|MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION|MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION|SIGNAL_MAP_ACTIVE_ALARM|MEDIACONNECT_ALERT|MEDIACONNECT_SOURCE_HEALTH|MEDIACONNECT_OUTPUT_HEALTH|MEDIACONNECT_FLOW_STATUS_CHANGE',
'GroupId' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- EventTargets
-
- Type: Array of EventBridgeRuleTemplateTarget structures
- EventType
-
- Type: string
The type of event to match with the rule. - GroupId
-
- Type: string
- Id
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
CreateEventBridgeRuleTemplateGroup
$result = $client->createEventBridgeRuleTemplateGroup([/* ... */]); $promise = $client->createEventBridgeRuleTemplateGroupAsync([/* ... */]);
Creates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.
Parameter Syntax
$result = $client->createEventBridgeRuleTemplateGroup([
'Description' => '<string>',
'Name' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- Description
-
- Type: string
- Name
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Result Syntax
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- Id
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
CreateInput
$result = $client->createInput([/* ... */]); $promise = $client->createInputAsync([/* ... */]);
Create an input
Parameter Syntax
$result = $client->createInput([
'Destinations' => [
[
'Network' => '<string>',
'NetworkRoutes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'StaticIpAddress' => '<string>',
'StreamName' => '<string>',
],
// ...
],
'InputDevices' => [
[
'Id' => '<string>',
],
// ...
],
'InputNetworkLocation' => 'AWS|ON_PREMISES',
'InputSecurityGroups' => ['<string>', ...],
'MediaConnectFlows' => [
[
'FlowArn' => '<string>',
],
// ...
],
'MulticastSettings' => [
'Sources' => [
[
'SourceIp' => '<string>',
'Url' => '<string>', // REQUIRED
],
// ...
],
],
'Name' => '<string>',
'RequestId' => '<string>',
'RoleArn' => '<string>',
'Sources' => [
[
'PasswordParam' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
'SrtCallerSources' => [
[
'Decryption' => [
'Algorithm' => 'AES128|AES192|AES256',
'PassphraseSecretArn' => '<string>',
],
'MinimumLatency' => <integer>,
'SrtListenerAddress' => '<string>',
'SrtListenerPort' => '<string>',
'StreamId' => '<string>',
],
// ...
],
],
'Tags' => ['<string>', ...],
'Type' => 'UDP_PUSH|RTP_PUSH|RTMP_PUSH|RTMP_PULL|URL_PULL|MP4_FILE|MEDIACONNECT|INPUT_DEVICE|AWS_CDI|TS_FILE|SRT_CALLER|MULTICAST',
'Vpc' => [
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...], // REQUIRED
],
]);
Parameter Details
Members
- Destinations
-
- Type: Array of InputDestinationRequest structures
- InputDevices
-
- Type: Array of InputDeviceSettings structures
- InputNetworkLocation
-
- Type: string
With the introduction of MediaLive Anywhere, a MediaLive input can now exist in two different places: AWS orinside an on-premises datacenter. By default all inputs will continue to be AWS inputs. - InputSecurityGroups
-
- Type: Array of strings
- MediaConnectFlows
-
- Type: Array of MediaConnectFlowRequest structures
- MulticastSettings
-
- Type: MulticastSettingsCreateRequest structure
Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses. - Name
-
- Type: string
- RequestId
-
- Type: string
- RoleArn
-
- Type: string
- Sources
-
- Type: Array of InputSourceRequest structures
- SrtSettings
-
- Type: SrtSettingsRequest structure
Configures the sources for this SRT input. For a single-pipeline input, include one srtCallerSource in the array. For a standard-pipeline input, include two srtCallerSource. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Type
-
- Type: string
The different types of inputs that AWS Elemental MediaLive supports. - Vpc
-
- Type: InputVpcRequest structure
Settings for a private VPC Input.When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses.This property requires setting the roleArn property on Input creation.Not compatible with the inputSecurityGroups property.
Result Syntax
[
'Input' => [
'Arn' => '<string>',
'AttachedChannels' => ['<string>', ...],
'Destinations' => [
[
'Ip' => '<string>',
'Network' => '<string>',
'NetworkRoutes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'Port' => '<string>',
'Url' => '<string>',
'Vpc' => [
'AvailabilityZone' => '<string>',
'NetworkInterfaceId' => '<string>',
],
],
// ...
],
'Id' => '<string>',
'InputClass' => 'STANDARD|SINGLE_PIPELINE',
'InputDevices' => [
[
'Id' => '<string>',
],
// ...
],
'InputNetworkLocation' => 'AWS|ON_PREMISES',
'InputPartnerIds' => ['<string>', ...],
'InputSourceType' => 'STATIC|DYNAMIC',
'MediaConnectFlows' => [
[
'FlowArn' => '<string>',
],
// ...
],
'MulticastSettings' => [
'Sources' => [
[
'SourceIp' => '<string>',
'Url' => '<string>',
],
// ...
],
],
'Name' => '<string>',
'RoleArn' => '<string>',
'SecurityGroups' => ['<string>', ...],
'Sources' => [
[
'PasswordParam' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
'SrtCallerSources' => [
[
'Decryption' => [
'Algorithm' => 'AES128|AES192|AES256',
'PassphraseSecretArn' => '<string>',
],
'MinimumLatency' => <integer>,
'SrtListenerAddress' => '<string>',
'SrtListenerPort' => '<string>',
'StreamId' => '<string>',
],
// ...
],
],
'State' => 'CREATING|DETACHED|ATTACHED|DELETING|DELETED',
'Tags' => ['<string>', ...],
'Type' => 'UDP_PUSH|RTP_PUSH|RTMP_PUSH|RTMP_PULL|URL_PULL|MP4_FILE|MEDIACONNECT|INPUT_DEVICE|AWS_CDI|TS_FILE|SRT_CALLER|MULTICAST',
],
]
Result Details
Members
- Input
-
- Type: Input structure
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
CreateInputSecurityGroup
$result = $client->createInputSecurityGroup([/* ... */]); $promise = $client->createInputSecurityGroupAsync([/* ... */]);
Creates a Input Security Group
Parameter Syntax
$result = $client->createInputSecurityGroup([
'Tags' => ['<string>', ...],
'WhitelistRules' => [
[
'Cidr' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- WhitelistRules
-
- Type: Array of InputWhitelistRuleCidr structures
Result Syntax
[
'SecurityGroup' => [
'Arn' => '<string>',
'Id' => '<string>',
'Inputs' => ['<string>', ...],
'State' => 'IDLE|IN_USE|UPDATING|DELETED',
'Tags' => ['<string>', ...],
'WhitelistRules' => [
[
'Cidr' => '<string>',
],
// ...
],
],
]
Result Details
Members
- SecurityGroup
-
- Type: InputSecurityGroup structure
An Input Security Group
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
CreateMultiplex
$result = $client->createMultiplex([/* ... */]); $promise = $client->createMultiplexAsync([/* ... */]);
Create a new multiplex.
Parameter Syntax
$result = $client->createMultiplex([
'AvailabilityZones' => ['<string>', ...], // REQUIRED
'MultiplexSettings' => [ // REQUIRED
'MaximumVideoBufferDelayMilliseconds' => <integer>,
'TransportStreamBitrate' => <integer>, // REQUIRED
'TransportStreamId' => <integer>, // REQUIRED
'TransportStreamReservedBitrate' => <integer>,
],
'Name' => '<string>', // REQUIRED
'RequestId' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- AvailabilityZones
-
- Required: Yes
- Type: Array of strings
- MultiplexSettings
-
- Required: Yes
- Type: MultiplexSettings structure
Contains configuration for a Multiplex event - Name
-
- Required: Yes
- Type: string
- RequestId
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Result Syntax
[
'Multiplex' => [
'Arn' => '<string>',
'AvailabilityZones' => ['<string>', ...],
'Destinations' => [
[
'MediaConnectSettings' => [
'EntitlementArn' => '<string>',
],
],
// ...
],
'Id' => '<string>',
'MultiplexSettings' => [
'MaximumVideoBufferDelayMilliseconds' => <integer>,
'TransportStreamBitrate' => <integer>,
'TransportStreamId' => <integer>,
'TransportStreamReservedBitrate' => <integer>,
],
'Name' => '<string>',
'PipelinesRunningCount' => <integer>,
'ProgramCount' => <integer>,
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED',
'Tags' => ['<string>', ...],
],
]
Result Details
Members
- Multiplex
-
- Type: Multiplex structure
The multiplex object.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
CreateMultiplexProgram
$result = $client->createMultiplexProgram([/* ... */]); $promise = $client->createMultiplexProgramAsync([/* ... */]);
Create a new program in the multiplex.
Parameter Syntax
$result = $client->createMultiplexProgram([
'MultiplexId' => '<string>', // REQUIRED
'MultiplexProgramSettings' => [ // REQUIRED
'PreferredChannelPipeline' => 'CURRENTLY_ACTIVE|PIPELINE_0|PIPELINE_1',
'ProgramNumber' => <integer>, // REQUIRED
'ServiceDescriptor' => [
'ProviderName' => '<string>', // REQUIRED
'ServiceName' => '<string>', // REQUIRED
],
'VideoSettings' => [
'ConstantBitrate' => <integer>,
'StatmuxSettings' => [
'MaximumBitrate' => <integer>,
'MinimumBitrate' => <integer>,
'Priority' => <integer>,
],
],
],
'ProgramName' => '<string>', // REQUIRED
'RequestId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MultiplexId
-
- Required: Yes
- Type: string
- MultiplexProgramSettings
-
- Required: Yes
- Type: MultiplexProgramSettings structure
Multiplex Program settings configuration. - ProgramName
-
- Required: Yes
- Type: string
- RequestId
-
- Required: Yes
- Type: string
Result Syntax
[
'MultiplexProgram' => [
'ChannelId' => '<string>',
'MultiplexProgramSettings' => [
'PreferredChannelPipeline' => 'CURRENTLY_ACTIVE|PIPELINE_0|PIPELINE_1',
'ProgramNumber' => <integer>,
'ServiceDescriptor' => [
'ProviderName' => '<string>',
'ServiceName' => '<string>',
],
'VideoSettings' => [
'ConstantBitrate' => <integer>,
'StatmuxSettings' => [
'MaximumBitrate' => <integer>,
'MinimumBitrate' => <integer>,
'Priority' => <integer>,
],
],
],
'PacketIdentifiersMap' => [
'AribCaptionsPid' => <integer>,
'AudioPids' => [<integer>, ...],
'DvbSubPids' => [<integer>, ...],
'DvbTeletextPid' => <integer>,
'DvbTeletextPids' => [<integer>, ...],
'EcmPid' => <integer>,
'EtvPlatformPid' => <integer>,
'EtvSignalPid' => <integer>,
'KlvDataPids' => [<integer>, ...],
'PcrPid' => <integer>,
'PmtPid' => <integer>,
'PrivateMetadataPid' => <integer>,
'Scte27Pids' => [<integer>, ...],
'Scte35Pid' => <integer>,
'Smpte2038Pid' => <integer>,
'TimedMetadataPid' => <integer>,
'VideoPid' => <integer>,
],
'PipelineDetails' => [
[
'ActiveChannelPipeline' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'ProgramName' => '<string>',
],
]
Result Details
Members
- MultiplexProgram
-
- Type: MultiplexProgram structure
The multiplex program object.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
CreateNetwork
$result = $client->createNetwork([/* ... */]); $promise = $client->createNetworkAsync([/* ... */]);
Create as many Networks as you need. You will associate one or more Clusters with each Network.Each Network provides MediaLive Anywhere with required information about the network in your organization that you are using for video encoding using MediaLive.
Parameter Syntax
$result = $client->createNetwork([
'IpPools' => [
[
'Cidr' => '<string>',
],
// ...
],
'Name' => '<string>',
'RequestId' => '<string>',
'Routes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- IpPools
-
- Type: Array of IpPoolCreateRequest structures
An array of IpPoolCreateRequests that identify a collection of IP addresses in your network that you want to reserve for use in MediaLive Anywhere. MediaLiveAnywhere uses these IP addresses for Push inputs (in both Bridge and NATnetworks) and for output destinations (only in Bridge networks). EachIpPoolUpdateRequest specifies one CIDR block. - Name
-
- Type: string
Specify a name that is unique in the AWS account. We recommend that you assign a name that hints at the type of traffic on the network. Names are case-sensitive. - RequestId
-
- Type: string
An ID that you assign to a create request. This ID ensures idempotency when creating resources. - Routes
-
- Type: Array of RouteCreateRequest structures
An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs.
Result Syntax
[
'Arn' => '<string>',
'AssociatedClusterIds' => ['<string>', ...],
'Id' => '<string>',
'IpPools' => [
[
'Cidr' => '<string>',
],
// ...
],
'Name' => '<string>',
'Routes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'State' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|IDLE|IN_USE|UPDATING|DELETE_FAILED|DELETED',
]
Result Details
Members
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
CreateNode
$result = $client->createNode([/* ... */]); $promise = $client->createNodeAsync([/* ... */]);
Create a Node in the specified Cluster. You can also create Nodes using the CreateNodeRegistrationScript. Note that you can't move a Node to another Cluster.
Parameter Syntax
$result = $client->createNode([
'ClusterId' => '<string>', // REQUIRED
'Name' => '<string>',
'NodeInterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkInterfaceMode' => 'NAT|BRIDGE',
'PhysicalInterfaceName' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Role' => 'BACKUP|ACTIVE',
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
- Name
-
- Type: string
The user-specified name of the Node to be created. - NodeInterfaceMappings
-
- Type: Array of NodeInterfaceMappingCreateRequest structures
An array of interface mappings for the Node. Each mapping logically connects one physical interface on the node hardware with one logical interface name. You created the logical names in the logicalInterfaceName parameter when you created the Cluster. Create one mapping for each physical interface on the node, but only for node interfaces that you plan to use for encoding content traffic (and not for any management-only interface). In each mapping pair, we recommend that you specify the logical name first, then assign the physical name that applies.The physicalInterfaceName is the final piece of data that associates a node interface with a network. The association works as follows: Node physicalInterfaceName > Node logicalInterfaceName = Cluster logicalInterfaceName > networkId. - RequestId
-
- Type: string
An ID that you assign to a create request. This ID ensures idempotency when creating resources. - Role
-
- Type: string
The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs.
Result Syntax
[
'Arn' => '<string>',
'ChannelPlacementGroups' => ['<string>', ...],
'ClusterId' => '<string>',
'ConnectionState' => 'CONNECTED|DISCONNECTED',
'Id' => '<string>',
'InstanceArn' => '<string>',
'Name' => '<string>',
'NodeInterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkInterfaceMode' => 'NAT|BRIDGE',
'PhysicalInterfaceName' => '<string>',
],
// ...
],
'Role' => 'BACKUP|ACTIVE',
'State' => 'CREATED|REGISTERING|READY_TO_ACTIVATE|REGISTRATION_FAILED|ACTIVATION_FAILED|ACTIVE|READY|IN_USE|DEREGISTERING|DRAINING|DEREGISTRATION_FAILED|DEREGISTERED',
]
Result Details
Members
- Arn
-
- Type: string
- ChannelPlacementGroups
-
- Type: Array of strings
- ClusterId
-
- Type: string
- ConnectionState
-
- Type: string
Used in DescribeNodeSummary. - Id
-
- Type: string
- InstanceArn
-
- Type: string
- Name
-
- Type: string
- NodeInterfaceMappings
-
- Type: Array of NodeInterfaceMapping structures
- Role
-
- Type: string
Used in CreateNodeRequest, CreateNodeRegistrationScriptRequest, DescribeNodeResult, DescribeNodeSummary, UpdateNodeRequest. - State
-
- Type: string
Used in DescribeNodeSummary.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
CreateNodeRegistrationScript
$result = $client->createNodeRegistrationScript([/* ... */]); $promise = $client->createNodeRegistrationScriptAsync([/* ... */]);
Create the Register Node script for all the nodes intended for a specific Cluster. You will then run the script on each hardware unit that is intended for that Cluster. The script creates a Node in the specified Cluster. It then binds the Node to this hardware unit, and activates the node hardware for use with MediaLive Anywhere.
Parameter Syntax
$result = $client->createNodeRegistrationScript([
'ClusterId' => '<string>', // REQUIRED
'Id' => '<string>',
'Name' => '<string>',
'NodeInterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkInterfaceMode' => 'NAT|BRIDGE',
'PhysicalInterfaceName' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Role' => 'BACKUP|ACTIVE',
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
- Id
-
- Type: string
If you're generating a re-registration script for an already existing node, this is where you provide the id. - Name
-
- Type: string
Specify a pattern for MediaLive Anywhere to use to assign a name to each Node in the Cluster. The pattern can include the variables $hn (hostname of the node hardware) and $ts for the date and time that the Node is created, in UTC (for example, 2024-08-20T23:35:12Z). - NodeInterfaceMappings
-
- Type: Array of NodeInterfaceMapping structures
An array of interface mappings for the Node. Each mapping logically connects one physical interface on the node hardware with one logical interface name. This mapping associates a node interface with a network. The association works as follows: Node physicalInterfaceName > Node logicalInterfaceName = Cluster logicalInterfaceName > networkId. - RequestId
-
- Type: string
An ID that you assign to a create request. This ID ensures idempotency when creating resources. - Role
-
- Type: string
The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
Result Syntax
[
'NodeRegistrationScript' => '<string>',
]
Result Details
Members
- NodeRegistrationScript
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
CreatePartnerInput
$result = $client->createPartnerInput([/* ... */]); $promise = $client->createPartnerInputAsync([/* ... */]);
Create a partner input
Parameter Syntax
$result = $client->createPartnerInput([
'InputId' => '<string>', // REQUIRED
'RequestId' => '<string>',
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- InputId
-
- Required: Yes
- Type: string
- RequestId
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Result Syntax
[
'Input' => [
'Arn' => '<string>',
'AttachedChannels' => ['<string>', ...],
'Destinations' => [
[
'Ip' => '<string>',
'Network' => '<string>',
'NetworkRoutes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'Port' => '<string>',
'Url' => '<string>',
'Vpc' => [
'AvailabilityZone' => '<string>',
'NetworkInterfaceId' => '<string>',
],
],
// ...
],
'Id' => '<string>',
'InputClass' => 'STANDARD|SINGLE_PIPELINE',
'InputDevices' => [
[
'Id' => '<string>',
],
// ...
],
'InputNetworkLocation' => 'AWS|ON_PREMISES',
'InputPartnerIds' => ['<string>', ...],
'InputSourceType' => 'STATIC|DYNAMIC',
'MediaConnectFlows' => [
[
'FlowArn' => '<string>',
],
// ...
],
'MulticastSettings' => [
'Sources' => [
[
'SourceIp' => '<string>',
'Url' => '<string>',
],
// ...
],
],
'Name' => '<string>',
'RoleArn' => '<string>',
'SecurityGroups' => ['<string>', ...],
'Sources' => [
[
'PasswordParam' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
'SrtCallerSources' => [
[
'Decryption' => [
'Algorithm' => 'AES128|AES192|AES256',
'PassphraseSecretArn' => '<string>',
],
'MinimumLatency' => <integer>,
'SrtListenerAddress' => '<string>',
'SrtListenerPort' => '<string>',
'StreamId' => '<string>',
],
// ...
],
],
'State' => 'CREATING|DETACHED|ATTACHED|DELETING|DELETED',
'Tags' => ['<string>', ...],
'Type' => 'UDP_PUSH|RTP_PUSH|RTMP_PUSH|RTMP_PULL|URL_PULL|MP4_FILE|MEDIACONNECT|INPUT_DEVICE|AWS_CDI|TS_FILE|SRT_CALLER|MULTICAST',
],
]
Result Details
Members
- Input
-
- Type: Input structure
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
CreateSignalMap
$result = $client->createSignalMap([/* ... */]); $promise = $client->createSignalMapAsync([/* ... */]);
Initiates the creation of a new signal map. Will discover a new mediaResourceMap based on the provided discoveryEntryPointArn.
Parameter Syntax
$result = $client->createSignalMap([
'CloudWatchAlarmTemplateGroupIdentifiers' => ['<string>', ...],
'Description' => '<string>',
'DiscoveryEntryPointArn' => '<string>', // REQUIRED
'EventBridgeRuleTemplateGroupIdentifiers' => ['<string>', ...],
'Name' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- CloudWatchAlarmTemplateGroupIdentifiers
-
- Type: Array of strings
- Description
-
- Type: string
- DiscoveryEntryPointArn
-
- Required: Yes
- Type: string
- EventBridgeRuleTemplateGroupIdentifiers
-
- Type: Array of strings
- Name
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Result Syntax
[
'Arn' => '<string>',
'CloudWatchAlarmTemplateGroupIds' => ['<string>', ...],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DiscoveryEntryPointArn' => '<string>',
'ErrorMessage' => '<string>',
'EventBridgeRuleTemplateGroupIds' => ['<string>', ...],
'FailedMediaResourceMap' => [
'<__string>' => [
'Destinations' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
'Name' => '<string>',
'Sources' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
],
// ...
],
'Id' => '<string>',
'LastDiscoveredAt' => <DateTime>,
'LastSuccessfulMonitorDeployment' => [
'DetailsUri' => '<string>',
'Status' => 'NOT_DEPLOYED|DRY_RUN_DEPLOYMENT_COMPLETE|DRY_RUN_DEPLOYMENT_FAILED|DRY_RUN_DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_COMPLETE|DEPLOYMENT_FAILED|DEPLOYMENT_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_IN_PROGRESS',
],
'MediaResourceMap' => [
'<__string>' => [
'Destinations' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
'Name' => '<string>',
'Sources' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
],
// ...
],
'ModifiedAt' => <DateTime>,
'MonitorChangesPendingDeployment' => true || false,
'MonitorDeployment' => [
'DetailsUri' => '<string>',
'ErrorMessage' => '<string>',
'Status' => 'NOT_DEPLOYED|DRY_RUN_DEPLOYMENT_COMPLETE|DRY_RUN_DEPLOYMENT_FAILED|DRY_RUN_DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_COMPLETE|DEPLOYMENT_FAILED|DEPLOYMENT_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_IN_PROGRESS',
],
'Name' => '<string>',
'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_REVERTED|UPDATE_FAILED|READY|NOT_READY',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CloudWatchAlarmTemplateGroupIds
-
- Type: Array of strings
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- DiscoveryEntryPointArn
-
- Type: string
- ErrorMessage
-
- Type: string
- EventBridgeRuleTemplateGroupIds
-
- Type: Array of strings
- FailedMediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an incomplete AWS media workflow as a graph. - Id
-
- Type: string
- LastDiscoveredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastSuccessfulMonitorDeployment
-
- Type: SuccessfulMonitorDeployment structure
Represents the latest successful monitor deployment of a signal map. - MediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an AWS media workflow as a graph. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- MonitorChangesPendingDeployment
-
- Type: boolean
- MonitorDeployment
-
- Type: MonitorDeployment structure
Represents the latest monitor deployment of a signal map. - Name
-
- Type: string
- Status
-
- Type: string
A signal map's current status which is dependent on its lifecycle actions or associated jobs. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
CreateTags
$result = $client->createTags([/* ... */]); $promise = $client->createTagsAsync([/* ... */]);
Create tags for a resource
Parameter Syntax
$result = $client->createTags([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- NotFoundException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
DeleteChannel
$result = $client->deleteChannel([/* ... */]); $promise = $client->deleteChannelAsync([/* ... */]);
Starts deletion of channel. The associated outputs are also deleted.
Parameter Syntax
$result = $client->deleteChannel([
'ChannelId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ChannelId
-
- Required: Yes
- Type: string
Result Syntax
[
'AnywhereSettings' => [
'ChannelPlacementGroupId' => '<string>',
'ClusterId' => '<string>',
],
'Arn' => '<string>',
'CdiInputSpecification' => [
'Resolution' => 'SD|HD|FHD|UHD',
],
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
'EgressEndpoints' => [
[
'SourceIp' => '<string>',
],
// ...
],
'EncoderSettings' => [
'AudioDescriptions' => [
[
'AudioDashRoles' => ['<string>', ...],
'AudioNormalizationSettings' => [
'Algorithm' => 'ITU_1770_1|ITU_1770_2',
'AlgorithmControl' => 'CORRECT_AUDIO',
'TargetLkfs' => <float>,
],
'AudioSelectorName' => '<string>',
'AudioType' => 'CLEAN_EFFECTS|HEARING_IMPAIRED|UNDEFINED|VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'AudioWatermarkingSettings' => [
'NielsenWatermarksSettings' => [
'NielsenCbetSettings' => [
'CbetCheckDigitString' => '<string>',
'CbetStepaside' => 'DISABLED|ENABLED',
'Csid' => '<string>',
],
'NielsenDistributionType' => 'FINAL_DISTRIBUTOR|PROGRAM_CONTENT',
'NielsenNaesIiNwSettings' => [
'CheckDigitString' => '<string>',
'Sid' => <float>,
'Timezone' => 'AMERICA_PUERTO_RICO|US_ALASKA|US_ARIZONA|US_CENTRAL|US_EASTERN|US_HAWAII|US_MOUNTAIN|US_PACIFIC|US_SAMOA|UTC',
],
],
],
'CodecSettings' => [
'AacSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'AD_RECEIVER_MIX|CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_5_1',
'InputType' => 'BROADCASTER_MIXED_AD|NORMAL',
'Profile' => 'HEV1|HEV2|LC',
'RateControlMode' => 'CBR|VBR',
'RawFormat' => 'LATM_LOAS|NONE',
'SampleRate' => <float>,
'Spec' => 'MPEG2|MPEG4',
'VbrQuality' => 'HIGH|LOW|MEDIUM_HIGH|MEDIUM_LOW',
],
'Ac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|DIALOGUE|EMERGENCY|HEARING_IMPAIRED|MUSIC_AND_EFFECTS|VISUALLY_IMPAIRED|VOICE_OVER',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_3_2_LFE',
'Dialnorm' => <integer>,
'DrcProfile' => 'FILM_STANDARD|NONE',
'LfeFilter' => 'DISABLED|ENABLED',
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
],
'Eac3AtmosSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_5_1_4|CODING_MODE_7_1_4|CODING_MODE_9_1_6',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'HeightTrim' => <float>,
'SurroundTrim' => <float>,
],
'Eac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|EMERGENCY|HEARING_IMPAIRED|VISUALLY_IMPAIRED',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_3_2',
'DcFilter' => 'DISABLED|ENABLED',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'LfeControl' => 'LFE|NO_LFE',
'LfeFilter' => 'DISABLED|ENABLED',
'LoRoCenterMixLevel' => <float>,
'LoRoSurroundMixLevel' => <float>,
'LtRtCenterMixLevel' => <float>,
'LtRtSurroundMixLevel' => <float>,
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'PassthroughControl' => 'NO_PASSTHROUGH|WHEN_POSSIBLE',
'PhaseControl' => 'NO_SHIFT|SHIFT_90_DEGREES',
'StereoDownmix' => 'DPL2|LO_RO|LT_RT|NOT_INDICATED',
'SurroundExMode' => 'DISABLED|ENABLED|NOT_INDICATED',
'SurroundMode' => 'DISABLED|ENABLED|NOT_INDICATED',
],
'Mp2Settings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0',
'SampleRate' => <float>,
],
'PassThroughSettings' => [
],
'WavSettings' => [
'BitDepth' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_4_0|CODING_MODE_8_0',
'SampleRate' => <float>,
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageCodeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'Name' => '<string>',
'RemixSettings' => [
'ChannelMappings' => [
[
'InputChannelLevels' => [
[
'Gain' => <integer>,
'InputChannel' => <integer>,
],
// ...
],
'OutputChannel' => <integer>,
],
// ...
],
'ChannelsIn' => <integer>,
'ChannelsOut' => <integer>,
],
'StreamName' => '<string>',
],
// ...
],
'AvailBlanking' => [
'AvailBlankingImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'State' => 'DISABLED|ENABLED',
],
'AvailConfiguration' => [
'AvailSettings' => [
'Esam' => [
'AcquisitionPointId' => '<string>',
'AdAvailOffset' => <integer>,
'PasswordParam' => '<string>',
'PoisEndpoint' => '<string>',
'Username' => '<string>',
'ZoneIdentity' => '<string>',
],
'Scte35SpliceInsert' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
'Scte35TimeSignalApos' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
],
'Scte35SegmentationScope' => 'ALL_OUTPUT_GROUPS|SCTE35_ENABLED_OUTPUT_GROUPS',
],
'BlackoutSlate' => [
'BlackoutSlateImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkEndBlackout' => 'DISABLED|ENABLED',
'NetworkEndBlackoutImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkId' => '<string>',
'State' => 'DISABLED|ENABLED',
],
'CaptionDescriptions' => [
[
'Accessibility' => 'DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES|IMPLEMENTS_ACCESSIBILITY_FEATURES',
'CaptionDashRoles' => ['<string>', ...],
'CaptionSelectorName' => '<string>',
'DestinationSettings' => [
'AribDestinationSettings' => [
],
'BurnInDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'DvbSubDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'EbuTtDDestinationSettings' => [
'CopyrightHolder' => '<string>',
'FillLineGap' => 'DISABLED|ENABLED',
'FontFamily' => '<string>',
'StyleControl' => 'EXCLUDE|INCLUDE',
],
'EmbeddedDestinationSettings' => [
],
'EmbeddedPlusScte20DestinationSettings' => [
],
'RtmpCaptionInfoDestinationSettings' => [
],
'Scte20PlusEmbeddedDestinationSettings' => [
],
'Scte27DestinationSettings' => [
],
'SmpteTtDestinationSettings' => [
],
'TeletextDestinationSettings' => [
],
'TtmlDestinationSettings' => [
'StyleControl' => 'PASSTHROUGH|USE_CONFIGURED',
],
'WebvttDestinationSettings' => [
'StyleControl' => 'NO_STYLE_DATA|PASSTHROUGH',
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
'Name' => '<string>',
],
// ...
],
'ColorCorrectionSettings' => [
'GlobalColorCorrections' => [
[
'InputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'OutputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'Uri' => '<string>',
],
// ...
],
],
'FeatureActivations' => [
'InputPrepareScheduleActions' => 'DISABLED|ENABLED',
'OutputStaticImageOverlayScheduleActions' => 'DISABLED|ENABLED',
],
'GlobalConfiguration' => [
'InitialAudioGain' => <integer>,
'InputEndAction' => 'NONE|SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior' => [
'BlackFrameMsec' => <integer>,
'InputLossImageColor' => '<string>',
'InputLossImageSlate' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'InputLossImageType' => 'COLOR|SLATE',
'RepeatFrameMsec' => <integer>,
],
'OutputLockingMode' => 'EPOCH_LOCKING|PIPELINE_LOCKING',
'OutputLockingSettings' => [
'EpochLockingSettings' => [
'CustomEpoch' => '<string>',
'JamSyncTime' => '<string>',
],
'PipelineLockingSettings' => [
],
],
'OutputTimingSource' => 'INPUT_CLOCK|SYSTEM_CLOCK',
'SupportLowFramerateInputs' => 'DISABLED|ENABLED',
],
'MotionGraphicsConfiguration' => [
'MotionGraphicsInsertion' => 'DISABLED|ENABLED',
'MotionGraphicsSettings' => [
'HtmlMotionGraphicsSettings' => [
],
],
],
'NielsenConfiguration' => [
'DistributorId' => '<string>',
'NielsenPcmToId3Tagging' => 'DISABLED|ENABLED',
],
'OutputGroups' => [
[
'Name' => '<string>',
'OutputGroupSettings' => [
'ArchiveGroupSettings' => [
'ArchiveCdnSettings' => [
'ArchiveS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'RolloverInterval' => <integer>,
],
'CmafIngestGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvNameModifier' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NielsenId3NameModifier' => '<string>',
'Scte35NameModifier' => '<string>',
'Scte35Type' => 'NONE|SCTE_35_WITHOUT_SEGMENTATION',
'SegmentLength' => <integer>,
'SegmentLengthUnits' => 'MILLISECONDS|SECONDS',
'SendDelayMs' => <integer>,
],
'FrameCaptureGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'FrameCaptureCdnSettings' => [
'FrameCaptureS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
],
'HlsGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'BaseUrlContent' => '<string>',
'BaseUrlContent1' => '<string>',
'BaseUrlManifest' => '<string>',
'BaseUrlManifest1' => '<string>',
'CaptionLanguageMappings' => [
[
'CaptionChannel' => <integer>,
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
],
// ...
],
'CaptionLanguageSetting' => 'INSERT|NONE|OMIT',
'ClientCache' => 'DISABLED|ENABLED',
'CodecSpecification' => 'RFC_4281|RFC_6381',
'ConstantIv' => '<string>',
'Destination' => [
'DestinationRefId' => '<string>',
],
'DirectoryStructure' => 'SINGLE_DIRECTORY|SUBDIRECTORY_PER_STREAM',
'DiscontinuityTags' => 'INSERT|NEVER_INSERT',
'EncryptionType' => 'AES128|SAMPLE_AES',
'HlsCdnSettings' => [
'HlsAkamaiSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'Salt' => '<string>',
'Token' => '<string>',
],
'HlsBasicPutSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsMediaStoreSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'MediaStoreStorageClass' => 'TEMPORAL',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
'HlsWebdavSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
],
'HlsId3SegmentTagging' => 'DISABLED|ENABLED',
'IFrameOnlyPlaylists' => 'DISABLED|STANDARD',
'IncompleteSegmentBehavior' => 'AUTO|SUPPRESS',
'IndexNSegments' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'IvInManifest' => 'EXCLUDE|INCLUDE',
'IvSource' => 'EXPLICIT|FOLLOWS_SEGMENT_NUMBER',
'KeepSegments' => <integer>,
'KeyFormat' => '<string>',
'KeyFormatVersions' => '<string>',
'KeyProviderSettings' => [
'StaticKeySettings' => [
'KeyProviderServer' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'StaticKeyValue' => '<string>',
],
],
'ManifestCompression' => 'GZIP|NONE',
'ManifestDurationFormat' => 'FLOATING_POINT|INTEGER',
'MinSegmentLength' => <integer>,
'Mode' => 'LIVE|VOD',
'OutputSelection' => 'MANIFESTS_AND_SEGMENTS|SEGMENTS_ONLY|VARIANT_MANIFESTS_AND_SEGMENTS',
'ProgramDateTime' => 'EXCLUDE|INCLUDE',
'ProgramDateTimeClock' => 'INITIALIZE_FROM_OUTPUT_TIMECODE|SYSTEM_CLOCK',
'ProgramDateTimePeriod' => <integer>,
'RedundantManifest' => 'DISABLED|ENABLED',
'SegmentLength' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory' => <integer>,
'StreamInfResolution' => 'EXCLUDE|INCLUDE',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
'TimestampDeltaMilliseconds' => <integer>,
'TsFileMode' => 'SEGMENTED_FILES|SINGLE_FILE',
],
'MediaPackageGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'MsSmoothGroupSettings' => [
'AcquisitionPointId' => '<string>',
'AudioOnlyTimecodeControl' => 'PASSTHROUGH|USE_CONFIGURED_CLOCK',
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'EventId' => '<string>',
'EventIdMode' => 'NO_EVENT_ID|USE_CONFIGURED|USE_TIMESTAMP',
'EventStopBehavior' => 'NONE|SEND_EOS',
'FilecacheDuration' => <integer>,
'FragmentLength' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SendDelayMs' => <integer>,
'SparseTrackType' => 'NONE|SCTE_35|SCTE_35_WITHOUT_SEGMENTATION',
'StreamManifestBehavior' => 'DO_NOT_SEND|SEND',
'TimestampOffset' => '<string>',
'TimestampOffsetMode' => 'USE_CONFIGURED_OFFSET|USE_EVENT_START_DATE',
],
'MultiplexGroupSettings' => [
],
'RtmpGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'AuthenticationScheme' => 'AKAMAI|COMMON',
'CacheFullBehavior' => 'DISCONNECT_IMMEDIATELY|WAIT_FOR_SERVER',
'CacheLength' => <integer>,
'CaptionData' => 'ALL|FIELD1_608|FIELD1_AND_FIELD2_608',
'IncludeFillerNalUnits' => 'AUTO|DROP|INCLUDE',
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'RestartDelay' => <integer>,
],
'SrtGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
],
'UdpGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
],
],
'Outputs' => [
[
'AudioDescriptionNames' => ['<string>', ...],
'CaptionDescriptionNames' => ['<string>', ...],
'OutputName' => '<string>',
'OutputSettings' => [
'ArchiveOutputSettings' => [
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
'RawSettings' => [
],
],
'Extension' => '<string>',
'NameModifier' => '<string>',
],
'CmafIngestOutputSettings' => [
'NameModifier' => '<string>',
],
'FrameCaptureOutputSettings' => [
'NameModifier' => '<string>',
],
'HlsOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'HlsSettings' => [
'AudioOnlyHlsSettings' => [
'AudioGroupId' => '<string>',
'AudioOnlyImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'AudioTrackType' => 'ALTERNATE_AUDIO_AUTO_SELECT|ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT|ALTERNATE_AUDIO_NOT_AUTO_SELECT|AUDIO_ONLY_VARIANT_STREAM',
'SegmentType' => 'AAC|FMP4',
],
'Fmp4HlsSettings' => [
'AudioRenditionSets' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
],
'FrameCaptureHlsSettings' => [
],
'StandardHlsSettings' => [
'AudioRenditionSets' => '<string>',
'M3u8Settings' => [
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'EcmPid' => '<string>',
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'Scte35Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'Scte35Pid' => '<string>',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
],
'NameModifier' => '<string>',
'SegmentModifier' => '<string>',
],
'MediaPackageOutputSettings' => [
],
'MsSmoothOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'NameModifier' => '<string>',
],
'MultiplexOutputSettings' => [
'ContainerSettings' => [
'MultiplexM2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioStreamType' => 'ATSC|DVB',
'CcDescriptor' => 'DISABLED|ENABLED',
'Ebif' => 'NONE|PASSTHROUGH',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'Klv' => 'NONE|PASSTHROUGH',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35PrerollPullupMilliseconds' => <float>,
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'RtmpOutputSettings' => [
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'NumRetries' => <integer>,
],
'SrtOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'EncryptionType' => 'AES128|AES192|AES256',
'Latency' => <integer>,
],
'UdpOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'FecOutputSettings' => [
'ColumnDepth' => <integer>,
'IncludeFec' => 'COLUMN|COLUMN_AND_ROW',
'RowLength' => <integer>,
],
],
],
'VideoDescriptionName' => '<string>',
],
// ...
],
],
// ...
],
'ThumbnailConfiguration' => [
'State' => 'AUTO|DISABLED',
],
'TimecodeConfig' => [
'Source' => 'EMBEDDED|SYSTEMCLOCK|ZEROBASED',
'SyncThreshold' => <integer>,
],
'VideoDescriptions' => [
[
'CodecSettings' => [
'Av1Settings' => [
'AfdSignaling' => 'AUTO|FIXED|NONE',
'BufSize' => <integer>,
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'AV1_LEVEL_2|AV1_LEVEL_2_1|AV1_LEVEL_3|AV1_LEVEL_3_1|AV1_LEVEL_4|AV1_LEVEL_4_1|AV1_LEVEL_5|AV1_LEVEL_5_1|AV1_LEVEL_5_2|AV1_LEVEL_5_3|AV1_LEVEL_6|AV1_LEVEL_6_1|AV1_LEVEL_6_2|AV1_LEVEL_6_3|AV1_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'QvbrQualityLevel' => <integer>,
'SceneChangeDetect' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'FrameCaptureSettings' => [
'CaptureInterval' => <integer>,
'CaptureIntervalUnits' => 'MILLISECONDS|SECONDS',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'H264Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'Bitrate' => <integer>,
'BufFillPct' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'EntropyEncoding' => 'CABAC|CAVLC',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'ForceFieldPictures' => 'DISABLED|ENABLED',
'FramerateControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopBReference' => 'DISABLED|ENABLED',
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H264_LEVEL_1|H264_LEVEL_1_1|H264_LEVEL_1_2|H264_LEVEL_1_3|H264_LEVEL_2|H264_LEVEL_2_1|H264_LEVEL_2_2|H264_LEVEL_3|H264_LEVEL_3_1|H264_LEVEL_3_2|H264_LEVEL_4|H264_LEVEL_4_1|H264_LEVEL_4_2|H264_LEVEL_5|H264_LEVEL_5_1|H264_LEVEL_5_2|H264_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'NumRefFrames' => <integer>,
'ParControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'BASELINE|HIGH|HIGH_10BIT|HIGH_422|HIGH_422_10BIT|MAIN',
'QualityLevel' => 'ENHANCED_QUALITY|STANDARD_QUALITY',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR|VBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Softness' => <integer>,
'SpatialAq' => 'DISABLED|ENABLED',
'SubgopLength' => 'DYNAMIC|FIXED',
'Syntax' => 'DEFAULT|RP2027',
'TemporalAq' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
],
'H265Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'AlternativeTransferFunction' => 'INSERT|OMIT',
'Bitrate' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'DolbyVision81Settings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'Deblocking' => 'DISABLED|ENABLED',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H265_LEVEL_1|H265_LEVEL_2|H265_LEVEL_2_1|H265_LEVEL_3|H265_LEVEL_3_1|H265_LEVEL_4|H265_LEVEL_4_1|H265_LEVEL_5|H265_LEVEL_5_1|H265_LEVEL_5_2|H265_LEVEL_6|H265_LEVEL_6_1|H265_LEVEL_6_2|H265_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'MvOverPictureBoundaries' => 'DISABLED|ENABLED',
'MvTemporalPredictor' => 'DISABLED|ENABLED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'MAIN|MAIN_10BIT',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Tier' => 'HIGH|MAIN',
'TileHeight' => <integer>,
'TilePadding' => 'NONE|PADDED',
'TileWidth' => <integer>,
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
'TreeblockSize' => 'AUTO|TREE_SIZE_32X32',
],
'Mpeg2Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|LOW|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpace' => 'AUTO|PASSTHROUGH',
'DisplayAspectRatio' => 'DISPLAYRATIO16X9|DISPLAYRATIO4X3',
'FilterSettings' => [
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SubgopLength' => 'DYNAMIC|FIXED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|GOP_TIMECODE',
],
],
'Height' => <integer>,
'Name' => '<string>',
'RespondToAfd' => 'NONE|PASSTHROUGH|RESPOND',
'ScalingBehavior' => 'DEFAULT|STRETCH_TO_OUTPUT',
'Sharpness' => <integer>,
'Width' => <integer>,
],
// ...
],
],
'Id' => '<string>',
'InputAttachments' => [
[
'AutomaticInputFailoverSettings' => [
'ErrorClearTimeMsec' => <integer>,
'FailoverConditions' => [
[
'FailoverConditionSettings' => [
'AudioSilenceSettings' => [
'AudioSelectorName' => '<string>',
'AudioSilenceThresholdMsec' => <integer>,
],
'InputLossSettings' => [
'InputLossThresholdMsec' => <integer>,
],
'VideoBlackSettings' => [
'BlackDetectThreshold' => <float>,
'VideoBlackThresholdMsec' => <integer>,
],
],
],
// ...
],
'InputPreference' => 'EQUAL_INPUT_PREFERENCE|PRIMARY_INPUT_PREFERRED',
'SecondaryInputId' => '<string>',
],
'InputAttachmentName' => '<string>',
'InputId' => '<string>',
'InputSettings' => [
'AudioSelectors' => [
[
'Name' => '<string>',
'SelectorSettings' => [
'AudioHlsRenditionSelection' => [
'GroupId' => '<string>',
'Name' => '<string>',
],
'AudioLanguageSelection' => [
'LanguageCode' => '<string>',
'LanguageSelectionPolicy' => 'LOOSE|STRICT',
],
'AudioPidSelection' => [
'Pid' => <integer>,
],
'AudioTrackSelection' => [
'DolbyEDecode' => [
'ProgramSelection' => 'ALL_CHANNELS|PROGRAM_1|PROGRAM_2|PROGRAM_3|PROGRAM_4|PROGRAM_5|PROGRAM_6|PROGRAM_7|PROGRAM_8',
],
'Tracks' => [
[
'Track' => <integer>,
],
// ...
],
],
],
],
// ...
],
'CaptionSelectors' => [
[
'LanguageCode' => '<string>',
'Name' => '<string>',
'SelectorSettings' => [
'AncillarySourceSettings' => [
'SourceAncillaryChannelNumber' => <integer>,
],
'AribSourceSettings' => [
],
'DvbSubSourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'EmbeddedSourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Scte20Detection' => 'AUTO|OFF',
'Source608ChannelNumber' => <integer>,
'Source608TrackNumber' => <integer>,
],
'Scte20SourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Source608ChannelNumber' => <integer>,
],
'Scte27SourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'TeletextSourceSettings' => [
'OutputRectangle' => [
'Height' => <float>,
'LeftOffset' => <float>,
'TopOffset' => <float>,
'Width' => <float>,
],
'PageNumber' => '<string>',
],
],
],
// ...
],
'DeblockFilter' => 'DISABLED|ENABLED',
'DenoiseFilter' => 'DISABLED|ENABLED',
'FilterStrength' => <integer>,
'InputFilter' => 'AUTO|DISABLED|FORCED',
'NetworkInputSettings' => [
'HlsInputSettings' => [
'Bandwidth' => <integer>,
'BufferSegments' => <integer>,
'Retries' => <integer>,
'RetryInterval' => <integer>,
'Scte35Source' => 'MANIFEST|SEGMENTS',
],
'MulticastInputSettings' => [
'SourceIpAddress' => '<string>',
],
'ServerValidation' => 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME|CHECK_CRYPTOGRAPHY_ONLY',
],
'Scte35Pid' => <integer>,
'Smpte2038DataPreference' => 'IGNORE|PREFER',
'SourceEndBehavior' => 'CONTINUE|LOOP',
'VideoSelector' => [
'ColorSpace' => 'FOLLOW|HDR10|HLG_2020|REC_601|REC_709',
'ColorSpaceSettings' => [
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
],
'ColorSpaceUsage' => 'FALLBACK|FORCE',
'SelectorSettings' => [
'VideoSelectorPid' => [
'Pid' => <integer>,
],
'VideoSelectorProgramId' => [
'ProgramId' => <integer>,
],
],
],
],
'LogicalInterfaceNames' => ['<string>', ...],
],
// ...
],
'InputSpecification' => [
'Codec' => 'MPEG2|AVC|HEVC',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'Resolution' => 'SD|HD|UHD',
],
'LogLevel' => 'ERROR|WARNING|INFO|DEBUG|DISABLED',
'Maintenance' => [
'MaintenanceDay' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartTime' => '<string>',
],
'Name' => '<string>',
'PipelineDetails' => [
[
'ActiveInputAttachmentName' => '<string>',
'ActiveInputSwitchActionName' => '<string>',
'ActiveMotionGraphicsActionName' => '<string>',
'ActiveMotionGraphicsUri' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'PipelinesRunningCount' => <integer>,
'RoleArn' => '<string>',
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED|UPDATING|UPDATE_FAILED',
'Tags' => ['<string>', ...],
'Vpc' => [
'AvailabilityZones' => ['<string>', ...],
'NetworkInterfaceIds' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
]
Result Details
Members
- AnywhereSettings
-
- Type: DescribeAnywhereSettings structure
Elemental anywhere settings - Arn
-
- Type: string
- CdiInputSpecification
-
- Type: CdiInputSpecification structure
- ChannelClass
-
- Type: string
A standard channel has two encoding pipelines and a single pipeline channel only has one. - Destinations
-
- Type: Array of OutputDestination structures
- EgressEndpoints
-
- Type: Array of ChannelEgressEndpoint structures
- EncoderSettings
-
- Type: EncoderSettings structure
Encoder Settings - Id
-
- Type: string
- InputAttachments
-
- Type: Array of InputAttachment structures
- InputSpecification
-
- Type: InputSpecification structure
- LogLevel
-
- Type: string
The log level the user wants for their channel. - Maintenance
-
- Type: MaintenanceStatus structure
- Name
-
- Type: string
- PipelineDetails
-
- Type: Array of PipelineDetail structures
- PipelinesRunningCount
-
- Type: int
- RoleArn
-
- Type: string
- State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Vpc
-
- Type: VpcOutputSettingsDescription structure
The properties for a private VPC Output
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteChannelPlacementGroup
$result = $client->deleteChannelPlacementGroup([/* ... */]); $promise = $client->deleteChannelPlacementGroupAsync([/* ... */]);
Delete the specified ChannelPlacementGroup that exists in the specified Cluster.
Parameter Syntax
$result = $client->deleteChannelPlacementGroup([
'ChannelPlacementGroupId' => '<string>', // REQUIRED
'ClusterId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ChannelPlacementGroupId
-
- Required: Yes
- Type: string
- ClusterId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'Channels' => ['<string>', ...],
'ClusterId' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Nodes' => ['<string>', ...],
'State' => 'UNASSIGNED|ASSIGNING|ASSIGNED|DELETING|DELETE_FAILED|DELETED|UNASSIGNING',
]
Result Details
Members
- Arn
-
- Type: string
- Channels
-
- Type: Array of strings
- ClusterId
-
- Type: string
- Id
-
- Type: string
- Name
-
- Type: string
- Nodes
-
- Type: Array of strings
- State
-
- Type: string
Used in DescribeChannelPlacementGroupResult
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteCloudWatchAlarmTemplate
$result = $client->deleteCloudWatchAlarmTemplate([/* ... */]); $promise = $client->deleteCloudWatchAlarmTemplateAsync([/* ... */]);
Deletes a cloudwatch alarm template.
Parameter Syntax
$result = $client->deleteCloudWatchAlarmTemplate([
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteCloudWatchAlarmTemplateGroup
$result = $client->deleteCloudWatchAlarmTemplateGroup([/* ... */]); $promise = $client->deleteCloudWatchAlarmTemplateGroupAsync([/* ... */]);
Deletes a cloudwatch alarm template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.
Parameter Syntax
$result = $client->deleteCloudWatchAlarmTemplateGroup([
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteCluster
$result = $client->deleteCluster([/* ... */]); $promise = $client->deleteClusterAsync([/* ... */]);
Delete a Cluster. The Cluster must be idle.
Parameter Syntax
$result = $client->deleteCluster([
'ClusterId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'ChannelIds' => ['<string>', ...],
'ClusterType' => 'ON_PREMISES',
'Id' => '<string>',
'InstanceRoleArn' => '<string>',
'Name' => '<string>',
'NetworkSettings' => [
'DefaultRoute' => '<string>',
'InterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkId' => '<string>',
],
// ...
],
],
'State' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETE_FAILED|DELETED',
]
Result Details
Members
- Arn
-
- Type: string
- ChannelIds
-
- Type: Array of strings
- ClusterType
-
- Type: string
Used in CreateClusterSummary, DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult. - Id
-
- Type: string
- InstanceRoleArn
-
- Type: string
- Name
-
- Type: string
- NetworkSettings
-
- Type: ClusterNetworkSettings structure
Used in DescribeClusterResult, DescribeClusterSummary, UpdateClusterResult. - State
-
- Type: string
Used in DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteEventBridgeRuleTemplate
$result = $client->deleteEventBridgeRuleTemplate([/* ... */]); $promise = $client->deleteEventBridgeRuleTemplateAsync([/* ... */]);
Deletes an eventbridge rule template.
Parameter Syntax
$result = $client->deleteEventBridgeRuleTemplate([
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteEventBridgeRuleTemplateGroup
$result = $client->deleteEventBridgeRuleTemplateGroup([/* ... */]); $promise = $client->deleteEventBridgeRuleTemplateGroupAsync([/* ... */]);
Deletes an eventbridge rule template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.
Parameter Syntax
$result = $client->deleteEventBridgeRuleTemplateGroup([
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteInput
$result = $client->deleteInput([/* ... */]); $promise = $client->deleteInputAsync([/* ... */]);
Deletes the input end point
Parameter Syntax
$result = $client->deleteInput([
'InputId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InputId
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteInputSecurityGroup
$result = $client->deleteInputSecurityGroup([/* ... */]); $promise = $client->deleteInputSecurityGroupAsync([/* ... */]);
Deletes an Input Security Group
Parameter Syntax
$result = $client->deleteInputSecurityGroup([
'InputSecurityGroupId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InputSecurityGroupId
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DeleteMultiplex
$result = $client->deleteMultiplex([/* ... */]); $promise = $client->deleteMultiplexAsync([/* ... */]);
Delete a multiplex. The multiplex must be idle.
Parameter Syntax
$result = $client->deleteMultiplex([
'MultiplexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MultiplexId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'AvailabilityZones' => ['<string>', ...],
'Destinations' => [
[
'MediaConnectSettings' => [
'EntitlementArn' => '<string>',
],
],
// ...
],
'Id' => '<string>',
'MultiplexSettings' => [
'MaximumVideoBufferDelayMilliseconds' => <integer>,
'TransportStreamBitrate' => <integer>,
'TransportStreamId' => <integer>,
'TransportStreamReservedBitrate' => <integer>,
],
'Name' => '<string>',
'PipelinesRunningCount' => <integer>,
'ProgramCount' => <integer>,
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- AvailabilityZones
-
- Type: Array of strings
- Destinations
-
- Type: Array of MultiplexOutputDestination structures
- Id
-
- Type: string
- MultiplexSettings
-
- Type: MultiplexSettings structure
Contains configuration for a Multiplex event - Name
-
- Type: string
- PipelinesRunningCount
-
- Type: int
- ProgramCount
-
- Type: int
- State
-
- Type: string
The current state of the multiplex. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteMultiplexProgram
$result = $client->deleteMultiplexProgram([/* ... */]); $promise = $client->deleteMultiplexProgramAsync([/* ... */]);
Delete a program from a multiplex.
Parameter Syntax
$result = $client->deleteMultiplexProgram([
'MultiplexId' => '<string>', // REQUIRED
'ProgramName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MultiplexId
-
- Required: Yes
- Type: string
- ProgramName
-
- Required: Yes
- Type: string
Result Syntax
[
'ChannelId' => '<string>',
'MultiplexProgramSettings' => [
'PreferredChannelPipeline' => 'CURRENTLY_ACTIVE|PIPELINE_0|PIPELINE_1',
'ProgramNumber' => <integer>,
'ServiceDescriptor' => [
'ProviderName' => '<string>',
'ServiceName' => '<string>',
],
'VideoSettings' => [
'ConstantBitrate' => <integer>,
'StatmuxSettings' => [
'MaximumBitrate' => <integer>,
'MinimumBitrate' => <integer>,
'Priority' => <integer>,
],
],
],
'PacketIdentifiersMap' => [
'AribCaptionsPid' => <integer>,
'AudioPids' => [<integer>, ...],
'DvbSubPids' => [<integer>, ...],
'DvbTeletextPid' => <integer>,
'DvbTeletextPids' => [<integer>, ...],
'EcmPid' => <integer>,
'EtvPlatformPid' => <integer>,
'EtvSignalPid' => <integer>,
'KlvDataPids' => [<integer>, ...],
'PcrPid' => <integer>,
'PmtPid' => <integer>,
'PrivateMetadataPid' => <integer>,
'Scte27Pids' => [<integer>, ...],
'Scte35Pid' => <integer>,
'Smpte2038Pid' => <integer>,
'TimedMetadataPid' => <integer>,
'VideoPid' => <integer>,
],
'PipelineDetails' => [
[
'ActiveChannelPipeline' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'ProgramName' => '<string>',
]
Result Details
Members
- ChannelId
-
- Type: string
- MultiplexProgramSettings
-
- Type: MultiplexProgramSettings structure
Multiplex Program settings configuration. - PacketIdentifiersMap
-
- Type: MultiplexProgramPacketIdentifiersMap structure
Packet identifiers map for a given Multiplex program. - PipelineDetails
-
- Type: Array of MultiplexProgramPipelineDetail structures
- ProgramName
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteNetwork
$result = $client->deleteNetwork([/* ... */]); $promise = $client->deleteNetworkAsync([/* ... */]);
Delete a Network. The Network must have no resources associated with it.
Parameter Syntax
$result = $client->deleteNetwork([
'NetworkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- NetworkId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'AssociatedClusterIds' => ['<string>', ...],
'Id' => '<string>',
'IpPools' => [
[
'Cidr' => '<string>',
],
// ...
],
'Name' => '<string>',
'Routes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'State' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|IDLE|IN_USE|UPDATING|DELETE_FAILED|DELETED',
]
Result Details
Members
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteNode
$result = $client->deleteNode([/* ... */]); $promise = $client->deleteNodeAsync([/* ... */]);
Delete a Node. The Node must be IDLE.
Parameter Syntax
$result = $client->deleteNode([
'ClusterId' => '<string>', // REQUIRED
'NodeId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
- NodeId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'ChannelPlacementGroups' => ['<string>', ...],
'ClusterId' => '<string>',
'ConnectionState' => 'CONNECTED|DISCONNECTED',
'Id' => '<string>',
'InstanceArn' => '<string>',
'Name' => '<string>',
'NodeInterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkInterfaceMode' => 'NAT|BRIDGE',
'PhysicalInterfaceName' => '<string>',
],
// ...
],
'Role' => 'BACKUP|ACTIVE',
'State' => 'CREATED|REGISTERING|READY_TO_ACTIVATE|REGISTRATION_FAILED|ACTIVATION_FAILED|ACTIVE|READY|IN_USE|DEREGISTERING|DRAINING|DEREGISTRATION_FAILED|DEREGISTERED',
]
Result Details
Members
- Arn
-
- Type: string
- ChannelPlacementGroups
-
- Type: Array of strings
- ClusterId
-
- Type: string
- ConnectionState
-
- Type: string
Used in DescribeNodeSummary. - Id
-
- Type: string
- InstanceArn
-
- Type: string
- Name
-
- Type: string
- NodeInterfaceMappings
-
- Type: Array of NodeInterfaceMapping structures
- Role
-
- Type: string
Used in CreateNodeRequest, CreateNodeRegistrationScriptRequest, DescribeNodeResult, DescribeNodeSummary, UpdateNodeRequest. - State
-
- Type: string
Used in DescribeNodeSummary.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteReservation
$result = $client->deleteReservation([/* ... */]); $promise = $client->deleteReservationAsync([/* ... */]);
Delete an expired reservation.
Parameter Syntax
$result = $client->deleteReservation([
'ReservationId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ReservationId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'Count' => <integer>,
'CurrencyCode' => '<string>',
'Duration' => <integer>,
'DurationUnits' => 'MONTHS',
'End' => '<string>',
'FixedPrice' => <float>,
'Name' => '<string>',
'OfferingDescription' => '<string>',
'OfferingId' => '<string>',
'OfferingType' => 'NO_UPFRONT',
'Region' => '<string>',
'RenewalSettings' => [
'AutomaticRenewal' => 'DISABLED|ENABLED|UNAVAILABLE',
'RenewalCount' => <integer>,
],
'ReservationId' => '<string>',
'ResourceSpecification' => [
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Codec' => 'MPEG2|AVC|HEVC|AUDIO|LINK|AV1',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'MaximumFramerate' => 'MAX_30_FPS|MAX_60_FPS',
'Resolution' => 'SD|HD|FHD|UHD',
'ResourceType' => 'INPUT|OUTPUT|MULTIPLEX|CHANNEL',
'SpecialFeature' => 'ADVANCED_AUDIO|AUDIO_NORMALIZATION|MGHD|MGUHD',
'VideoQuality' => 'STANDARD|ENHANCED|PREMIUM',
],
'Start' => '<string>',
'State' => 'ACTIVE|EXPIRED|CANCELED|DELETED',
'Tags' => ['<string>', ...],
'UsagePrice' => <float>,
]
Result Details
Members
- Arn
-
- Type: string
- Count
-
- Type: int
- CurrencyCode
-
- Type: string
- Duration
-
- Type: int
- DurationUnits
-
- Type: string
Units for duration, e.g. 'MONTHS' - End
-
- Type: string
- FixedPrice
-
- Type: double
- Name
-
- Type: string
- OfferingDescription
-
- Type: string
- OfferingId
-
- Type: string
- OfferingType
-
- Type: string
Offering type, e.g. 'NO_UPFRONT' - Region
-
- Type: string
- RenewalSettings
-
- Type: RenewalSettings structure
The Renewal settings for Reservations - ReservationId
-
- Type: string
- ResourceSpecification
-
- Type: ReservationResourceSpecification structure
Resource configuration (codec, resolution, bitrate, ...) - Start
-
- Type: string
- State
-
- Type: string
Current reservation state - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- UsagePrice
-
- Type: double
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteSchedule
$result = $client->deleteSchedule([/* ... */]); $promise = $client->deleteScheduleAsync([/* ... */]);
Delete all schedule actions on a channel.
Parameter Syntax
$result = $client->deleteSchedule([
'ChannelId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ChannelId
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DeleteSignalMap
$result = $client->deleteSignalMap([/* ... */]); $promise = $client->deleteSignalMapAsync([/* ... */]);
Deletes the specified signal map.
Parameter Syntax
$result = $client->deleteSignalMap([
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
DeleteTags
$result = $client->deleteTags([/* ... */]); $promise = $client->deleteTagsAsync([/* ... */]);
Removes tags for a resource
Parameter Syntax
$result = $client->deleteTags([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
- TagKeys
-
- Required: Yes
- Type: Array of strings
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- NotFoundException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
DescribeAccountConfiguration
$result = $client->describeAccountConfiguration([/* ... */]); $promise = $client->describeAccountConfigurationAsync([/* ... */]);
Describe account configuration
Parameter Syntax
$result = $client->describeAccountConfiguration([ ]);
Parameter Details
Members
Result Syntax
[
'AccountConfiguration' => [
'KmsKeyId' => '<string>',
],
]
Result Details
Members
- AccountConfiguration
-
- Type: AccountConfiguration structure
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeChannel
$result = $client->describeChannel([/* ... */]); $promise = $client->describeChannelAsync([/* ... */]);
Gets details about a channel
Parameter Syntax
$result = $client->describeChannel([
'ChannelId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ChannelId
-
- Required: Yes
- Type: string
Result Syntax
[
'AnywhereSettings' => [
'ChannelPlacementGroupId' => '<string>',
'ClusterId' => '<string>',
],
'Arn' => '<string>',
'CdiInputSpecification' => [
'Resolution' => 'SD|HD|FHD|UHD',
],
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
'EgressEndpoints' => [
[
'SourceIp' => '<string>',
],
// ...
],
'EncoderSettings' => [
'AudioDescriptions' => [
[
'AudioDashRoles' => ['<string>', ...],
'AudioNormalizationSettings' => [
'Algorithm' => 'ITU_1770_1|ITU_1770_2',
'AlgorithmControl' => 'CORRECT_AUDIO',
'TargetLkfs' => <float>,
],
'AudioSelectorName' => '<string>',
'AudioType' => 'CLEAN_EFFECTS|HEARING_IMPAIRED|UNDEFINED|VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'AudioWatermarkingSettings' => [
'NielsenWatermarksSettings' => [
'NielsenCbetSettings' => [
'CbetCheckDigitString' => '<string>',
'CbetStepaside' => 'DISABLED|ENABLED',
'Csid' => '<string>',
],
'NielsenDistributionType' => 'FINAL_DISTRIBUTOR|PROGRAM_CONTENT',
'NielsenNaesIiNwSettings' => [
'CheckDigitString' => '<string>',
'Sid' => <float>,
'Timezone' => 'AMERICA_PUERTO_RICO|US_ALASKA|US_ARIZONA|US_CENTRAL|US_EASTERN|US_HAWAII|US_MOUNTAIN|US_PACIFIC|US_SAMOA|UTC',
],
],
],
'CodecSettings' => [
'AacSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'AD_RECEIVER_MIX|CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_5_1',
'InputType' => 'BROADCASTER_MIXED_AD|NORMAL',
'Profile' => 'HEV1|HEV2|LC',
'RateControlMode' => 'CBR|VBR',
'RawFormat' => 'LATM_LOAS|NONE',
'SampleRate' => <float>,
'Spec' => 'MPEG2|MPEG4',
'VbrQuality' => 'HIGH|LOW|MEDIUM_HIGH|MEDIUM_LOW',
],
'Ac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|DIALOGUE|EMERGENCY|HEARING_IMPAIRED|MUSIC_AND_EFFECTS|VISUALLY_IMPAIRED|VOICE_OVER',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_3_2_LFE',
'Dialnorm' => <integer>,
'DrcProfile' => 'FILM_STANDARD|NONE',
'LfeFilter' => 'DISABLED|ENABLED',
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
],
'Eac3AtmosSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_5_1_4|CODING_MODE_7_1_4|CODING_MODE_9_1_6',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'HeightTrim' => <float>,
'SurroundTrim' => <float>,
],
'Eac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|EMERGENCY|HEARING_IMPAIRED|VISUALLY_IMPAIRED',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_3_2',
'DcFilter' => 'DISABLED|ENABLED',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'LfeControl' => 'LFE|NO_LFE',
'LfeFilter' => 'DISABLED|ENABLED',
'LoRoCenterMixLevel' => <float>,
'LoRoSurroundMixLevel' => <float>,
'LtRtCenterMixLevel' => <float>,
'LtRtSurroundMixLevel' => <float>,
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'PassthroughControl' => 'NO_PASSTHROUGH|WHEN_POSSIBLE',
'PhaseControl' => 'NO_SHIFT|SHIFT_90_DEGREES',
'StereoDownmix' => 'DPL2|LO_RO|LT_RT|NOT_INDICATED',
'SurroundExMode' => 'DISABLED|ENABLED|NOT_INDICATED',
'SurroundMode' => 'DISABLED|ENABLED|NOT_INDICATED',
],
'Mp2Settings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0',
'SampleRate' => <float>,
],
'PassThroughSettings' => [
],
'WavSettings' => [
'BitDepth' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_4_0|CODING_MODE_8_0',
'SampleRate' => <float>,
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageCodeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'Name' => '<string>',
'RemixSettings' => [
'ChannelMappings' => [
[
'InputChannelLevels' => [
[
'Gain' => <integer>,
'InputChannel' => <integer>,
],
// ...
],
'OutputChannel' => <integer>,
],
// ...
],
'ChannelsIn' => <integer>,
'ChannelsOut' => <integer>,
],
'StreamName' => '<string>',
],
// ...
],
'AvailBlanking' => [
'AvailBlankingImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'State' => 'DISABLED|ENABLED',
],
'AvailConfiguration' => [
'AvailSettings' => [
'Esam' => [
'AcquisitionPointId' => '<string>',
'AdAvailOffset' => <integer>,
'PasswordParam' => '<string>',
'PoisEndpoint' => '<string>',
'Username' => '<string>',
'ZoneIdentity' => '<string>',
],
'Scte35SpliceInsert' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
'Scte35TimeSignalApos' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
],
'Scte35SegmentationScope' => 'ALL_OUTPUT_GROUPS|SCTE35_ENABLED_OUTPUT_GROUPS',
],
'BlackoutSlate' => [
'BlackoutSlateImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkEndBlackout' => 'DISABLED|ENABLED',
'NetworkEndBlackoutImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkId' => '<string>',
'State' => 'DISABLED|ENABLED',
],
'CaptionDescriptions' => [
[
'Accessibility' => 'DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES|IMPLEMENTS_ACCESSIBILITY_FEATURES',
'CaptionDashRoles' => ['<string>', ...],
'CaptionSelectorName' => '<string>',
'DestinationSettings' => [
'AribDestinationSettings' => [
],
'BurnInDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'DvbSubDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'EbuTtDDestinationSettings' => [
'CopyrightHolder' => '<string>',
'FillLineGap' => 'DISABLED|ENABLED',
'FontFamily' => '<string>',
'StyleControl' => 'EXCLUDE|INCLUDE',
],
'EmbeddedDestinationSettings' => [
],
'EmbeddedPlusScte20DestinationSettings' => [
],
'RtmpCaptionInfoDestinationSettings' => [
],
'Scte20PlusEmbeddedDestinationSettings' => [
],
'Scte27DestinationSettings' => [
],
'SmpteTtDestinationSettings' => [
],
'TeletextDestinationSettings' => [
],
'TtmlDestinationSettings' => [
'StyleControl' => 'PASSTHROUGH|USE_CONFIGURED',
],
'WebvttDestinationSettings' => [
'StyleControl' => 'NO_STYLE_DATA|PASSTHROUGH',
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
'Name' => '<string>',
],
// ...
],
'ColorCorrectionSettings' => [
'GlobalColorCorrections' => [
[
'InputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'OutputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'Uri' => '<string>',
],
// ...
],
],
'FeatureActivations' => [
'InputPrepareScheduleActions' => 'DISABLED|ENABLED',
'OutputStaticImageOverlayScheduleActions' => 'DISABLED|ENABLED',
],
'GlobalConfiguration' => [
'InitialAudioGain' => <integer>,
'InputEndAction' => 'NONE|SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior' => [
'BlackFrameMsec' => <integer>,
'InputLossImageColor' => '<string>',
'InputLossImageSlate' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'InputLossImageType' => 'COLOR|SLATE',
'RepeatFrameMsec' => <integer>,
],
'OutputLockingMode' => 'EPOCH_LOCKING|PIPELINE_LOCKING',
'OutputLockingSettings' => [
'EpochLockingSettings' => [
'CustomEpoch' => '<string>',
'JamSyncTime' => '<string>',
],
'PipelineLockingSettings' => [
],
],
'OutputTimingSource' => 'INPUT_CLOCK|SYSTEM_CLOCK',
'SupportLowFramerateInputs' => 'DISABLED|ENABLED',
],
'MotionGraphicsConfiguration' => [
'MotionGraphicsInsertion' => 'DISABLED|ENABLED',
'MotionGraphicsSettings' => [
'HtmlMotionGraphicsSettings' => [
],
],
],
'NielsenConfiguration' => [
'DistributorId' => '<string>',
'NielsenPcmToId3Tagging' => 'DISABLED|ENABLED',
],
'OutputGroups' => [
[
'Name' => '<string>',
'OutputGroupSettings' => [
'ArchiveGroupSettings' => [
'ArchiveCdnSettings' => [
'ArchiveS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'RolloverInterval' => <integer>,
],
'CmafIngestGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvNameModifier' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NielsenId3NameModifier' => '<string>',
'Scte35NameModifier' => '<string>',
'Scte35Type' => 'NONE|SCTE_35_WITHOUT_SEGMENTATION',
'SegmentLength' => <integer>,
'SegmentLengthUnits' => 'MILLISECONDS|SECONDS',
'SendDelayMs' => <integer>,
],
'FrameCaptureGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'FrameCaptureCdnSettings' => [
'FrameCaptureS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
],
'HlsGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'BaseUrlContent' => '<string>',
'BaseUrlContent1' => '<string>',
'BaseUrlManifest' => '<string>',
'BaseUrlManifest1' => '<string>',
'CaptionLanguageMappings' => [
[
'CaptionChannel' => <integer>,
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
],
// ...
],
'CaptionLanguageSetting' => 'INSERT|NONE|OMIT',
'ClientCache' => 'DISABLED|ENABLED',
'CodecSpecification' => 'RFC_4281|RFC_6381',
'ConstantIv' => '<string>',
'Destination' => [
'DestinationRefId' => '<string>',
],
'DirectoryStructure' => 'SINGLE_DIRECTORY|SUBDIRECTORY_PER_STREAM',
'DiscontinuityTags' => 'INSERT|NEVER_INSERT',
'EncryptionType' => 'AES128|SAMPLE_AES',
'HlsCdnSettings' => [
'HlsAkamaiSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'Salt' => '<string>',
'Token' => '<string>',
],
'HlsBasicPutSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsMediaStoreSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'MediaStoreStorageClass' => 'TEMPORAL',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
'HlsWebdavSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
],
'HlsId3SegmentTagging' => 'DISABLED|ENABLED',
'IFrameOnlyPlaylists' => 'DISABLED|STANDARD',
'IncompleteSegmentBehavior' => 'AUTO|SUPPRESS',
'IndexNSegments' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'IvInManifest' => 'EXCLUDE|INCLUDE',
'IvSource' => 'EXPLICIT|FOLLOWS_SEGMENT_NUMBER',
'KeepSegments' => <integer>,
'KeyFormat' => '<string>',
'KeyFormatVersions' => '<string>',
'KeyProviderSettings' => [
'StaticKeySettings' => [
'KeyProviderServer' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'StaticKeyValue' => '<string>',
],
],
'ManifestCompression' => 'GZIP|NONE',
'ManifestDurationFormat' => 'FLOATING_POINT|INTEGER',
'MinSegmentLength' => <integer>,
'Mode' => 'LIVE|VOD',
'OutputSelection' => 'MANIFESTS_AND_SEGMENTS|SEGMENTS_ONLY|VARIANT_MANIFESTS_AND_SEGMENTS',
'ProgramDateTime' => 'EXCLUDE|INCLUDE',
'ProgramDateTimeClock' => 'INITIALIZE_FROM_OUTPUT_TIMECODE|SYSTEM_CLOCK',
'ProgramDateTimePeriod' => <integer>,
'RedundantManifest' => 'DISABLED|ENABLED',
'SegmentLength' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory' => <integer>,
'StreamInfResolution' => 'EXCLUDE|INCLUDE',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
'TimestampDeltaMilliseconds' => <integer>,
'TsFileMode' => 'SEGMENTED_FILES|SINGLE_FILE',
],
'MediaPackageGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'MsSmoothGroupSettings' => [
'AcquisitionPointId' => '<string>',
'AudioOnlyTimecodeControl' => 'PASSTHROUGH|USE_CONFIGURED_CLOCK',
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'EventId' => '<string>',
'EventIdMode' => 'NO_EVENT_ID|USE_CONFIGURED|USE_TIMESTAMP',
'EventStopBehavior' => 'NONE|SEND_EOS',
'FilecacheDuration' => <integer>,
'FragmentLength' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SendDelayMs' => <integer>,
'SparseTrackType' => 'NONE|SCTE_35|SCTE_35_WITHOUT_SEGMENTATION',
'StreamManifestBehavior' => 'DO_NOT_SEND|SEND',
'TimestampOffset' => '<string>',
'TimestampOffsetMode' => 'USE_CONFIGURED_OFFSET|USE_EVENT_START_DATE',
],
'MultiplexGroupSettings' => [
],
'RtmpGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'AuthenticationScheme' => 'AKAMAI|COMMON',
'CacheFullBehavior' => 'DISCONNECT_IMMEDIATELY|WAIT_FOR_SERVER',
'CacheLength' => <integer>,
'CaptionData' => 'ALL|FIELD1_608|FIELD1_AND_FIELD2_608',
'IncludeFillerNalUnits' => 'AUTO|DROP|INCLUDE',
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'RestartDelay' => <integer>,
],
'SrtGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
],
'UdpGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
],
],
'Outputs' => [
[
'AudioDescriptionNames' => ['<string>', ...],
'CaptionDescriptionNames' => ['<string>', ...],
'OutputName' => '<string>',
'OutputSettings' => [
'ArchiveOutputSettings' => [
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
'RawSettings' => [
],
],
'Extension' => '<string>',
'NameModifier' => '<string>',
],
'CmafIngestOutputSettings' => [
'NameModifier' => '<string>',
],
'FrameCaptureOutputSettings' => [
'NameModifier' => '<string>',
],
'HlsOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'HlsSettings' => [
'AudioOnlyHlsSettings' => [
'AudioGroupId' => '<string>',
'AudioOnlyImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'AudioTrackType' => 'ALTERNATE_AUDIO_AUTO_SELECT|ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT|ALTERNATE_AUDIO_NOT_AUTO_SELECT|AUDIO_ONLY_VARIANT_STREAM',
'SegmentType' => 'AAC|FMP4',
],
'Fmp4HlsSettings' => [
'AudioRenditionSets' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
],
'FrameCaptureHlsSettings' => [
],
'StandardHlsSettings' => [
'AudioRenditionSets' => '<string>',
'M3u8Settings' => [
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'EcmPid' => '<string>',
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'Scte35Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'Scte35Pid' => '<string>',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
],
'NameModifier' => '<string>',
'SegmentModifier' => '<string>',
],
'MediaPackageOutputSettings' => [
],
'MsSmoothOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'NameModifier' => '<string>',
],
'MultiplexOutputSettings' => [
'ContainerSettings' => [
'MultiplexM2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioStreamType' => 'ATSC|DVB',
'CcDescriptor' => 'DISABLED|ENABLED',
'Ebif' => 'NONE|PASSTHROUGH',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'Klv' => 'NONE|PASSTHROUGH',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35PrerollPullupMilliseconds' => <float>,
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'RtmpOutputSettings' => [
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'NumRetries' => <integer>,
],
'SrtOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'EncryptionType' => 'AES128|AES192|AES256',
'Latency' => <integer>,
],
'UdpOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'FecOutputSettings' => [
'ColumnDepth' => <integer>,
'IncludeFec' => 'COLUMN|COLUMN_AND_ROW',
'RowLength' => <integer>,
],
],
],
'VideoDescriptionName' => '<string>',
],
// ...
],
],
// ...
],
'ThumbnailConfiguration' => [
'State' => 'AUTO|DISABLED',
],
'TimecodeConfig' => [
'Source' => 'EMBEDDED|SYSTEMCLOCK|ZEROBASED',
'SyncThreshold' => <integer>,
],
'VideoDescriptions' => [
[
'CodecSettings' => [
'Av1Settings' => [
'AfdSignaling' => 'AUTO|FIXED|NONE',
'BufSize' => <integer>,
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'AV1_LEVEL_2|AV1_LEVEL_2_1|AV1_LEVEL_3|AV1_LEVEL_3_1|AV1_LEVEL_4|AV1_LEVEL_4_1|AV1_LEVEL_5|AV1_LEVEL_5_1|AV1_LEVEL_5_2|AV1_LEVEL_5_3|AV1_LEVEL_6|AV1_LEVEL_6_1|AV1_LEVEL_6_2|AV1_LEVEL_6_3|AV1_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'QvbrQualityLevel' => <integer>,
'SceneChangeDetect' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'FrameCaptureSettings' => [
'CaptureInterval' => <integer>,
'CaptureIntervalUnits' => 'MILLISECONDS|SECONDS',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'H264Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'Bitrate' => <integer>,
'BufFillPct' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'EntropyEncoding' => 'CABAC|CAVLC',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'ForceFieldPictures' => 'DISABLED|ENABLED',
'FramerateControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopBReference' => 'DISABLED|ENABLED',
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H264_LEVEL_1|H264_LEVEL_1_1|H264_LEVEL_1_2|H264_LEVEL_1_3|H264_LEVEL_2|H264_LEVEL_2_1|H264_LEVEL_2_2|H264_LEVEL_3|H264_LEVEL_3_1|H264_LEVEL_3_2|H264_LEVEL_4|H264_LEVEL_4_1|H264_LEVEL_4_2|H264_LEVEL_5|H264_LEVEL_5_1|H264_LEVEL_5_2|H264_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'NumRefFrames' => <integer>,
'ParControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'BASELINE|HIGH|HIGH_10BIT|HIGH_422|HIGH_422_10BIT|MAIN',
'QualityLevel' => 'ENHANCED_QUALITY|STANDARD_QUALITY',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR|VBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Softness' => <integer>,
'SpatialAq' => 'DISABLED|ENABLED',
'SubgopLength' => 'DYNAMIC|FIXED',
'Syntax' => 'DEFAULT|RP2027',
'TemporalAq' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
],
'H265Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'AlternativeTransferFunction' => 'INSERT|OMIT',
'Bitrate' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'DolbyVision81Settings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'Deblocking' => 'DISABLED|ENABLED',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H265_LEVEL_1|H265_LEVEL_2|H265_LEVEL_2_1|H265_LEVEL_3|H265_LEVEL_3_1|H265_LEVEL_4|H265_LEVEL_4_1|H265_LEVEL_5|H265_LEVEL_5_1|H265_LEVEL_5_2|H265_LEVEL_6|H265_LEVEL_6_1|H265_LEVEL_6_2|H265_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'MvOverPictureBoundaries' => 'DISABLED|ENABLED',
'MvTemporalPredictor' => 'DISABLED|ENABLED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'MAIN|MAIN_10BIT',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Tier' => 'HIGH|MAIN',
'TileHeight' => <integer>,
'TilePadding' => 'NONE|PADDED',
'TileWidth' => <integer>,
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
'TreeblockSize' => 'AUTO|TREE_SIZE_32X32',
],
'Mpeg2Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|LOW|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpace' => 'AUTO|PASSTHROUGH',
'DisplayAspectRatio' => 'DISPLAYRATIO16X9|DISPLAYRATIO4X3',
'FilterSettings' => [
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SubgopLength' => 'DYNAMIC|FIXED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|GOP_TIMECODE',
],
],
'Height' => <integer>,
'Name' => '<string>',
'RespondToAfd' => 'NONE|PASSTHROUGH|RESPOND',
'ScalingBehavior' => 'DEFAULT|STRETCH_TO_OUTPUT',
'Sharpness' => <integer>,
'Width' => <integer>,
],
// ...
],
],
'Id' => '<string>',
'InputAttachments' => [
[
'AutomaticInputFailoverSettings' => [
'ErrorClearTimeMsec' => <integer>,
'FailoverConditions' => [
[
'FailoverConditionSettings' => [
'AudioSilenceSettings' => [
'AudioSelectorName' => '<string>',
'AudioSilenceThresholdMsec' => <integer>,
],
'InputLossSettings' => [
'InputLossThresholdMsec' => <integer>,
],
'VideoBlackSettings' => [
'BlackDetectThreshold' => <float>,
'VideoBlackThresholdMsec' => <integer>,
],
],
],
// ...
],
'InputPreference' => 'EQUAL_INPUT_PREFERENCE|PRIMARY_INPUT_PREFERRED',
'SecondaryInputId' => '<string>',
],
'InputAttachmentName' => '<string>',
'InputId' => '<string>',
'InputSettings' => [
'AudioSelectors' => [
[
'Name' => '<string>',
'SelectorSettings' => [
'AudioHlsRenditionSelection' => [
'GroupId' => '<string>',
'Name' => '<string>',
],
'AudioLanguageSelection' => [
'LanguageCode' => '<string>',
'LanguageSelectionPolicy' => 'LOOSE|STRICT',
],
'AudioPidSelection' => [
'Pid' => <integer>,
],
'AudioTrackSelection' => [
'DolbyEDecode' => [
'ProgramSelection' => 'ALL_CHANNELS|PROGRAM_1|PROGRAM_2|PROGRAM_3|PROGRAM_4|PROGRAM_5|PROGRAM_6|PROGRAM_7|PROGRAM_8',
],
'Tracks' => [
[
'Track' => <integer>,
],
// ...
],
],
],
],
// ...
],
'CaptionSelectors' => [
[
'LanguageCode' => '<string>',
'Name' => '<string>',
'SelectorSettings' => [
'AncillarySourceSettings' => [
'SourceAncillaryChannelNumber' => <integer>,
],
'AribSourceSettings' => [
],
'DvbSubSourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'EmbeddedSourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Scte20Detection' => 'AUTO|OFF',
'Source608ChannelNumber' => <integer>,
'Source608TrackNumber' => <integer>,
],
'Scte20SourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Source608ChannelNumber' => <integer>,
],
'Scte27SourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'TeletextSourceSettings' => [
'OutputRectangle' => [
'Height' => <float>,
'LeftOffset' => <float>,
'TopOffset' => <float>,
'Width' => <float>,
],
'PageNumber' => '<string>',
],
],
],
// ...
],
'DeblockFilter' => 'DISABLED|ENABLED',
'DenoiseFilter' => 'DISABLED|ENABLED',
'FilterStrength' => <integer>,
'InputFilter' => 'AUTO|DISABLED|FORCED',
'NetworkInputSettings' => [
'HlsInputSettings' => [
'Bandwidth' => <integer>,
'BufferSegments' => <integer>,
'Retries' => <integer>,
'RetryInterval' => <integer>,
'Scte35Source' => 'MANIFEST|SEGMENTS',
],
'MulticastInputSettings' => [
'SourceIpAddress' => '<string>',
],
'ServerValidation' => 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME|CHECK_CRYPTOGRAPHY_ONLY',
],
'Scte35Pid' => <integer>,
'Smpte2038DataPreference' => 'IGNORE|PREFER',
'SourceEndBehavior' => 'CONTINUE|LOOP',
'VideoSelector' => [
'ColorSpace' => 'FOLLOW|HDR10|HLG_2020|REC_601|REC_709',
'ColorSpaceSettings' => [
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
],
'ColorSpaceUsage' => 'FALLBACK|FORCE',
'SelectorSettings' => [
'VideoSelectorPid' => [
'Pid' => <integer>,
],
'VideoSelectorProgramId' => [
'ProgramId' => <integer>,
],
],
],
],
'LogicalInterfaceNames' => ['<string>', ...],
],
// ...
],
'InputSpecification' => [
'Codec' => 'MPEG2|AVC|HEVC',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'Resolution' => 'SD|HD|UHD',
],
'LogLevel' => 'ERROR|WARNING|INFO|DEBUG|DISABLED',
'Maintenance' => [
'MaintenanceDay' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartTime' => '<string>',
],
'Name' => '<string>',
'PipelineDetails' => [
[
'ActiveInputAttachmentName' => '<string>',
'ActiveInputSwitchActionName' => '<string>',
'ActiveMotionGraphicsActionName' => '<string>',
'ActiveMotionGraphicsUri' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'PipelinesRunningCount' => <integer>,
'RoleArn' => '<string>',
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED|UPDATING|UPDATE_FAILED',
'Tags' => ['<string>', ...],
'Vpc' => [
'AvailabilityZones' => ['<string>', ...],
'NetworkInterfaceIds' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
]
Result Details
Members
- AnywhereSettings
-
- Type: DescribeAnywhereSettings structure
Elemental anywhere settings - Arn
-
- Type: string
- CdiInputSpecification
-
- Type: CdiInputSpecification structure
- ChannelClass
-
- Type: string
A standard channel has two encoding pipelines and a single pipeline channel only has one. - Destinations
-
- Type: Array of OutputDestination structures
- EgressEndpoints
-
- Type: Array of ChannelEgressEndpoint structures
- EncoderSettings
-
- Type: EncoderSettings structure
Encoder Settings - Id
-
- Type: string
- InputAttachments
-
- Type: Array of InputAttachment structures
- InputSpecification
-
- Type: InputSpecification structure
- LogLevel
-
- Type: string
The log level the user wants for their channel. - Maintenance
-
- Type: MaintenanceStatus structure
- Name
-
- Type: string
- PipelineDetails
-
- Type: Array of PipelineDetail structures
- PipelinesRunningCount
-
- Type: int
- RoleArn
-
- Type: string
- State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Vpc
-
- Type: VpcOutputSettingsDescription structure
The properties for a private VPC Output
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeChannelPlacementGroup
$result = $client->describeChannelPlacementGroup([/* ... */]); $promise = $client->describeChannelPlacementGroupAsync([/* ... */]);
Get details about a ChannelPlacementGroup.
Parameter Syntax
$result = $client->describeChannelPlacementGroup([
'ChannelPlacementGroupId' => '<string>', // REQUIRED
'ClusterId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ChannelPlacementGroupId
-
- Required: Yes
- Type: string
- ClusterId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'Channels' => ['<string>', ...],
'ClusterId' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Nodes' => ['<string>', ...],
'State' => 'UNASSIGNED|ASSIGNING|ASSIGNED|DELETING|DELETE_FAILED|DELETED|UNASSIGNING',
]
Result Details
Members
- Arn
-
- Type: string
- Channels
-
- Type: Array of strings
- ClusterId
-
- Type: string
- Id
-
- Type: string
- Name
-
- Type: string
- Nodes
-
- Type: Array of strings
- State
-
- Type: string
Used in DescribeChannelPlacementGroupResult
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeCluster
$result = $client->describeCluster([/* ... */]); $promise = $client->describeClusterAsync([/* ... */]);
Get details about a Cluster.
Parameter Syntax
$result = $client->describeCluster([
'ClusterId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'ChannelIds' => ['<string>', ...],
'ClusterType' => 'ON_PREMISES',
'Id' => '<string>',
'InstanceRoleArn' => '<string>',
'Name' => '<string>',
'NetworkSettings' => [
'DefaultRoute' => '<string>',
'InterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkId' => '<string>',
],
// ...
],
],
'State' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETE_FAILED|DELETED',
]
Result Details
Members
- Arn
-
- Type: string
- ChannelIds
-
- Type: Array of strings
- ClusterType
-
- Type: string
Used in CreateClusterSummary, DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult. - Id
-
- Type: string
- InstanceRoleArn
-
- Type: string
- Name
-
- Type: string
- NetworkSettings
-
- Type: ClusterNetworkSettings structure
Used in DescribeClusterResult, DescribeClusterSummary, UpdateClusterResult. - State
-
- Type: string
Used in DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeInput
$result = $client->describeInput([/* ... */]); $promise = $client->describeInputAsync([/* ... */]);
Produces details about an input
Parameter Syntax
$result = $client->describeInput([
'InputId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InputId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'AttachedChannels' => ['<string>', ...],
'Destinations' => [
[
'Ip' => '<string>',
'Network' => '<string>',
'NetworkRoutes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'Port' => '<string>',
'Url' => '<string>',
'Vpc' => [
'AvailabilityZone' => '<string>',
'NetworkInterfaceId' => '<string>',
],
],
// ...
],
'Id' => '<string>',
'InputClass' => 'STANDARD|SINGLE_PIPELINE',
'InputDevices' => [
[
'Id' => '<string>',
],
// ...
],
'InputNetworkLocation' => 'AWS|ON_PREMISES',
'InputPartnerIds' => ['<string>', ...],
'InputSourceType' => 'STATIC|DYNAMIC',
'MediaConnectFlows' => [
[
'FlowArn' => '<string>',
],
// ...
],
'MulticastSettings' => [
'Sources' => [
[
'SourceIp' => '<string>',
'Url' => '<string>',
],
// ...
],
],
'Name' => '<string>',
'RoleArn' => '<string>',
'SecurityGroups' => ['<string>', ...],
'Sources' => [
[
'PasswordParam' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
'SrtCallerSources' => [
[
'Decryption' => [
'Algorithm' => 'AES128|AES192|AES256',
'PassphraseSecretArn' => '<string>',
],
'MinimumLatency' => <integer>,
'SrtListenerAddress' => '<string>',
'SrtListenerPort' => '<string>',
'StreamId' => '<string>',
],
// ...
],
],
'State' => 'CREATING|DETACHED|ATTACHED|DELETING|DELETED',
'Tags' => ['<string>', ...],
'Type' => 'UDP_PUSH|RTP_PUSH|RTMP_PUSH|RTMP_PULL|URL_PULL|MP4_FILE|MEDIACONNECT|INPUT_DEVICE|AWS_CDI|TS_FILE|SRT_CALLER|MULTICAST',
]
Result Details
Members
- Arn
-
- Type: string
- AttachedChannels
-
- Type: Array of strings
- Destinations
-
- Type: Array of InputDestination structures
- Id
-
- Type: string
- InputClass
-
- Type: string
A standard input has two sources and a single pipeline input only has one. - InputDevices
-
- Type: Array of InputDeviceSettings structures
- InputNetworkLocation
-
- Type: string
With the introduction of MediaLive Anywhere, a MediaLive input can now exist in two different places: AWS orinside an on-premises datacenter. By default all inputs will continue to be AWS inputs. - InputPartnerIds
-
- Type: Array of strings
- InputSourceType
-
- Type: string
There are two types of input sources, static and dynamic. If an input source is dynamic you canchange the source url of the input dynamically using an input switch action. Currently, two input typessupport a dynamic url at this time, MP4_FILE and TS_FILE. By default all input sources are static. - MediaConnectFlows
-
- Type: Array of MediaConnectFlow structures
- MulticastSettings
-
- Type: MulticastSettings structure
Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses. - Name
-
- Type: string
- RoleArn
-
- Type: string
- SecurityGroups
-
- Type: Array of strings
- Sources
-
- Type: Array of InputSource structures
- SrtSettings
-
- Type: SrtSettings structure
The configured sources for this SRT input. - State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Type
-
- Type: string
The different types of inputs that AWS Elemental MediaLive supports.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeInputDevice
$result = $client->describeInputDevice([/* ... */]); $promise = $client->describeInputDeviceAsync([/* ... */]);
Gets the details for the input device
Parameter Syntax
$result = $client->describeInputDevice([
'InputDeviceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InputDeviceId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'AvailabilityZone' => '<string>',
'ConnectionState' => 'DISCONNECTED|CONNECTED',
'DeviceSettingsSyncState' => 'SYNCED|SYNCING',
'DeviceUpdateStatus' => 'UP_TO_DATE|NOT_UP_TO_DATE|UPDATING',
'HdDeviceSettings' => [
'ActiveInput' => 'HDMI|SDI',
'ConfiguredInput' => 'AUTO|HDMI|SDI',
'DeviceState' => 'IDLE|STREAMING',
'Framerate' => <float>,
'Height' => <integer>,
'LatencyMs' => <integer>,
'MaxBitrate' => <integer>,
'ScanType' => 'INTERLACED|PROGRESSIVE',
'Width' => <integer>,
],
'Id' => '<string>',
'MacAddress' => '<string>',
'MedialiveInputArns' => ['<string>', ...],
'Name' => '<string>',
'NetworkSettings' => [
'DnsAddresses' => ['<string>', ...],
'Gateway' => '<string>',
'IpAddress' => '<string>',
'IpScheme' => 'STATIC|DHCP',
'SubnetMask' => '<string>',
],
'OutputType' => 'NONE|MEDIALIVE_INPUT|MEDIACONNECT_FLOW',
'SerialNumber' => '<string>',
'Tags' => ['<string>', ...],
'Type' => 'HD|UHD',
'UhdDeviceSettings' => [
'ActiveInput' => 'HDMI|SDI',
'AudioChannelPairs' => [
[
'Id' => <integer>,
'Profile' => 'DISABLED|VBR-AAC_HHE-16000|VBR-AAC_HE-64000|VBR-AAC_LC-128000|CBR-AAC_HQ-192000|CBR-AAC_HQ-256000|CBR-AAC_HQ-384000|CBR-AAC_HQ-512000',
],
// ...
],
'Codec' => 'HEVC|AVC',
'ConfiguredInput' => 'AUTO|HDMI|SDI',
'DeviceState' => 'IDLE|STREAMING',
'Framerate' => <float>,
'Height' => <integer>,
'LatencyMs' => <integer>,
'MaxBitrate' => <integer>,
'MediaconnectSettings' => [
'FlowArn' => '<string>',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
'SourceName' => '<string>',
],
'ScanType' => 'INTERLACED|PROGRESSIVE',
'Width' => <integer>,
],
]
Result Details
Members
- Arn
-
- Type: string
- AvailabilityZone
-
- Type: string
- ConnectionState
-
- Type: string
The state of the connection between the input device and AWS. - DeviceSettingsSyncState
-
- Type: string
The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration. - DeviceUpdateStatus
-
- Type: string
The status of software on the input device. - HdDeviceSettings
-
- Type: InputDeviceHdSettings structure
Settings that describe the active source from the input device, and the video characteristics of that source. - Id
-
- Type: string
- MacAddress
-
- Type: string
- MedialiveInputArns
-
- Type: Array of strings
- Name
-
- Type: string
- NetworkSettings
-
- Type: InputDeviceNetworkSettings structure
The network settings for the input device. - OutputType
-
- Type: string
The output attachment type of the input device. - SerialNumber
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Type
-
- Type: string
The type of the input device. For an AWS Elemental Link device that outputs resolutions up to 1080, choose "HD". - UhdDeviceSettings
-
- Type: InputDeviceUhdSettings structure
Settings that describe the active source from the input device, and the video characteristics of that source.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeInputDeviceThumbnail
$result = $client->describeInputDeviceThumbnail([/* ... */]); $promise = $client->describeInputDeviceThumbnailAsync([/* ... */]);
Get the latest thumbnail data for the input device.
Parameter Syntax
$result = $client->describeInputDeviceThumbnail([
'Accept' => 'image/jpeg', // REQUIRED
'InputDeviceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Accept
-
- Required: Yes
- Type: string
- InputDeviceId
-
- Required: Yes
- Type: string
Result Syntax
[
'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
'ContentLength' => <integer>,
'ContentType' => 'image/jpeg',
'ETag' => '<string>',
'LastModified' => <DateTime>,
]
Result Details
Members
- Body
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
- ContentLength
-
- Type: long (int|float)
- ContentType
-
- Type: string
- ETag
-
- Type: string
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeInputSecurityGroup
$result = $client->describeInputSecurityGroup([/* ... */]); $promise = $client->describeInputSecurityGroupAsync([/* ... */]);
Produces a summary of an Input Security Group
Parameter Syntax
$result = $client->describeInputSecurityGroup([
'InputSecurityGroupId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InputSecurityGroupId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'Id' => '<string>',
'Inputs' => ['<string>', ...],
'State' => 'IDLE|IN_USE|UPDATING|DELETED',
'Tags' => ['<string>', ...],
'WhitelistRules' => [
[
'Cidr' => '<string>',
],
// ...
],
]
Result Details
Members
- Arn
-
- Type: string
- Id
-
- Type: string
- Inputs
-
- Type: Array of strings
- State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- WhitelistRules
-
- Type: Array of InputWhitelistRule structures
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeMultiplex
$result = $client->describeMultiplex([/* ... */]); $promise = $client->describeMultiplexAsync([/* ... */]);
Gets details about a multiplex.
Parameter Syntax
$result = $client->describeMultiplex([
'MultiplexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MultiplexId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'AvailabilityZones' => ['<string>', ...],
'Destinations' => [
[
'MediaConnectSettings' => [
'EntitlementArn' => '<string>',
],
],
// ...
],
'Id' => '<string>',
'MultiplexSettings' => [
'MaximumVideoBufferDelayMilliseconds' => <integer>,
'TransportStreamBitrate' => <integer>,
'TransportStreamId' => <integer>,
'TransportStreamReservedBitrate' => <integer>,
],
'Name' => '<string>',
'PipelinesRunningCount' => <integer>,
'ProgramCount' => <integer>,
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- AvailabilityZones
-
- Type: Array of strings
- Destinations
-
- Type: Array of MultiplexOutputDestination structures
- Id
-
- Type: string
- MultiplexSettings
-
- Type: MultiplexSettings structure
Contains configuration for a Multiplex event - Name
-
- Type: string
- PipelinesRunningCount
-
- Type: int
- ProgramCount
-
- Type: int
- State
-
- Type: string
The current state of the multiplex. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeMultiplexProgram
$result = $client->describeMultiplexProgram([/* ... */]); $promise = $client->describeMultiplexProgramAsync([/* ... */]);
Get the details for a program in a multiplex.
Parameter Syntax
$result = $client->describeMultiplexProgram([
'MultiplexId' => '<string>', // REQUIRED
'ProgramName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MultiplexId
-
- Required: Yes
- Type: string
- ProgramName
-
- Required: Yes
- Type: string
Result Syntax
[
'ChannelId' => '<string>',
'MultiplexProgramSettings' => [
'PreferredChannelPipeline' => 'CURRENTLY_ACTIVE|PIPELINE_0|PIPELINE_1',
'ProgramNumber' => <integer>,
'ServiceDescriptor' => [
'ProviderName' => '<string>',
'ServiceName' => '<string>',
],
'VideoSettings' => [
'ConstantBitrate' => <integer>,
'StatmuxSettings' => [
'MaximumBitrate' => <integer>,
'MinimumBitrate' => <integer>,
'Priority' => <integer>,
],
],
],
'PacketIdentifiersMap' => [
'AribCaptionsPid' => <integer>,
'AudioPids' => [<integer>, ...],
'DvbSubPids' => [<integer>, ...],
'DvbTeletextPid' => <integer>,
'DvbTeletextPids' => [<integer>, ...],
'EcmPid' => <integer>,
'EtvPlatformPid' => <integer>,
'EtvSignalPid' => <integer>,
'KlvDataPids' => [<integer>, ...],
'PcrPid' => <integer>,
'PmtPid' => <integer>,
'PrivateMetadataPid' => <integer>,
'Scte27Pids' => [<integer>, ...],
'Scte35Pid' => <integer>,
'Smpte2038Pid' => <integer>,
'TimedMetadataPid' => <integer>,
'VideoPid' => <integer>,
],
'PipelineDetails' => [
[
'ActiveChannelPipeline' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'ProgramName' => '<string>',
]
Result Details
Members
- ChannelId
-
- Type: string
- MultiplexProgramSettings
-
- Type: MultiplexProgramSettings structure
Multiplex Program settings configuration. - PacketIdentifiersMap
-
- Type: MultiplexProgramPacketIdentifiersMap structure
Packet identifiers map for a given Multiplex program. - PipelineDetails
-
- Type: Array of MultiplexProgramPipelineDetail structures
- ProgramName
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeNetwork
$result = $client->describeNetwork([/* ... */]); $promise = $client->describeNetworkAsync([/* ... */]);
Get details about a Network.
Parameter Syntax
$result = $client->describeNetwork([
'NetworkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- NetworkId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'AssociatedClusterIds' => ['<string>', ...],
'Id' => '<string>',
'IpPools' => [
[
'Cidr' => '<string>',
],
// ...
],
'Name' => '<string>',
'Routes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'State' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|IDLE|IN_USE|UPDATING|DELETE_FAILED|DELETED',
]
Result Details
Members
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeNode
$result = $client->describeNode([/* ... */]); $promise = $client->describeNodeAsync([/* ... */]);
Get details about a Node in the specified Cluster.
Parameter Syntax
$result = $client->describeNode([
'ClusterId' => '<string>', // REQUIRED
'NodeId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
- NodeId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'ChannelPlacementGroups' => ['<string>', ...],
'ClusterId' => '<string>',
'ConnectionState' => 'CONNECTED|DISCONNECTED',
'Id' => '<string>',
'InstanceArn' => '<string>',
'Name' => '<string>',
'NodeInterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkInterfaceMode' => 'NAT|BRIDGE',
'PhysicalInterfaceName' => '<string>',
],
// ...
],
'Role' => 'BACKUP|ACTIVE',
'State' => 'CREATED|REGISTERING|READY_TO_ACTIVATE|REGISTRATION_FAILED|ACTIVATION_FAILED|ACTIVE|READY|IN_USE|DEREGISTERING|DRAINING|DEREGISTRATION_FAILED|DEREGISTERED',
]
Result Details
Members
- Arn
-
- Type: string
- ChannelPlacementGroups
-
- Type: Array of strings
- ClusterId
-
- Type: string
- ConnectionState
-
- Type: string
Used in DescribeNodeSummary. - Id
-
- Type: string
- InstanceArn
-
- Type: string
- Name
-
- Type: string
- NodeInterfaceMappings
-
- Type: Array of NodeInterfaceMapping structures
- Role
-
- Type: string
Used in CreateNodeRequest, CreateNodeRegistrationScriptRequest, DescribeNodeResult, DescribeNodeSummary, UpdateNodeRequest. - State
-
- Type: string
Used in DescribeNodeSummary.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeOffering
$result = $client->describeOffering([/* ... */]); $promise = $client->describeOfferingAsync([/* ... */]);
Get details for an offering.
Parameter Syntax
$result = $client->describeOffering([
'OfferingId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- OfferingId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CurrencyCode' => '<string>',
'Duration' => <integer>,
'DurationUnits' => 'MONTHS',
'FixedPrice' => <float>,
'OfferingDescription' => '<string>',
'OfferingId' => '<string>',
'OfferingType' => 'NO_UPFRONT',
'Region' => '<string>',
'ResourceSpecification' => [
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Codec' => 'MPEG2|AVC|HEVC|AUDIO|LINK|AV1',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'MaximumFramerate' => 'MAX_30_FPS|MAX_60_FPS',
'Resolution' => 'SD|HD|FHD|UHD',
'ResourceType' => 'INPUT|OUTPUT|MULTIPLEX|CHANNEL',
'SpecialFeature' => 'ADVANCED_AUDIO|AUDIO_NORMALIZATION|MGHD|MGUHD',
'VideoQuality' => 'STANDARD|ENHANCED|PREMIUM',
],
'UsagePrice' => <float>,
]
Result Details
Members
- Arn
-
- Type: string
- CurrencyCode
-
- Type: string
- Duration
-
- Type: int
- DurationUnits
-
- Type: string
Units for duration, e.g. 'MONTHS' - FixedPrice
-
- Type: double
- OfferingDescription
-
- Type: string
- OfferingId
-
- Type: string
- OfferingType
-
- Type: string
Offering type, e.g. 'NO_UPFRONT' - Region
-
- Type: string
- ResourceSpecification
-
- Type: ReservationResourceSpecification structure
Resource configuration (codec, resolution, bitrate, ...) - UsagePrice
-
- Type: double
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeReservation
$result = $client->describeReservation([/* ... */]); $promise = $client->describeReservationAsync([/* ... */]);
Get details for a reservation.
Parameter Syntax
$result = $client->describeReservation([
'ReservationId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ReservationId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'Count' => <integer>,
'CurrencyCode' => '<string>',
'Duration' => <integer>,
'DurationUnits' => 'MONTHS',
'End' => '<string>',
'FixedPrice' => <float>,
'Name' => '<string>',
'OfferingDescription' => '<string>',
'OfferingId' => '<string>',
'OfferingType' => 'NO_UPFRONT',
'Region' => '<string>',
'RenewalSettings' => [
'AutomaticRenewal' => 'DISABLED|ENABLED|UNAVAILABLE',
'RenewalCount' => <integer>,
],
'ReservationId' => '<string>',
'ResourceSpecification' => [
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Codec' => 'MPEG2|AVC|HEVC|AUDIO|LINK|AV1',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'MaximumFramerate' => 'MAX_30_FPS|MAX_60_FPS',
'Resolution' => 'SD|HD|FHD|UHD',
'ResourceType' => 'INPUT|OUTPUT|MULTIPLEX|CHANNEL',
'SpecialFeature' => 'ADVANCED_AUDIO|AUDIO_NORMALIZATION|MGHD|MGUHD',
'VideoQuality' => 'STANDARD|ENHANCED|PREMIUM',
],
'Start' => '<string>',
'State' => 'ACTIVE|EXPIRED|CANCELED|DELETED',
'Tags' => ['<string>', ...],
'UsagePrice' => <float>,
]
Result Details
Members
- Arn
-
- Type: string
- Count
-
- Type: int
- CurrencyCode
-
- Type: string
- Duration
-
- Type: int
- DurationUnits
-
- Type: string
Units for duration, e.g. 'MONTHS' - End
-
- Type: string
- FixedPrice
-
- Type: double
- Name
-
- Type: string
- OfferingDescription
-
- Type: string
- OfferingId
-
- Type: string
- OfferingType
-
- Type: string
Offering type, e.g. 'NO_UPFRONT' - Region
-
- Type: string
- RenewalSettings
-
- Type: RenewalSettings structure
The Renewal settings for Reservations - ReservationId
-
- Type: string
- ResourceSpecification
-
- Type: ReservationResourceSpecification structure
Resource configuration (codec, resolution, bitrate, ...) - Start
-
- Type: string
- State
-
- Type: string
Current reservation state - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- UsagePrice
-
- Type: double
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeSchedule
$result = $client->describeSchedule([/* ... */]); $promise = $client->describeScheduleAsync([/* ... */]);
Get a channel schedule
Parameter Syntax
$result = $client->describeSchedule([
'ChannelId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- ChannelId
-
- Required: Yes
- Type: string
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[
'NextToken' => '<string>',
'ScheduleActions' => [
[
'ActionName' => '<string>',
'ScheduleActionSettings' => [
'HlsId3SegmentTaggingSettings' => [
'Id3' => '<string>',
'Tag' => '<string>',
],
'HlsTimedMetadataSettings' => [
'Id3' => '<string>',
],
'InputPrepareSettings' => [
'InputAttachmentNameReference' => '<string>',
'InputClippingSettings' => [
'InputTimecodeSource' => 'ZEROBASED|EMBEDDED',
'StartTimecode' => [
'Timecode' => '<string>',
],
'StopTimecode' => [
'LastFrameClippingBehavior' => 'EXCLUDE_LAST_FRAME|INCLUDE_LAST_FRAME',
'Timecode' => '<string>',
],
],
'UrlPath' => ['<string>', ...],
],
'InputSwitchSettings' => [
'InputAttachmentNameReference' => '<string>',
'InputClippingSettings' => [
'InputTimecodeSource' => 'ZEROBASED|EMBEDDED',
'StartTimecode' => [
'Timecode' => '<string>',
],
'StopTimecode' => [
'LastFrameClippingBehavior' => 'EXCLUDE_LAST_FRAME|INCLUDE_LAST_FRAME',
'Timecode' => '<string>',
],
],
'UrlPath' => ['<string>', ...],
],
'MotionGraphicsImageActivateSettings' => [
'Duration' => <integer>,
'PasswordParam' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
'MotionGraphicsImageDeactivateSettings' => [
],
'PauseStateSettings' => [
'Pipelines' => [
[
'PipelineId' => 'PIPELINE_0|PIPELINE_1',
],
// ...
],
],
'Scte35InputSettings' => [
'InputAttachmentNameReference' => '<string>',
'Mode' => 'FIXED|FOLLOW_ACTIVE',
],
'Scte35ReturnToNetworkSettings' => [
'SpliceEventId' => <integer>,
],
'Scte35SpliceInsertSettings' => [
'Duration' => <integer>,
'SpliceEventId' => <integer>,
],
'Scte35TimeSignalSettings' => [
'Scte35Descriptors' => [
[
'Scte35DescriptorSettings' => [
'SegmentationDescriptorScte35DescriptorSettings' => [
'DeliveryRestrictions' => [
'ArchiveAllowedFlag' => 'ARCHIVE_NOT_ALLOWED|ARCHIVE_ALLOWED',
'DeviceRestrictions' => 'NONE|RESTRICT_GROUP0|RESTRICT_GROUP1|RESTRICT_GROUP2',
'NoRegionalBlackoutFlag' => 'REGIONAL_BLACKOUT|NO_REGIONAL_BLACKOUT',
'WebDeliveryAllowedFlag' => 'WEB_DELIVERY_NOT_ALLOWED|WEB_DELIVERY_ALLOWED',
],
'SegmentNum' => <integer>,
'SegmentationCancelIndicator' => 'SEGMENTATION_EVENT_NOT_CANCELED|SEGMENTATION_EVENT_CANCELED',
'SegmentationDuration' => <integer>,
'SegmentationEventId' => <integer>,
'SegmentationTypeId' => <integer>,
'SegmentationUpid' => '<string>',
'SegmentationUpidType' => <integer>,
'SegmentsExpected' => <integer>,
'SubSegmentNum' => <integer>,
'SubSegmentsExpected' => <integer>,
],
],
],
// ...
],
],
'StaticImageActivateSettings' => [
'Duration' => <integer>,
'FadeIn' => <integer>,
'FadeOut' => <integer>,
'Height' => <integer>,
'Image' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'ImageX' => <integer>,
'ImageY' => <integer>,
'Layer' => <integer>,
'Opacity' => <integer>,
'Width' => <integer>,
],
'StaticImageDeactivateSettings' => [
'FadeOut' => <integer>,
'Layer' => <integer>,
],
'StaticImageOutputActivateSettings' => [
'Duration' => <integer>,
'FadeIn' => <integer>,
'FadeOut' => <integer>,
'Height' => <integer>,
'Image' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'ImageX' => <integer>,
'ImageY' => <integer>,
'Layer' => <integer>,
'Opacity' => <integer>,
'OutputNames' => ['<string>', ...],
'Width' => <integer>,
],
'StaticImageOutputDeactivateSettings' => [
'FadeOut' => <integer>,
'Layer' => <integer>,
'OutputNames' => ['<string>', ...],
],
],
'ScheduleActionStartSettings' => [
'FixedModeScheduleActionStartSettings' => [
'Time' => '<string>',
],
'FollowModeScheduleActionStartSettings' => [
'FollowPoint' => 'END|START',
'ReferenceActionName' => '<string>',
],
'ImmediateModeScheduleActionStartSettings' => [
],
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- ScheduleActions
-
- Type: Array of ScheduleAction structures
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
DescribeThumbnails
$result = $client->describeThumbnails([/* ... */]); $promise = $client->describeThumbnailsAsync([/* ... */]);
Describe the latest thumbnails data.
Parameter Syntax
$result = $client->describeThumbnails([
'ChannelId' => '<string>', // REQUIRED
'PipelineId' => '<string>', // REQUIRED
'ThumbnailType' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ChannelId
-
- Required: Yes
- Type: string
- PipelineId
-
- Required: Yes
- Type: string
- ThumbnailType
-
- Required: Yes
- Type: string
Result Syntax
[
'ThumbnailDetails' => [
[
'PipelineId' => '<string>',
'Thumbnails' => [
[
'Body' => '<string>',
'ContentType' => '<string>',
'ThumbnailType' => 'UNSPECIFIED|CURRENT_ACTIVE',
'TimeStamp' => <DateTime>,
],
// ...
],
],
// ...
],
]
Result Details
Members
- ThumbnailDetails
-
- Type: Array of ThumbnailDetail structures
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
GetCloudWatchAlarmTemplate
$result = $client->getCloudWatchAlarmTemplate([/* ... */]); $promise = $client->getCloudWatchAlarmTemplateAsync([/* ... */]);
Retrieves the specified cloudwatch alarm template.
Parameter Syntax
$result = $client->getCloudWatchAlarmTemplate([
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'ComparisonOperator' => 'GreaterThanOrEqualToThreshold|GreaterThanThreshold|LessThanThreshold|LessThanOrEqualToThreshold',
'CreatedAt' => <DateTime>,
'DatapointsToAlarm' => <integer>,
'Description' => '<string>',
'EvaluationPeriods' => <integer>,
'GroupId' => '<string>',
'Id' => '<string>',
'MetricName' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Period' => <integer>,
'Statistic' => 'SampleCount|Average|Sum|Minimum|Maximum',
'Tags' => ['<string>', ...],
'TargetResourceType' => 'CLOUDFRONT_DISTRIBUTION|MEDIALIVE_MULTIPLEX|MEDIALIVE_CHANNEL|MEDIALIVE_INPUT_DEVICE|MEDIAPACKAGE_CHANNEL|MEDIAPACKAGE_ORIGIN_ENDPOINT|MEDIACONNECT_FLOW|S3_BUCKET',
'Threshold' => <float>,
'TreatMissingData' => 'notBreaching|breaching|ignore|missing',
]
Result Details
Members
- Arn
-
- Type: string
- ComparisonOperator
-
- Type: string
The comparison operator used to compare the specified statistic and the threshold. - CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DatapointsToAlarm
-
- Type: int
- Description
-
- Type: string
- EvaluationPeriods
-
- Type: int
- GroupId
-
- Type: string
- Id
-
- Type: string
- MetricName
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Period
-
- Type: int
- Statistic
-
- Type: string
The statistic to apply to the alarm's metric data. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource. - TargetResourceType
-
- Type: string
The resource type this template should dynamically generate cloudwatch metric alarms for. - Threshold
-
- Type: double
- TreatMissingData
-
- Type: string
Specifies how missing data points are treated when evaluating the alarm's condition.
Errors
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
GetCloudWatchAlarmTemplateGroup
$result = $client->getCloudWatchAlarmTemplateGroup([/* ... */]); $promise = $client->getCloudWatchAlarmTemplateGroupAsync([/* ... */]);
Retrieves the specified cloudwatch alarm template group.
Parameter Syntax
$result = $client->getCloudWatchAlarmTemplateGroup([
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- Id
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
GetEventBridgeRuleTemplate
$result = $client->getEventBridgeRuleTemplate([/* ... */]); $promise = $client->getEventBridgeRuleTemplateAsync([/* ... */]);
Retrieves the specified eventbridge rule template.
Parameter Syntax
$result = $client->getEventBridgeRuleTemplate([
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'EventTargets' => [
[
'Arn' => '<string>',
],
// ...
],
'EventType' => 'MEDIALIVE_MULTIPLEX_ALERT|MEDIALIVE_MULTIPLEX_STATE_CHANGE|MEDIALIVE_CHANNEL_ALERT|MEDIALIVE_CHANNEL_INPUT_CHANGE|MEDIALIVE_CHANNEL_STATE_CHANGE|MEDIAPACKAGE_INPUT_NOTIFICATION|MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION|MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION|SIGNAL_MAP_ACTIVE_ALARM|MEDIACONNECT_ALERT|MEDIACONNECT_SOURCE_HEALTH|MEDIACONNECT_OUTPUT_HEALTH|MEDIACONNECT_FLOW_STATUS_CHANGE',
'GroupId' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- EventTargets
-
- Type: Array of EventBridgeRuleTemplateTarget structures
- EventType
-
- Type: string
The type of event to match with the rule. - GroupId
-
- Type: string
- Id
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
GetEventBridgeRuleTemplateGroup
$result = $client->getEventBridgeRuleTemplateGroup([/* ... */]); $promise = $client->getEventBridgeRuleTemplateGroupAsync([/* ... */]);
Retrieves the specified eventbridge rule template group.
Parameter Syntax
$result = $client->getEventBridgeRuleTemplateGroup([
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- Id
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
GetSignalMap
$result = $client->getSignalMap([/* ... */]); $promise = $client->getSignalMapAsync([/* ... */]);
Retrieves the specified signal map.
Parameter Syntax
$result = $client->getSignalMap([
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CloudWatchAlarmTemplateGroupIds' => ['<string>', ...],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DiscoveryEntryPointArn' => '<string>',
'ErrorMessage' => '<string>',
'EventBridgeRuleTemplateGroupIds' => ['<string>', ...],
'FailedMediaResourceMap' => [
'<__string>' => [
'Destinations' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
'Name' => '<string>',
'Sources' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
],
// ...
],
'Id' => '<string>',
'LastDiscoveredAt' => <DateTime>,
'LastSuccessfulMonitorDeployment' => [
'DetailsUri' => '<string>',
'Status' => 'NOT_DEPLOYED|DRY_RUN_DEPLOYMENT_COMPLETE|DRY_RUN_DEPLOYMENT_FAILED|DRY_RUN_DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_COMPLETE|DEPLOYMENT_FAILED|DEPLOYMENT_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_IN_PROGRESS',
],
'MediaResourceMap' => [
'<__string>' => [
'Destinations' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
'Name' => '<string>',
'Sources' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
],
// ...
],
'ModifiedAt' => <DateTime>,
'MonitorChangesPendingDeployment' => true || false,
'MonitorDeployment' => [
'DetailsUri' => '<string>',
'ErrorMessage' => '<string>',
'Status' => 'NOT_DEPLOYED|DRY_RUN_DEPLOYMENT_COMPLETE|DRY_RUN_DEPLOYMENT_FAILED|DRY_RUN_DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_COMPLETE|DEPLOYMENT_FAILED|DEPLOYMENT_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_IN_PROGRESS',
],
'Name' => '<string>',
'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_REVERTED|UPDATE_FAILED|READY|NOT_READY',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CloudWatchAlarmTemplateGroupIds
-
- Type: Array of strings
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- DiscoveryEntryPointArn
-
- Type: string
- ErrorMessage
-
- Type: string
- EventBridgeRuleTemplateGroupIds
-
- Type: Array of strings
- FailedMediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an incomplete AWS media workflow as a graph. - Id
-
- Type: string
- LastDiscoveredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastSuccessfulMonitorDeployment
-
- Type: SuccessfulMonitorDeployment structure
Represents the latest successful monitor deployment of a signal map. - MediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an AWS media workflow as a graph. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- MonitorChangesPendingDeployment
-
- Type: boolean
- MonitorDeployment
-
- Type: MonitorDeployment structure
Represents the latest monitor deployment of a signal map. - Name
-
- Type: string
- Status
-
- Type: string
A signal map's current status which is dependent on its lifecycle actions or associated jobs. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
ListChannelPlacementGroups
$result = $client->listChannelPlacementGroups([/* ... */]); $promise = $client->listChannelPlacementGroupsAsync([/* ... */]);
Retrieve the list of ChannelPlacementGroups in the specified Cluster.
Parameter Syntax
$result = $client->listChannelPlacementGroups([
'ClusterId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[
'ChannelPlacementGroups' => [
[
'Arn' => '<string>',
'Channels' => ['<string>', ...],
'ClusterId' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Nodes' => ['<string>', ...],
'State' => 'UNASSIGNED|ASSIGNING|ASSIGNED|DELETING|DELETE_FAILED|DELETED|UNASSIGNING',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ChannelPlacementGroups
-
- Type: Array of DescribeChannelPlacementGroupSummary structures
- NextToken
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListChannels
$result = $client->listChannels([/* ... */]); $promise = $client->listChannelsAsync([/* ... */]);
Produces list of channels that have been created
Parameter Syntax
$result = $client->listChannels([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[
'Channels' => [
[
'AnywhereSettings' => [
'ChannelPlacementGroupId' => '<string>',
'ClusterId' => '<string>',
],
'Arn' => '<string>',
'CdiInputSpecification' => [
'Resolution' => 'SD|HD|FHD|UHD',
],
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
'EgressEndpoints' => [
[
'SourceIp' => '<string>',
],
// ...
],
'Id' => '<string>',
'InputAttachments' => [
[
'AutomaticInputFailoverSettings' => [
'ErrorClearTimeMsec' => <integer>,
'FailoverConditions' => [
[
'FailoverConditionSettings' => [
'AudioSilenceSettings' => [
'AudioSelectorName' => '<string>',
'AudioSilenceThresholdMsec' => <integer>,
],
'InputLossSettings' => [
'InputLossThresholdMsec' => <integer>,
],
'VideoBlackSettings' => [
'BlackDetectThreshold' => <float>,
'VideoBlackThresholdMsec' => <integer>,
],
],
],
// ...
],
'InputPreference' => 'EQUAL_INPUT_PREFERENCE|PRIMARY_INPUT_PREFERRED',
'SecondaryInputId' => '<string>',
],
'InputAttachmentName' => '<string>',
'InputId' => '<string>',
'InputSettings' => [
'AudioSelectors' => [
[
'Name' => '<string>',
'SelectorSettings' => [
'AudioHlsRenditionSelection' => [
'GroupId' => '<string>',
'Name' => '<string>',
],
'AudioLanguageSelection' => [
'LanguageCode' => '<string>',
'LanguageSelectionPolicy' => 'LOOSE|STRICT',
],
'AudioPidSelection' => [
'Pid' => <integer>,
],
'AudioTrackSelection' => [
'DolbyEDecode' => [
'ProgramSelection' => 'ALL_CHANNELS|PROGRAM_1|PROGRAM_2|PROGRAM_3|PROGRAM_4|PROGRAM_5|PROGRAM_6|PROGRAM_7|PROGRAM_8',
],
'Tracks' => [
[
'Track' => <integer>,
],
// ...
],
],
],
],
// ...
],
'CaptionSelectors' => [
[
'LanguageCode' => '<string>',
'Name' => '<string>',
'SelectorSettings' => [
'AncillarySourceSettings' => [
'SourceAncillaryChannelNumber' => <integer>,
],
'AribSourceSettings' => [
],
'DvbSubSourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'EmbeddedSourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Scte20Detection' => 'AUTO|OFF',
'Source608ChannelNumber' => <integer>,
'Source608TrackNumber' => <integer>,
],
'Scte20SourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Source608ChannelNumber' => <integer>,
],
'Scte27SourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'TeletextSourceSettings' => [
'OutputRectangle' => [
'Height' => <float>,
'LeftOffset' => <float>,
'TopOffset' => <float>,
'Width' => <float>,
],
'PageNumber' => '<string>',
],
],
],
// ...
],
'DeblockFilter' => 'DISABLED|ENABLED',
'DenoiseFilter' => 'DISABLED|ENABLED',
'FilterStrength' => <integer>,
'InputFilter' => 'AUTO|DISABLED|FORCED',
'NetworkInputSettings' => [
'HlsInputSettings' => [
'Bandwidth' => <integer>,
'BufferSegments' => <integer>,
'Retries' => <integer>,
'RetryInterval' => <integer>,
'Scte35Source' => 'MANIFEST|SEGMENTS',
],
'MulticastInputSettings' => [
'SourceIpAddress' => '<string>',
],
'ServerValidation' => 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME|CHECK_CRYPTOGRAPHY_ONLY',
],
'Scte35Pid' => <integer>,
'Smpte2038DataPreference' => 'IGNORE|PREFER',
'SourceEndBehavior' => 'CONTINUE|LOOP',
'VideoSelector' => [
'ColorSpace' => 'FOLLOW|HDR10|HLG_2020|REC_601|REC_709',
'ColorSpaceSettings' => [
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
],
'ColorSpaceUsage' => 'FALLBACK|FORCE',
'SelectorSettings' => [
'VideoSelectorPid' => [
'Pid' => <integer>,
],
'VideoSelectorProgramId' => [
'ProgramId' => <integer>,
],
],
],
],
'LogicalInterfaceNames' => ['<string>', ...],
],
// ...
],
'InputSpecification' => [
'Codec' => 'MPEG2|AVC|HEVC',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'Resolution' => 'SD|HD|UHD',
],
'LogLevel' => 'ERROR|WARNING|INFO|DEBUG|DISABLED',
'Maintenance' => [
'MaintenanceDay' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartTime' => '<string>',
],
'Name' => '<string>',
'PipelinesRunningCount' => <integer>,
'RoleArn' => '<string>',
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED|UPDATING|UPDATE_FAILED',
'Tags' => ['<string>', ...],
'Vpc' => [
'AvailabilityZones' => ['<string>', ...],
'NetworkInterfaceIds' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Channels
-
- Type: Array of ChannelSummary structures
- NextToken
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListCloudWatchAlarmTemplateGroups
$result = $client->listCloudWatchAlarmTemplateGroups([/* ... */]); $promise = $client->listCloudWatchAlarmTemplateGroupsAsync([/* ... */]);
Lists cloudwatch alarm template groups.
Parameter Syntax
$result = $client->listCloudWatchAlarmTemplateGroups([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'Scope' => '<string>',
'SignalMapIdentifier' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
- Scope
-
- Type: string
- SignalMapIdentifier
-
- Type: string
Result Syntax
[
'CloudWatchAlarmTemplateGroups' => [
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
'TemplateCount' => <integer>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- CloudWatchAlarmTemplateGroups
-
- Type: Array of CloudWatchAlarmTemplateGroupSummary structures
- NextToken
-
- Type: string
Errors
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
ListCloudWatchAlarmTemplates
$result = $client->listCloudWatchAlarmTemplates([/* ... */]); $promise = $client->listCloudWatchAlarmTemplatesAsync([/* ... */]);
Lists cloudwatch alarm templates.
Parameter Syntax
$result = $client->listCloudWatchAlarmTemplates([
'GroupIdentifier' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'Scope' => '<string>',
'SignalMapIdentifier' => '<string>',
]);
Parameter Details
Members
- GroupIdentifier
-
- Type: string
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
- Scope
-
- Type: string
- SignalMapIdentifier
-
- Type: string
Result Syntax
[
'CloudWatchAlarmTemplates' => [
[
'Arn' => '<string>',
'ComparisonOperator' => 'GreaterThanOrEqualToThreshold|GreaterThanThreshold|LessThanThreshold|LessThanOrEqualToThreshold',
'CreatedAt' => <DateTime>,
'DatapointsToAlarm' => <integer>,
'Description' => '<string>',
'EvaluationPeriods' => <integer>,
'GroupId' => '<string>',
'Id' => '<string>',
'MetricName' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Period' => <integer>,
'Statistic' => 'SampleCount|Average|Sum|Minimum|Maximum',
'Tags' => ['<string>', ...],
'TargetResourceType' => 'CLOUDFRONT_DISTRIBUTION|MEDIALIVE_MULTIPLEX|MEDIALIVE_CHANNEL|MEDIALIVE_INPUT_DEVICE|MEDIAPACKAGE_CHANNEL|MEDIAPACKAGE_ORIGIN_ENDPOINT|MEDIACONNECT_FLOW|S3_BUCKET',
'Threshold' => <float>,
'TreatMissingData' => 'notBreaching|breaching|ignore|missing',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- CloudWatchAlarmTemplates
-
- Type: Array of CloudWatchAlarmTemplateSummary structures
- NextToken
-
- Type: string
Errors
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
ListClusters
$result = $client->listClusters([/* ... */]); $promise = $client->listClustersAsync([/* ... */]);
Retrieve the list of Clusters.
Parameter Syntax
$result = $client->listClusters([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[
'Clusters' => [
[
'Arn' => '<string>',
'ChannelIds' => ['<string>', ...],
'ClusterType' => 'ON_PREMISES',
'Id' => '<string>',
'InstanceRoleArn' => '<string>',
'Name' => '<string>',
'NetworkSettings' => [
'DefaultRoute' => '<string>',
'InterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkId' => '<string>',
],
// ...
],
],
'State' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETE_FAILED|DELETED',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Clusters
-
- Type: Array of DescribeClusterSummary structures
- NextToken
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListEventBridgeRuleTemplateGroups
$result = $client->listEventBridgeRuleTemplateGroups([/* ... */]); $promise = $client->listEventBridgeRuleTemplateGroupsAsync([/* ... */]);
Lists eventbridge rule template groups.
Parameter Syntax
$result = $client->listEventBridgeRuleTemplateGroups([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SignalMapIdentifier' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
- SignalMapIdentifier
-
- Type: string
Result Syntax
[
'EventBridgeRuleTemplateGroups' => [
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
'TemplateCount' => <integer>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- EventBridgeRuleTemplateGroups
-
- Type: Array of EventBridgeRuleTemplateGroupSummary structures
- NextToken
-
- Type: string
Errors
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
ListEventBridgeRuleTemplates
$result = $client->listEventBridgeRuleTemplates([/* ... */]); $promise = $client->listEventBridgeRuleTemplatesAsync([/* ... */]);
Lists eventbridge rule templates.
Parameter Syntax
$result = $client->listEventBridgeRuleTemplates([
'GroupIdentifier' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SignalMapIdentifier' => '<string>',
]);
Parameter Details
Members
- GroupIdentifier
-
- Type: string
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
- SignalMapIdentifier
-
- Type: string
Result Syntax
[
'EventBridgeRuleTemplates' => [
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'EventTargetCount' => <integer>,
'EventType' => 'MEDIALIVE_MULTIPLEX_ALERT|MEDIALIVE_MULTIPLEX_STATE_CHANGE|MEDIALIVE_CHANNEL_ALERT|MEDIALIVE_CHANNEL_INPUT_CHANGE|MEDIALIVE_CHANNEL_STATE_CHANGE|MEDIAPACKAGE_INPUT_NOTIFICATION|MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION|MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION|SIGNAL_MAP_ACTIVE_ALARM|MEDIACONNECT_ALERT|MEDIACONNECT_SOURCE_HEALTH|MEDIACONNECT_OUTPUT_HEALTH|MEDIACONNECT_FLOW_STATUS_CHANGE',
'GroupId' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- EventBridgeRuleTemplates
-
- Type: Array of EventBridgeRuleTemplateSummary structures
- NextToken
-
- Type: string
Errors
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
ListInputDeviceTransfers
$result = $client->listInputDeviceTransfers([/* ... */]); $promise = $client->listInputDeviceTransfersAsync([/* ... */]);
List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you.
Parameter Syntax
$result = $client->listInputDeviceTransfers([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'TransferType' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
- TransferType
-
- Required: Yes
- Type: string
Result Syntax
[
'InputDeviceTransfers' => [
[
'Id' => '<string>',
'Message' => '<string>',
'TargetCustomerId' => '<string>',
'TransferType' => 'OUTGOING|INCOMING',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- InputDeviceTransfers
-
- Type: Array of TransferringInputDeviceSummary structures
- NextToken
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListInputDevices
$result = $client->listInputDevices([/* ... */]); $promise = $client->listInputDevicesAsync([/* ... */]);
List input devices
Parameter Syntax
$result = $client->listInputDevices([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[
'InputDevices' => [
[
'Arn' => '<string>',
'AvailabilityZone' => '<string>',
'ConnectionState' => 'DISCONNECTED|CONNECTED',
'DeviceSettingsSyncState' => 'SYNCED|SYNCING',
'DeviceUpdateStatus' => 'UP_TO_DATE|NOT_UP_TO_DATE|UPDATING',
'HdDeviceSettings' => [
'ActiveInput' => 'HDMI|SDI',
'ConfiguredInput' => 'AUTO|HDMI|SDI',
'DeviceState' => 'IDLE|STREAMING',
'Framerate' => <float>,
'Height' => <integer>,
'LatencyMs' => <integer>,
'MaxBitrate' => <integer>,
'ScanType' => 'INTERLACED|PROGRESSIVE',
'Width' => <integer>,
],
'Id' => '<string>',
'MacAddress' => '<string>',
'MedialiveInputArns' => ['<string>', ...],
'Name' => '<string>',
'NetworkSettings' => [
'DnsAddresses' => ['<string>', ...],
'Gateway' => '<string>',
'IpAddress' => '<string>',
'IpScheme' => 'STATIC|DHCP',
'SubnetMask' => '<string>',
],
'OutputType' => 'NONE|MEDIALIVE_INPUT|MEDIACONNECT_FLOW',
'SerialNumber' => '<string>',
'Tags' => ['<string>', ...],
'Type' => 'HD|UHD',
'UhdDeviceSettings' => [
'ActiveInput' => 'HDMI|SDI',
'AudioChannelPairs' => [
[
'Id' => <integer>,
'Profile' => 'DISABLED|VBR-AAC_HHE-16000|VBR-AAC_HE-64000|VBR-AAC_LC-128000|CBR-AAC_HQ-192000|CBR-AAC_HQ-256000|CBR-AAC_HQ-384000|CBR-AAC_HQ-512000',
],
// ...
],
'Codec' => 'HEVC|AVC',
'ConfiguredInput' => 'AUTO|HDMI|SDI',
'DeviceState' => 'IDLE|STREAMING',
'Framerate' => <float>,
'Height' => <integer>,
'LatencyMs' => <integer>,
'MaxBitrate' => <integer>,
'MediaconnectSettings' => [
'FlowArn' => '<string>',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
'SourceName' => '<string>',
],
'ScanType' => 'INTERLACED|PROGRESSIVE',
'Width' => <integer>,
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- InputDevices
-
- Type: Array of InputDeviceSummary structures
- NextToken
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListInputSecurityGroups
$result = $client->listInputSecurityGroups([/* ... */]); $promise = $client->listInputSecurityGroupsAsync([/* ... */]);
Produces a list of Input Security Groups for an account
Parameter Syntax
$result = $client->listInputSecurityGroups([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[
'InputSecurityGroups' => [
[
'Arn' => '<string>',
'Id' => '<string>',
'Inputs' => ['<string>', ...],
'State' => 'IDLE|IN_USE|UPDATING|DELETED',
'Tags' => ['<string>', ...],
'WhitelistRules' => [
[
'Cidr' => '<string>',
],
// ...
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- InputSecurityGroups
-
- Type: Array of InputSecurityGroup structures
- NextToken
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListInputs
$result = $client->listInputs([/* ... */]); $promise = $client->listInputsAsync([/* ... */]);
Produces list of inputs that have been created
Parameter Syntax
$result = $client->listInputs([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[
'Inputs' => [
[
'Arn' => '<string>',
'AttachedChannels' => ['<string>', ...],
'Destinations' => [
[
'Ip' => '<string>',
'Network' => '<string>',
'NetworkRoutes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'Port' => '<string>',
'Url' => '<string>',
'Vpc' => [
'AvailabilityZone' => '<string>',
'NetworkInterfaceId' => '<string>',
],
],
// ...
],
'Id' => '<string>',
'InputClass' => 'STANDARD|SINGLE_PIPELINE',
'InputDevices' => [
[
'Id' => '<string>',
],
// ...
],
'InputNetworkLocation' => 'AWS|ON_PREMISES',
'InputPartnerIds' => ['<string>', ...],
'InputSourceType' => 'STATIC|DYNAMIC',
'MediaConnectFlows' => [
[
'FlowArn' => '<string>',
],
// ...
],
'MulticastSettings' => [
'Sources' => [
[
'SourceIp' => '<string>',
'Url' => '<string>',
],
// ...
],
],
'Name' => '<string>',
'RoleArn' => '<string>',
'SecurityGroups' => ['<string>', ...],
'Sources' => [
[
'PasswordParam' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
'SrtCallerSources' => [
[
'Decryption' => [
'Algorithm' => 'AES128|AES192|AES256',
'PassphraseSecretArn' => '<string>',
],
'MinimumLatency' => <integer>,
'SrtListenerAddress' => '<string>',
'SrtListenerPort' => '<string>',
'StreamId' => '<string>',
],
// ...
],
],
'State' => 'CREATING|DETACHED|ATTACHED|DELETING|DELETED',
'Tags' => ['<string>', ...],
'Type' => 'UDP_PUSH|RTP_PUSH|RTMP_PUSH|RTMP_PULL|URL_PULL|MP4_FILE|MEDIACONNECT|INPUT_DEVICE|AWS_CDI|TS_FILE|SRT_CALLER|MULTICAST',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Inputs
-
- Type: Array of Input structures
- NextToken
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListMultiplexPrograms
$result = $client->listMultiplexPrograms([/* ... */]); $promise = $client->listMultiplexProgramsAsync([/* ... */]);
List the programs that currently exist for a specific multiplex.
Parameter Syntax
$result = $client->listMultiplexPrograms([
'MaxResults' => <integer>,
'MultiplexId' => '<string>', // REQUIRED
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
- MultiplexId
-
- Required: Yes
- Type: string
- NextToken
-
- Type: string
Result Syntax
[
'MultiplexPrograms' => [
[
'ChannelId' => '<string>',
'ProgramName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- MultiplexPrograms
-
- Type: Array of MultiplexProgramSummary structures
- NextToken
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListMultiplexes
$result = $client->listMultiplexes([/* ... */]); $promise = $client->listMultiplexesAsync([/* ... */]);
Retrieve a list of the existing multiplexes.
Parameter Syntax
$result = $client->listMultiplexes([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[
'Multiplexes' => [
[
'Arn' => '<string>',
'AvailabilityZones' => ['<string>', ...],
'Id' => '<string>',
'MultiplexSettings' => [
'TransportStreamBitrate' => <integer>,
],
'Name' => '<string>',
'PipelinesRunningCount' => <integer>,
'ProgramCount' => <integer>,
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED',
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Multiplexes
-
- Type: Array of MultiplexSummary structures
- NextToken
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListNetworks
$result = $client->listNetworks([/* ... */]); $promise = $client->listNetworksAsync([/* ... */]);
Retrieve the list of Networks.
Parameter Syntax
$result = $client->listNetworks([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[
'Networks' => [
[
'Arn' => '<string>',
'AssociatedClusterIds' => ['<string>', ...],
'Id' => '<string>',
'IpPools' => [
[
'Cidr' => '<string>',
],
// ...
],
'Name' => '<string>',
'Routes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'State' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|IDLE|IN_USE|UPDATING|DELETE_FAILED|DELETED',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Networks
-
- Type: Array of DescribeNetworkSummary structures
- NextToken
-
- Type: string
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListNodes
$result = $client->listNodes([/* ... */]); $promise = $client->listNodesAsync([/* ... */]);
Retrieve the list of Nodes.
Parameter Syntax
$result = $client->listNodes([
'ClusterId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[
'NextToken' => '<string>',
'Nodes' => [
[
'Arn' => '<string>',
'ChannelPlacementGroups' => ['<string>', ...],
'ClusterId' => '<string>',
'ConnectionState' => 'CONNECTED|DISCONNECTED',
'Id' => '<string>',
'InstanceArn' => '<string>',
'ManagedInstanceId' => '<string>',
'Name' => '<string>',
'NodeInterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkInterfaceMode' => 'NAT|BRIDGE',
'PhysicalInterfaceName' => '<string>',
],
// ...
],
'Role' => 'BACKUP|ACTIVE',
'State' => 'CREATED|REGISTERING|READY_TO_ACTIVATE|REGISTRATION_FAILED|ACTIVATION_FAILED|ACTIVE|READY|IN_USE|DEREGISTERING|DRAINING|DEREGISTRATION_FAILED|DEREGISTERED',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Nodes
-
- Type: Array of DescribeNodeSummary structures
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListOfferings
$result = $client->listOfferings([/* ... */]); $promise = $client->listOfferingsAsync([/* ... */]);
List offerings available for purchase.
Parameter Syntax
$result = $client->listOfferings([
'ChannelClass' => '<string>',
'ChannelConfiguration' => '<string>',
'Codec' => '<string>',
'Duration' => '<string>',
'MaxResults' => <integer>,
'MaximumBitrate' => '<string>',
'MaximumFramerate' => '<string>',
'NextToken' => '<string>',
'Resolution' => '<string>',
'ResourceType' => '<string>',
'SpecialFeature' => '<string>',
'VideoQuality' => '<string>',
]);
Parameter Details
Members
- ChannelClass
-
- Type: string
- ChannelConfiguration
-
- Type: string
- Codec
-
- Type: string
- Duration
-
- Type: string
- MaxResults
-
- Type: int
- MaximumBitrate
-
- Type: string
- MaximumFramerate
-
- Type: string
- NextToken
-
- Type: string
- Resolution
-
- Type: string
- ResourceType
-
- Type: string
- SpecialFeature
-
- Type: string
- VideoQuality
-
- Type: string
Result Syntax
[
'NextToken' => '<string>',
'Offerings' => [
[
'Arn' => '<string>',
'CurrencyCode' => '<string>',
'Duration' => <integer>,
'DurationUnits' => 'MONTHS',
'FixedPrice' => <float>,
'OfferingDescription' => '<string>',
'OfferingId' => '<string>',
'OfferingType' => 'NO_UPFRONT',
'Region' => '<string>',
'ResourceSpecification' => [
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Codec' => 'MPEG2|AVC|HEVC|AUDIO|LINK|AV1',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'MaximumFramerate' => 'MAX_30_FPS|MAX_60_FPS',
'Resolution' => 'SD|HD|FHD|UHD',
'ResourceType' => 'INPUT|OUTPUT|MULTIPLEX|CHANNEL',
'SpecialFeature' => 'ADVANCED_AUDIO|AUDIO_NORMALIZATION|MGHD|MGUHD',
'VideoQuality' => 'STANDARD|ENHANCED|PREMIUM',
],
'UsagePrice' => <float>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Offerings
-
- Type: Array of Offering structures
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListReservations
$result = $client->listReservations([/* ... */]); $promise = $client->listReservationsAsync([/* ... */]);
List purchased reservations.
Parameter Syntax
$result = $client->listReservations([
'ChannelClass' => '<string>',
'Codec' => '<string>',
'MaxResults' => <integer>,
'MaximumBitrate' => '<string>',
'MaximumFramerate' => '<string>',
'NextToken' => '<string>',
'Resolution' => '<string>',
'ResourceType' => '<string>',
'SpecialFeature' => '<string>',
'VideoQuality' => '<string>',
]);
Parameter Details
Members
- ChannelClass
-
- Type: string
- Codec
-
- Type: string
- MaxResults
-
- Type: int
- MaximumBitrate
-
- Type: string
- MaximumFramerate
-
- Type: string
- NextToken
-
- Type: string
- Resolution
-
- Type: string
- ResourceType
-
- Type: string
- SpecialFeature
-
- Type: string
- VideoQuality
-
- Type: string
Result Syntax
[
'NextToken' => '<string>',
'Reservations' => [
[
'Arn' => '<string>',
'Count' => <integer>,
'CurrencyCode' => '<string>',
'Duration' => <integer>,
'DurationUnits' => 'MONTHS',
'End' => '<string>',
'FixedPrice' => <float>,
'Name' => '<string>',
'OfferingDescription' => '<string>',
'OfferingId' => '<string>',
'OfferingType' => 'NO_UPFRONT',
'Region' => '<string>',
'RenewalSettings' => [
'AutomaticRenewal' => 'DISABLED|ENABLED|UNAVAILABLE',
'RenewalCount' => <integer>,
],
'ReservationId' => '<string>',
'ResourceSpecification' => [
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Codec' => 'MPEG2|AVC|HEVC|AUDIO|LINK|AV1',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'MaximumFramerate' => 'MAX_30_FPS|MAX_60_FPS',
'Resolution' => 'SD|HD|FHD|UHD',
'ResourceType' => 'INPUT|OUTPUT|MULTIPLEX|CHANNEL',
'SpecialFeature' => 'ADVANCED_AUDIO|AUDIO_NORMALIZATION|MGHD|MGUHD',
'VideoQuality' => 'STANDARD|ENHANCED|PREMIUM',
],
'Start' => '<string>',
'State' => 'ACTIVE|EXPIRED|CANCELED|DELETED',
'Tags' => ['<string>', ...],
'UsagePrice' => <float>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Reservations
-
- Type: Array of Reservation structures
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
ListSignalMaps
$result = $client->listSignalMaps([/* ... */]); $promise = $client->listSignalMapsAsync([/* ... */]);
Lists signal maps.
Parameter Syntax
$result = $client->listSignalMaps([
'CloudWatchAlarmTemplateGroupIdentifier' => '<string>',
'EventBridgeRuleTemplateGroupIdentifier' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- CloudWatchAlarmTemplateGroupIdentifier
-
- Type: string
- EventBridgeRuleTemplateGroupIdentifier
-
- Type: string
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[
'NextToken' => '<string>',
'SignalMaps' => [
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'MonitorDeploymentStatus' => 'NOT_DEPLOYED|DRY_RUN_DEPLOYMENT_COMPLETE|DRY_RUN_DEPLOYMENT_FAILED|DRY_RUN_DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_COMPLETE|DEPLOYMENT_FAILED|DEPLOYMENT_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_IN_PROGRESS',
'Name' => '<string>',
'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_REVERTED|UPDATE_FAILED|READY|NOT_READY',
'Tags' => ['<string>', ...],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- SignalMaps
-
- Type: Array of SignalMapSummary structures
Errors
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Produces list of tags that have been created for a resource
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Members
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Errors
- NotFoundException:
- This error does not currently have a description.
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
PurchaseOffering
$result = $client->purchaseOffering([/* ... */]); $promise = $client->purchaseOfferingAsync([/* ... */]);
Purchase an offering and create a reservation.
Parameter Syntax
$result = $client->purchaseOffering([
'Count' => <integer>, // REQUIRED
'Name' => '<string>',
'OfferingId' => '<string>', // REQUIRED
'RenewalSettings' => [
'AutomaticRenewal' => 'DISABLED|ENABLED|UNAVAILABLE',
'RenewalCount' => <integer>,
],
'RequestId' => '<string>',
'Start' => '<string>',
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- Count
-
- Required: Yes
- Type: int
- Name
-
- Type: string
- OfferingId
-
- Required: Yes
- Type: string
- RenewalSettings
-
- Type: RenewalSettings structure
The Renewal settings for Reservations - RequestId
-
- Type: string
- Start
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Result Syntax
[
'Reservation' => [
'Arn' => '<string>',
'Count' => <integer>,
'CurrencyCode' => '<string>',
'Duration' => <integer>,
'DurationUnits' => 'MONTHS',
'End' => '<string>',
'FixedPrice' => <float>,
'Name' => '<string>',
'OfferingDescription' => '<string>',
'OfferingId' => '<string>',
'OfferingType' => 'NO_UPFRONT',
'Region' => '<string>',
'RenewalSettings' => [
'AutomaticRenewal' => 'DISABLED|ENABLED|UNAVAILABLE',
'RenewalCount' => <integer>,
],
'ReservationId' => '<string>',
'ResourceSpecification' => [
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Codec' => 'MPEG2|AVC|HEVC|AUDIO|LINK|AV1',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'MaximumFramerate' => 'MAX_30_FPS|MAX_60_FPS',
'Resolution' => 'SD|HD|FHD|UHD',
'ResourceType' => 'INPUT|OUTPUT|MULTIPLEX|CHANNEL',
'SpecialFeature' => 'ADVANCED_AUDIO|AUDIO_NORMALIZATION|MGHD|MGUHD',
'VideoQuality' => 'STANDARD|ENHANCED|PREMIUM',
],
'Start' => '<string>',
'State' => 'ACTIVE|EXPIRED|CANCELED|DELETED',
'Tags' => ['<string>', ...],
'UsagePrice' => <float>,
],
]
Result Details
Members
- Reservation
-
- Type: Reservation structure
Reserved resources available to use
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
RebootInputDevice
$result = $client->rebootInputDevice([/* ... */]); $promise = $client->rebootInputDeviceAsync([/* ... */]);
Send a reboot command to the specified input device. The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected.
Parameter Syntax
$result = $client->rebootInputDevice([
'Force' => 'NO|YES',
'InputDeviceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Force
-
- Type: string
Whether or not to force reboot the input device. - InputDeviceId
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
RejectInputDeviceTransfer
$result = $client->rejectInputDeviceTransfer([/* ... */]); $promise = $client->rejectInputDeviceTransferAsync([/* ... */]);
Reject the transfer of the specified input device to your AWS account.
Parameter Syntax
$result = $client->rejectInputDeviceTransfer([
'InputDeviceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InputDeviceId
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
RestartChannelPipelines
$result = $client->restartChannelPipelines([/* ... */]); $promise = $client->restartChannelPipelinesAsync([/* ... */]);
Restart pipelines in one channel that is currently running.
Parameter Syntax
$result = $client->restartChannelPipelines([
'ChannelId' => '<string>', // REQUIRED
'PipelineIds' => ['<string>', ...],
]);
Parameter Details
Members
- ChannelId
-
- Required: Yes
- Type: string
- PipelineIds
-
- Type: Array of strings
An array of pipelines to restart in this channel. Format PIPELINE_0 or PIPELINE_1.
Result Syntax
[
'AnywhereSettings' => [
'ChannelPlacementGroupId' => '<string>',
'ClusterId' => '<string>',
],
'Arn' => '<string>',
'CdiInputSpecification' => [
'Resolution' => 'SD|HD|FHD|UHD',
],
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
'EgressEndpoints' => [
[
'SourceIp' => '<string>',
],
// ...
],
'EncoderSettings' => [
'AudioDescriptions' => [
[
'AudioDashRoles' => ['<string>', ...],
'AudioNormalizationSettings' => [
'Algorithm' => 'ITU_1770_1|ITU_1770_2',
'AlgorithmControl' => 'CORRECT_AUDIO',
'TargetLkfs' => <float>,
],
'AudioSelectorName' => '<string>',
'AudioType' => 'CLEAN_EFFECTS|HEARING_IMPAIRED|UNDEFINED|VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'AudioWatermarkingSettings' => [
'NielsenWatermarksSettings' => [
'NielsenCbetSettings' => [
'CbetCheckDigitString' => '<string>',
'CbetStepaside' => 'DISABLED|ENABLED',
'Csid' => '<string>',
],
'NielsenDistributionType' => 'FINAL_DISTRIBUTOR|PROGRAM_CONTENT',
'NielsenNaesIiNwSettings' => [
'CheckDigitString' => '<string>',
'Sid' => <float>,
'Timezone' => 'AMERICA_PUERTO_RICO|US_ALASKA|US_ARIZONA|US_CENTRAL|US_EASTERN|US_HAWAII|US_MOUNTAIN|US_PACIFIC|US_SAMOA|UTC',
],
],
],
'CodecSettings' => [
'AacSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'AD_RECEIVER_MIX|CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_5_1',
'InputType' => 'BROADCASTER_MIXED_AD|NORMAL',
'Profile' => 'HEV1|HEV2|LC',
'RateControlMode' => 'CBR|VBR',
'RawFormat' => 'LATM_LOAS|NONE',
'SampleRate' => <float>,
'Spec' => 'MPEG2|MPEG4',
'VbrQuality' => 'HIGH|LOW|MEDIUM_HIGH|MEDIUM_LOW',
],
'Ac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|DIALOGUE|EMERGENCY|HEARING_IMPAIRED|MUSIC_AND_EFFECTS|VISUALLY_IMPAIRED|VOICE_OVER',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_3_2_LFE',
'Dialnorm' => <integer>,
'DrcProfile' => 'FILM_STANDARD|NONE',
'LfeFilter' => 'DISABLED|ENABLED',
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
],
'Eac3AtmosSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_5_1_4|CODING_MODE_7_1_4|CODING_MODE_9_1_6',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'HeightTrim' => <float>,
'SurroundTrim' => <float>,
],
'Eac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|EMERGENCY|HEARING_IMPAIRED|VISUALLY_IMPAIRED',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_3_2',
'DcFilter' => 'DISABLED|ENABLED',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'LfeControl' => 'LFE|NO_LFE',
'LfeFilter' => 'DISABLED|ENABLED',
'LoRoCenterMixLevel' => <float>,
'LoRoSurroundMixLevel' => <float>,
'LtRtCenterMixLevel' => <float>,
'LtRtSurroundMixLevel' => <float>,
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'PassthroughControl' => 'NO_PASSTHROUGH|WHEN_POSSIBLE',
'PhaseControl' => 'NO_SHIFT|SHIFT_90_DEGREES',
'StereoDownmix' => 'DPL2|LO_RO|LT_RT|NOT_INDICATED',
'SurroundExMode' => 'DISABLED|ENABLED|NOT_INDICATED',
'SurroundMode' => 'DISABLED|ENABLED|NOT_INDICATED',
],
'Mp2Settings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0',
'SampleRate' => <float>,
],
'PassThroughSettings' => [
],
'WavSettings' => [
'BitDepth' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_4_0|CODING_MODE_8_0',
'SampleRate' => <float>,
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageCodeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'Name' => '<string>',
'RemixSettings' => [
'ChannelMappings' => [
[
'InputChannelLevels' => [
[
'Gain' => <integer>,
'InputChannel' => <integer>,
],
// ...
],
'OutputChannel' => <integer>,
],
// ...
],
'ChannelsIn' => <integer>,
'ChannelsOut' => <integer>,
],
'StreamName' => '<string>',
],
// ...
],
'AvailBlanking' => [
'AvailBlankingImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'State' => 'DISABLED|ENABLED',
],
'AvailConfiguration' => [
'AvailSettings' => [
'Esam' => [
'AcquisitionPointId' => '<string>',
'AdAvailOffset' => <integer>,
'PasswordParam' => '<string>',
'PoisEndpoint' => '<string>',
'Username' => '<string>',
'ZoneIdentity' => '<string>',
],
'Scte35SpliceInsert' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
'Scte35TimeSignalApos' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
],
'Scte35SegmentationScope' => 'ALL_OUTPUT_GROUPS|SCTE35_ENABLED_OUTPUT_GROUPS',
],
'BlackoutSlate' => [
'BlackoutSlateImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkEndBlackout' => 'DISABLED|ENABLED',
'NetworkEndBlackoutImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkId' => '<string>',
'State' => 'DISABLED|ENABLED',
],
'CaptionDescriptions' => [
[
'Accessibility' => 'DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES|IMPLEMENTS_ACCESSIBILITY_FEATURES',
'CaptionDashRoles' => ['<string>', ...],
'CaptionSelectorName' => '<string>',
'DestinationSettings' => [
'AribDestinationSettings' => [
],
'BurnInDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'DvbSubDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'EbuTtDDestinationSettings' => [
'CopyrightHolder' => '<string>',
'FillLineGap' => 'DISABLED|ENABLED',
'FontFamily' => '<string>',
'StyleControl' => 'EXCLUDE|INCLUDE',
],
'EmbeddedDestinationSettings' => [
],
'EmbeddedPlusScte20DestinationSettings' => [
],
'RtmpCaptionInfoDestinationSettings' => [
],
'Scte20PlusEmbeddedDestinationSettings' => [
],
'Scte27DestinationSettings' => [
],
'SmpteTtDestinationSettings' => [
],
'TeletextDestinationSettings' => [
],
'TtmlDestinationSettings' => [
'StyleControl' => 'PASSTHROUGH|USE_CONFIGURED',
],
'WebvttDestinationSettings' => [
'StyleControl' => 'NO_STYLE_DATA|PASSTHROUGH',
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
'Name' => '<string>',
],
// ...
],
'ColorCorrectionSettings' => [
'GlobalColorCorrections' => [
[
'InputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'OutputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'Uri' => '<string>',
],
// ...
],
],
'FeatureActivations' => [
'InputPrepareScheduleActions' => 'DISABLED|ENABLED',
'OutputStaticImageOverlayScheduleActions' => 'DISABLED|ENABLED',
],
'GlobalConfiguration' => [
'InitialAudioGain' => <integer>,
'InputEndAction' => 'NONE|SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior' => [
'BlackFrameMsec' => <integer>,
'InputLossImageColor' => '<string>',
'InputLossImageSlate' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'InputLossImageType' => 'COLOR|SLATE',
'RepeatFrameMsec' => <integer>,
],
'OutputLockingMode' => 'EPOCH_LOCKING|PIPELINE_LOCKING',
'OutputLockingSettings' => [
'EpochLockingSettings' => [
'CustomEpoch' => '<string>',
'JamSyncTime' => '<string>',
],
'PipelineLockingSettings' => [
],
],
'OutputTimingSource' => 'INPUT_CLOCK|SYSTEM_CLOCK',
'SupportLowFramerateInputs' => 'DISABLED|ENABLED',
],
'MotionGraphicsConfiguration' => [
'MotionGraphicsInsertion' => 'DISABLED|ENABLED',
'MotionGraphicsSettings' => [
'HtmlMotionGraphicsSettings' => [
],
],
],
'NielsenConfiguration' => [
'DistributorId' => '<string>',
'NielsenPcmToId3Tagging' => 'DISABLED|ENABLED',
],
'OutputGroups' => [
[
'Name' => '<string>',
'OutputGroupSettings' => [
'ArchiveGroupSettings' => [
'ArchiveCdnSettings' => [
'ArchiveS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'RolloverInterval' => <integer>,
],
'CmafIngestGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvNameModifier' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NielsenId3NameModifier' => '<string>',
'Scte35NameModifier' => '<string>',
'Scte35Type' => 'NONE|SCTE_35_WITHOUT_SEGMENTATION',
'SegmentLength' => <integer>,
'SegmentLengthUnits' => 'MILLISECONDS|SECONDS',
'SendDelayMs' => <integer>,
],
'FrameCaptureGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'FrameCaptureCdnSettings' => [
'FrameCaptureS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
],
'HlsGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'BaseUrlContent' => '<string>',
'BaseUrlContent1' => '<string>',
'BaseUrlManifest' => '<string>',
'BaseUrlManifest1' => '<string>',
'CaptionLanguageMappings' => [
[
'CaptionChannel' => <integer>,
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
],
// ...
],
'CaptionLanguageSetting' => 'INSERT|NONE|OMIT',
'ClientCache' => 'DISABLED|ENABLED',
'CodecSpecification' => 'RFC_4281|RFC_6381',
'ConstantIv' => '<string>',
'Destination' => [
'DestinationRefId' => '<string>',
],
'DirectoryStructure' => 'SINGLE_DIRECTORY|SUBDIRECTORY_PER_STREAM',
'DiscontinuityTags' => 'INSERT|NEVER_INSERT',
'EncryptionType' => 'AES128|SAMPLE_AES',
'HlsCdnSettings' => [
'HlsAkamaiSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'Salt' => '<string>',
'Token' => '<string>',
],
'HlsBasicPutSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsMediaStoreSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'MediaStoreStorageClass' => 'TEMPORAL',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
'HlsWebdavSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
],
'HlsId3SegmentTagging' => 'DISABLED|ENABLED',
'IFrameOnlyPlaylists' => 'DISABLED|STANDARD',
'IncompleteSegmentBehavior' => 'AUTO|SUPPRESS',
'IndexNSegments' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'IvInManifest' => 'EXCLUDE|INCLUDE',
'IvSource' => 'EXPLICIT|FOLLOWS_SEGMENT_NUMBER',
'KeepSegments' => <integer>,
'KeyFormat' => '<string>',
'KeyFormatVersions' => '<string>',
'KeyProviderSettings' => [
'StaticKeySettings' => [
'KeyProviderServer' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'StaticKeyValue' => '<string>',
],
],
'ManifestCompression' => 'GZIP|NONE',
'ManifestDurationFormat' => 'FLOATING_POINT|INTEGER',
'MinSegmentLength' => <integer>,
'Mode' => 'LIVE|VOD',
'OutputSelection' => 'MANIFESTS_AND_SEGMENTS|SEGMENTS_ONLY|VARIANT_MANIFESTS_AND_SEGMENTS',
'ProgramDateTime' => 'EXCLUDE|INCLUDE',
'ProgramDateTimeClock' => 'INITIALIZE_FROM_OUTPUT_TIMECODE|SYSTEM_CLOCK',
'ProgramDateTimePeriod' => <integer>,
'RedundantManifest' => 'DISABLED|ENABLED',
'SegmentLength' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory' => <integer>,
'StreamInfResolution' => 'EXCLUDE|INCLUDE',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
'TimestampDeltaMilliseconds' => <integer>,
'TsFileMode' => 'SEGMENTED_FILES|SINGLE_FILE',
],
'MediaPackageGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'MsSmoothGroupSettings' => [
'AcquisitionPointId' => '<string>',
'AudioOnlyTimecodeControl' => 'PASSTHROUGH|USE_CONFIGURED_CLOCK',
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'EventId' => '<string>',
'EventIdMode' => 'NO_EVENT_ID|USE_CONFIGURED|USE_TIMESTAMP',
'EventStopBehavior' => 'NONE|SEND_EOS',
'FilecacheDuration' => <integer>,
'FragmentLength' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SendDelayMs' => <integer>,
'SparseTrackType' => 'NONE|SCTE_35|SCTE_35_WITHOUT_SEGMENTATION',
'StreamManifestBehavior' => 'DO_NOT_SEND|SEND',
'TimestampOffset' => '<string>',
'TimestampOffsetMode' => 'USE_CONFIGURED_OFFSET|USE_EVENT_START_DATE',
],
'MultiplexGroupSettings' => [
],
'RtmpGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'AuthenticationScheme' => 'AKAMAI|COMMON',
'CacheFullBehavior' => 'DISCONNECT_IMMEDIATELY|WAIT_FOR_SERVER',
'CacheLength' => <integer>,
'CaptionData' => 'ALL|FIELD1_608|FIELD1_AND_FIELD2_608',
'IncludeFillerNalUnits' => 'AUTO|DROP|INCLUDE',
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'RestartDelay' => <integer>,
],
'SrtGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
],
'UdpGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
],
],
'Outputs' => [
[
'AudioDescriptionNames' => ['<string>', ...],
'CaptionDescriptionNames' => ['<string>', ...],
'OutputName' => '<string>',
'OutputSettings' => [
'ArchiveOutputSettings' => [
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
'RawSettings' => [
],
],
'Extension' => '<string>',
'NameModifier' => '<string>',
],
'CmafIngestOutputSettings' => [
'NameModifier' => '<string>',
],
'FrameCaptureOutputSettings' => [
'NameModifier' => '<string>',
],
'HlsOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'HlsSettings' => [
'AudioOnlyHlsSettings' => [
'AudioGroupId' => '<string>',
'AudioOnlyImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'AudioTrackType' => 'ALTERNATE_AUDIO_AUTO_SELECT|ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT|ALTERNATE_AUDIO_NOT_AUTO_SELECT|AUDIO_ONLY_VARIANT_STREAM',
'SegmentType' => 'AAC|FMP4',
],
'Fmp4HlsSettings' => [
'AudioRenditionSets' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
],
'FrameCaptureHlsSettings' => [
],
'StandardHlsSettings' => [
'AudioRenditionSets' => '<string>',
'M3u8Settings' => [
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'EcmPid' => '<string>',
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'Scte35Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'Scte35Pid' => '<string>',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
],
'NameModifier' => '<string>',
'SegmentModifier' => '<string>',
],
'MediaPackageOutputSettings' => [
],
'MsSmoothOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'NameModifier' => '<string>',
],
'MultiplexOutputSettings' => [
'ContainerSettings' => [
'MultiplexM2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioStreamType' => 'ATSC|DVB',
'CcDescriptor' => 'DISABLED|ENABLED',
'Ebif' => 'NONE|PASSTHROUGH',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'Klv' => 'NONE|PASSTHROUGH',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35PrerollPullupMilliseconds' => <float>,
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'RtmpOutputSettings' => [
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'NumRetries' => <integer>,
],
'SrtOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'EncryptionType' => 'AES128|AES192|AES256',
'Latency' => <integer>,
],
'UdpOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'FecOutputSettings' => [
'ColumnDepth' => <integer>,
'IncludeFec' => 'COLUMN|COLUMN_AND_ROW',
'RowLength' => <integer>,
],
],
],
'VideoDescriptionName' => '<string>',
],
// ...
],
],
// ...
],
'ThumbnailConfiguration' => [
'State' => 'AUTO|DISABLED',
],
'TimecodeConfig' => [
'Source' => 'EMBEDDED|SYSTEMCLOCK|ZEROBASED',
'SyncThreshold' => <integer>,
],
'VideoDescriptions' => [
[
'CodecSettings' => [
'Av1Settings' => [
'AfdSignaling' => 'AUTO|FIXED|NONE',
'BufSize' => <integer>,
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'AV1_LEVEL_2|AV1_LEVEL_2_1|AV1_LEVEL_3|AV1_LEVEL_3_1|AV1_LEVEL_4|AV1_LEVEL_4_1|AV1_LEVEL_5|AV1_LEVEL_5_1|AV1_LEVEL_5_2|AV1_LEVEL_5_3|AV1_LEVEL_6|AV1_LEVEL_6_1|AV1_LEVEL_6_2|AV1_LEVEL_6_3|AV1_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'QvbrQualityLevel' => <integer>,
'SceneChangeDetect' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'FrameCaptureSettings' => [
'CaptureInterval' => <integer>,
'CaptureIntervalUnits' => 'MILLISECONDS|SECONDS',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'H264Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'Bitrate' => <integer>,
'BufFillPct' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'EntropyEncoding' => 'CABAC|CAVLC',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'ForceFieldPictures' => 'DISABLED|ENABLED',
'FramerateControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopBReference' => 'DISABLED|ENABLED',
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H264_LEVEL_1|H264_LEVEL_1_1|H264_LEVEL_1_2|H264_LEVEL_1_3|H264_LEVEL_2|H264_LEVEL_2_1|H264_LEVEL_2_2|H264_LEVEL_3|H264_LEVEL_3_1|H264_LEVEL_3_2|H264_LEVEL_4|H264_LEVEL_4_1|H264_LEVEL_4_2|H264_LEVEL_5|H264_LEVEL_5_1|H264_LEVEL_5_2|H264_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'NumRefFrames' => <integer>,
'ParControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'BASELINE|HIGH|HIGH_10BIT|HIGH_422|HIGH_422_10BIT|MAIN',
'QualityLevel' => 'ENHANCED_QUALITY|STANDARD_QUALITY',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR|VBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Softness' => <integer>,
'SpatialAq' => 'DISABLED|ENABLED',
'SubgopLength' => 'DYNAMIC|FIXED',
'Syntax' => 'DEFAULT|RP2027',
'TemporalAq' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
],
'H265Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'AlternativeTransferFunction' => 'INSERT|OMIT',
'Bitrate' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'DolbyVision81Settings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'Deblocking' => 'DISABLED|ENABLED',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H265_LEVEL_1|H265_LEVEL_2|H265_LEVEL_2_1|H265_LEVEL_3|H265_LEVEL_3_1|H265_LEVEL_4|H265_LEVEL_4_1|H265_LEVEL_5|H265_LEVEL_5_1|H265_LEVEL_5_2|H265_LEVEL_6|H265_LEVEL_6_1|H265_LEVEL_6_2|H265_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'MvOverPictureBoundaries' => 'DISABLED|ENABLED',
'MvTemporalPredictor' => 'DISABLED|ENABLED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'MAIN|MAIN_10BIT',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Tier' => 'HIGH|MAIN',
'TileHeight' => <integer>,
'TilePadding' => 'NONE|PADDED',
'TileWidth' => <integer>,
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
'TreeblockSize' => 'AUTO|TREE_SIZE_32X32',
],
'Mpeg2Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|LOW|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpace' => 'AUTO|PASSTHROUGH',
'DisplayAspectRatio' => 'DISPLAYRATIO16X9|DISPLAYRATIO4X3',
'FilterSettings' => [
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SubgopLength' => 'DYNAMIC|FIXED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|GOP_TIMECODE',
],
],
'Height' => <integer>,
'Name' => '<string>',
'RespondToAfd' => 'NONE|PASSTHROUGH|RESPOND',
'ScalingBehavior' => 'DEFAULT|STRETCH_TO_OUTPUT',
'Sharpness' => <integer>,
'Width' => <integer>,
],
// ...
],
],
'Id' => '<string>',
'InputAttachments' => [
[
'AutomaticInputFailoverSettings' => [
'ErrorClearTimeMsec' => <integer>,
'FailoverConditions' => [
[
'FailoverConditionSettings' => [
'AudioSilenceSettings' => [
'AudioSelectorName' => '<string>',
'AudioSilenceThresholdMsec' => <integer>,
],
'InputLossSettings' => [
'InputLossThresholdMsec' => <integer>,
],
'VideoBlackSettings' => [
'BlackDetectThreshold' => <float>,
'VideoBlackThresholdMsec' => <integer>,
],
],
],
// ...
],
'InputPreference' => 'EQUAL_INPUT_PREFERENCE|PRIMARY_INPUT_PREFERRED',
'SecondaryInputId' => '<string>',
],
'InputAttachmentName' => '<string>',
'InputId' => '<string>',
'InputSettings' => [
'AudioSelectors' => [
[
'Name' => '<string>',
'SelectorSettings' => [
'AudioHlsRenditionSelection' => [
'GroupId' => '<string>',
'Name' => '<string>',
],
'AudioLanguageSelection' => [
'LanguageCode' => '<string>',
'LanguageSelectionPolicy' => 'LOOSE|STRICT',
],
'AudioPidSelection' => [
'Pid' => <integer>,
],
'AudioTrackSelection' => [
'DolbyEDecode' => [
'ProgramSelection' => 'ALL_CHANNELS|PROGRAM_1|PROGRAM_2|PROGRAM_3|PROGRAM_4|PROGRAM_5|PROGRAM_6|PROGRAM_7|PROGRAM_8',
],
'Tracks' => [
[
'Track' => <integer>,
],
// ...
],
],
],
],
// ...
],
'CaptionSelectors' => [
[
'LanguageCode' => '<string>',
'Name' => '<string>',
'SelectorSettings' => [
'AncillarySourceSettings' => [
'SourceAncillaryChannelNumber' => <integer>,
],
'AribSourceSettings' => [
],
'DvbSubSourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'EmbeddedSourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Scte20Detection' => 'AUTO|OFF',
'Source608ChannelNumber' => <integer>,
'Source608TrackNumber' => <integer>,
],
'Scte20SourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Source608ChannelNumber' => <integer>,
],
'Scte27SourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'TeletextSourceSettings' => [
'OutputRectangle' => [
'Height' => <float>,
'LeftOffset' => <float>,
'TopOffset' => <float>,
'Width' => <float>,
],
'PageNumber' => '<string>',
],
],
],
// ...
],
'DeblockFilter' => 'DISABLED|ENABLED',
'DenoiseFilter' => 'DISABLED|ENABLED',
'FilterStrength' => <integer>,
'InputFilter' => 'AUTO|DISABLED|FORCED',
'NetworkInputSettings' => [
'HlsInputSettings' => [
'Bandwidth' => <integer>,
'BufferSegments' => <integer>,
'Retries' => <integer>,
'RetryInterval' => <integer>,
'Scte35Source' => 'MANIFEST|SEGMENTS',
],
'MulticastInputSettings' => [
'SourceIpAddress' => '<string>',
],
'ServerValidation' => 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME|CHECK_CRYPTOGRAPHY_ONLY',
],
'Scte35Pid' => <integer>,
'Smpte2038DataPreference' => 'IGNORE|PREFER',
'SourceEndBehavior' => 'CONTINUE|LOOP',
'VideoSelector' => [
'ColorSpace' => 'FOLLOW|HDR10|HLG_2020|REC_601|REC_709',
'ColorSpaceSettings' => [
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
],
'ColorSpaceUsage' => 'FALLBACK|FORCE',
'SelectorSettings' => [
'VideoSelectorPid' => [
'Pid' => <integer>,
],
'VideoSelectorProgramId' => [
'ProgramId' => <integer>,
],
],
],
],
'LogicalInterfaceNames' => ['<string>', ...],
],
// ...
],
'InputSpecification' => [
'Codec' => 'MPEG2|AVC|HEVC',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'Resolution' => 'SD|HD|UHD',
],
'LogLevel' => 'ERROR|WARNING|INFO|DEBUG|DISABLED',
'Maintenance' => [
'MaintenanceDay' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartTime' => '<string>',
],
'MaintenanceStatus' => '<string>',
'Name' => '<string>',
'PipelineDetails' => [
[
'ActiveInputAttachmentName' => '<string>',
'ActiveInputSwitchActionName' => '<string>',
'ActiveMotionGraphicsActionName' => '<string>',
'ActiveMotionGraphicsUri' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'PipelinesRunningCount' => <integer>,
'RoleArn' => '<string>',
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED|UPDATING|UPDATE_FAILED',
'Tags' => ['<string>', ...],
'Vpc' => [
'AvailabilityZones' => ['<string>', ...],
'NetworkInterfaceIds' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
]
Result Details
Members
- AnywhereSettings
-
- Type: DescribeAnywhereSettings structure
Elemental anywhere settings - Arn
-
- Type: string
- CdiInputSpecification
-
- Type: CdiInputSpecification structure
- ChannelClass
-
- Type: string
A standard channel has two encoding pipelines and a single pipeline channel only has one. - Destinations
-
- Type: Array of OutputDestination structures
- EgressEndpoints
-
- Type: Array of ChannelEgressEndpoint structures
- EncoderSettings
-
- Type: EncoderSettings structure
Encoder Settings - Id
-
- Type: string
- InputAttachments
-
- Type: Array of InputAttachment structures
- InputSpecification
-
- Type: InputSpecification structure
- LogLevel
-
- Type: string
The log level the user wants for their channel. - Maintenance
-
- Type: MaintenanceStatus structure
- MaintenanceStatus
-
- Type: string
- Name
-
- Type: string
- PipelineDetails
-
- Type: Array of PipelineDetail structures
- PipelinesRunningCount
-
- Type: int
- RoleArn
-
- Type: string
- State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Vpc
-
- Type: VpcOutputSettingsDescription structure
The properties for a private VPC Output
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
StartChannel
$result = $client->startChannel([/* ... */]); $promise = $client->startChannelAsync([/* ... */]);
Starts an existing channel
Parameter Syntax
$result = $client->startChannel([
'ChannelId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ChannelId
-
- Required: Yes
- Type: string
Result Syntax
[
'AnywhereSettings' => [
'ChannelPlacementGroupId' => '<string>',
'ClusterId' => '<string>',
],
'Arn' => '<string>',
'CdiInputSpecification' => [
'Resolution' => 'SD|HD|FHD|UHD',
],
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
'EgressEndpoints' => [
[
'SourceIp' => '<string>',
],
// ...
],
'EncoderSettings' => [
'AudioDescriptions' => [
[
'AudioDashRoles' => ['<string>', ...],
'AudioNormalizationSettings' => [
'Algorithm' => 'ITU_1770_1|ITU_1770_2',
'AlgorithmControl' => 'CORRECT_AUDIO',
'TargetLkfs' => <float>,
],
'AudioSelectorName' => '<string>',
'AudioType' => 'CLEAN_EFFECTS|HEARING_IMPAIRED|UNDEFINED|VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'AudioWatermarkingSettings' => [
'NielsenWatermarksSettings' => [
'NielsenCbetSettings' => [
'CbetCheckDigitString' => '<string>',
'CbetStepaside' => 'DISABLED|ENABLED',
'Csid' => '<string>',
],
'NielsenDistributionType' => 'FINAL_DISTRIBUTOR|PROGRAM_CONTENT',
'NielsenNaesIiNwSettings' => [
'CheckDigitString' => '<string>',
'Sid' => <float>,
'Timezone' => 'AMERICA_PUERTO_RICO|US_ALASKA|US_ARIZONA|US_CENTRAL|US_EASTERN|US_HAWAII|US_MOUNTAIN|US_PACIFIC|US_SAMOA|UTC',
],
],
],
'CodecSettings' => [
'AacSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'AD_RECEIVER_MIX|CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_5_1',
'InputType' => 'BROADCASTER_MIXED_AD|NORMAL',
'Profile' => 'HEV1|HEV2|LC',
'RateControlMode' => 'CBR|VBR',
'RawFormat' => 'LATM_LOAS|NONE',
'SampleRate' => <float>,
'Spec' => 'MPEG2|MPEG4',
'VbrQuality' => 'HIGH|LOW|MEDIUM_HIGH|MEDIUM_LOW',
],
'Ac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|DIALOGUE|EMERGENCY|HEARING_IMPAIRED|MUSIC_AND_EFFECTS|VISUALLY_IMPAIRED|VOICE_OVER',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_3_2_LFE',
'Dialnorm' => <integer>,
'DrcProfile' => 'FILM_STANDARD|NONE',
'LfeFilter' => 'DISABLED|ENABLED',
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
],
'Eac3AtmosSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_5_1_4|CODING_MODE_7_1_4|CODING_MODE_9_1_6',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'HeightTrim' => <float>,
'SurroundTrim' => <float>,
],
'Eac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|EMERGENCY|HEARING_IMPAIRED|VISUALLY_IMPAIRED',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_3_2',
'DcFilter' => 'DISABLED|ENABLED',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'LfeControl' => 'LFE|NO_LFE',
'LfeFilter' => 'DISABLED|ENABLED',
'LoRoCenterMixLevel' => <float>,
'LoRoSurroundMixLevel' => <float>,
'LtRtCenterMixLevel' => <float>,
'LtRtSurroundMixLevel' => <float>,
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'PassthroughControl' => 'NO_PASSTHROUGH|WHEN_POSSIBLE',
'PhaseControl' => 'NO_SHIFT|SHIFT_90_DEGREES',
'StereoDownmix' => 'DPL2|LO_RO|LT_RT|NOT_INDICATED',
'SurroundExMode' => 'DISABLED|ENABLED|NOT_INDICATED',
'SurroundMode' => 'DISABLED|ENABLED|NOT_INDICATED',
],
'Mp2Settings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0',
'SampleRate' => <float>,
],
'PassThroughSettings' => [
],
'WavSettings' => [
'BitDepth' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_4_0|CODING_MODE_8_0',
'SampleRate' => <float>,
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageCodeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'Name' => '<string>',
'RemixSettings' => [
'ChannelMappings' => [
[
'InputChannelLevels' => [
[
'Gain' => <integer>,
'InputChannel' => <integer>,
],
// ...
],
'OutputChannel' => <integer>,
],
// ...
],
'ChannelsIn' => <integer>,
'ChannelsOut' => <integer>,
],
'StreamName' => '<string>',
],
// ...
],
'AvailBlanking' => [
'AvailBlankingImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'State' => 'DISABLED|ENABLED',
],
'AvailConfiguration' => [
'AvailSettings' => [
'Esam' => [
'AcquisitionPointId' => '<string>',
'AdAvailOffset' => <integer>,
'PasswordParam' => '<string>',
'PoisEndpoint' => '<string>',
'Username' => '<string>',
'ZoneIdentity' => '<string>',
],
'Scte35SpliceInsert' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
'Scte35TimeSignalApos' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
],
'Scte35SegmentationScope' => 'ALL_OUTPUT_GROUPS|SCTE35_ENABLED_OUTPUT_GROUPS',
],
'BlackoutSlate' => [
'BlackoutSlateImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkEndBlackout' => 'DISABLED|ENABLED',
'NetworkEndBlackoutImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkId' => '<string>',
'State' => 'DISABLED|ENABLED',
],
'CaptionDescriptions' => [
[
'Accessibility' => 'DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES|IMPLEMENTS_ACCESSIBILITY_FEATURES',
'CaptionDashRoles' => ['<string>', ...],
'CaptionSelectorName' => '<string>',
'DestinationSettings' => [
'AribDestinationSettings' => [
],
'BurnInDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'DvbSubDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'EbuTtDDestinationSettings' => [
'CopyrightHolder' => '<string>',
'FillLineGap' => 'DISABLED|ENABLED',
'FontFamily' => '<string>',
'StyleControl' => 'EXCLUDE|INCLUDE',
],
'EmbeddedDestinationSettings' => [
],
'EmbeddedPlusScte20DestinationSettings' => [
],
'RtmpCaptionInfoDestinationSettings' => [
],
'Scte20PlusEmbeddedDestinationSettings' => [
],
'Scte27DestinationSettings' => [
],
'SmpteTtDestinationSettings' => [
],
'TeletextDestinationSettings' => [
],
'TtmlDestinationSettings' => [
'StyleControl' => 'PASSTHROUGH|USE_CONFIGURED',
],
'WebvttDestinationSettings' => [
'StyleControl' => 'NO_STYLE_DATA|PASSTHROUGH',
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
'Name' => '<string>',
],
// ...
],
'ColorCorrectionSettings' => [
'GlobalColorCorrections' => [
[
'InputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'OutputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'Uri' => '<string>',
],
// ...
],
],
'FeatureActivations' => [
'InputPrepareScheduleActions' => 'DISABLED|ENABLED',
'OutputStaticImageOverlayScheduleActions' => 'DISABLED|ENABLED',
],
'GlobalConfiguration' => [
'InitialAudioGain' => <integer>,
'InputEndAction' => 'NONE|SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior' => [
'BlackFrameMsec' => <integer>,
'InputLossImageColor' => '<string>',
'InputLossImageSlate' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'InputLossImageType' => 'COLOR|SLATE',
'RepeatFrameMsec' => <integer>,
],
'OutputLockingMode' => 'EPOCH_LOCKING|PIPELINE_LOCKING',
'OutputLockingSettings' => [
'EpochLockingSettings' => [
'CustomEpoch' => '<string>',
'JamSyncTime' => '<string>',
],
'PipelineLockingSettings' => [
],
],
'OutputTimingSource' => 'INPUT_CLOCK|SYSTEM_CLOCK',
'SupportLowFramerateInputs' => 'DISABLED|ENABLED',
],
'MotionGraphicsConfiguration' => [
'MotionGraphicsInsertion' => 'DISABLED|ENABLED',
'MotionGraphicsSettings' => [
'HtmlMotionGraphicsSettings' => [
],
],
],
'NielsenConfiguration' => [
'DistributorId' => '<string>',
'NielsenPcmToId3Tagging' => 'DISABLED|ENABLED',
],
'OutputGroups' => [
[
'Name' => '<string>',
'OutputGroupSettings' => [
'ArchiveGroupSettings' => [
'ArchiveCdnSettings' => [
'ArchiveS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'RolloverInterval' => <integer>,
],
'CmafIngestGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvNameModifier' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NielsenId3NameModifier' => '<string>',
'Scte35NameModifier' => '<string>',
'Scte35Type' => 'NONE|SCTE_35_WITHOUT_SEGMENTATION',
'SegmentLength' => <integer>,
'SegmentLengthUnits' => 'MILLISECONDS|SECONDS',
'SendDelayMs' => <integer>,
],
'FrameCaptureGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'FrameCaptureCdnSettings' => [
'FrameCaptureS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
],
'HlsGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'BaseUrlContent' => '<string>',
'BaseUrlContent1' => '<string>',
'BaseUrlManifest' => '<string>',
'BaseUrlManifest1' => '<string>',
'CaptionLanguageMappings' => [
[
'CaptionChannel' => <integer>,
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
],
// ...
],
'CaptionLanguageSetting' => 'INSERT|NONE|OMIT',
'ClientCache' => 'DISABLED|ENABLED',
'CodecSpecification' => 'RFC_4281|RFC_6381',
'ConstantIv' => '<string>',
'Destination' => [
'DestinationRefId' => '<string>',
],
'DirectoryStructure' => 'SINGLE_DIRECTORY|SUBDIRECTORY_PER_STREAM',
'DiscontinuityTags' => 'INSERT|NEVER_INSERT',
'EncryptionType' => 'AES128|SAMPLE_AES',
'HlsCdnSettings' => [
'HlsAkamaiSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'Salt' => '<string>',
'Token' => '<string>',
],
'HlsBasicPutSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsMediaStoreSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'MediaStoreStorageClass' => 'TEMPORAL',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
'HlsWebdavSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
],
'HlsId3SegmentTagging' => 'DISABLED|ENABLED',
'IFrameOnlyPlaylists' => 'DISABLED|STANDARD',
'IncompleteSegmentBehavior' => 'AUTO|SUPPRESS',
'IndexNSegments' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'IvInManifest' => 'EXCLUDE|INCLUDE',
'IvSource' => 'EXPLICIT|FOLLOWS_SEGMENT_NUMBER',
'KeepSegments' => <integer>,
'KeyFormat' => '<string>',
'KeyFormatVersions' => '<string>',
'KeyProviderSettings' => [
'StaticKeySettings' => [
'KeyProviderServer' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'StaticKeyValue' => '<string>',
],
],
'ManifestCompression' => 'GZIP|NONE',
'ManifestDurationFormat' => 'FLOATING_POINT|INTEGER',
'MinSegmentLength' => <integer>,
'Mode' => 'LIVE|VOD',
'OutputSelection' => 'MANIFESTS_AND_SEGMENTS|SEGMENTS_ONLY|VARIANT_MANIFESTS_AND_SEGMENTS',
'ProgramDateTime' => 'EXCLUDE|INCLUDE',
'ProgramDateTimeClock' => 'INITIALIZE_FROM_OUTPUT_TIMECODE|SYSTEM_CLOCK',
'ProgramDateTimePeriod' => <integer>,
'RedundantManifest' => 'DISABLED|ENABLED',
'SegmentLength' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory' => <integer>,
'StreamInfResolution' => 'EXCLUDE|INCLUDE',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
'TimestampDeltaMilliseconds' => <integer>,
'TsFileMode' => 'SEGMENTED_FILES|SINGLE_FILE',
],
'MediaPackageGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'MsSmoothGroupSettings' => [
'AcquisitionPointId' => '<string>',
'AudioOnlyTimecodeControl' => 'PASSTHROUGH|USE_CONFIGURED_CLOCK',
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'EventId' => '<string>',
'EventIdMode' => 'NO_EVENT_ID|USE_CONFIGURED|USE_TIMESTAMP',
'EventStopBehavior' => 'NONE|SEND_EOS',
'FilecacheDuration' => <integer>,
'FragmentLength' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SendDelayMs' => <integer>,
'SparseTrackType' => 'NONE|SCTE_35|SCTE_35_WITHOUT_SEGMENTATION',
'StreamManifestBehavior' => 'DO_NOT_SEND|SEND',
'TimestampOffset' => '<string>',
'TimestampOffsetMode' => 'USE_CONFIGURED_OFFSET|USE_EVENT_START_DATE',
],
'MultiplexGroupSettings' => [
],
'RtmpGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'AuthenticationScheme' => 'AKAMAI|COMMON',
'CacheFullBehavior' => 'DISCONNECT_IMMEDIATELY|WAIT_FOR_SERVER',
'CacheLength' => <integer>,
'CaptionData' => 'ALL|FIELD1_608|FIELD1_AND_FIELD2_608',
'IncludeFillerNalUnits' => 'AUTO|DROP|INCLUDE',
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'RestartDelay' => <integer>,
],
'SrtGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
],
'UdpGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
],
],
'Outputs' => [
[
'AudioDescriptionNames' => ['<string>', ...],
'CaptionDescriptionNames' => ['<string>', ...],
'OutputName' => '<string>',
'OutputSettings' => [
'ArchiveOutputSettings' => [
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
'RawSettings' => [
],
],
'Extension' => '<string>',
'NameModifier' => '<string>',
],
'CmafIngestOutputSettings' => [
'NameModifier' => '<string>',
],
'FrameCaptureOutputSettings' => [
'NameModifier' => '<string>',
],
'HlsOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'HlsSettings' => [
'AudioOnlyHlsSettings' => [
'AudioGroupId' => '<string>',
'AudioOnlyImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'AudioTrackType' => 'ALTERNATE_AUDIO_AUTO_SELECT|ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT|ALTERNATE_AUDIO_NOT_AUTO_SELECT|AUDIO_ONLY_VARIANT_STREAM',
'SegmentType' => 'AAC|FMP4',
],
'Fmp4HlsSettings' => [
'AudioRenditionSets' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
],
'FrameCaptureHlsSettings' => [
],
'StandardHlsSettings' => [
'AudioRenditionSets' => '<string>',
'M3u8Settings' => [
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'EcmPid' => '<string>',
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'Scte35Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'Scte35Pid' => '<string>',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
],
'NameModifier' => '<string>',
'SegmentModifier' => '<string>',
],
'MediaPackageOutputSettings' => [
],
'MsSmoothOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'NameModifier' => '<string>',
],
'MultiplexOutputSettings' => [
'ContainerSettings' => [
'MultiplexM2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioStreamType' => 'ATSC|DVB',
'CcDescriptor' => 'DISABLED|ENABLED',
'Ebif' => 'NONE|PASSTHROUGH',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'Klv' => 'NONE|PASSTHROUGH',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35PrerollPullupMilliseconds' => <float>,
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'RtmpOutputSettings' => [
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'NumRetries' => <integer>,
],
'SrtOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'EncryptionType' => 'AES128|AES192|AES256',
'Latency' => <integer>,
],
'UdpOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'FecOutputSettings' => [
'ColumnDepth' => <integer>,
'IncludeFec' => 'COLUMN|COLUMN_AND_ROW',
'RowLength' => <integer>,
],
],
],
'VideoDescriptionName' => '<string>',
],
// ...
],
],
// ...
],
'ThumbnailConfiguration' => [
'State' => 'AUTO|DISABLED',
],
'TimecodeConfig' => [
'Source' => 'EMBEDDED|SYSTEMCLOCK|ZEROBASED',
'SyncThreshold' => <integer>,
],
'VideoDescriptions' => [
[
'CodecSettings' => [
'Av1Settings' => [
'AfdSignaling' => 'AUTO|FIXED|NONE',
'BufSize' => <integer>,
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'AV1_LEVEL_2|AV1_LEVEL_2_1|AV1_LEVEL_3|AV1_LEVEL_3_1|AV1_LEVEL_4|AV1_LEVEL_4_1|AV1_LEVEL_5|AV1_LEVEL_5_1|AV1_LEVEL_5_2|AV1_LEVEL_5_3|AV1_LEVEL_6|AV1_LEVEL_6_1|AV1_LEVEL_6_2|AV1_LEVEL_6_3|AV1_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'QvbrQualityLevel' => <integer>,
'SceneChangeDetect' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'FrameCaptureSettings' => [
'CaptureInterval' => <integer>,
'CaptureIntervalUnits' => 'MILLISECONDS|SECONDS',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'H264Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'Bitrate' => <integer>,
'BufFillPct' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'EntropyEncoding' => 'CABAC|CAVLC',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'ForceFieldPictures' => 'DISABLED|ENABLED',
'FramerateControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopBReference' => 'DISABLED|ENABLED',
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H264_LEVEL_1|H264_LEVEL_1_1|H264_LEVEL_1_2|H264_LEVEL_1_3|H264_LEVEL_2|H264_LEVEL_2_1|H264_LEVEL_2_2|H264_LEVEL_3|H264_LEVEL_3_1|H264_LEVEL_3_2|H264_LEVEL_4|H264_LEVEL_4_1|H264_LEVEL_4_2|H264_LEVEL_5|H264_LEVEL_5_1|H264_LEVEL_5_2|H264_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'NumRefFrames' => <integer>,
'ParControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'BASELINE|HIGH|HIGH_10BIT|HIGH_422|HIGH_422_10BIT|MAIN',
'QualityLevel' => 'ENHANCED_QUALITY|STANDARD_QUALITY',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR|VBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Softness' => <integer>,
'SpatialAq' => 'DISABLED|ENABLED',
'SubgopLength' => 'DYNAMIC|FIXED',
'Syntax' => 'DEFAULT|RP2027',
'TemporalAq' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
],
'H265Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'AlternativeTransferFunction' => 'INSERT|OMIT',
'Bitrate' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'DolbyVision81Settings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'Deblocking' => 'DISABLED|ENABLED',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H265_LEVEL_1|H265_LEVEL_2|H265_LEVEL_2_1|H265_LEVEL_3|H265_LEVEL_3_1|H265_LEVEL_4|H265_LEVEL_4_1|H265_LEVEL_5|H265_LEVEL_5_1|H265_LEVEL_5_2|H265_LEVEL_6|H265_LEVEL_6_1|H265_LEVEL_6_2|H265_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'MvOverPictureBoundaries' => 'DISABLED|ENABLED',
'MvTemporalPredictor' => 'DISABLED|ENABLED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'MAIN|MAIN_10BIT',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Tier' => 'HIGH|MAIN',
'TileHeight' => <integer>,
'TilePadding' => 'NONE|PADDED',
'TileWidth' => <integer>,
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
'TreeblockSize' => 'AUTO|TREE_SIZE_32X32',
],
'Mpeg2Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|LOW|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpace' => 'AUTO|PASSTHROUGH',
'DisplayAspectRatio' => 'DISPLAYRATIO16X9|DISPLAYRATIO4X3',
'FilterSettings' => [
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SubgopLength' => 'DYNAMIC|FIXED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|GOP_TIMECODE',
],
],
'Height' => <integer>,
'Name' => '<string>',
'RespondToAfd' => 'NONE|PASSTHROUGH|RESPOND',
'ScalingBehavior' => 'DEFAULT|STRETCH_TO_OUTPUT',
'Sharpness' => <integer>,
'Width' => <integer>,
],
// ...
],
],
'Id' => '<string>',
'InputAttachments' => [
[
'AutomaticInputFailoverSettings' => [
'ErrorClearTimeMsec' => <integer>,
'FailoverConditions' => [
[
'FailoverConditionSettings' => [
'AudioSilenceSettings' => [
'AudioSelectorName' => '<string>',
'AudioSilenceThresholdMsec' => <integer>,
],
'InputLossSettings' => [
'InputLossThresholdMsec' => <integer>,
],
'VideoBlackSettings' => [
'BlackDetectThreshold' => <float>,
'VideoBlackThresholdMsec' => <integer>,
],
],
],
// ...
],
'InputPreference' => 'EQUAL_INPUT_PREFERENCE|PRIMARY_INPUT_PREFERRED',
'SecondaryInputId' => '<string>',
],
'InputAttachmentName' => '<string>',
'InputId' => '<string>',
'InputSettings' => [
'AudioSelectors' => [
[
'Name' => '<string>',
'SelectorSettings' => [
'AudioHlsRenditionSelection' => [
'GroupId' => '<string>',
'Name' => '<string>',
],
'AudioLanguageSelection' => [
'LanguageCode' => '<string>',
'LanguageSelectionPolicy' => 'LOOSE|STRICT',
],
'AudioPidSelection' => [
'Pid' => <integer>,
],
'AudioTrackSelection' => [
'DolbyEDecode' => [
'ProgramSelection' => 'ALL_CHANNELS|PROGRAM_1|PROGRAM_2|PROGRAM_3|PROGRAM_4|PROGRAM_5|PROGRAM_6|PROGRAM_7|PROGRAM_8',
],
'Tracks' => [
[
'Track' => <integer>,
],
// ...
],
],
],
],
// ...
],
'CaptionSelectors' => [
[
'LanguageCode' => '<string>',
'Name' => '<string>',
'SelectorSettings' => [
'AncillarySourceSettings' => [
'SourceAncillaryChannelNumber' => <integer>,
],
'AribSourceSettings' => [
],
'DvbSubSourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'EmbeddedSourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Scte20Detection' => 'AUTO|OFF',
'Source608ChannelNumber' => <integer>,
'Source608TrackNumber' => <integer>,
],
'Scte20SourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Source608ChannelNumber' => <integer>,
],
'Scte27SourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'TeletextSourceSettings' => [
'OutputRectangle' => [
'Height' => <float>,
'LeftOffset' => <float>,
'TopOffset' => <float>,
'Width' => <float>,
],
'PageNumber' => '<string>',
],
],
],
// ...
],
'DeblockFilter' => 'DISABLED|ENABLED',
'DenoiseFilter' => 'DISABLED|ENABLED',
'FilterStrength' => <integer>,
'InputFilter' => 'AUTO|DISABLED|FORCED',
'NetworkInputSettings' => [
'HlsInputSettings' => [
'Bandwidth' => <integer>,
'BufferSegments' => <integer>,
'Retries' => <integer>,
'RetryInterval' => <integer>,
'Scte35Source' => 'MANIFEST|SEGMENTS',
],
'MulticastInputSettings' => [
'SourceIpAddress' => '<string>',
],
'ServerValidation' => 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME|CHECK_CRYPTOGRAPHY_ONLY',
],
'Scte35Pid' => <integer>,
'Smpte2038DataPreference' => 'IGNORE|PREFER',
'SourceEndBehavior' => 'CONTINUE|LOOP',
'VideoSelector' => [
'ColorSpace' => 'FOLLOW|HDR10|HLG_2020|REC_601|REC_709',
'ColorSpaceSettings' => [
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
],
'ColorSpaceUsage' => 'FALLBACK|FORCE',
'SelectorSettings' => [
'VideoSelectorPid' => [
'Pid' => <integer>,
],
'VideoSelectorProgramId' => [
'ProgramId' => <integer>,
],
],
],
],
'LogicalInterfaceNames' => ['<string>', ...],
],
// ...
],
'InputSpecification' => [
'Codec' => 'MPEG2|AVC|HEVC',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'Resolution' => 'SD|HD|UHD',
],
'LogLevel' => 'ERROR|WARNING|INFO|DEBUG|DISABLED',
'Maintenance' => [
'MaintenanceDay' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartTime' => '<string>',
],
'Name' => '<string>',
'PipelineDetails' => [
[
'ActiveInputAttachmentName' => '<string>',
'ActiveInputSwitchActionName' => '<string>',
'ActiveMotionGraphicsActionName' => '<string>',
'ActiveMotionGraphicsUri' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'PipelinesRunningCount' => <integer>,
'RoleArn' => '<string>',
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED|UPDATING|UPDATE_FAILED',
'Tags' => ['<string>', ...],
'Vpc' => [
'AvailabilityZones' => ['<string>', ...],
'NetworkInterfaceIds' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
]
Result Details
Members
- AnywhereSettings
-
- Type: DescribeAnywhereSettings structure
Elemental anywhere settings - Arn
-
- Type: string
- CdiInputSpecification
-
- Type: CdiInputSpecification structure
- ChannelClass
-
- Type: string
A standard channel has two encoding pipelines and a single pipeline channel only has one. - Destinations
-
- Type: Array of OutputDestination structures
- EgressEndpoints
-
- Type: Array of ChannelEgressEndpoint structures
- EncoderSettings
-
- Type: EncoderSettings structure
Encoder Settings - Id
-
- Type: string
- InputAttachments
-
- Type: Array of InputAttachment structures
- InputSpecification
-
- Type: InputSpecification structure
- LogLevel
-
- Type: string
The log level the user wants for their channel. - Maintenance
-
- Type: MaintenanceStatus structure
- Name
-
- Type: string
- PipelineDetails
-
- Type: Array of PipelineDetail structures
- PipelinesRunningCount
-
- Type: int
- RoleArn
-
- Type: string
- State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Vpc
-
- Type: VpcOutputSettingsDescription structure
The properties for a private VPC Output
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
StartDeleteMonitorDeployment
$result = $client->startDeleteMonitorDeployment([/* ... */]); $promise = $client->startDeleteMonitorDeploymentAsync([/* ... */]);
Initiates a deployment to delete the monitor of the specified signal map.
Parameter Syntax
$result = $client->startDeleteMonitorDeployment([
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CloudWatchAlarmTemplateGroupIds' => ['<string>', ...],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DiscoveryEntryPointArn' => '<string>',
'ErrorMessage' => '<string>',
'EventBridgeRuleTemplateGroupIds' => ['<string>', ...],
'FailedMediaResourceMap' => [
'<__string>' => [
'Destinations' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
'Name' => '<string>',
'Sources' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
],
// ...
],
'Id' => '<string>',
'LastDiscoveredAt' => <DateTime>,
'LastSuccessfulMonitorDeployment' => [
'DetailsUri' => '<string>',
'Status' => 'NOT_DEPLOYED|DRY_RUN_DEPLOYMENT_COMPLETE|DRY_RUN_DEPLOYMENT_FAILED|DRY_RUN_DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_COMPLETE|DEPLOYMENT_FAILED|DEPLOYMENT_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_IN_PROGRESS',
],
'MediaResourceMap' => [
'<__string>' => [
'Destinations' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
'Name' => '<string>',
'Sources' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
],
// ...
],
'ModifiedAt' => <DateTime>,
'MonitorChangesPendingDeployment' => true || false,
'MonitorDeployment' => [
'DetailsUri' => '<string>',
'ErrorMessage' => '<string>',
'Status' => 'NOT_DEPLOYED|DRY_RUN_DEPLOYMENT_COMPLETE|DRY_RUN_DEPLOYMENT_FAILED|DRY_RUN_DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_COMPLETE|DEPLOYMENT_FAILED|DEPLOYMENT_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_IN_PROGRESS',
],
'Name' => '<string>',
'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_REVERTED|UPDATE_FAILED|READY|NOT_READY',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CloudWatchAlarmTemplateGroupIds
-
- Type: Array of strings
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- DiscoveryEntryPointArn
-
- Type: string
- ErrorMessage
-
- Type: string
- EventBridgeRuleTemplateGroupIds
-
- Type: Array of strings
- FailedMediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an incomplete AWS media workflow as a graph. - Id
-
- Type: string
- LastDiscoveredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastSuccessfulMonitorDeployment
-
- Type: SuccessfulMonitorDeployment structure
Represents the latest successful monitor deployment of a signal map. - MediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an AWS media workflow as a graph. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- MonitorChangesPendingDeployment
-
- Type: boolean
- MonitorDeployment
-
- Type: MonitorDeployment structure
Represents the latest monitor deployment of a signal map. - Name
-
- Type: string
- Status
-
- Type: string
A signal map's current status which is dependent on its lifecycle actions or associated jobs. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
StartInputDevice
$result = $client->startInputDevice([/* ... */]); $promise = $client->startInputDeviceAsync([/* ... */]);
Start an input device that is attached to a MediaConnect flow. (There is no need to start a device that is attached to a MediaLive input; MediaLive starts the device when the channel starts.)
Parameter Syntax
$result = $client->startInputDevice([
'InputDeviceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InputDeviceId
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
StartInputDeviceMaintenanceWindow
$result = $client->startInputDeviceMaintenanceWindow([/* ... */]); $promise = $client->startInputDeviceMaintenanceWindowAsync([/* ... */]);
Start a maintenance window for the specified input device. Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance.
Parameter Syntax
$result = $client->startInputDeviceMaintenanceWindow([
'InputDeviceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InputDeviceId
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
StartMonitorDeployment
$result = $client->startMonitorDeployment([/* ... */]); $promise = $client->startMonitorDeploymentAsync([/* ... */]);
Initiates a deployment to deploy the latest monitor of the specified signal map.
Parameter Syntax
$result = $client->startMonitorDeployment([
'DryRun' => true || false,
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DryRun
-
- Type: boolean
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CloudWatchAlarmTemplateGroupIds' => ['<string>', ...],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DiscoveryEntryPointArn' => '<string>',
'ErrorMessage' => '<string>',
'EventBridgeRuleTemplateGroupIds' => ['<string>', ...],
'FailedMediaResourceMap' => [
'<__string>' => [
'Destinations' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
'Name' => '<string>',
'Sources' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
],
// ...
],
'Id' => '<string>',
'LastDiscoveredAt' => <DateTime>,
'LastSuccessfulMonitorDeployment' => [
'DetailsUri' => '<string>',
'Status' => 'NOT_DEPLOYED|DRY_RUN_DEPLOYMENT_COMPLETE|DRY_RUN_DEPLOYMENT_FAILED|DRY_RUN_DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_COMPLETE|DEPLOYMENT_FAILED|DEPLOYMENT_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_IN_PROGRESS',
],
'MediaResourceMap' => [
'<__string>' => [
'Destinations' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
'Name' => '<string>',
'Sources' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
],
// ...
],
'ModifiedAt' => <DateTime>,
'MonitorChangesPendingDeployment' => true || false,
'MonitorDeployment' => [
'DetailsUri' => '<string>',
'ErrorMessage' => '<string>',
'Status' => 'NOT_DEPLOYED|DRY_RUN_DEPLOYMENT_COMPLETE|DRY_RUN_DEPLOYMENT_FAILED|DRY_RUN_DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_COMPLETE|DEPLOYMENT_FAILED|DEPLOYMENT_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_IN_PROGRESS',
],
'Name' => '<string>',
'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_REVERTED|UPDATE_FAILED|READY|NOT_READY',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CloudWatchAlarmTemplateGroupIds
-
- Type: Array of strings
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- DiscoveryEntryPointArn
-
- Type: string
- ErrorMessage
-
- Type: string
- EventBridgeRuleTemplateGroupIds
-
- Type: Array of strings
- FailedMediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an incomplete AWS media workflow as a graph. - Id
-
- Type: string
- LastDiscoveredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastSuccessfulMonitorDeployment
-
- Type: SuccessfulMonitorDeployment structure
Represents the latest successful monitor deployment of a signal map. - MediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an AWS media workflow as a graph. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- MonitorChangesPendingDeployment
-
- Type: boolean
- MonitorDeployment
-
- Type: MonitorDeployment structure
Represents the latest monitor deployment of a signal map. - Name
-
- Type: string
- Status
-
- Type: string
A signal map's current status which is dependent on its lifecycle actions or associated jobs. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
StartMultiplex
$result = $client->startMultiplex([/* ... */]); $promise = $client->startMultiplexAsync([/* ... */]);
Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.
Parameter Syntax
$result = $client->startMultiplex([
'MultiplexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MultiplexId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'AvailabilityZones' => ['<string>', ...],
'Destinations' => [
[
'MediaConnectSettings' => [
'EntitlementArn' => '<string>',
],
],
// ...
],
'Id' => '<string>',
'MultiplexSettings' => [
'MaximumVideoBufferDelayMilliseconds' => <integer>,
'TransportStreamBitrate' => <integer>,
'TransportStreamId' => <integer>,
'TransportStreamReservedBitrate' => <integer>,
],
'Name' => '<string>',
'PipelinesRunningCount' => <integer>,
'ProgramCount' => <integer>,
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- AvailabilityZones
-
- Type: Array of strings
- Destinations
-
- Type: Array of MultiplexOutputDestination structures
- Id
-
- Type: string
- MultiplexSettings
-
- Type: MultiplexSettings structure
Contains configuration for a Multiplex event - Name
-
- Type: string
- PipelinesRunningCount
-
- Type: int
- ProgramCount
-
- Type: int
- State
-
- Type: string
The current state of the multiplex. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
StartUpdateSignalMap
$result = $client->startUpdateSignalMap([/* ... */]); $promise = $client->startUpdateSignalMapAsync([/* ... */]);
Initiates an update for the specified signal map. Will discover a new signal map if a changed discoveryEntryPointArn is provided.
Parameter Syntax
$result = $client->startUpdateSignalMap([
'CloudWatchAlarmTemplateGroupIdentifiers' => ['<string>', ...],
'Description' => '<string>',
'DiscoveryEntryPointArn' => '<string>',
'EventBridgeRuleTemplateGroupIdentifiers' => ['<string>', ...],
'ForceRediscovery' => true || false,
'Identifier' => '<string>', // REQUIRED
'Name' => '<string>',
]);
Parameter Details
Members
- CloudWatchAlarmTemplateGroupIdentifiers
-
- Type: Array of strings
- Description
-
- Type: string
- DiscoveryEntryPointArn
-
- Type: string
- EventBridgeRuleTemplateGroupIdentifiers
-
- Type: Array of strings
- ForceRediscovery
-
- Type: boolean
- Identifier
-
- Required: Yes
- Type: string
- Name
-
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CloudWatchAlarmTemplateGroupIds' => ['<string>', ...],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DiscoveryEntryPointArn' => '<string>',
'ErrorMessage' => '<string>',
'EventBridgeRuleTemplateGroupIds' => ['<string>', ...],
'FailedMediaResourceMap' => [
'<__string>' => [
'Destinations' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
'Name' => '<string>',
'Sources' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
],
// ...
],
'Id' => '<string>',
'LastDiscoveredAt' => <DateTime>,
'LastSuccessfulMonitorDeployment' => [
'DetailsUri' => '<string>',
'Status' => 'NOT_DEPLOYED|DRY_RUN_DEPLOYMENT_COMPLETE|DRY_RUN_DEPLOYMENT_FAILED|DRY_RUN_DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_COMPLETE|DEPLOYMENT_FAILED|DEPLOYMENT_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_IN_PROGRESS',
],
'MediaResourceMap' => [
'<__string>' => [
'Destinations' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
'Name' => '<string>',
'Sources' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
],
// ...
],
'ModifiedAt' => <DateTime>,
'MonitorChangesPendingDeployment' => true || false,
'MonitorDeployment' => [
'DetailsUri' => '<string>',
'ErrorMessage' => '<string>',
'Status' => 'NOT_DEPLOYED|DRY_RUN_DEPLOYMENT_COMPLETE|DRY_RUN_DEPLOYMENT_FAILED|DRY_RUN_DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_COMPLETE|DEPLOYMENT_FAILED|DEPLOYMENT_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_IN_PROGRESS',
],
'Name' => '<string>',
'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_REVERTED|UPDATE_FAILED|READY|NOT_READY',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CloudWatchAlarmTemplateGroupIds
-
- Type: Array of strings
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- DiscoveryEntryPointArn
-
- Type: string
- ErrorMessage
-
- Type: string
- EventBridgeRuleTemplateGroupIds
-
- Type: Array of strings
- FailedMediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an incomplete AWS media workflow as a graph. - Id
-
- Type: string
- LastDiscoveredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastSuccessfulMonitorDeployment
-
- Type: SuccessfulMonitorDeployment structure
Represents the latest successful monitor deployment of a signal map. - MediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an AWS media workflow as a graph. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- MonitorChangesPendingDeployment
-
- Type: boolean
- MonitorDeployment
-
- Type: MonitorDeployment structure
Represents the latest monitor deployment of a signal map. - Name
-
- Type: string
- Status
-
- Type: string
A signal map's current status which is dependent on its lifecycle actions or associated jobs. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
StopChannel
$result = $client->stopChannel([/* ... */]); $promise = $client->stopChannelAsync([/* ... */]);
Stops a running channel
Parameter Syntax
$result = $client->stopChannel([
'ChannelId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ChannelId
-
- Required: Yes
- Type: string
Result Syntax
[
'AnywhereSettings' => [
'ChannelPlacementGroupId' => '<string>',
'ClusterId' => '<string>',
],
'Arn' => '<string>',
'CdiInputSpecification' => [
'Resolution' => 'SD|HD|FHD|UHD',
],
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
'EgressEndpoints' => [
[
'SourceIp' => '<string>',
],
// ...
],
'EncoderSettings' => [
'AudioDescriptions' => [
[
'AudioDashRoles' => ['<string>', ...],
'AudioNormalizationSettings' => [
'Algorithm' => 'ITU_1770_1|ITU_1770_2',
'AlgorithmControl' => 'CORRECT_AUDIO',
'TargetLkfs' => <float>,
],
'AudioSelectorName' => '<string>',
'AudioType' => 'CLEAN_EFFECTS|HEARING_IMPAIRED|UNDEFINED|VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'AudioWatermarkingSettings' => [
'NielsenWatermarksSettings' => [
'NielsenCbetSettings' => [
'CbetCheckDigitString' => '<string>',
'CbetStepaside' => 'DISABLED|ENABLED',
'Csid' => '<string>',
],
'NielsenDistributionType' => 'FINAL_DISTRIBUTOR|PROGRAM_CONTENT',
'NielsenNaesIiNwSettings' => [
'CheckDigitString' => '<string>',
'Sid' => <float>,
'Timezone' => 'AMERICA_PUERTO_RICO|US_ALASKA|US_ARIZONA|US_CENTRAL|US_EASTERN|US_HAWAII|US_MOUNTAIN|US_PACIFIC|US_SAMOA|UTC',
],
],
],
'CodecSettings' => [
'AacSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'AD_RECEIVER_MIX|CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_5_1',
'InputType' => 'BROADCASTER_MIXED_AD|NORMAL',
'Profile' => 'HEV1|HEV2|LC',
'RateControlMode' => 'CBR|VBR',
'RawFormat' => 'LATM_LOAS|NONE',
'SampleRate' => <float>,
'Spec' => 'MPEG2|MPEG4',
'VbrQuality' => 'HIGH|LOW|MEDIUM_HIGH|MEDIUM_LOW',
],
'Ac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|DIALOGUE|EMERGENCY|HEARING_IMPAIRED|MUSIC_AND_EFFECTS|VISUALLY_IMPAIRED|VOICE_OVER',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_3_2_LFE',
'Dialnorm' => <integer>,
'DrcProfile' => 'FILM_STANDARD|NONE',
'LfeFilter' => 'DISABLED|ENABLED',
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
],
'Eac3AtmosSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_5_1_4|CODING_MODE_7_1_4|CODING_MODE_9_1_6',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'HeightTrim' => <float>,
'SurroundTrim' => <float>,
],
'Eac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|EMERGENCY|HEARING_IMPAIRED|VISUALLY_IMPAIRED',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_3_2',
'DcFilter' => 'DISABLED|ENABLED',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'LfeControl' => 'LFE|NO_LFE',
'LfeFilter' => 'DISABLED|ENABLED',
'LoRoCenterMixLevel' => <float>,
'LoRoSurroundMixLevel' => <float>,
'LtRtCenterMixLevel' => <float>,
'LtRtSurroundMixLevel' => <float>,
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'PassthroughControl' => 'NO_PASSTHROUGH|WHEN_POSSIBLE',
'PhaseControl' => 'NO_SHIFT|SHIFT_90_DEGREES',
'StereoDownmix' => 'DPL2|LO_RO|LT_RT|NOT_INDICATED',
'SurroundExMode' => 'DISABLED|ENABLED|NOT_INDICATED',
'SurroundMode' => 'DISABLED|ENABLED|NOT_INDICATED',
],
'Mp2Settings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0',
'SampleRate' => <float>,
],
'PassThroughSettings' => [
],
'WavSettings' => [
'BitDepth' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_4_0|CODING_MODE_8_0',
'SampleRate' => <float>,
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageCodeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'Name' => '<string>',
'RemixSettings' => [
'ChannelMappings' => [
[
'InputChannelLevels' => [
[
'Gain' => <integer>,
'InputChannel' => <integer>,
],
// ...
],
'OutputChannel' => <integer>,
],
// ...
],
'ChannelsIn' => <integer>,
'ChannelsOut' => <integer>,
],
'StreamName' => '<string>',
],
// ...
],
'AvailBlanking' => [
'AvailBlankingImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'State' => 'DISABLED|ENABLED',
],
'AvailConfiguration' => [
'AvailSettings' => [
'Esam' => [
'AcquisitionPointId' => '<string>',
'AdAvailOffset' => <integer>,
'PasswordParam' => '<string>',
'PoisEndpoint' => '<string>',
'Username' => '<string>',
'ZoneIdentity' => '<string>',
],
'Scte35SpliceInsert' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
'Scte35TimeSignalApos' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
],
'Scte35SegmentationScope' => 'ALL_OUTPUT_GROUPS|SCTE35_ENABLED_OUTPUT_GROUPS',
],
'BlackoutSlate' => [
'BlackoutSlateImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkEndBlackout' => 'DISABLED|ENABLED',
'NetworkEndBlackoutImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkId' => '<string>',
'State' => 'DISABLED|ENABLED',
],
'CaptionDescriptions' => [
[
'Accessibility' => 'DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES|IMPLEMENTS_ACCESSIBILITY_FEATURES',
'CaptionDashRoles' => ['<string>', ...],
'CaptionSelectorName' => '<string>',
'DestinationSettings' => [
'AribDestinationSettings' => [
],
'BurnInDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'DvbSubDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'EbuTtDDestinationSettings' => [
'CopyrightHolder' => '<string>',
'FillLineGap' => 'DISABLED|ENABLED',
'FontFamily' => '<string>',
'StyleControl' => 'EXCLUDE|INCLUDE',
],
'EmbeddedDestinationSettings' => [
],
'EmbeddedPlusScte20DestinationSettings' => [
],
'RtmpCaptionInfoDestinationSettings' => [
],
'Scte20PlusEmbeddedDestinationSettings' => [
],
'Scte27DestinationSettings' => [
],
'SmpteTtDestinationSettings' => [
],
'TeletextDestinationSettings' => [
],
'TtmlDestinationSettings' => [
'StyleControl' => 'PASSTHROUGH|USE_CONFIGURED',
],
'WebvttDestinationSettings' => [
'StyleControl' => 'NO_STYLE_DATA|PASSTHROUGH',
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
'Name' => '<string>',
],
// ...
],
'ColorCorrectionSettings' => [
'GlobalColorCorrections' => [
[
'InputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'OutputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'Uri' => '<string>',
],
// ...
],
],
'FeatureActivations' => [
'InputPrepareScheduleActions' => 'DISABLED|ENABLED',
'OutputStaticImageOverlayScheduleActions' => 'DISABLED|ENABLED',
],
'GlobalConfiguration' => [
'InitialAudioGain' => <integer>,
'InputEndAction' => 'NONE|SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior' => [
'BlackFrameMsec' => <integer>,
'InputLossImageColor' => '<string>',
'InputLossImageSlate' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'InputLossImageType' => 'COLOR|SLATE',
'RepeatFrameMsec' => <integer>,
],
'OutputLockingMode' => 'EPOCH_LOCKING|PIPELINE_LOCKING',
'OutputLockingSettings' => [
'EpochLockingSettings' => [
'CustomEpoch' => '<string>',
'JamSyncTime' => '<string>',
],
'PipelineLockingSettings' => [
],
],
'OutputTimingSource' => 'INPUT_CLOCK|SYSTEM_CLOCK',
'SupportLowFramerateInputs' => 'DISABLED|ENABLED',
],
'MotionGraphicsConfiguration' => [
'MotionGraphicsInsertion' => 'DISABLED|ENABLED',
'MotionGraphicsSettings' => [
'HtmlMotionGraphicsSettings' => [
],
],
],
'NielsenConfiguration' => [
'DistributorId' => '<string>',
'NielsenPcmToId3Tagging' => 'DISABLED|ENABLED',
],
'OutputGroups' => [
[
'Name' => '<string>',
'OutputGroupSettings' => [
'ArchiveGroupSettings' => [
'ArchiveCdnSettings' => [
'ArchiveS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'RolloverInterval' => <integer>,
],
'CmafIngestGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvNameModifier' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NielsenId3NameModifier' => '<string>',
'Scte35NameModifier' => '<string>',
'Scte35Type' => 'NONE|SCTE_35_WITHOUT_SEGMENTATION',
'SegmentLength' => <integer>,
'SegmentLengthUnits' => 'MILLISECONDS|SECONDS',
'SendDelayMs' => <integer>,
],
'FrameCaptureGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'FrameCaptureCdnSettings' => [
'FrameCaptureS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
],
'HlsGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'BaseUrlContent' => '<string>',
'BaseUrlContent1' => '<string>',
'BaseUrlManifest' => '<string>',
'BaseUrlManifest1' => '<string>',
'CaptionLanguageMappings' => [
[
'CaptionChannel' => <integer>,
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
],
// ...
],
'CaptionLanguageSetting' => 'INSERT|NONE|OMIT',
'ClientCache' => 'DISABLED|ENABLED',
'CodecSpecification' => 'RFC_4281|RFC_6381',
'ConstantIv' => '<string>',
'Destination' => [
'DestinationRefId' => '<string>',
],
'DirectoryStructure' => 'SINGLE_DIRECTORY|SUBDIRECTORY_PER_STREAM',
'DiscontinuityTags' => 'INSERT|NEVER_INSERT',
'EncryptionType' => 'AES128|SAMPLE_AES',
'HlsCdnSettings' => [
'HlsAkamaiSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'Salt' => '<string>',
'Token' => '<string>',
],
'HlsBasicPutSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsMediaStoreSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'MediaStoreStorageClass' => 'TEMPORAL',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
'HlsWebdavSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
],
'HlsId3SegmentTagging' => 'DISABLED|ENABLED',
'IFrameOnlyPlaylists' => 'DISABLED|STANDARD',
'IncompleteSegmentBehavior' => 'AUTO|SUPPRESS',
'IndexNSegments' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'IvInManifest' => 'EXCLUDE|INCLUDE',
'IvSource' => 'EXPLICIT|FOLLOWS_SEGMENT_NUMBER',
'KeepSegments' => <integer>,
'KeyFormat' => '<string>',
'KeyFormatVersions' => '<string>',
'KeyProviderSettings' => [
'StaticKeySettings' => [
'KeyProviderServer' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'StaticKeyValue' => '<string>',
],
],
'ManifestCompression' => 'GZIP|NONE',
'ManifestDurationFormat' => 'FLOATING_POINT|INTEGER',
'MinSegmentLength' => <integer>,
'Mode' => 'LIVE|VOD',
'OutputSelection' => 'MANIFESTS_AND_SEGMENTS|SEGMENTS_ONLY|VARIANT_MANIFESTS_AND_SEGMENTS',
'ProgramDateTime' => 'EXCLUDE|INCLUDE',
'ProgramDateTimeClock' => 'INITIALIZE_FROM_OUTPUT_TIMECODE|SYSTEM_CLOCK',
'ProgramDateTimePeriod' => <integer>,
'RedundantManifest' => 'DISABLED|ENABLED',
'SegmentLength' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory' => <integer>,
'StreamInfResolution' => 'EXCLUDE|INCLUDE',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
'TimestampDeltaMilliseconds' => <integer>,
'TsFileMode' => 'SEGMENTED_FILES|SINGLE_FILE',
],
'MediaPackageGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'MsSmoothGroupSettings' => [
'AcquisitionPointId' => '<string>',
'AudioOnlyTimecodeControl' => 'PASSTHROUGH|USE_CONFIGURED_CLOCK',
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'EventId' => '<string>',
'EventIdMode' => 'NO_EVENT_ID|USE_CONFIGURED|USE_TIMESTAMP',
'EventStopBehavior' => 'NONE|SEND_EOS',
'FilecacheDuration' => <integer>,
'FragmentLength' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SendDelayMs' => <integer>,
'SparseTrackType' => 'NONE|SCTE_35|SCTE_35_WITHOUT_SEGMENTATION',
'StreamManifestBehavior' => 'DO_NOT_SEND|SEND',
'TimestampOffset' => '<string>',
'TimestampOffsetMode' => 'USE_CONFIGURED_OFFSET|USE_EVENT_START_DATE',
],
'MultiplexGroupSettings' => [
],
'RtmpGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'AuthenticationScheme' => 'AKAMAI|COMMON',
'CacheFullBehavior' => 'DISCONNECT_IMMEDIATELY|WAIT_FOR_SERVER',
'CacheLength' => <integer>,
'CaptionData' => 'ALL|FIELD1_608|FIELD1_AND_FIELD2_608',
'IncludeFillerNalUnits' => 'AUTO|DROP|INCLUDE',
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'RestartDelay' => <integer>,
],
'SrtGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
],
'UdpGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
],
],
'Outputs' => [
[
'AudioDescriptionNames' => ['<string>', ...],
'CaptionDescriptionNames' => ['<string>', ...],
'OutputName' => '<string>',
'OutputSettings' => [
'ArchiveOutputSettings' => [
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
'RawSettings' => [
],
],
'Extension' => '<string>',
'NameModifier' => '<string>',
],
'CmafIngestOutputSettings' => [
'NameModifier' => '<string>',
],
'FrameCaptureOutputSettings' => [
'NameModifier' => '<string>',
],
'HlsOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'HlsSettings' => [
'AudioOnlyHlsSettings' => [
'AudioGroupId' => '<string>',
'AudioOnlyImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'AudioTrackType' => 'ALTERNATE_AUDIO_AUTO_SELECT|ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT|ALTERNATE_AUDIO_NOT_AUTO_SELECT|AUDIO_ONLY_VARIANT_STREAM',
'SegmentType' => 'AAC|FMP4',
],
'Fmp4HlsSettings' => [
'AudioRenditionSets' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
],
'FrameCaptureHlsSettings' => [
],
'StandardHlsSettings' => [
'AudioRenditionSets' => '<string>',
'M3u8Settings' => [
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'EcmPid' => '<string>',
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'Scte35Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'Scte35Pid' => '<string>',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
],
'NameModifier' => '<string>',
'SegmentModifier' => '<string>',
],
'MediaPackageOutputSettings' => [
],
'MsSmoothOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'NameModifier' => '<string>',
],
'MultiplexOutputSettings' => [
'ContainerSettings' => [
'MultiplexM2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioStreamType' => 'ATSC|DVB',
'CcDescriptor' => 'DISABLED|ENABLED',
'Ebif' => 'NONE|PASSTHROUGH',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'Klv' => 'NONE|PASSTHROUGH',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35PrerollPullupMilliseconds' => <float>,
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'RtmpOutputSettings' => [
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'NumRetries' => <integer>,
],
'SrtOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'EncryptionType' => 'AES128|AES192|AES256',
'Latency' => <integer>,
],
'UdpOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'FecOutputSettings' => [
'ColumnDepth' => <integer>,
'IncludeFec' => 'COLUMN|COLUMN_AND_ROW',
'RowLength' => <integer>,
],
],
],
'VideoDescriptionName' => '<string>',
],
// ...
],
],
// ...
],
'ThumbnailConfiguration' => [
'State' => 'AUTO|DISABLED',
],
'TimecodeConfig' => [
'Source' => 'EMBEDDED|SYSTEMCLOCK|ZEROBASED',
'SyncThreshold' => <integer>,
],
'VideoDescriptions' => [
[
'CodecSettings' => [
'Av1Settings' => [
'AfdSignaling' => 'AUTO|FIXED|NONE',
'BufSize' => <integer>,
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'AV1_LEVEL_2|AV1_LEVEL_2_1|AV1_LEVEL_3|AV1_LEVEL_3_1|AV1_LEVEL_4|AV1_LEVEL_4_1|AV1_LEVEL_5|AV1_LEVEL_5_1|AV1_LEVEL_5_2|AV1_LEVEL_5_3|AV1_LEVEL_6|AV1_LEVEL_6_1|AV1_LEVEL_6_2|AV1_LEVEL_6_3|AV1_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'QvbrQualityLevel' => <integer>,
'SceneChangeDetect' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'FrameCaptureSettings' => [
'CaptureInterval' => <integer>,
'CaptureIntervalUnits' => 'MILLISECONDS|SECONDS',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'H264Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'Bitrate' => <integer>,
'BufFillPct' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'EntropyEncoding' => 'CABAC|CAVLC',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'ForceFieldPictures' => 'DISABLED|ENABLED',
'FramerateControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopBReference' => 'DISABLED|ENABLED',
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H264_LEVEL_1|H264_LEVEL_1_1|H264_LEVEL_1_2|H264_LEVEL_1_3|H264_LEVEL_2|H264_LEVEL_2_1|H264_LEVEL_2_2|H264_LEVEL_3|H264_LEVEL_3_1|H264_LEVEL_3_2|H264_LEVEL_4|H264_LEVEL_4_1|H264_LEVEL_4_2|H264_LEVEL_5|H264_LEVEL_5_1|H264_LEVEL_5_2|H264_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'NumRefFrames' => <integer>,
'ParControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'BASELINE|HIGH|HIGH_10BIT|HIGH_422|HIGH_422_10BIT|MAIN',
'QualityLevel' => 'ENHANCED_QUALITY|STANDARD_QUALITY',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR|VBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Softness' => <integer>,
'SpatialAq' => 'DISABLED|ENABLED',
'SubgopLength' => 'DYNAMIC|FIXED',
'Syntax' => 'DEFAULT|RP2027',
'TemporalAq' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
],
'H265Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'AlternativeTransferFunction' => 'INSERT|OMIT',
'Bitrate' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'DolbyVision81Settings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'Deblocking' => 'DISABLED|ENABLED',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H265_LEVEL_1|H265_LEVEL_2|H265_LEVEL_2_1|H265_LEVEL_3|H265_LEVEL_3_1|H265_LEVEL_4|H265_LEVEL_4_1|H265_LEVEL_5|H265_LEVEL_5_1|H265_LEVEL_5_2|H265_LEVEL_6|H265_LEVEL_6_1|H265_LEVEL_6_2|H265_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'MvOverPictureBoundaries' => 'DISABLED|ENABLED',
'MvTemporalPredictor' => 'DISABLED|ENABLED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'MAIN|MAIN_10BIT',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Tier' => 'HIGH|MAIN',
'TileHeight' => <integer>,
'TilePadding' => 'NONE|PADDED',
'TileWidth' => <integer>,
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
'TreeblockSize' => 'AUTO|TREE_SIZE_32X32',
],
'Mpeg2Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|LOW|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpace' => 'AUTO|PASSTHROUGH',
'DisplayAspectRatio' => 'DISPLAYRATIO16X9|DISPLAYRATIO4X3',
'FilterSettings' => [
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SubgopLength' => 'DYNAMIC|FIXED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|GOP_TIMECODE',
],
],
'Height' => <integer>,
'Name' => '<string>',
'RespondToAfd' => 'NONE|PASSTHROUGH|RESPOND',
'ScalingBehavior' => 'DEFAULT|STRETCH_TO_OUTPUT',
'Sharpness' => <integer>,
'Width' => <integer>,
],
// ...
],
],
'Id' => '<string>',
'InputAttachments' => [
[
'AutomaticInputFailoverSettings' => [
'ErrorClearTimeMsec' => <integer>,
'FailoverConditions' => [
[
'FailoverConditionSettings' => [
'AudioSilenceSettings' => [
'AudioSelectorName' => '<string>',
'AudioSilenceThresholdMsec' => <integer>,
],
'InputLossSettings' => [
'InputLossThresholdMsec' => <integer>,
],
'VideoBlackSettings' => [
'BlackDetectThreshold' => <float>,
'VideoBlackThresholdMsec' => <integer>,
],
],
],
// ...
],
'InputPreference' => 'EQUAL_INPUT_PREFERENCE|PRIMARY_INPUT_PREFERRED',
'SecondaryInputId' => '<string>',
],
'InputAttachmentName' => '<string>',
'InputId' => '<string>',
'InputSettings' => [
'AudioSelectors' => [
[
'Name' => '<string>',
'SelectorSettings' => [
'AudioHlsRenditionSelection' => [
'GroupId' => '<string>',
'Name' => '<string>',
],
'AudioLanguageSelection' => [
'LanguageCode' => '<string>',
'LanguageSelectionPolicy' => 'LOOSE|STRICT',
],
'AudioPidSelection' => [
'Pid' => <integer>,
],
'AudioTrackSelection' => [
'DolbyEDecode' => [
'ProgramSelection' => 'ALL_CHANNELS|PROGRAM_1|PROGRAM_2|PROGRAM_3|PROGRAM_4|PROGRAM_5|PROGRAM_6|PROGRAM_7|PROGRAM_8',
],
'Tracks' => [
[
'Track' => <integer>,
],
// ...
],
],
],
],
// ...
],
'CaptionSelectors' => [
[
'LanguageCode' => '<string>',
'Name' => '<string>',
'SelectorSettings' => [
'AncillarySourceSettings' => [
'SourceAncillaryChannelNumber' => <integer>,
],
'AribSourceSettings' => [
],
'DvbSubSourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'EmbeddedSourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Scte20Detection' => 'AUTO|OFF',
'Source608ChannelNumber' => <integer>,
'Source608TrackNumber' => <integer>,
],
'Scte20SourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Source608ChannelNumber' => <integer>,
],
'Scte27SourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'TeletextSourceSettings' => [
'OutputRectangle' => [
'Height' => <float>,
'LeftOffset' => <float>,
'TopOffset' => <float>,
'Width' => <float>,
],
'PageNumber' => '<string>',
],
],
],
// ...
],
'DeblockFilter' => 'DISABLED|ENABLED',
'DenoiseFilter' => 'DISABLED|ENABLED',
'FilterStrength' => <integer>,
'InputFilter' => 'AUTO|DISABLED|FORCED',
'NetworkInputSettings' => [
'HlsInputSettings' => [
'Bandwidth' => <integer>,
'BufferSegments' => <integer>,
'Retries' => <integer>,
'RetryInterval' => <integer>,
'Scte35Source' => 'MANIFEST|SEGMENTS',
],
'MulticastInputSettings' => [
'SourceIpAddress' => '<string>',
],
'ServerValidation' => 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME|CHECK_CRYPTOGRAPHY_ONLY',
],
'Scte35Pid' => <integer>,
'Smpte2038DataPreference' => 'IGNORE|PREFER',
'SourceEndBehavior' => 'CONTINUE|LOOP',
'VideoSelector' => [
'ColorSpace' => 'FOLLOW|HDR10|HLG_2020|REC_601|REC_709',
'ColorSpaceSettings' => [
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
],
'ColorSpaceUsage' => 'FALLBACK|FORCE',
'SelectorSettings' => [
'VideoSelectorPid' => [
'Pid' => <integer>,
],
'VideoSelectorProgramId' => [
'ProgramId' => <integer>,
],
],
],
],
'LogicalInterfaceNames' => ['<string>', ...],
],
// ...
],
'InputSpecification' => [
'Codec' => 'MPEG2|AVC|HEVC',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'Resolution' => 'SD|HD|UHD',
],
'LogLevel' => 'ERROR|WARNING|INFO|DEBUG|DISABLED',
'Maintenance' => [
'MaintenanceDay' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartTime' => '<string>',
],
'Name' => '<string>',
'PipelineDetails' => [
[
'ActiveInputAttachmentName' => '<string>',
'ActiveInputSwitchActionName' => '<string>',
'ActiveMotionGraphicsActionName' => '<string>',
'ActiveMotionGraphicsUri' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'PipelinesRunningCount' => <integer>,
'RoleArn' => '<string>',
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED|UPDATING|UPDATE_FAILED',
'Tags' => ['<string>', ...],
'Vpc' => [
'AvailabilityZones' => ['<string>', ...],
'NetworkInterfaceIds' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
]
Result Details
Members
- AnywhereSettings
-
- Type: DescribeAnywhereSettings structure
Elemental anywhere settings - Arn
-
- Type: string
- CdiInputSpecification
-
- Type: CdiInputSpecification structure
- ChannelClass
-
- Type: string
A standard channel has two encoding pipelines and a single pipeline channel only has one. - Destinations
-
- Type: Array of OutputDestination structures
- EgressEndpoints
-
- Type: Array of ChannelEgressEndpoint structures
- EncoderSettings
-
- Type: EncoderSettings structure
Encoder Settings - Id
-
- Type: string
- InputAttachments
-
- Type: Array of InputAttachment structures
- InputSpecification
-
- Type: InputSpecification structure
- LogLevel
-
- Type: string
The log level the user wants for their channel. - Maintenance
-
- Type: MaintenanceStatus structure
- Name
-
- Type: string
- PipelineDetails
-
- Type: Array of PipelineDetail structures
- PipelinesRunningCount
-
- Type: int
- RoleArn
-
- Type: string
- State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Vpc
-
- Type: VpcOutputSettingsDescription structure
The properties for a private VPC Output
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
StopInputDevice
$result = $client->stopInputDevice([/* ... */]); $promise = $client->stopInputDeviceAsync([/* ... */]);
Stop an input device that is attached to a MediaConnect flow. (There is no need to stop a device that is attached to a MediaLive input; MediaLive automatically stops the device when the channel stops.)
Parameter Syntax
$result = $client->stopInputDevice([
'InputDeviceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InputDeviceId
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
StopMultiplex
$result = $client->stopMultiplex([/* ... */]); $promise = $client->stopMultiplexAsync([/* ... */]);
Stops a running multiplex. If the multiplex isn't running, this action has no effect.
Parameter Syntax
$result = $client->stopMultiplex([
'MultiplexId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MultiplexId
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'AvailabilityZones' => ['<string>', ...],
'Destinations' => [
[
'MediaConnectSettings' => [
'EntitlementArn' => '<string>',
],
],
// ...
],
'Id' => '<string>',
'MultiplexSettings' => [
'MaximumVideoBufferDelayMilliseconds' => <integer>,
'TransportStreamBitrate' => <integer>,
'TransportStreamId' => <integer>,
'TransportStreamReservedBitrate' => <integer>,
],
'Name' => '<string>',
'PipelinesRunningCount' => <integer>,
'ProgramCount' => <integer>,
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- AvailabilityZones
-
- Type: Array of strings
- Destinations
-
- Type: Array of MultiplexOutputDestination structures
- Id
-
- Type: string
- MultiplexSettings
-
- Type: MultiplexSettings structure
Contains configuration for a Multiplex event - Name
-
- Type: string
- PipelinesRunningCount
-
- Type: int
- ProgramCount
-
- Type: int
- State
-
- Type: string
The current state of the multiplex. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
TransferInputDevice
$result = $client->transferInputDevice([/* ... */]); $promise = $client->transferInputDeviceAsync([/* ... */]);
Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.
Parameter Syntax
$result = $client->transferInputDevice([
'InputDeviceId' => '<string>', // REQUIRED
'TargetCustomerId' => '<string>',
'TargetRegion' => '<string>',
'TransferMessage' => '<string>',
]);
Parameter Details
Members
- InputDeviceId
-
- Required: Yes
- Type: string
- TargetCustomerId
-
- Type: string
- TargetRegion
-
- Type: string
- TransferMessage
-
- Type: string
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateAccountConfiguration
$result = $client->updateAccountConfiguration([/* ... */]); $promise = $client->updateAccountConfigurationAsync([/* ... */]);
Update account configuration
Parameter Syntax
$result = $client->updateAccountConfiguration([
'AccountConfiguration' => [
'KmsKeyId' => '<string>',
],
]);
Parameter Details
Members
- AccountConfiguration
-
- Type: AccountConfiguration structure
Result Syntax
[
'AccountConfiguration' => [
'KmsKeyId' => '<string>',
],
]
Result Details
Members
- AccountConfiguration
-
- Type: AccountConfiguration structure
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
UpdateChannel
$result = $client->updateChannel([/* ... */]); $promise = $client->updateChannelAsync([/* ... */]);
Updates a channel.
Parameter Syntax
$result = $client->updateChannel([
'CdiInputSpecification' => [
'Resolution' => 'SD|HD|FHD|UHD',
],
'ChannelId' => '<string>', // REQUIRED
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
'EncoderSettings' => [
'AudioDescriptions' => [ // REQUIRED
[
'AudioDashRoles' => ['<string>', ...],
'AudioNormalizationSettings' => [
'Algorithm' => 'ITU_1770_1|ITU_1770_2',
'AlgorithmControl' => 'CORRECT_AUDIO',
'TargetLkfs' => <float>,
],
'AudioSelectorName' => '<string>', // REQUIRED
'AudioType' => 'CLEAN_EFFECTS|HEARING_IMPAIRED|UNDEFINED|VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'AudioWatermarkingSettings' => [
'NielsenWatermarksSettings' => [
'NielsenCbetSettings' => [
'CbetCheckDigitString' => '<string>', // REQUIRED
'CbetStepaside' => 'DISABLED|ENABLED', // REQUIRED
'Csid' => '<string>', // REQUIRED
],
'NielsenDistributionType' => 'FINAL_DISTRIBUTOR|PROGRAM_CONTENT',
'NielsenNaesIiNwSettings' => [
'CheckDigitString' => '<string>', // REQUIRED
'Sid' => <float>, // REQUIRED
'Timezone' => 'AMERICA_PUERTO_RICO|US_ALASKA|US_ARIZONA|US_CENTRAL|US_EASTERN|US_HAWAII|US_MOUNTAIN|US_PACIFIC|US_SAMOA|UTC',
],
],
],
'CodecSettings' => [
'AacSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'AD_RECEIVER_MIX|CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_5_1',
'InputType' => 'BROADCASTER_MIXED_AD|NORMAL',
'Profile' => 'HEV1|HEV2|LC',
'RateControlMode' => 'CBR|VBR',
'RawFormat' => 'LATM_LOAS|NONE',
'SampleRate' => <float>,
'Spec' => 'MPEG2|MPEG4',
'VbrQuality' => 'HIGH|LOW|MEDIUM_HIGH|MEDIUM_LOW',
],
'Ac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|DIALOGUE|EMERGENCY|HEARING_IMPAIRED|MUSIC_AND_EFFECTS|VISUALLY_IMPAIRED|VOICE_OVER',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_3_2_LFE',
'Dialnorm' => <integer>,
'DrcProfile' => 'FILM_STANDARD|NONE',
'LfeFilter' => 'DISABLED|ENABLED',
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
],
'Eac3AtmosSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_5_1_4|CODING_MODE_7_1_4|CODING_MODE_9_1_6',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'HeightTrim' => <float>,
'SurroundTrim' => <float>,
],
'Eac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|EMERGENCY|HEARING_IMPAIRED|VISUALLY_IMPAIRED',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_3_2',
'DcFilter' => 'DISABLED|ENABLED',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'LfeControl' => 'LFE|NO_LFE',
'LfeFilter' => 'DISABLED|ENABLED',
'LoRoCenterMixLevel' => <float>,
'LoRoSurroundMixLevel' => <float>,
'LtRtCenterMixLevel' => <float>,
'LtRtSurroundMixLevel' => <float>,
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'PassthroughControl' => 'NO_PASSTHROUGH|WHEN_POSSIBLE',
'PhaseControl' => 'NO_SHIFT|SHIFT_90_DEGREES',
'StereoDownmix' => 'DPL2|LO_RO|LT_RT|NOT_INDICATED',
'SurroundExMode' => 'DISABLED|ENABLED|NOT_INDICATED',
'SurroundMode' => 'DISABLED|ENABLED|NOT_INDICATED',
],
'Mp2Settings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0',
'SampleRate' => <float>,
],
'PassThroughSettings' => [
],
'WavSettings' => [
'BitDepth' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_4_0|CODING_MODE_8_0',
'SampleRate' => <float>,
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageCodeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'Name' => '<string>', // REQUIRED
'RemixSettings' => [
'ChannelMappings' => [ // REQUIRED
[
'InputChannelLevels' => [ // REQUIRED
[
'Gain' => <integer>, // REQUIRED
'InputChannel' => <integer>, // REQUIRED
],
// ...
],
'OutputChannel' => <integer>, // REQUIRED
],
// ...
],
'ChannelsIn' => <integer>,
'ChannelsOut' => <integer>,
],
'StreamName' => '<string>',
],
// ...
],
'AvailBlanking' => [
'AvailBlankingImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'State' => 'DISABLED|ENABLED',
],
'AvailConfiguration' => [
'AvailSettings' => [
'Esam' => [
'AcquisitionPointId' => '<string>', // REQUIRED
'AdAvailOffset' => <integer>,
'PasswordParam' => '<string>',
'PoisEndpoint' => '<string>', // REQUIRED
'Username' => '<string>',
'ZoneIdentity' => '<string>',
],
'Scte35SpliceInsert' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
'Scte35TimeSignalApos' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
],
'Scte35SegmentationScope' => 'ALL_OUTPUT_GROUPS|SCTE35_ENABLED_OUTPUT_GROUPS',
],
'BlackoutSlate' => [
'BlackoutSlateImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'NetworkEndBlackout' => 'DISABLED|ENABLED',
'NetworkEndBlackoutImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'NetworkId' => '<string>',
'State' => 'DISABLED|ENABLED',
],
'CaptionDescriptions' => [
[
'Accessibility' => 'DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES|IMPLEMENTS_ACCESSIBILITY_FEATURES',
'CaptionDashRoles' => ['<string>', ...],
'CaptionSelectorName' => '<string>', // REQUIRED
'DestinationSettings' => [
'AribDestinationSettings' => [
],
'BurnInDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'DvbSubDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'EbuTtDDestinationSettings' => [
'CopyrightHolder' => '<string>',
'FillLineGap' => 'DISABLED|ENABLED',
'FontFamily' => '<string>',
'StyleControl' => 'EXCLUDE|INCLUDE',
],
'EmbeddedDestinationSettings' => [
],
'EmbeddedPlusScte20DestinationSettings' => [
],
'RtmpCaptionInfoDestinationSettings' => [
],
'Scte20PlusEmbeddedDestinationSettings' => [
],
'Scte27DestinationSettings' => [
],
'SmpteTtDestinationSettings' => [
],
'TeletextDestinationSettings' => [
],
'TtmlDestinationSettings' => [
'StyleControl' => 'PASSTHROUGH|USE_CONFIGURED',
],
'WebvttDestinationSettings' => [
'StyleControl' => 'NO_STYLE_DATA|PASSTHROUGH',
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
'Name' => '<string>', // REQUIRED
],
// ...
],
'ColorCorrectionSettings' => [
'GlobalColorCorrections' => [ // REQUIRED
[
'InputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709', // REQUIRED
'OutputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709', // REQUIRED
'Uri' => '<string>', // REQUIRED
],
// ...
],
],
'FeatureActivations' => [
'InputPrepareScheduleActions' => 'DISABLED|ENABLED',
'OutputStaticImageOverlayScheduleActions' => 'DISABLED|ENABLED',
],
'GlobalConfiguration' => [
'InitialAudioGain' => <integer>,
'InputEndAction' => 'NONE|SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior' => [
'BlackFrameMsec' => <integer>,
'InputLossImageColor' => '<string>',
'InputLossImageSlate' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'InputLossImageType' => 'COLOR|SLATE',
'RepeatFrameMsec' => <integer>,
],
'OutputLockingMode' => 'EPOCH_LOCKING|PIPELINE_LOCKING',
'OutputLockingSettings' => [
'EpochLockingSettings' => [
'CustomEpoch' => '<string>',
'JamSyncTime' => '<string>',
],
'PipelineLockingSettings' => [
],
],
'OutputTimingSource' => 'INPUT_CLOCK|SYSTEM_CLOCK',
'SupportLowFramerateInputs' => 'DISABLED|ENABLED',
],
'MotionGraphicsConfiguration' => [
'MotionGraphicsInsertion' => 'DISABLED|ENABLED',
'MotionGraphicsSettings' => [ // REQUIRED
'HtmlMotionGraphicsSettings' => [
],
],
],
'NielsenConfiguration' => [
'DistributorId' => '<string>',
'NielsenPcmToId3Tagging' => 'DISABLED|ENABLED',
],
'OutputGroups' => [ // REQUIRED
[
'Name' => '<string>',
'OutputGroupSettings' => [ // REQUIRED
'ArchiveGroupSettings' => [
'ArchiveCdnSettings' => [
'ArchiveS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'RolloverInterval' => <integer>,
],
'CmafIngestGroupSettings' => [
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvNameModifier' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NielsenId3NameModifier' => '<string>',
'Scte35NameModifier' => '<string>',
'Scte35Type' => 'NONE|SCTE_35_WITHOUT_SEGMENTATION',
'SegmentLength' => <integer>,
'SegmentLengthUnits' => 'MILLISECONDS|SECONDS',
'SendDelayMs' => <integer>,
],
'FrameCaptureGroupSettings' => [
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'FrameCaptureCdnSettings' => [
'FrameCaptureS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
],
'HlsGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'BaseUrlContent' => '<string>',
'BaseUrlContent1' => '<string>',
'BaseUrlManifest' => '<string>',
'BaseUrlManifest1' => '<string>',
'CaptionLanguageMappings' => [
[
'CaptionChannel' => <integer>, // REQUIRED
'LanguageCode' => '<string>', // REQUIRED
'LanguageDescription' => '<string>', // REQUIRED
],
// ...
],
'CaptionLanguageSetting' => 'INSERT|NONE|OMIT',
'ClientCache' => 'DISABLED|ENABLED',
'CodecSpecification' => 'RFC_4281|RFC_6381',
'ConstantIv' => '<string>',
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'DirectoryStructure' => 'SINGLE_DIRECTORY|SUBDIRECTORY_PER_STREAM',
'DiscontinuityTags' => 'INSERT|NEVER_INSERT',
'EncryptionType' => 'AES128|SAMPLE_AES',
'HlsCdnSettings' => [
'HlsAkamaiSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'Salt' => '<string>',
'Token' => '<string>',
],
'HlsBasicPutSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsMediaStoreSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'MediaStoreStorageClass' => 'TEMPORAL',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
'HlsWebdavSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
],
'HlsId3SegmentTagging' => 'DISABLED|ENABLED',
'IFrameOnlyPlaylists' => 'DISABLED|STANDARD',
'IncompleteSegmentBehavior' => 'AUTO|SUPPRESS',
'IndexNSegments' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'IvInManifest' => 'EXCLUDE|INCLUDE',
'IvSource' => 'EXPLICIT|FOLLOWS_SEGMENT_NUMBER',
'KeepSegments' => <integer>,
'KeyFormat' => '<string>',
'KeyFormatVersions' => '<string>',
'KeyProviderSettings' => [
'StaticKeySettings' => [
'KeyProviderServer' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'StaticKeyValue' => '<string>', // REQUIRED
],
],
'ManifestCompression' => 'GZIP|NONE',
'ManifestDurationFormat' => 'FLOATING_POINT|INTEGER',
'MinSegmentLength' => <integer>,
'Mode' => 'LIVE|VOD',
'OutputSelection' => 'MANIFESTS_AND_SEGMENTS|SEGMENTS_ONLY|VARIANT_MANIFESTS_AND_SEGMENTS',
'ProgramDateTime' => 'EXCLUDE|INCLUDE',
'ProgramDateTimeClock' => 'INITIALIZE_FROM_OUTPUT_TIMECODE|SYSTEM_CLOCK',
'ProgramDateTimePeriod' => <integer>,
'RedundantManifest' => 'DISABLED|ENABLED',
'SegmentLength' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory' => <integer>,
'StreamInfResolution' => 'EXCLUDE|INCLUDE',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
'TimestampDeltaMilliseconds' => <integer>,
'TsFileMode' => 'SEGMENTED_FILES|SINGLE_FILE',
],
'MediaPackageGroupSettings' => [
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
],
'MsSmoothGroupSettings' => [
'AcquisitionPointId' => '<string>',
'AudioOnlyTimecodeControl' => 'PASSTHROUGH|USE_CONFIGURED_CLOCK',
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'EventId' => '<string>',
'EventIdMode' => 'NO_EVENT_ID|USE_CONFIGURED|USE_TIMESTAMP',
'EventStopBehavior' => 'NONE|SEND_EOS',
'FilecacheDuration' => <integer>,
'FragmentLength' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SendDelayMs' => <integer>,
'SparseTrackType' => 'NONE|SCTE_35|SCTE_35_WITHOUT_SEGMENTATION',
'StreamManifestBehavior' => 'DO_NOT_SEND|SEND',
'TimestampOffset' => '<string>',
'TimestampOffsetMode' => 'USE_CONFIGURED_OFFSET|USE_EVENT_START_DATE',
],
'MultiplexGroupSettings' => [
],
'RtmpGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'AuthenticationScheme' => 'AKAMAI|COMMON',
'CacheFullBehavior' => 'DISCONNECT_IMMEDIATELY|WAIT_FOR_SERVER',
'CacheLength' => <integer>,
'CaptionData' => 'ALL|FIELD1_608|FIELD1_AND_FIELD2_608',
'IncludeFillerNalUnits' => 'AUTO|DROP|INCLUDE',
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'RestartDelay' => <integer>,
],
'SrtGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
],
'UdpGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
],
],
'Outputs' => [ // REQUIRED
[
'AudioDescriptionNames' => ['<string>', ...],
'CaptionDescriptionNames' => ['<string>', ...],
'OutputName' => '<string>',
'OutputSettings' => [ // REQUIRED
'ArchiveOutputSettings' => [
'ContainerSettings' => [ // REQUIRED
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>, // REQUIRED
'NetworkName' => '<string>', // REQUIRED
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
'RawSettings' => [
],
],
'Extension' => '<string>',
'NameModifier' => '<string>',
],
'CmafIngestOutputSettings' => [
'NameModifier' => '<string>',
],
'FrameCaptureOutputSettings' => [
'NameModifier' => '<string>',
],
'HlsOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'HlsSettings' => [ // REQUIRED
'AudioOnlyHlsSettings' => [
'AudioGroupId' => '<string>',
'AudioOnlyImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>', // REQUIRED
'Username' => '<string>',
],
'AudioTrackType' => 'ALTERNATE_AUDIO_AUTO_SELECT|ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT|ALTERNATE_AUDIO_NOT_AUTO_SELECT|AUDIO_ONLY_VARIANT_STREAM',
'SegmentType' => 'AAC|FMP4',
],
'Fmp4HlsSettings' => [
'AudioRenditionSets' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
],
'FrameCaptureHlsSettings' => [
],
'StandardHlsSettings' => [
'AudioRenditionSets' => '<string>',
'M3u8Settings' => [ // REQUIRED
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'EcmPid' => '<string>',
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'Scte35Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'Scte35Pid' => '<string>',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
],
'NameModifier' => '<string>',
'SegmentModifier' => '<string>',
],
'MediaPackageOutputSettings' => [
],
'MsSmoothOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'NameModifier' => '<string>',
],
'MultiplexOutputSettings' => [
'ContainerSettings' => [
'MultiplexM2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioStreamType' => 'ATSC|DVB',
'CcDescriptor' => 'DISABLED|ENABLED',
'Ebif' => 'NONE|PASSTHROUGH',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'Klv' => 'NONE|PASSTHROUGH',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35PrerollPullupMilliseconds' => <float>,
],
],
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
],
'RtmpOutputSettings' => [
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'NumRetries' => <integer>,
],
'SrtOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [ // REQUIRED
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>, // REQUIRED
'NetworkName' => '<string>', // REQUIRED
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'EncryptionType' => 'AES128|AES192|AES256',
'Latency' => <integer>,
],
'UdpOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [ // REQUIRED
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>, // REQUIRED
'NetworkName' => '<string>', // REQUIRED
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [ // REQUIRED
'DestinationRefId' => '<string>',
],
'FecOutputSettings' => [
'ColumnDepth' => <integer>,
'IncludeFec' => 'COLUMN|COLUMN_AND_ROW',
'RowLength' => <integer>,
],
],
],
'VideoDescriptionName' => '<string>',
],
// ...
],
],
// ...
],
'ThumbnailConfiguration' => [
'State' => 'AUTO|DISABLED', // REQUIRED
],
'TimecodeConfig' => [ // REQUIRED
'Source' => 'EMBEDDED|SYSTEMCLOCK|ZEROBASED', // REQUIRED
'SyncThreshold' => <integer>,
],
'VideoDescriptions' => [ // REQUIRED
[
'CodecSettings' => [
'Av1Settings' => [
'AfdSignaling' => 'AUTO|FIXED|NONE',
'BufSize' => <integer>,
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>, // REQUIRED
'FramerateNumerator' => <integer>, // REQUIRED
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'AV1_LEVEL_2|AV1_LEVEL_2_1|AV1_LEVEL_3|AV1_LEVEL_3_1|AV1_LEVEL_4|AV1_LEVEL_4_1|AV1_LEVEL_5|AV1_LEVEL_5_1|AV1_LEVEL_5_2|AV1_LEVEL_5_3|AV1_LEVEL_6|AV1_LEVEL_6_1|AV1_LEVEL_6_2|AV1_LEVEL_6_3|AV1_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'QvbrQualityLevel' => <integer>,
'SceneChangeDetect' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16', // REQUIRED
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT', // REQUIRED
'Prefix' => '<string>',
],
],
'FrameCaptureSettings' => [
'CaptureInterval' => <integer>,
'CaptureIntervalUnits' => 'MILLISECONDS|SECONDS',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16', // REQUIRED
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT', // REQUIRED
'Prefix' => '<string>',
],
],
'H264Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'Bitrate' => <integer>,
'BufFillPct' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'EntropyEncoding' => 'CABAC|CAVLC',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'ForceFieldPictures' => 'DISABLED|ENABLED',
'FramerateControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopBReference' => 'DISABLED|ENABLED',
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H264_LEVEL_1|H264_LEVEL_1_1|H264_LEVEL_1_2|H264_LEVEL_1_3|H264_LEVEL_2|H264_LEVEL_2_1|H264_LEVEL_2_2|H264_LEVEL_3|H264_LEVEL_3_1|H264_LEVEL_3_2|H264_LEVEL_4|H264_LEVEL_4_1|H264_LEVEL_4_2|H264_LEVEL_5|H264_LEVEL_5_1|H264_LEVEL_5_2|H264_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'NumRefFrames' => <integer>,
'ParControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'BASELINE|HIGH|HIGH_10BIT|HIGH_422|HIGH_422_10BIT|MAIN',
'QualityLevel' => 'ENHANCED_QUALITY|STANDARD_QUALITY',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR|VBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Softness' => <integer>,
'SpatialAq' => 'DISABLED|ENABLED',
'SubgopLength' => 'DYNAMIC|FIXED',
'Syntax' => 'DEFAULT|RP2027',
'TemporalAq' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16', // REQUIRED
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT', // REQUIRED
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
],
'H265Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'AlternativeTransferFunction' => 'INSERT|OMIT',
'Bitrate' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'DolbyVision81Settings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'Deblocking' => 'DISABLED|ENABLED',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'FramerateDenominator' => <integer>, // REQUIRED
'FramerateNumerator' => <integer>, // REQUIRED
'GopClosedCadence' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H265_LEVEL_1|H265_LEVEL_2|H265_LEVEL_2_1|H265_LEVEL_3|H265_LEVEL_3_1|H265_LEVEL_4|H265_LEVEL_4_1|H265_LEVEL_5|H265_LEVEL_5_1|H265_LEVEL_5_2|H265_LEVEL_6|H265_LEVEL_6_1|H265_LEVEL_6_2|H265_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'MvOverPictureBoundaries' => 'DISABLED|ENABLED',
'MvTemporalPredictor' => 'DISABLED|ENABLED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'MAIN|MAIN_10BIT',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Tier' => 'HIGH|MAIN',
'TileHeight' => <integer>,
'TilePadding' => 'NONE|PADDED',
'TileWidth' => <integer>,
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16', // REQUIRED
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT', // REQUIRED
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
'TreeblockSize' => 'AUTO|TREE_SIZE_32X32',
],
'Mpeg2Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|LOW|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpace' => 'AUTO|PASSTHROUGH',
'DisplayAspectRatio' => 'DISPLAYRATIO16X9|DISPLAYRATIO4X3',
'FilterSettings' => [
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>, // REQUIRED
'FramerateNumerator' => <integer>, // REQUIRED
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SubgopLength' => 'DYNAMIC|FIXED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16', // REQUIRED
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT', // REQUIRED
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|GOP_TIMECODE',
],
],
'Height' => <integer>,
'Name' => '<string>', // REQUIRED
'RespondToAfd' => 'NONE|PASSTHROUGH|RESPOND',
'ScalingBehavior' => 'DEFAULT|STRETCH_TO_OUTPUT',
'Sharpness' => <integer>,
'Width' => <integer>,
],
// ...
],
],
'InputAttachments' => [
[
'AutomaticInputFailoverSettings' => [
'ErrorClearTimeMsec' => <integer>,
'FailoverConditions' => [
[
'FailoverConditionSettings' => [
'AudioSilenceSettings' => [
'AudioSelectorName' => '<string>', // REQUIRED
'AudioSilenceThresholdMsec' => <integer>,
],
'InputLossSettings' => [
'InputLossThresholdMsec' => <integer>,
],
'VideoBlackSettings' => [
'BlackDetectThreshold' => <float>,
'VideoBlackThresholdMsec' => <integer>,
],
],
],
// ...
],
'InputPreference' => 'EQUAL_INPUT_PREFERENCE|PRIMARY_INPUT_PREFERRED',
'SecondaryInputId' => '<string>', // REQUIRED
],
'InputAttachmentName' => '<string>',
'InputId' => '<string>',
'InputSettings' => [
'AudioSelectors' => [
[
'Name' => '<string>', // REQUIRED
'SelectorSettings' => [
'AudioHlsRenditionSelection' => [
'GroupId' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
],
'AudioLanguageSelection' => [
'LanguageCode' => '<string>', // REQUIRED
'LanguageSelectionPolicy' => 'LOOSE|STRICT',
],
'AudioPidSelection' => [
'Pid' => <integer>, // REQUIRED
],
'AudioTrackSelection' => [
'DolbyEDecode' => [
'ProgramSelection' => 'ALL_CHANNELS|PROGRAM_1|PROGRAM_2|PROGRAM_3|PROGRAM_4|PROGRAM_5|PROGRAM_6|PROGRAM_7|PROGRAM_8', // REQUIRED
],
'Tracks' => [ // REQUIRED
[
'Track' => <integer>, // REQUIRED
],
// ...
],
],
],
],
// ...
],
'CaptionSelectors' => [
[
'LanguageCode' => '<string>',
'Name' => '<string>', // REQUIRED
'SelectorSettings' => [
'AncillarySourceSettings' => [
'SourceAncillaryChannelNumber' => <integer>,
],
'AribSourceSettings' => [
],
'DvbSubSourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'EmbeddedSourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Scte20Detection' => 'AUTO|OFF',
'Source608ChannelNumber' => <integer>,
'Source608TrackNumber' => <integer>,
],
'Scte20SourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Source608ChannelNumber' => <integer>,
],
'Scte27SourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'TeletextSourceSettings' => [
'OutputRectangle' => [
'Height' => <float>, // REQUIRED
'LeftOffset' => <float>, // REQUIRED
'TopOffset' => <float>, // REQUIRED
'Width' => <float>, // REQUIRED
],
'PageNumber' => '<string>',
],
],
],
// ...
],
'DeblockFilter' => 'DISABLED|ENABLED',
'DenoiseFilter' => 'DISABLED|ENABLED',
'FilterStrength' => <integer>,
'InputFilter' => 'AUTO|DISABLED|FORCED',
'NetworkInputSettings' => [
'HlsInputSettings' => [
'Bandwidth' => <integer>,
'BufferSegments' => <integer>,
'Retries' => <integer>,
'RetryInterval' => <integer>,
'Scte35Source' => 'MANIFEST|SEGMENTS',
],
'MulticastInputSettings' => [
'SourceIpAddress' => '<string>',
],
'ServerValidation' => 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME|CHECK_CRYPTOGRAPHY_ONLY',
],
'Scte35Pid' => <integer>,
'Smpte2038DataPreference' => 'IGNORE|PREFER',
'SourceEndBehavior' => 'CONTINUE|LOOP',
'VideoSelector' => [
'ColorSpace' => 'FOLLOW|HDR10|HLG_2020|REC_601|REC_709',
'ColorSpaceSettings' => [
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
],
'ColorSpaceUsage' => 'FALLBACK|FORCE',
'SelectorSettings' => [
'VideoSelectorPid' => [
'Pid' => <integer>,
],
'VideoSelectorProgramId' => [
'ProgramId' => <integer>,
],
],
],
],
'LogicalInterfaceNames' => ['<string>', ...],
],
// ...
],
'InputSpecification' => [
'Codec' => 'MPEG2|AVC|HEVC',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'Resolution' => 'SD|HD|UHD',
],
'LogLevel' => 'ERROR|WARNING|INFO|DEBUG|DISABLED',
'Maintenance' => [
'MaintenanceDay' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartTime' => '<string>',
],
'Name' => '<string>',
'RoleArn' => '<string>',
]);
Parameter Details
Members
- CdiInputSpecification
-
- Type: CdiInputSpecification structure
- ChannelId
-
- Required: Yes
- Type: string
- Destinations
-
- Type: Array of OutputDestination structures
- EncoderSettings
-
- Type: EncoderSettings structure
Encoder Settings - InputAttachments
-
- Type: Array of InputAttachment structures
- InputSpecification
-
- Type: InputSpecification structure
- LogLevel
-
- Type: string
The log level the user wants for their channel. - Maintenance
-
- Type: MaintenanceUpdateSettings structure
- Name
-
- Type: string
- RoleArn
-
- Type: string
Result Syntax
[
'Channel' => [
'AnywhereSettings' => [
'ChannelPlacementGroupId' => '<string>',
'ClusterId' => '<string>',
],
'Arn' => '<string>',
'CdiInputSpecification' => [
'Resolution' => 'SD|HD|FHD|UHD',
],
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
'EgressEndpoints' => [
[
'SourceIp' => '<string>',
],
// ...
],
'EncoderSettings' => [
'AudioDescriptions' => [
[
'AudioDashRoles' => ['<string>', ...],
'AudioNormalizationSettings' => [
'Algorithm' => 'ITU_1770_1|ITU_1770_2',
'AlgorithmControl' => 'CORRECT_AUDIO',
'TargetLkfs' => <float>,
],
'AudioSelectorName' => '<string>',
'AudioType' => 'CLEAN_EFFECTS|HEARING_IMPAIRED|UNDEFINED|VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'AudioWatermarkingSettings' => [
'NielsenWatermarksSettings' => [
'NielsenCbetSettings' => [
'CbetCheckDigitString' => '<string>',
'CbetStepaside' => 'DISABLED|ENABLED',
'Csid' => '<string>',
],
'NielsenDistributionType' => 'FINAL_DISTRIBUTOR|PROGRAM_CONTENT',
'NielsenNaesIiNwSettings' => [
'CheckDigitString' => '<string>',
'Sid' => <float>,
'Timezone' => 'AMERICA_PUERTO_RICO|US_ALASKA|US_ARIZONA|US_CENTRAL|US_EASTERN|US_HAWAII|US_MOUNTAIN|US_PACIFIC|US_SAMOA|UTC',
],
],
],
'CodecSettings' => [
'AacSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'AD_RECEIVER_MIX|CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_5_1',
'InputType' => 'BROADCASTER_MIXED_AD|NORMAL',
'Profile' => 'HEV1|HEV2|LC',
'RateControlMode' => 'CBR|VBR',
'RawFormat' => 'LATM_LOAS|NONE',
'SampleRate' => <float>,
'Spec' => 'MPEG2|MPEG4',
'VbrQuality' => 'HIGH|LOW|MEDIUM_HIGH|MEDIUM_LOW',
],
'Ac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|DIALOGUE|EMERGENCY|HEARING_IMPAIRED|MUSIC_AND_EFFECTS|VISUALLY_IMPAIRED|VOICE_OVER',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_3_2_LFE',
'Dialnorm' => <integer>,
'DrcProfile' => 'FILM_STANDARD|NONE',
'LfeFilter' => 'DISABLED|ENABLED',
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
],
'Eac3AtmosSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_5_1_4|CODING_MODE_7_1_4|CODING_MODE_9_1_6',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'HeightTrim' => <float>,
'SurroundTrim' => <float>,
],
'Eac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|EMERGENCY|HEARING_IMPAIRED|VISUALLY_IMPAIRED',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_3_2',
'DcFilter' => 'DISABLED|ENABLED',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'LfeControl' => 'LFE|NO_LFE',
'LfeFilter' => 'DISABLED|ENABLED',
'LoRoCenterMixLevel' => <float>,
'LoRoSurroundMixLevel' => <float>,
'LtRtCenterMixLevel' => <float>,
'LtRtSurroundMixLevel' => <float>,
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'PassthroughControl' => 'NO_PASSTHROUGH|WHEN_POSSIBLE',
'PhaseControl' => 'NO_SHIFT|SHIFT_90_DEGREES',
'StereoDownmix' => 'DPL2|LO_RO|LT_RT|NOT_INDICATED',
'SurroundExMode' => 'DISABLED|ENABLED|NOT_INDICATED',
'SurroundMode' => 'DISABLED|ENABLED|NOT_INDICATED',
],
'Mp2Settings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0',
'SampleRate' => <float>,
],
'PassThroughSettings' => [
],
'WavSettings' => [
'BitDepth' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_4_0|CODING_MODE_8_0',
'SampleRate' => <float>,
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageCodeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'Name' => '<string>',
'RemixSettings' => [
'ChannelMappings' => [
[
'InputChannelLevels' => [
[
'Gain' => <integer>,
'InputChannel' => <integer>,
],
// ...
],
'OutputChannel' => <integer>,
],
// ...
],
'ChannelsIn' => <integer>,
'ChannelsOut' => <integer>,
],
'StreamName' => '<string>',
],
// ...
],
'AvailBlanking' => [
'AvailBlankingImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'State' => 'DISABLED|ENABLED',
],
'AvailConfiguration' => [
'AvailSettings' => [
'Esam' => [
'AcquisitionPointId' => '<string>',
'AdAvailOffset' => <integer>,
'PasswordParam' => '<string>',
'PoisEndpoint' => '<string>',
'Username' => '<string>',
'ZoneIdentity' => '<string>',
],
'Scte35SpliceInsert' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
'Scte35TimeSignalApos' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
],
'Scte35SegmentationScope' => 'ALL_OUTPUT_GROUPS|SCTE35_ENABLED_OUTPUT_GROUPS',
],
'BlackoutSlate' => [
'BlackoutSlateImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkEndBlackout' => 'DISABLED|ENABLED',
'NetworkEndBlackoutImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkId' => '<string>',
'State' => 'DISABLED|ENABLED',
],
'CaptionDescriptions' => [
[
'Accessibility' => 'DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES|IMPLEMENTS_ACCESSIBILITY_FEATURES',
'CaptionDashRoles' => ['<string>', ...],
'CaptionSelectorName' => '<string>',
'DestinationSettings' => [
'AribDestinationSettings' => [
],
'BurnInDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'DvbSubDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'EbuTtDDestinationSettings' => [
'CopyrightHolder' => '<string>',
'FillLineGap' => 'DISABLED|ENABLED',
'FontFamily' => '<string>',
'StyleControl' => 'EXCLUDE|INCLUDE',
],
'EmbeddedDestinationSettings' => [
],
'EmbeddedPlusScte20DestinationSettings' => [
],
'RtmpCaptionInfoDestinationSettings' => [
],
'Scte20PlusEmbeddedDestinationSettings' => [
],
'Scte27DestinationSettings' => [
],
'SmpteTtDestinationSettings' => [
],
'TeletextDestinationSettings' => [
],
'TtmlDestinationSettings' => [
'StyleControl' => 'PASSTHROUGH|USE_CONFIGURED',
],
'WebvttDestinationSettings' => [
'StyleControl' => 'NO_STYLE_DATA|PASSTHROUGH',
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
'Name' => '<string>',
],
// ...
],
'ColorCorrectionSettings' => [
'GlobalColorCorrections' => [
[
'InputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'OutputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'Uri' => '<string>',
],
// ...
],
],
'FeatureActivations' => [
'InputPrepareScheduleActions' => 'DISABLED|ENABLED',
'OutputStaticImageOverlayScheduleActions' => 'DISABLED|ENABLED',
],
'GlobalConfiguration' => [
'InitialAudioGain' => <integer>,
'InputEndAction' => 'NONE|SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior' => [
'BlackFrameMsec' => <integer>,
'InputLossImageColor' => '<string>',
'InputLossImageSlate' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'InputLossImageType' => 'COLOR|SLATE',
'RepeatFrameMsec' => <integer>,
],
'OutputLockingMode' => 'EPOCH_LOCKING|PIPELINE_LOCKING',
'OutputLockingSettings' => [
'EpochLockingSettings' => [
'CustomEpoch' => '<string>',
'JamSyncTime' => '<string>',
],
'PipelineLockingSettings' => [
],
],
'OutputTimingSource' => 'INPUT_CLOCK|SYSTEM_CLOCK',
'SupportLowFramerateInputs' => 'DISABLED|ENABLED',
],
'MotionGraphicsConfiguration' => [
'MotionGraphicsInsertion' => 'DISABLED|ENABLED',
'MotionGraphicsSettings' => [
'HtmlMotionGraphicsSettings' => [
],
],
],
'NielsenConfiguration' => [
'DistributorId' => '<string>',
'NielsenPcmToId3Tagging' => 'DISABLED|ENABLED',
],
'OutputGroups' => [
[
'Name' => '<string>',
'OutputGroupSettings' => [
'ArchiveGroupSettings' => [
'ArchiveCdnSettings' => [
'ArchiveS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'RolloverInterval' => <integer>,
],
'CmafIngestGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvNameModifier' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NielsenId3NameModifier' => '<string>',
'Scte35NameModifier' => '<string>',
'Scte35Type' => 'NONE|SCTE_35_WITHOUT_SEGMENTATION',
'SegmentLength' => <integer>,
'SegmentLengthUnits' => 'MILLISECONDS|SECONDS',
'SendDelayMs' => <integer>,
],
'FrameCaptureGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'FrameCaptureCdnSettings' => [
'FrameCaptureS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
],
'HlsGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'BaseUrlContent' => '<string>',
'BaseUrlContent1' => '<string>',
'BaseUrlManifest' => '<string>',
'BaseUrlManifest1' => '<string>',
'CaptionLanguageMappings' => [
[
'CaptionChannel' => <integer>,
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
],
// ...
],
'CaptionLanguageSetting' => 'INSERT|NONE|OMIT',
'ClientCache' => 'DISABLED|ENABLED',
'CodecSpecification' => 'RFC_4281|RFC_6381',
'ConstantIv' => '<string>',
'Destination' => [
'DestinationRefId' => '<string>',
],
'DirectoryStructure' => 'SINGLE_DIRECTORY|SUBDIRECTORY_PER_STREAM',
'DiscontinuityTags' => 'INSERT|NEVER_INSERT',
'EncryptionType' => 'AES128|SAMPLE_AES',
'HlsCdnSettings' => [
'HlsAkamaiSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'Salt' => '<string>',
'Token' => '<string>',
],
'HlsBasicPutSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsMediaStoreSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'MediaStoreStorageClass' => 'TEMPORAL',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
'HlsWebdavSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
],
'HlsId3SegmentTagging' => 'DISABLED|ENABLED',
'IFrameOnlyPlaylists' => 'DISABLED|STANDARD',
'IncompleteSegmentBehavior' => 'AUTO|SUPPRESS',
'IndexNSegments' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'IvInManifest' => 'EXCLUDE|INCLUDE',
'IvSource' => 'EXPLICIT|FOLLOWS_SEGMENT_NUMBER',
'KeepSegments' => <integer>,
'KeyFormat' => '<string>',
'KeyFormatVersions' => '<string>',
'KeyProviderSettings' => [
'StaticKeySettings' => [
'KeyProviderServer' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'StaticKeyValue' => '<string>',
],
],
'ManifestCompression' => 'GZIP|NONE',
'ManifestDurationFormat' => 'FLOATING_POINT|INTEGER',
'MinSegmentLength' => <integer>,
'Mode' => 'LIVE|VOD',
'OutputSelection' => 'MANIFESTS_AND_SEGMENTS|SEGMENTS_ONLY|VARIANT_MANIFESTS_AND_SEGMENTS',
'ProgramDateTime' => 'EXCLUDE|INCLUDE',
'ProgramDateTimeClock' => 'INITIALIZE_FROM_OUTPUT_TIMECODE|SYSTEM_CLOCK',
'ProgramDateTimePeriod' => <integer>,
'RedundantManifest' => 'DISABLED|ENABLED',
'SegmentLength' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory' => <integer>,
'StreamInfResolution' => 'EXCLUDE|INCLUDE',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
'TimestampDeltaMilliseconds' => <integer>,
'TsFileMode' => 'SEGMENTED_FILES|SINGLE_FILE',
],
'MediaPackageGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'MsSmoothGroupSettings' => [
'AcquisitionPointId' => '<string>',
'AudioOnlyTimecodeControl' => 'PASSTHROUGH|USE_CONFIGURED_CLOCK',
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'EventId' => '<string>',
'EventIdMode' => 'NO_EVENT_ID|USE_CONFIGURED|USE_TIMESTAMP',
'EventStopBehavior' => 'NONE|SEND_EOS',
'FilecacheDuration' => <integer>,
'FragmentLength' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SendDelayMs' => <integer>,
'SparseTrackType' => 'NONE|SCTE_35|SCTE_35_WITHOUT_SEGMENTATION',
'StreamManifestBehavior' => 'DO_NOT_SEND|SEND',
'TimestampOffset' => '<string>',
'TimestampOffsetMode' => 'USE_CONFIGURED_OFFSET|USE_EVENT_START_DATE',
],
'MultiplexGroupSettings' => [
],
'RtmpGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'AuthenticationScheme' => 'AKAMAI|COMMON',
'CacheFullBehavior' => 'DISCONNECT_IMMEDIATELY|WAIT_FOR_SERVER',
'CacheLength' => <integer>,
'CaptionData' => 'ALL|FIELD1_608|FIELD1_AND_FIELD2_608',
'IncludeFillerNalUnits' => 'AUTO|DROP|INCLUDE',
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'RestartDelay' => <integer>,
],
'SrtGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
],
'UdpGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
],
],
'Outputs' => [
[
'AudioDescriptionNames' => ['<string>', ...],
'CaptionDescriptionNames' => ['<string>', ...],
'OutputName' => '<string>',
'OutputSettings' => [
'ArchiveOutputSettings' => [
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
'RawSettings' => [
],
],
'Extension' => '<string>',
'NameModifier' => '<string>',
],
'CmafIngestOutputSettings' => [
'NameModifier' => '<string>',
],
'FrameCaptureOutputSettings' => [
'NameModifier' => '<string>',
],
'HlsOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'HlsSettings' => [
'AudioOnlyHlsSettings' => [
'AudioGroupId' => '<string>',
'AudioOnlyImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'AudioTrackType' => 'ALTERNATE_AUDIO_AUTO_SELECT|ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT|ALTERNATE_AUDIO_NOT_AUTO_SELECT|AUDIO_ONLY_VARIANT_STREAM',
'SegmentType' => 'AAC|FMP4',
],
'Fmp4HlsSettings' => [
'AudioRenditionSets' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
],
'FrameCaptureHlsSettings' => [
],
'StandardHlsSettings' => [
'AudioRenditionSets' => '<string>',
'M3u8Settings' => [
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'EcmPid' => '<string>',
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'Scte35Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'Scte35Pid' => '<string>',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
],
'NameModifier' => '<string>',
'SegmentModifier' => '<string>',
],
'MediaPackageOutputSettings' => [
],
'MsSmoothOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'NameModifier' => '<string>',
],
'MultiplexOutputSettings' => [
'ContainerSettings' => [
'MultiplexM2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioStreamType' => 'ATSC|DVB',
'CcDescriptor' => 'DISABLED|ENABLED',
'Ebif' => 'NONE|PASSTHROUGH',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'Klv' => 'NONE|PASSTHROUGH',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35PrerollPullupMilliseconds' => <float>,
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'RtmpOutputSettings' => [
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'NumRetries' => <integer>,
],
'SrtOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'EncryptionType' => 'AES128|AES192|AES256',
'Latency' => <integer>,
],
'UdpOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'FecOutputSettings' => [
'ColumnDepth' => <integer>,
'IncludeFec' => 'COLUMN|COLUMN_AND_ROW',
'RowLength' => <integer>,
],
],
],
'VideoDescriptionName' => '<string>',
],
// ...
],
],
// ...
],
'ThumbnailConfiguration' => [
'State' => 'AUTO|DISABLED',
],
'TimecodeConfig' => [
'Source' => 'EMBEDDED|SYSTEMCLOCK|ZEROBASED',
'SyncThreshold' => <integer>,
],
'VideoDescriptions' => [
[
'CodecSettings' => [
'Av1Settings' => [
'AfdSignaling' => 'AUTO|FIXED|NONE',
'BufSize' => <integer>,
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'AV1_LEVEL_2|AV1_LEVEL_2_1|AV1_LEVEL_3|AV1_LEVEL_3_1|AV1_LEVEL_4|AV1_LEVEL_4_1|AV1_LEVEL_5|AV1_LEVEL_5_1|AV1_LEVEL_5_2|AV1_LEVEL_5_3|AV1_LEVEL_6|AV1_LEVEL_6_1|AV1_LEVEL_6_2|AV1_LEVEL_6_3|AV1_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'QvbrQualityLevel' => <integer>,
'SceneChangeDetect' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'FrameCaptureSettings' => [
'CaptureInterval' => <integer>,
'CaptureIntervalUnits' => 'MILLISECONDS|SECONDS',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'H264Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'Bitrate' => <integer>,
'BufFillPct' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'EntropyEncoding' => 'CABAC|CAVLC',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'ForceFieldPictures' => 'DISABLED|ENABLED',
'FramerateControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopBReference' => 'DISABLED|ENABLED',
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H264_LEVEL_1|H264_LEVEL_1_1|H264_LEVEL_1_2|H264_LEVEL_1_3|H264_LEVEL_2|H264_LEVEL_2_1|H264_LEVEL_2_2|H264_LEVEL_3|H264_LEVEL_3_1|H264_LEVEL_3_2|H264_LEVEL_4|H264_LEVEL_4_1|H264_LEVEL_4_2|H264_LEVEL_5|H264_LEVEL_5_1|H264_LEVEL_5_2|H264_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'NumRefFrames' => <integer>,
'ParControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'BASELINE|HIGH|HIGH_10BIT|HIGH_422|HIGH_422_10BIT|MAIN',
'QualityLevel' => 'ENHANCED_QUALITY|STANDARD_QUALITY',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR|VBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Softness' => <integer>,
'SpatialAq' => 'DISABLED|ENABLED',
'SubgopLength' => 'DYNAMIC|FIXED',
'Syntax' => 'DEFAULT|RP2027',
'TemporalAq' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
],
'H265Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'AlternativeTransferFunction' => 'INSERT|OMIT',
'Bitrate' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'DolbyVision81Settings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'Deblocking' => 'DISABLED|ENABLED',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H265_LEVEL_1|H265_LEVEL_2|H265_LEVEL_2_1|H265_LEVEL_3|H265_LEVEL_3_1|H265_LEVEL_4|H265_LEVEL_4_1|H265_LEVEL_5|H265_LEVEL_5_1|H265_LEVEL_5_2|H265_LEVEL_6|H265_LEVEL_6_1|H265_LEVEL_6_2|H265_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'MvOverPictureBoundaries' => 'DISABLED|ENABLED',
'MvTemporalPredictor' => 'DISABLED|ENABLED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'MAIN|MAIN_10BIT',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Tier' => 'HIGH|MAIN',
'TileHeight' => <integer>,
'TilePadding' => 'NONE|PADDED',
'TileWidth' => <integer>,
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
'TreeblockSize' => 'AUTO|TREE_SIZE_32X32',
],
'Mpeg2Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|LOW|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpace' => 'AUTO|PASSTHROUGH',
'DisplayAspectRatio' => 'DISPLAYRATIO16X9|DISPLAYRATIO4X3',
'FilterSettings' => [
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SubgopLength' => 'DYNAMIC|FIXED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|GOP_TIMECODE',
],
],
'Height' => <integer>,
'Name' => '<string>',
'RespondToAfd' => 'NONE|PASSTHROUGH|RESPOND',
'ScalingBehavior' => 'DEFAULT|STRETCH_TO_OUTPUT',
'Sharpness' => <integer>,
'Width' => <integer>,
],
// ...
],
],
'Id' => '<string>',
'InputAttachments' => [
[
'AutomaticInputFailoverSettings' => [
'ErrorClearTimeMsec' => <integer>,
'FailoverConditions' => [
[
'FailoverConditionSettings' => [
'AudioSilenceSettings' => [
'AudioSelectorName' => '<string>',
'AudioSilenceThresholdMsec' => <integer>,
],
'InputLossSettings' => [
'InputLossThresholdMsec' => <integer>,
],
'VideoBlackSettings' => [
'BlackDetectThreshold' => <float>,
'VideoBlackThresholdMsec' => <integer>,
],
],
],
// ...
],
'InputPreference' => 'EQUAL_INPUT_PREFERENCE|PRIMARY_INPUT_PREFERRED',
'SecondaryInputId' => '<string>',
],
'InputAttachmentName' => '<string>',
'InputId' => '<string>',
'InputSettings' => [
'AudioSelectors' => [
[
'Name' => '<string>',
'SelectorSettings' => [
'AudioHlsRenditionSelection' => [
'GroupId' => '<string>',
'Name' => '<string>',
],
'AudioLanguageSelection' => [
'LanguageCode' => '<string>',
'LanguageSelectionPolicy' => 'LOOSE|STRICT',
],
'AudioPidSelection' => [
'Pid' => <integer>,
],
'AudioTrackSelection' => [
'DolbyEDecode' => [
'ProgramSelection' => 'ALL_CHANNELS|PROGRAM_1|PROGRAM_2|PROGRAM_3|PROGRAM_4|PROGRAM_5|PROGRAM_6|PROGRAM_7|PROGRAM_8',
],
'Tracks' => [
[
'Track' => <integer>,
],
// ...
],
],
],
],
// ...
],
'CaptionSelectors' => [
[
'LanguageCode' => '<string>',
'Name' => '<string>',
'SelectorSettings' => [
'AncillarySourceSettings' => [
'SourceAncillaryChannelNumber' => <integer>,
],
'AribSourceSettings' => [
],
'DvbSubSourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'EmbeddedSourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Scte20Detection' => 'AUTO|OFF',
'Source608ChannelNumber' => <integer>,
'Source608TrackNumber' => <integer>,
],
'Scte20SourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Source608ChannelNumber' => <integer>,
],
'Scte27SourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'TeletextSourceSettings' => [
'OutputRectangle' => [
'Height' => <float>,
'LeftOffset' => <float>,
'TopOffset' => <float>,
'Width' => <float>,
],
'PageNumber' => '<string>',
],
],
],
// ...
],
'DeblockFilter' => 'DISABLED|ENABLED',
'DenoiseFilter' => 'DISABLED|ENABLED',
'FilterStrength' => <integer>,
'InputFilter' => 'AUTO|DISABLED|FORCED',
'NetworkInputSettings' => [
'HlsInputSettings' => [
'Bandwidth' => <integer>,
'BufferSegments' => <integer>,
'Retries' => <integer>,
'RetryInterval' => <integer>,
'Scte35Source' => 'MANIFEST|SEGMENTS',
],
'MulticastInputSettings' => [
'SourceIpAddress' => '<string>',
],
'ServerValidation' => 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME|CHECK_CRYPTOGRAPHY_ONLY',
],
'Scte35Pid' => <integer>,
'Smpte2038DataPreference' => 'IGNORE|PREFER',
'SourceEndBehavior' => 'CONTINUE|LOOP',
'VideoSelector' => [
'ColorSpace' => 'FOLLOW|HDR10|HLG_2020|REC_601|REC_709',
'ColorSpaceSettings' => [
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
],
'ColorSpaceUsage' => 'FALLBACK|FORCE',
'SelectorSettings' => [
'VideoSelectorPid' => [
'Pid' => <integer>,
],
'VideoSelectorProgramId' => [
'ProgramId' => <integer>,
],
],
],
],
'LogicalInterfaceNames' => ['<string>', ...],
],
// ...
],
'InputSpecification' => [
'Codec' => 'MPEG2|AVC|HEVC',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'Resolution' => 'SD|HD|UHD',
],
'LogLevel' => 'ERROR|WARNING|INFO|DEBUG|DISABLED',
'Maintenance' => [
'MaintenanceDay' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartTime' => '<string>',
],
'Name' => '<string>',
'PipelineDetails' => [
[
'ActiveInputAttachmentName' => '<string>',
'ActiveInputSwitchActionName' => '<string>',
'ActiveMotionGraphicsActionName' => '<string>',
'ActiveMotionGraphicsUri' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'PipelinesRunningCount' => <integer>,
'RoleArn' => '<string>',
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED|UPDATING|UPDATE_FAILED',
'Tags' => ['<string>', ...],
'Vpc' => [
'AvailabilityZones' => ['<string>', ...],
'NetworkInterfaceIds' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
],
]
Result Details
Members
- Channel
-
- Type: Channel structure
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateChannelClass
$result = $client->updateChannelClass([/* ... */]); $promise = $client->updateChannelClassAsync([/* ... */]);
Changes the class of the channel.
Parameter Syntax
$result = $client->updateChannelClass([
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE', // REQUIRED
'ChannelId' => '<string>', // REQUIRED
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
]);
Parameter Details
Members
- ChannelClass
-
- Required: Yes
- Type: string
A standard channel has two encoding pipelines and a single pipeline channel only has one. - ChannelId
-
- Required: Yes
- Type: string
- Destinations
-
- Type: Array of OutputDestination structures
Result Syntax
[
'Channel' => [
'AnywhereSettings' => [
'ChannelPlacementGroupId' => '<string>',
'ClusterId' => '<string>',
],
'Arn' => '<string>',
'CdiInputSpecification' => [
'Resolution' => 'SD|HD|FHD|UHD',
],
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Destinations' => [
[
'Id' => '<string>',
'MediaPackageSettings' => [
[
'ChannelGroup' => '<string>',
'ChannelId' => '<string>',
'ChannelName' => '<string>',
],
// ...
],
'MultiplexSettings' => [
'MultiplexId' => '<string>',
'ProgramName' => '<string>',
],
'Settings' => [
[
'PasswordParam' => '<string>',
'StreamName' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
[
'EncryptionPassphraseSecretArn' => '<string>',
'StreamId' => '<string>',
'Url' => '<string>',
],
// ...
],
],
// ...
],
'EgressEndpoints' => [
[
'SourceIp' => '<string>',
],
// ...
],
'EncoderSettings' => [
'AudioDescriptions' => [
[
'AudioDashRoles' => ['<string>', ...],
'AudioNormalizationSettings' => [
'Algorithm' => 'ITU_1770_1|ITU_1770_2',
'AlgorithmControl' => 'CORRECT_AUDIO',
'TargetLkfs' => <float>,
],
'AudioSelectorName' => '<string>',
'AudioType' => 'CLEAN_EFFECTS|HEARING_IMPAIRED|UNDEFINED|VISUAL_IMPAIRED_COMMENTARY',
'AudioTypeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'AudioWatermarkingSettings' => [
'NielsenWatermarksSettings' => [
'NielsenCbetSettings' => [
'CbetCheckDigitString' => '<string>',
'CbetStepaside' => 'DISABLED|ENABLED',
'Csid' => '<string>',
],
'NielsenDistributionType' => 'FINAL_DISTRIBUTOR|PROGRAM_CONTENT',
'NielsenNaesIiNwSettings' => [
'CheckDigitString' => '<string>',
'Sid' => <float>,
'Timezone' => 'AMERICA_PUERTO_RICO|US_ALASKA|US_ARIZONA|US_CENTRAL|US_EASTERN|US_HAWAII|US_MOUNTAIN|US_PACIFIC|US_SAMOA|UTC',
],
],
],
'CodecSettings' => [
'AacSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'AD_RECEIVER_MIX|CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_5_1',
'InputType' => 'BROADCASTER_MIXED_AD|NORMAL',
'Profile' => 'HEV1|HEV2|LC',
'RateControlMode' => 'CBR|VBR',
'RawFormat' => 'LATM_LOAS|NONE',
'SampleRate' => <float>,
'Spec' => 'MPEG2|MPEG4',
'VbrQuality' => 'HIGH|LOW|MEDIUM_HIGH|MEDIUM_LOW',
],
'Ac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|DIALOGUE|EMERGENCY|HEARING_IMPAIRED|MUSIC_AND_EFFECTS|VISUALLY_IMPAIRED|VOICE_OVER',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_1_1|CODING_MODE_2_0|CODING_MODE_3_2_LFE',
'Dialnorm' => <integer>,
'DrcProfile' => 'FILM_STANDARD|NONE',
'LfeFilter' => 'DISABLED|ENABLED',
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
],
'Eac3AtmosSettings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_5_1_4|CODING_MODE_7_1_4|CODING_MODE_9_1_6',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'HeightTrim' => <float>,
'SurroundTrim' => <float>,
],
'Eac3Settings' => [
'AttenuationControl' => 'ATTENUATE_3_DB|NONE',
'Bitrate' => <float>,
'BitstreamMode' => 'COMMENTARY|COMPLETE_MAIN|EMERGENCY|HEARING_IMPAIRED|VISUALLY_IMPAIRED',
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_3_2',
'DcFilter' => 'DISABLED|ENABLED',
'Dialnorm' => <integer>,
'DrcLine' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'DrcRf' => 'FILM_LIGHT|FILM_STANDARD|MUSIC_LIGHT|MUSIC_STANDARD|NONE|SPEECH',
'LfeControl' => 'LFE|NO_LFE',
'LfeFilter' => 'DISABLED|ENABLED',
'LoRoCenterMixLevel' => <float>,
'LoRoSurroundMixLevel' => <float>,
'LtRtCenterMixLevel' => <float>,
'LtRtSurroundMixLevel' => <float>,
'MetadataControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'PassthroughControl' => 'NO_PASSTHROUGH|WHEN_POSSIBLE',
'PhaseControl' => 'NO_SHIFT|SHIFT_90_DEGREES',
'StereoDownmix' => 'DPL2|LO_RO|LT_RT|NOT_INDICATED',
'SurroundExMode' => 'DISABLED|ENABLED|NOT_INDICATED',
'SurroundMode' => 'DISABLED|ENABLED|NOT_INDICATED',
],
'Mp2Settings' => [
'Bitrate' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0',
'SampleRate' => <float>,
],
'PassThroughSettings' => [
],
'WavSettings' => [
'BitDepth' => <float>,
'CodingMode' => 'CODING_MODE_1_0|CODING_MODE_2_0|CODING_MODE_4_0|CODING_MODE_8_0',
'SampleRate' => <float>,
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageCodeControl' => 'FOLLOW_INPUT|USE_CONFIGURED',
'Name' => '<string>',
'RemixSettings' => [
'ChannelMappings' => [
[
'InputChannelLevels' => [
[
'Gain' => <integer>,
'InputChannel' => <integer>,
],
// ...
],
'OutputChannel' => <integer>,
],
// ...
],
'ChannelsIn' => <integer>,
'ChannelsOut' => <integer>,
],
'StreamName' => '<string>',
],
// ...
],
'AvailBlanking' => [
'AvailBlankingImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'State' => 'DISABLED|ENABLED',
],
'AvailConfiguration' => [
'AvailSettings' => [
'Esam' => [
'AcquisitionPointId' => '<string>',
'AdAvailOffset' => <integer>,
'PasswordParam' => '<string>',
'PoisEndpoint' => '<string>',
'Username' => '<string>',
'ZoneIdentity' => '<string>',
],
'Scte35SpliceInsert' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
'Scte35TimeSignalApos' => [
'AdAvailOffset' => <integer>,
'NoRegionalBlackoutFlag' => 'FOLLOW|IGNORE',
'WebDeliveryAllowedFlag' => 'FOLLOW|IGNORE',
],
],
'Scte35SegmentationScope' => 'ALL_OUTPUT_GROUPS|SCTE35_ENABLED_OUTPUT_GROUPS',
],
'BlackoutSlate' => [
'BlackoutSlateImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkEndBlackout' => 'DISABLED|ENABLED',
'NetworkEndBlackoutImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'NetworkId' => '<string>',
'State' => 'DISABLED|ENABLED',
],
'CaptionDescriptions' => [
[
'Accessibility' => 'DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES|IMPLEMENTS_ACCESSIBILITY_FEATURES',
'CaptionDashRoles' => ['<string>', ...],
'CaptionSelectorName' => '<string>',
'DestinationSettings' => [
'AribDestinationSettings' => [
],
'BurnInDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'DvbSubDestinationSettings' => [
'Alignment' => 'CENTERED|LEFT|SMART',
'BackgroundColor' => 'BLACK|NONE|WHITE',
'BackgroundOpacity' => <integer>,
'Font' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'FontColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'FontOpacity' => <integer>,
'FontResolution' => <integer>,
'FontSize' => '<string>',
'OutlineColor' => 'BLACK|BLUE|GREEN|RED|WHITE|YELLOW',
'OutlineSize' => <integer>,
'ShadowColor' => 'BLACK|NONE|WHITE',
'ShadowOpacity' => <integer>,
'ShadowXOffset' => <integer>,
'ShadowYOffset' => <integer>,
'TeletextGridControl' => 'FIXED|SCALED',
'XPosition' => <integer>,
'YPosition' => <integer>,
],
'EbuTtDDestinationSettings' => [
'CopyrightHolder' => '<string>',
'FillLineGap' => 'DISABLED|ENABLED',
'FontFamily' => '<string>',
'StyleControl' => 'EXCLUDE|INCLUDE',
],
'EmbeddedDestinationSettings' => [
],
'EmbeddedPlusScte20DestinationSettings' => [
],
'RtmpCaptionInfoDestinationSettings' => [
],
'Scte20PlusEmbeddedDestinationSettings' => [
],
'Scte27DestinationSettings' => [
],
'SmpteTtDestinationSettings' => [
],
'TeletextDestinationSettings' => [
],
'TtmlDestinationSettings' => [
'StyleControl' => 'PASSTHROUGH|USE_CONFIGURED',
],
'WebvttDestinationSettings' => [
'StyleControl' => 'NO_STYLE_DATA|PASSTHROUGH',
],
],
'DvbDashAccessibility' => 'DVBDASH_1_VISUALLY_IMPAIRED|DVBDASH_2_HARD_OF_HEARING|DVBDASH_3_SUPPLEMENTAL_COMMENTARY|DVBDASH_4_DIRECTORS_COMMENTARY|DVBDASH_5_EDUCATIONAL_NOTES|DVBDASH_6_MAIN_PROGRAM|DVBDASH_7_CLEAN_FEED',
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
'Name' => '<string>',
],
// ...
],
'ColorCorrectionSettings' => [
'GlobalColorCorrections' => [
[
'InputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'OutputColorSpace' => 'HDR10|HLG_2020|REC_601|REC_709',
'Uri' => '<string>',
],
// ...
],
],
'FeatureActivations' => [
'InputPrepareScheduleActions' => 'DISABLED|ENABLED',
'OutputStaticImageOverlayScheduleActions' => 'DISABLED|ENABLED',
],
'GlobalConfiguration' => [
'InitialAudioGain' => <integer>,
'InputEndAction' => 'NONE|SWITCH_AND_LOOP_INPUTS',
'InputLossBehavior' => [
'BlackFrameMsec' => <integer>,
'InputLossImageColor' => '<string>',
'InputLossImageSlate' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'InputLossImageType' => 'COLOR|SLATE',
'RepeatFrameMsec' => <integer>,
],
'OutputLockingMode' => 'EPOCH_LOCKING|PIPELINE_LOCKING',
'OutputLockingSettings' => [
'EpochLockingSettings' => [
'CustomEpoch' => '<string>',
'JamSyncTime' => '<string>',
],
'PipelineLockingSettings' => [
],
],
'OutputTimingSource' => 'INPUT_CLOCK|SYSTEM_CLOCK',
'SupportLowFramerateInputs' => 'DISABLED|ENABLED',
],
'MotionGraphicsConfiguration' => [
'MotionGraphicsInsertion' => 'DISABLED|ENABLED',
'MotionGraphicsSettings' => [
'HtmlMotionGraphicsSettings' => [
],
],
],
'NielsenConfiguration' => [
'DistributorId' => '<string>',
'NielsenPcmToId3Tagging' => 'DISABLED|ENABLED',
],
'OutputGroups' => [
[
'Name' => '<string>',
'OutputGroupSettings' => [
'ArchiveGroupSettings' => [
'ArchiveCdnSettings' => [
'ArchiveS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'RolloverInterval' => <integer>,
],
'CmafIngestGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvNameModifier' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NielsenId3NameModifier' => '<string>',
'Scte35NameModifier' => '<string>',
'Scte35Type' => 'NONE|SCTE_35_WITHOUT_SEGMENTATION',
'SegmentLength' => <integer>,
'SegmentLengthUnits' => 'MILLISECONDS|SECONDS',
'SendDelayMs' => <integer>,
],
'FrameCaptureGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
'FrameCaptureCdnSettings' => [
'FrameCaptureS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
],
],
'HlsGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'BaseUrlContent' => '<string>',
'BaseUrlContent1' => '<string>',
'BaseUrlManifest' => '<string>',
'BaseUrlManifest1' => '<string>',
'CaptionLanguageMappings' => [
[
'CaptionChannel' => <integer>,
'LanguageCode' => '<string>',
'LanguageDescription' => '<string>',
],
// ...
],
'CaptionLanguageSetting' => 'INSERT|NONE|OMIT',
'ClientCache' => 'DISABLED|ENABLED',
'CodecSpecification' => 'RFC_4281|RFC_6381',
'ConstantIv' => '<string>',
'Destination' => [
'DestinationRefId' => '<string>',
],
'DirectoryStructure' => 'SINGLE_DIRECTORY|SUBDIRECTORY_PER_STREAM',
'DiscontinuityTags' => 'INSERT|NEVER_INSERT',
'EncryptionType' => 'AES128|SAMPLE_AES',
'HlsCdnSettings' => [
'HlsAkamaiSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'Salt' => '<string>',
'Token' => '<string>',
],
'HlsBasicPutSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsMediaStoreSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'MediaStoreStorageClass' => 'TEMPORAL',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
'HlsS3Settings' => [
'CannedAcl' => 'AUTHENTICATED_READ|BUCKET_OWNER_FULL_CONTROL|BUCKET_OWNER_READ|PUBLIC_READ',
],
'HlsWebdavSettings' => [
'ConnectionRetryInterval' => <integer>,
'FilecacheDuration' => <integer>,
'HttpTransferMode' => 'CHUNKED|NON_CHUNKED',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
],
],
'HlsId3SegmentTagging' => 'DISABLED|ENABLED',
'IFrameOnlyPlaylists' => 'DISABLED|STANDARD',
'IncompleteSegmentBehavior' => 'AUTO|SUPPRESS',
'IndexNSegments' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'IvInManifest' => 'EXCLUDE|INCLUDE',
'IvSource' => 'EXPLICIT|FOLLOWS_SEGMENT_NUMBER',
'KeepSegments' => <integer>,
'KeyFormat' => '<string>',
'KeyFormatVersions' => '<string>',
'KeyProviderSettings' => [
'StaticKeySettings' => [
'KeyProviderServer' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'StaticKeyValue' => '<string>',
],
],
'ManifestCompression' => 'GZIP|NONE',
'ManifestDurationFormat' => 'FLOATING_POINT|INTEGER',
'MinSegmentLength' => <integer>,
'Mode' => 'LIVE|VOD',
'OutputSelection' => 'MANIFESTS_AND_SEGMENTS|SEGMENTS_ONLY|VARIANT_MANIFESTS_AND_SEGMENTS',
'ProgramDateTime' => 'EXCLUDE|INCLUDE',
'ProgramDateTimeClock' => 'INITIALIZE_FROM_OUTPUT_TIMECODE|SYSTEM_CLOCK',
'ProgramDateTimePeriod' => <integer>,
'RedundantManifest' => 'DISABLED|ENABLED',
'SegmentLength' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SegmentsPerSubdirectory' => <integer>,
'StreamInfResolution' => 'EXCLUDE|INCLUDE',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
'TimestampDeltaMilliseconds' => <integer>,
'TsFileMode' => 'SEGMENTED_FILES|SINGLE_FILE',
],
'MediaPackageGroupSettings' => [
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'MsSmoothGroupSettings' => [
'AcquisitionPointId' => '<string>',
'AudioOnlyTimecodeControl' => 'PASSTHROUGH|USE_CONFIGURED_CLOCK',
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'EventId' => '<string>',
'EventIdMode' => 'NO_EVENT_ID|USE_CONFIGURED|USE_TIMESTAMP',
'EventStopBehavior' => 'NONE|SEND_EOS',
'FilecacheDuration' => <integer>,
'FragmentLength' => <integer>,
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'NumRetries' => <integer>,
'RestartDelay' => <integer>,
'SegmentationMode' => 'USE_INPUT_SEGMENTATION|USE_SEGMENT_DURATION',
'SendDelayMs' => <integer>,
'SparseTrackType' => 'NONE|SCTE_35|SCTE_35_WITHOUT_SEGMENTATION',
'StreamManifestBehavior' => 'DO_NOT_SEND|SEND',
'TimestampOffset' => '<string>',
'TimestampOffsetMode' => 'USE_CONFIGURED_OFFSET|USE_EVENT_START_DATE',
],
'MultiplexGroupSettings' => [
],
'RtmpGroupSettings' => [
'AdMarkers' => ['<string>', ...],
'AuthenticationScheme' => 'AKAMAI|COMMON',
'CacheFullBehavior' => 'DISCONNECT_IMMEDIATELY|WAIT_FOR_SERVER',
'CacheLength' => <integer>,
'CaptionData' => 'ALL|FIELD1_608|FIELD1_AND_FIELD2_608',
'IncludeFillerNalUnits' => 'AUTO|DROP|INCLUDE',
'InputLossAction' => 'EMIT_OUTPUT|PAUSE_OUTPUT',
'RestartDelay' => <integer>,
],
'SrtGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
],
'UdpGroupSettings' => [
'InputLossAction' => 'DROP_PROGRAM|DROP_TS|EMIT_PROGRAM',
'TimedMetadataId3Frame' => 'NONE|PRIV|TDRL',
'TimedMetadataId3Period' => <integer>,
],
],
'Outputs' => [
[
'AudioDescriptionNames' => ['<string>', ...],
'CaptionDescriptionNames' => ['<string>', ...],
'OutputName' => '<string>',
'OutputSettings' => [
'ArchiveOutputSettings' => [
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
'RawSettings' => [
],
],
'Extension' => '<string>',
'NameModifier' => '<string>',
],
'CmafIngestOutputSettings' => [
'NameModifier' => '<string>',
],
'FrameCaptureOutputSettings' => [
'NameModifier' => '<string>',
],
'HlsOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'HlsSettings' => [
'AudioOnlyHlsSettings' => [
'AudioGroupId' => '<string>',
'AudioOnlyImage' => [
'PasswordParam' => '<string>',
'Uri' => '<string>',
'Username' => '<string>',
],
'AudioTrackType' => 'ALTERNATE_AUDIO_AUTO_SELECT|ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT|ALTERNATE_AUDIO_NOT_AUTO_SELECT|AUDIO_ONLY_VARIANT_STREAM',
'SegmentType' => 'AAC|FMP4',
],
'Fmp4HlsSettings' => [
'AudioRenditionSets' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
],
'FrameCaptureHlsSettings' => [
],
'StandardHlsSettings' => [
'AudioRenditionSets' => '<string>',
'M3u8Settings' => [
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'EcmPid' => '<string>',
'KlvBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'Scte35Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'Scte35Pid' => '<string>',
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
],
'NameModifier' => '<string>',
'SegmentModifier' => '<string>',
],
'MediaPackageOutputSettings' => [
],
'MsSmoothOutputSettings' => [
'H265PackagingType' => 'HEV1|HVC1',
'NameModifier' => '<string>',
],
'MultiplexOutputSettings' => [
'ContainerSettings' => [
'MultiplexM2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioStreamType' => 'ATSC|DVB',
'CcDescriptor' => 'DISABLED|ENABLED',
'Ebif' => 'NONE|PASSTHROUGH',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'Klv' => 'NONE|PASSTHROUGH',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35PrerollPullupMilliseconds' => <float>,
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
],
'RtmpOutputSettings' => [
'CertificateMode' => 'SELF_SIGNED|VERIFY_AUTHENTICITY',
'ConnectionRetryInterval' => <integer>,
'Destination' => [
'DestinationRefId' => '<string>',
],
'NumRetries' => <integer>,
],
'SrtOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'EncryptionType' => 'AES128|AES192|AES256',
'Latency' => <integer>,
],
'UdpOutputSettings' => [
'BufferMsec' => <integer>,
'ContainerSettings' => [
'M2tsSettings' => [
'AbsentInputAudioBehavior' => 'DROP|ENCODE_SILENCE',
'Arib' => 'DISABLED|ENABLED',
'AribCaptionsPid' => '<string>',
'AribCaptionsPidControl' => 'AUTO|USE_CONFIGURED',
'AudioBufferModel' => 'ATSC|DVB',
'AudioFramesPerPes' => <integer>,
'AudioPids' => '<string>',
'AudioStreamType' => 'ATSC|DVB',
'Bitrate' => <integer>,
'BufferModel' => 'MULTIPLEX|NONE',
'CcDescriptor' => 'DISABLED|ENABLED',
'DvbNitSettings' => [
'NetworkId' => <integer>,
'NetworkName' => '<string>',
'RepInterval' => <integer>,
],
'DvbSdtSettings' => [
'OutputSdt' => 'SDT_FOLLOW|SDT_FOLLOW_IF_PRESENT|SDT_MANUAL|SDT_NONE',
'RepInterval' => <integer>,
'ServiceName' => '<string>',
'ServiceProviderName' => '<string>',
],
'DvbSubPids' => '<string>',
'DvbTdtSettings' => [
'RepInterval' => <integer>,
],
'DvbTeletextPid' => '<string>',
'Ebif' => 'NONE|PASSTHROUGH',
'EbpAudioInterval' => 'VIDEO_AND_FIXED_INTERVALS|VIDEO_INTERVAL',
'EbpLookaheadMs' => <integer>,
'EbpPlacement' => 'VIDEO_AND_AUDIO_PIDS|VIDEO_PID',
'EcmPid' => '<string>',
'EsRateInPes' => 'EXCLUDE|INCLUDE',
'EtvPlatformPid' => '<string>',
'EtvSignalPid' => '<string>',
'FragmentTime' => <float>,
'Klv' => 'NONE|PASSTHROUGH',
'KlvDataPids' => '<string>',
'NielsenId3Behavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'NullPacketBitrate' => <float>,
'PatInterval' => <integer>,
'PcrControl' => 'CONFIGURED_PCR_PERIOD|PCR_EVERY_PES_PACKET',
'PcrPeriod' => <integer>,
'PcrPid' => '<string>',
'PmtInterval' => <integer>,
'PmtPid' => '<string>',
'ProgramNum' => <integer>,
'RateMode' => 'CBR|VBR',
'Scte27Pids' => '<string>',
'Scte35Control' => 'NONE|PASSTHROUGH',
'Scte35Pid' => '<string>',
'Scte35PrerollPullupMilliseconds' => <float>,
'SegmentationMarkers' => 'EBP|EBP_LEGACY|NONE|PSI_SEGSTART|RAI_ADAPT|RAI_SEGSTART',
'SegmentationStyle' => 'MAINTAIN_CADENCE|RESET_CADENCE',
'SegmentationTime' => <float>,
'TimedMetadataBehavior' => 'NO_PASSTHROUGH|PASSTHROUGH',
'TimedMetadataPid' => '<string>',
'TransportStreamId' => <integer>,
'VideoPid' => '<string>',
],
],
'Destination' => [
'DestinationRefId' => '<string>',
],
'FecOutputSettings' => [
'ColumnDepth' => <integer>,
'IncludeFec' => 'COLUMN|COLUMN_AND_ROW',
'RowLength' => <integer>,
],
],
],
'VideoDescriptionName' => '<string>',
],
// ...
],
],
// ...
],
'ThumbnailConfiguration' => [
'State' => 'AUTO|DISABLED',
],
'TimecodeConfig' => [
'Source' => 'EMBEDDED|SYSTEMCLOCK|ZEROBASED',
'SyncThreshold' => <integer>,
],
'VideoDescriptions' => [
[
'CodecSettings' => [
'Av1Settings' => [
'AfdSignaling' => 'AUTO|FIXED|NONE',
'BufSize' => <integer>,
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'AV1_LEVEL_2|AV1_LEVEL_2_1|AV1_LEVEL_3|AV1_LEVEL_3_1|AV1_LEVEL_4|AV1_LEVEL_4_1|AV1_LEVEL_5|AV1_LEVEL_5_1|AV1_LEVEL_5_2|AV1_LEVEL_5_3|AV1_LEVEL_6|AV1_LEVEL_6_1|AV1_LEVEL_6_2|AV1_LEVEL_6_3|AV1_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'QvbrQualityLevel' => <integer>,
'SceneChangeDetect' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'FrameCaptureSettings' => [
'CaptureInterval' => <integer>,
'CaptureIntervalUnits' => 'MILLISECONDS|SECONDS',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
],
'H264Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'Bitrate' => <integer>,
'BufFillPct' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'EntropyEncoding' => 'CABAC|CAVLC',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'ForceFieldPictures' => 'DISABLED|ENABLED',
'FramerateControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopBReference' => 'DISABLED|ENABLED',
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H264_LEVEL_1|H264_LEVEL_1_1|H264_LEVEL_1_2|H264_LEVEL_1_3|H264_LEVEL_2|H264_LEVEL_2_1|H264_LEVEL_2_2|H264_LEVEL_3|H264_LEVEL_3_1|H264_LEVEL_3_2|H264_LEVEL_4|H264_LEVEL_4_1|H264_LEVEL_4_2|H264_LEVEL_5|H264_LEVEL_5_1|H264_LEVEL_5_2|H264_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'NumRefFrames' => <integer>,
'ParControl' => 'INITIALIZE_FROM_SOURCE|SPECIFIED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'BASELINE|HIGH|HIGH_10BIT|HIGH_422|HIGH_422_10BIT|MAIN',
'QualityLevel' => 'ENHANCED_QUALITY|STANDARD_QUALITY',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR|VBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Softness' => <integer>,
'SpatialAq' => 'DISABLED|ENABLED',
'SubgopLength' => 'DYNAMIC|FIXED',
'Syntax' => 'DEFAULT|RP2027',
'TemporalAq' => 'DISABLED|ENABLED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
],
'H265Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|HIGHER|LOW|MAX|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'AlternativeTransferFunction' => 'INSERT|OMIT',
'Bitrate' => <integer>,
'BufSize' => <integer>,
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpaceSettings' => [
'ColorSpacePassthroughSettings' => [
],
'DolbyVision81Settings' => [
],
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
'Rec601Settings' => [
],
'Rec709Settings' => [
],
],
'Deblocking' => 'DISABLED|ENABLED',
'FilterSettings' => [
'BandwidthReductionFilterSettings' => [
'PostFilterSharpening' => 'DISABLED|SHARPENING_1|SHARPENING_2|SHARPENING_3',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4',
],
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FlickerAq' => 'DISABLED|ENABLED',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'Level' => 'H265_LEVEL_1|H265_LEVEL_2|H265_LEVEL_2_1|H265_LEVEL_3|H265_LEVEL_3_1|H265_LEVEL_4|H265_LEVEL_4_1|H265_LEVEL_5|H265_LEVEL_5_1|H265_LEVEL_5_2|H265_LEVEL_6|H265_LEVEL_6_1|H265_LEVEL_6_2|H265_LEVEL_AUTO',
'LookAheadRateControl' => 'HIGH|LOW|MEDIUM',
'MaxBitrate' => <integer>,
'MinIInterval' => <integer>,
'MinQp' => <integer>,
'MvOverPictureBoundaries' => 'DISABLED|ENABLED',
'MvTemporalPredictor' => 'DISABLED|ENABLED',
'ParDenominator' => <integer>,
'ParNumerator' => <integer>,
'Profile' => 'MAIN|MAIN_10BIT',
'QvbrQualityLevel' => <integer>,
'RateControlMode' => 'CBR|MULTIPLEX|QVBR',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SceneChangeDetect' => 'DISABLED|ENABLED',
'Slices' => <integer>,
'Tier' => 'HIGH|MAIN',
'TileHeight' => <integer>,
'TilePadding' => 'NONE|PADDED',
'TileWidth' => <integer>,
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|PIC_TIMING_SEI',
'TreeblockSize' => 'AUTO|TREE_SIZE_32X32',
],
'Mpeg2Settings' => [
'AdaptiveQuantization' => 'AUTO|HIGH|LOW|MEDIUM|OFF',
'AfdSignaling' => 'AUTO|FIXED|NONE',
'ColorMetadata' => 'IGNORE|INSERT',
'ColorSpace' => 'AUTO|PASSTHROUGH',
'DisplayAspectRatio' => 'DISPLAYRATIO16X9|DISPLAYRATIO4X3',
'FilterSettings' => [
'TemporalFilterSettings' => [
'PostFilterSharpening' => 'AUTO|DISABLED|ENABLED',
'Strength' => 'AUTO|STRENGTH_1|STRENGTH_2|STRENGTH_3|STRENGTH_4|STRENGTH_5|STRENGTH_6|STRENGTH_7|STRENGTH_8|STRENGTH_9|STRENGTH_10|STRENGTH_11|STRENGTH_12|STRENGTH_13|STRENGTH_14|STRENGTH_15|STRENGTH_16',
],
],
'FixedAfd' => 'AFD_0000|AFD_0010|AFD_0011|AFD_0100|AFD_1000|AFD_1001|AFD_1010|AFD_1011|AFD_1101|AFD_1110|AFD_1111',
'FramerateDenominator' => <integer>,
'FramerateNumerator' => <integer>,
'GopClosedCadence' => <integer>,
'GopNumBFrames' => <integer>,
'GopSize' => <float>,
'GopSizeUnits' => 'FRAMES|SECONDS',
'ScanType' => 'INTERLACED|PROGRESSIVE',
'SubgopLength' => 'DYNAMIC|FIXED',
'TimecodeBurninSettings' => [
'FontSize' => 'EXTRA_SMALL_10|LARGE_48|MEDIUM_32|SMALL_16',
'Position' => 'BOTTOM_CENTER|BOTTOM_LEFT|BOTTOM_RIGHT|MIDDLE_CENTER|MIDDLE_LEFT|MIDDLE_RIGHT|TOP_CENTER|TOP_LEFT|TOP_RIGHT',
'Prefix' => '<string>',
],
'TimecodeInsertion' => 'DISABLED|GOP_TIMECODE',
],
],
'Height' => <integer>,
'Name' => '<string>',
'RespondToAfd' => 'NONE|PASSTHROUGH|RESPOND',
'ScalingBehavior' => 'DEFAULT|STRETCH_TO_OUTPUT',
'Sharpness' => <integer>,
'Width' => <integer>,
],
// ...
],
],
'Id' => '<string>',
'InputAttachments' => [
[
'AutomaticInputFailoverSettings' => [
'ErrorClearTimeMsec' => <integer>,
'FailoverConditions' => [
[
'FailoverConditionSettings' => [
'AudioSilenceSettings' => [
'AudioSelectorName' => '<string>',
'AudioSilenceThresholdMsec' => <integer>,
],
'InputLossSettings' => [
'InputLossThresholdMsec' => <integer>,
],
'VideoBlackSettings' => [
'BlackDetectThreshold' => <float>,
'VideoBlackThresholdMsec' => <integer>,
],
],
],
// ...
],
'InputPreference' => 'EQUAL_INPUT_PREFERENCE|PRIMARY_INPUT_PREFERRED',
'SecondaryInputId' => '<string>',
],
'InputAttachmentName' => '<string>',
'InputId' => '<string>',
'InputSettings' => [
'AudioSelectors' => [
[
'Name' => '<string>',
'SelectorSettings' => [
'AudioHlsRenditionSelection' => [
'GroupId' => '<string>',
'Name' => '<string>',
],
'AudioLanguageSelection' => [
'LanguageCode' => '<string>',
'LanguageSelectionPolicy' => 'LOOSE|STRICT',
],
'AudioPidSelection' => [
'Pid' => <integer>,
],
'AudioTrackSelection' => [
'DolbyEDecode' => [
'ProgramSelection' => 'ALL_CHANNELS|PROGRAM_1|PROGRAM_2|PROGRAM_3|PROGRAM_4|PROGRAM_5|PROGRAM_6|PROGRAM_7|PROGRAM_8',
],
'Tracks' => [
[
'Track' => <integer>,
],
// ...
],
],
],
],
// ...
],
'CaptionSelectors' => [
[
'LanguageCode' => '<string>',
'Name' => '<string>',
'SelectorSettings' => [
'AncillarySourceSettings' => [
'SourceAncillaryChannelNumber' => <integer>,
],
'AribSourceSettings' => [
],
'DvbSubSourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'EmbeddedSourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Scte20Detection' => 'AUTO|OFF',
'Source608ChannelNumber' => <integer>,
'Source608TrackNumber' => <integer>,
],
'Scte20SourceSettings' => [
'Convert608To708' => 'DISABLED|UPCONVERT',
'Source608ChannelNumber' => <integer>,
],
'Scte27SourceSettings' => [
'OcrLanguage' => 'DEU|ENG|FRA|NLD|POR|SPA',
'Pid' => <integer>,
],
'TeletextSourceSettings' => [
'OutputRectangle' => [
'Height' => <float>,
'LeftOffset' => <float>,
'TopOffset' => <float>,
'Width' => <float>,
],
'PageNumber' => '<string>',
],
],
],
// ...
],
'DeblockFilter' => 'DISABLED|ENABLED',
'DenoiseFilter' => 'DISABLED|ENABLED',
'FilterStrength' => <integer>,
'InputFilter' => 'AUTO|DISABLED|FORCED',
'NetworkInputSettings' => [
'HlsInputSettings' => [
'Bandwidth' => <integer>,
'BufferSegments' => <integer>,
'Retries' => <integer>,
'RetryInterval' => <integer>,
'Scte35Source' => 'MANIFEST|SEGMENTS',
],
'MulticastInputSettings' => [
'SourceIpAddress' => '<string>',
],
'ServerValidation' => 'CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME|CHECK_CRYPTOGRAPHY_ONLY',
],
'Scte35Pid' => <integer>,
'Smpte2038DataPreference' => 'IGNORE|PREFER',
'SourceEndBehavior' => 'CONTINUE|LOOP',
'VideoSelector' => [
'ColorSpace' => 'FOLLOW|HDR10|HLG_2020|REC_601|REC_709',
'ColorSpaceSettings' => [
'Hdr10Settings' => [
'MaxCll' => <integer>,
'MaxFall' => <integer>,
],
],
'ColorSpaceUsage' => 'FALLBACK|FORCE',
'SelectorSettings' => [
'VideoSelectorPid' => [
'Pid' => <integer>,
],
'VideoSelectorProgramId' => [
'ProgramId' => <integer>,
],
],
],
],
'LogicalInterfaceNames' => ['<string>', ...],
],
// ...
],
'InputSpecification' => [
'Codec' => 'MPEG2|AVC|HEVC',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'Resolution' => 'SD|HD|UHD',
],
'LogLevel' => 'ERROR|WARNING|INFO|DEBUG|DISABLED',
'Maintenance' => [
'MaintenanceDay' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
'MaintenanceDeadline' => '<string>',
'MaintenanceScheduledDate' => '<string>',
'MaintenanceStartTime' => '<string>',
],
'Name' => '<string>',
'PipelineDetails' => [
[
'ActiveInputAttachmentName' => '<string>',
'ActiveInputSwitchActionName' => '<string>',
'ActiveMotionGraphicsActionName' => '<string>',
'ActiveMotionGraphicsUri' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'PipelinesRunningCount' => <integer>,
'RoleArn' => '<string>',
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED|UPDATING|UPDATE_FAILED',
'Tags' => ['<string>', ...],
'Vpc' => [
'AvailabilityZones' => ['<string>', ...],
'NetworkInterfaceIds' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
],
]
Result Details
Members
- Channel
-
- Type: Channel structure
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateChannelPlacementGroup
$result = $client->updateChannelPlacementGroup([/* ... */]); $promise = $client->updateChannelPlacementGroupAsync([/* ... */]);
Change the settings for a ChannelPlacementGroup.
Parameter Syntax
$result = $client->updateChannelPlacementGroup([
'ChannelPlacementGroupId' => '<string>', // REQUIRED
'ClusterId' => '<string>', // REQUIRED
'Name' => '<string>',
'Nodes' => ['<string>', ...],
]);
Parameter Details
Members
- ChannelPlacementGroupId
-
- Required: Yes
- Type: string
- ClusterId
-
- Required: Yes
- Type: string
- Name
-
- Type: string
Include this parameter only if you want to change the current name of the ChannelPlacementGroup. Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive. - Nodes
-
- Type: Array of strings
Include this parameter only if you want to change the list of Nodes that are associated with the ChannelPlacementGroup.
Result Syntax
[
'Arn' => '<string>',
'Channels' => ['<string>', ...],
'ClusterId' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Nodes' => ['<string>', ...],
'State' => 'UNASSIGNED|ASSIGNING|ASSIGNED|DELETING|DELETE_FAILED|DELETED|UNASSIGNING',
]
Result Details
Members
- Arn
-
- Type: string
- Channels
-
- Type: Array of strings
- ClusterId
-
- Type: string
- Id
-
- Type: string
- Name
-
- Type: string
- Nodes
-
- Type: Array of strings
- State
-
- Type: string
Used in DescribeChannelPlacementGroupResult
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateCloudWatchAlarmTemplate
$result = $client->updateCloudWatchAlarmTemplate([/* ... */]); $promise = $client->updateCloudWatchAlarmTemplateAsync([/* ... */]);
Updates the specified cloudwatch alarm template.
Parameter Syntax
$result = $client->updateCloudWatchAlarmTemplate([
'ComparisonOperator' => 'GreaterThanOrEqualToThreshold|GreaterThanThreshold|LessThanThreshold|LessThanOrEqualToThreshold',
'DatapointsToAlarm' => <integer>,
'Description' => '<string>',
'EvaluationPeriods' => <integer>,
'GroupIdentifier' => '<string>',
'Identifier' => '<string>', // REQUIRED
'MetricName' => '<string>',
'Name' => '<string>',
'Period' => <integer>,
'Statistic' => 'SampleCount|Average|Sum|Minimum|Maximum',
'TargetResourceType' => 'CLOUDFRONT_DISTRIBUTION|MEDIALIVE_MULTIPLEX|MEDIALIVE_CHANNEL|MEDIALIVE_INPUT_DEVICE|MEDIAPACKAGE_CHANNEL|MEDIAPACKAGE_ORIGIN_ENDPOINT|MEDIACONNECT_FLOW|S3_BUCKET',
'Threshold' => <float>,
'TreatMissingData' => 'notBreaching|breaching|ignore|missing',
]);
Parameter Details
Members
- ComparisonOperator
-
- Type: string
The comparison operator used to compare the specified statistic and the threshold. - DatapointsToAlarm
-
- Type: int
- Description
-
- Type: string
- EvaluationPeriods
-
- Type: int
- GroupIdentifier
-
- Type: string
- Identifier
-
- Required: Yes
- Type: string
- MetricName
-
- Type: string
- Name
-
- Type: string
- Period
-
- Type: int
- Statistic
-
- Type: string
The statistic to apply to the alarm's metric data. - TargetResourceType
-
- Type: string
The resource type this template should dynamically generate cloudwatch metric alarms for. - Threshold
-
- Type: double
- TreatMissingData
-
- Type: string
Specifies how missing data points are treated when evaluating the alarm's condition.
Result Syntax
[
'Arn' => '<string>',
'ComparisonOperator' => 'GreaterThanOrEqualToThreshold|GreaterThanThreshold|LessThanThreshold|LessThanOrEqualToThreshold',
'CreatedAt' => <DateTime>,
'DatapointsToAlarm' => <integer>,
'Description' => '<string>',
'EvaluationPeriods' => <integer>,
'GroupId' => '<string>',
'Id' => '<string>',
'MetricName' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Period' => <integer>,
'Statistic' => 'SampleCount|Average|Sum|Minimum|Maximum',
'Tags' => ['<string>', ...],
'TargetResourceType' => 'CLOUDFRONT_DISTRIBUTION|MEDIALIVE_MULTIPLEX|MEDIALIVE_CHANNEL|MEDIALIVE_INPUT_DEVICE|MEDIAPACKAGE_CHANNEL|MEDIAPACKAGE_ORIGIN_ENDPOINT|MEDIACONNECT_FLOW|S3_BUCKET',
'Threshold' => <float>,
'TreatMissingData' => 'notBreaching|breaching|ignore|missing',
]
Result Details
Members
- Arn
-
- Type: string
- ComparisonOperator
-
- Type: string
The comparison operator used to compare the specified statistic and the threshold. - CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DatapointsToAlarm
-
- Type: int
- Description
-
- Type: string
- EvaluationPeriods
-
- Type: int
- GroupId
-
- Type: string
- Id
-
- Type: string
- MetricName
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Period
-
- Type: int
- Statistic
-
- Type: string
The statistic to apply to the alarm's metric data. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource. - TargetResourceType
-
- Type: string
The resource type this template should dynamically generate cloudwatch metric alarms for. - Threshold
-
- Type: double
- TreatMissingData
-
- Type: string
Specifies how missing data points are treated when evaluating the alarm's condition.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateCloudWatchAlarmTemplateGroup
$result = $client->updateCloudWatchAlarmTemplateGroup([/* ... */]); $promise = $client->updateCloudWatchAlarmTemplateGroupAsync([/* ... */]);
Updates the specified cloudwatch alarm template group.
Parameter Syntax
$result = $client->updateCloudWatchAlarmTemplateGroup([
'Description' => '<string>',
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Description
-
- Type: string
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- Id
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateCluster
$result = $client->updateCluster([/* ... */]); $promise = $client->updateClusterAsync([/* ... */]);
Change the settings for a Cluster.
Parameter Syntax
$result = $client->updateCluster([
'ClusterId' => '<string>', // REQUIRED
'Name' => '<string>',
'NetworkSettings' => [
'DefaultRoute' => '<string>',
'InterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkId' => '<string>',
],
// ...
],
],
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
- Name
-
- Type: string
Include this parameter only if you want to change the current name of the Cluster. Specify a name that is unique in the AWS account. You can't change the name. Names are case-sensitive. - NetworkSettings
-
- Type: ClusterNetworkSettingsUpdateRequest structure
Include this property only if you want to change the current connections between the Nodes in the Cluster and the Networks the Cluster is associated with.
Result Syntax
[
'Arn' => '<string>',
'ChannelIds' => ['<string>', ...],
'ClusterType' => 'ON_PREMISES',
'Id' => '<string>',
'Name' => '<string>',
'NetworkSettings' => [
'DefaultRoute' => '<string>',
'InterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkId' => '<string>',
],
// ...
],
],
'State' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|DELETE_FAILED|DELETED',
]
Result Details
Members
- Arn
-
- Type: string
- ChannelIds
-
- Type: Array of strings
- ClusterType
-
- Type: string
Used in CreateClusterSummary, DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult. - Id
-
- Type: string
- Name
-
- Type: string
- NetworkSettings
-
- Type: ClusterNetworkSettings structure
Used in DescribeClusterResult, DescribeClusterSummary, UpdateClusterResult. - State
-
- Type: string
Used in DescribeClusterSummary, DescribeClusterResult, UpdateClusterResult.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateEventBridgeRuleTemplate
$result = $client->updateEventBridgeRuleTemplate([/* ... */]); $promise = $client->updateEventBridgeRuleTemplateAsync([/* ... */]);
Updates the specified eventbridge rule template.
Parameter Syntax
$result = $client->updateEventBridgeRuleTemplate([
'Description' => '<string>',
'EventTargets' => [
[
'Arn' => '<string>', // REQUIRED
],
// ...
],
'EventType' => 'MEDIALIVE_MULTIPLEX_ALERT|MEDIALIVE_MULTIPLEX_STATE_CHANGE|MEDIALIVE_CHANNEL_ALERT|MEDIALIVE_CHANNEL_INPUT_CHANGE|MEDIALIVE_CHANNEL_STATE_CHANGE|MEDIAPACKAGE_INPUT_NOTIFICATION|MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION|MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION|SIGNAL_MAP_ACTIVE_ALARM|MEDIACONNECT_ALERT|MEDIACONNECT_SOURCE_HEALTH|MEDIACONNECT_OUTPUT_HEALTH|MEDIACONNECT_FLOW_STATUS_CHANGE',
'GroupIdentifier' => '<string>',
'Identifier' => '<string>', // REQUIRED
'Name' => '<string>',
]);
Parameter Details
Members
- Description
-
- Type: string
- EventTargets
-
- Type: Array of EventBridgeRuleTemplateTarget structures
- EventType
-
- Type: string
The type of event to match with the rule. - GroupIdentifier
-
- Type: string
- Identifier
-
- Required: Yes
- Type: string
- Name
-
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'EventTargets' => [
[
'Arn' => '<string>',
],
// ...
],
'EventType' => 'MEDIALIVE_MULTIPLEX_ALERT|MEDIALIVE_MULTIPLEX_STATE_CHANGE|MEDIALIVE_CHANNEL_ALERT|MEDIALIVE_CHANNEL_INPUT_CHANGE|MEDIALIVE_CHANNEL_STATE_CHANGE|MEDIAPACKAGE_INPUT_NOTIFICATION|MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION|MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION|SIGNAL_MAP_ACTIVE_ALARM|MEDIACONNECT_ALERT|MEDIACONNECT_SOURCE_HEALTH|MEDIACONNECT_OUTPUT_HEALTH|MEDIACONNECT_FLOW_STATUS_CHANGE',
'GroupId' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- EventTargets
-
- Type: Array of EventBridgeRuleTemplateTarget structures
- EventType
-
- Type: string
The type of event to match with the rule. - GroupId
-
- Type: string
- Id
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateEventBridgeRuleTemplateGroup
$result = $client->updateEventBridgeRuleTemplateGroup([/* ... */]); $promise = $client->updateEventBridgeRuleTemplateGroupAsync([/* ... */]);
Updates the specified eventbridge rule template group.
Parameter Syntax
$result = $client->updateEventBridgeRuleTemplateGroup([
'Description' => '<string>',
'Identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Description
-
- Type: string
- Identifier
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'ModifiedAt' => <DateTime>,
'Name' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
- Id
-
- Type: string
- ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateInput
$result = $client->updateInput([/* ... */]); $promise = $client->updateInputAsync([/* ... */]);
Updates an input.
Parameter Syntax
$result = $client->updateInput([
'Destinations' => [
[
'Network' => '<string>',
'NetworkRoutes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'StaticIpAddress' => '<string>',
'StreamName' => '<string>',
],
// ...
],
'InputDevices' => [
[
'Id' => '<string>',
],
// ...
],
'InputId' => '<string>', // REQUIRED
'InputSecurityGroups' => ['<string>', ...],
'MediaConnectFlows' => [
[
'FlowArn' => '<string>',
],
// ...
],
'MulticastSettings' => [
'Sources' => [
[
'SourceIp' => '<string>',
'Url' => '<string>', // REQUIRED
],
// ...
],
],
'Name' => '<string>',
'RoleArn' => '<string>',
'Sources' => [
[
'PasswordParam' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
'SrtCallerSources' => [
[
'Decryption' => [
'Algorithm' => 'AES128|AES192|AES256',
'PassphraseSecretArn' => '<string>',
],
'MinimumLatency' => <integer>,
'SrtListenerAddress' => '<string>',
'SrtListenerPort' => '<string>',
'StreamId' => '<string>',
],
// ...
],
],
]);
Parameter Details
Members
- Destinations
-
- Type: Array of InputDestinationRequest structures
- InputDevices
-
- Type: Array of InputDeviceRequest structures
- InputId
-
- Required: Yes
- Type: string
- InputSecurityGroups
-
- Type: Array of strings
- MediaConnectFlows
-
- Type: Array of MediaConnectFlowRequest structures
- MulticastSettings
-
- Type: MulticastSettingsUpdateRequest structure
Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses. - Name
-
- Type: string
- RoleArn
-
- Type: string
- Sources
-
- Type: Array of InputSourceRequest structures
- SrtSettings
-
- Type: SrtSettingsRequest structure
Configures the sources for this SRT input. For a single-pipeline input, include one srtCallerSource in the array. For a standard-pipeline input, include two srtCallerSource.
Result Syntax
[
'Input' => [
'Arn' => '<string>',
'AttachedChannels' => ['<string>', ...],
'Destinations' => [
[
'Ip' => '<string>',
'Network' => '<string>',
'NetworkRoutes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'Port' => '<string>',
'Url' => '<string>',
'Vpc' => [
'AvailabilityZone' => '<string>',
'NetworkInterfaceId' => '<string>',
],
],
// ...
],
'Id' => '<string>',
'InputClass' => 'STANDARD|SINGLE_PIPELINE',
'InputDevices' => [
[
'Id' => '<string>',
],
// ...
],
'InputNetworkLocation' => 'AWS|ON_PREMISES',
'InputPartnerIds' => ['<string>', ...],
'InputSourceType' => 'STATIC|DYNAMIC',
'MediaConnectFlows' => [
[
'FlowArn' => '<string>',
],
// ...
],
'MulticastSettings' => [
'Sources' => [
[
'SourceIp' => '<string>',
'Url' => '<string>',
],
// ...
],
],
'Name' => '<string>',
'RoleArn' => '<string>',
'SecurityGroups' => ['<string>', ...],
'Sources' => [
[
'PasswordParam' => '<string>',
'Url' => '<string>',
'Username' => '<string>',
],
// ...
],
'SrtSettings' => [
'SrtCallerSources' => [
[
'Decryption' => [
'Algorithm' => 'AES128|AES192|AES256',
'PassphraseSecretArn' => '<string>',
],
'MinimumLatency' => <integer>,
'SrtListenerAddress' => '<string>',
'SrtListenerPort' => '<string>',
'StreamId' => '<string>',
],
// ...
],
],
'State' => 'CREATING|DETACHED|ATTACHED|DELETING|DELETED',
'Tags' => ['<string>', ...],
'Type' => 'UDP_PUSH|RTP_PUSH|RTMP_PUSH|RTMP_PULL|URL_PULL|MP4_FILE|MEDIACONNECT|INPUT_DEVICE|AWS_CDI|TS_FILE|SRT_CALLER|MULTICAST',
],
]
Result Details
Members
- Input
-
- Type: Input structure
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateInputDevice
$result = $client->updateInputDevice([/* ... */]); $promise = $client->updateInputDeviceAsync([/* ... */]);
Updates the parameters for the input device.
Parameter Syntax
$result = $client->updateInputDevice([
'AvailabilityZone' => '<string>',
'HdDeviceSettings' => [
'AudioChannelPairs' => [
[
'Id' => <integer>,
'Profile' => 'DISABLED|VBR-AAC_HHE-16000|VBR-AAC_HE-64000|VBR-AAC_LC-128000|CBR-AAC_HQ-192000|CBR-AAC_HQ-256000|CBR-AAC_HQ-384000|CBR-AAC_HQ-512000',
],
// ...
],
'Codec' => 'HEVC|AVC',
'ConfiguredInput' => 'AUTO|HDMI|SDI',
'LatencyMs' => <integer>,
'MaxBitrate' => <integer>,
'MediaconnectSettings' => [
'FlowArn' => '<string>',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
'SourceName' => '<string>',
],
],
'InputDeviceId' => '<string>', // REQUIRED
'Name' => '<string>',
'UhdDeviceSettings' => [
'AudioChannelPairs' => [
[
'Id' => <integer>,
'Profile' => 'DISABLED|VBR-AAC_HHE-16000|VBR-AAC_HE-64000|VBR-AAC_LC-128000|CBR-AAC_HQ-192000|CBR-AAC_HQ-256000|CBR-AAC_HQ-384000|CBR-AAC_HQ-512000',
],
// ...
],
'Codec' => 'HEVC|AVC',
'ConfiguredInput' => 'AUTO|HDMI|SDI',
'LatencyMs' => <integer>,
'MaxBitrate' => <integer>,
'MediaconnectSettings' => [
'FlowArn' => '<string>',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
'SourceName' => '<string>',
],
],
]);
Parameter Details
Members
- AvailabilityZone
-
- Type: string
- HdDeviceSettings
-
- Type: InputDeviceConfigurableSettings structure
Configurable settings for the input device. - InputDeviceId
-
- Required: Yes
- Type: string
- Name
-
- Type: string
- UhdDeviceSettings
-
- Type: InputDeviceConfigurableSettings structure
Configurable settings for the input device.
Result Syntax
[
'Arn' => '<string>',
'AvailabilityZone' => '<string>',
'ConnectionState' => 'DISCONNECTED|CONNECTED',
'DeviceSettingsSyncState' => 'SYNCED|SYNCING',
'DeviceUpdateStatus' => 'UP_TO_DATE|NOT_UP_TO_DATE|UPDATING',
'HdDeviceSettings' => [
'ActiveInput' => 'HDMI|SDI',
'ConfiguredInput' => 'AUTO|HDMI|SDI',
'DeviceState' => 'IDLE|STREAMING',
'Framerate' => <float>,
'Height' => <integer>,
'LatencyMs' => <integer>,
'MaxBitrate' => <integer>,
'ScanType' => 'INTERLACED|PROGRESSIVE',
'Width' => <integer>,
],
'Id' => '<string>',
'MacAddress' => '<string>',
'MedialiveInputArns' => ['<string>', ...],
'Name' => '<string>',
'NetworkSettings' => [
'DnsAddresses' => ['<string>', ...],
'Gateway' => '<string>',
'IpAddress' => '<string>',
'IpScheme' => 'STATIC|DHCP',
'SubnetMask' => '<string>',
],
'OutputType' => 'NONE|MEDIALIVE_INPUT|MEDIACONNECT_FLOW',
'SerialNumber' => '<string>',
'Tags' => ['<string>', ...],
'Type' => 'HD|UHD',
'UhdDeviceSettings' => [
'ActiveInput' => 'HDMI|SDI',
'AudioChannelPairs' => [
[
'Id' => <integer>,
'Profile' => 'DISABLED|VBR-AAC_HHE-16000|VBR-AAC_HE-64000|VBR-AAC_LC-128000|CBR-AAC_HQ-192000|CBR-AAC_HQ-256000|CBR-AAC_HQ-384000|CBR-AAC_HQ-512000',
],
// ...
],
'Codec' => 'HEVC|AVC',
'ConfiguredInput' => 'AUTO|HDMI|SDI',
'DeviceState' => 'IDLE|STREAMING',
'Framerate' => <float>,
'Height' => <integer>,
'LatencyMs' => <integer>,
'MaxBitrate' => <integer>,
'MediaconnectSettings' => [
'FlowArn' => '<string>',
'RoleArn' => '<string>',
'SecretArn' => '<string>',
'SourceName' => '<string>',
],
'ScanType' => 'INTERLACED|PROGRESSIVE',
'Width' => <integer>,
],
]
Result Details
Members
- Arn
-
- Type: string
- AvailabilityZone
-
- Type: string
- ConnectionState
-
- Type: string
The state of the connection between the input device and AWS. - DeviceSettingsSyncState
-
- Type: string
The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration. - DeviceUpdateStatus
-
- Type: string
The status of software on the input device. - HdDeviceSettings
-
- Type: InputDeviceHdSettings structure
Settings that describe the active source from the input device, and the video characteristics of that source. - Id
-
- Type: string
- MacAddress
-
- Type: string
- MedialiveInputArns
-
- Type: Array of strings
- Name
-
- Type: string
- NetworkSettings
-
- Type: InputDeviceNetworkSettings structure
The network settings for the input device. - OutputType
-
- Type: string
The output attachment type of the input device. - SerialNumber
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Type
-
- Type: string
The type of the input device. For an AWS Elemental Link device that outputs resolutions up to 1080, choose "HD". - UhdDeviceSettings
-
- Type: InputDeviceUhdSettings structure
Settings that describe the active source from the input device, and the video characteristics of that source.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
UpdateInputSecurityGroup
$result = $client->updateInputSecurityGroup([/* ... */]); $promise = $client->updateInputSecurityGroupAsync([/* ... */]);
Update an Input Security Group's Whilelists.
Parameter Syntax
$result = $client->updateInputSecurityGroup([
'InputSecurityGroupId' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
'WhitelistRules' => [
[
'Cidr' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- InputSecurityGroupId
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- WhitelistRules
-
- Type: Array of InputWhitelistRuleCidr structures
Result Syntax
[
'SecurityGroup' => [
'Arn' => '<string>',
'Id' => '<string>',
'Inputs' => ['<string>', ...],
'State' => 'IDLE|IN_USE|UPDATING|DELETED',
'Tags' => ['<string>', ...],
'WhitelistRules' => [
[
'Cidr' => '<string>',
],
// ...
],
],
]
Result Details
Members
- SecurityGroup
-
- Type: InputSecurityGroup structure
An Input Security Group
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateMultiplex
$result = $client->updateMultiplex([/* ... */]); $promise = $client->updateMultiplexAsync([/* ... */]);
Updates a multiplex.
Parameter Syntax
$result = $client->updateMultiplex([
'MultiplexId' => '<string>', // REQUIRED
'MultiplexSettings' => [
'MaximumVideoBufferDelayMilliseconds' => <integer>,
'TransportStreamBitrate' => <integer>, // REQUIRED
'TransportStreamId' => <integer>, // REQUIRED
'TransportStreamReservedBitrate' => <integer>,
],
'Name' => '<string>',
'PacketIdentifiersMapping' => [
'<__string>' => [
'AribCaptionsPid' => <integer>,
'AudioPids' => [<integer>, ...],
'DvbSubPids' => [<integer>, ...],
'DvbTeletextPid' => <integer>,
'DvbTeletextPids' => [<integer>, ...],
'EcmPid' => <integer>,
'EtvPlatformPid' => <integer>,
'EtvSignalPid' => <integer>,
'KlvDataPids' => [<integer>, ...],
'PcrPid' => <integer>,
'PmtPid' => <integer>,
'PrivateMetadataPid' => <integer>,
'Scte27Pids' => [<integer>, ...],
'Scte35Pid' => <integer>,
'Smpte2038Pid' => <integer>,
'TimedMetadataPid' => <integer>,
'VideoPid' => <integer>,
],
// ...
],
]);
Parameter Details
Members
- MultiplexId
-
- Required: Yes
- Type: string
- MultiplexSettings
-
- Type: MultiplexSettings structure
Contains configuration for a Multiplex event - Name
-
- Type: string
- PacketIdentifiersMapping
-
- Type: Associative array of custom strings keys (__string) to MultiplexProgramPacketIdentifiersMap structures
Result Syntax
[
'Multiplex' => [
'Arn' => '<string>',
'AvailabilityZones' => ['<string>', ...],
'Destinations' => [
[
'MediaConnectSettings' => [
'EntitlementArn' => '<string>',
],
],
// ...
],
'Id' => '<string>',
'MultiplexSettings' => [
'MaximumVideoBufferDelayMilliseconds' => <integer>,
'TransportStreamBitrate' => <integer>,
'TransportStreamId' => <integer>,
'TransportStreamReservedBitrate' => <integer>,
],
'Name' => '<string>',
'PipelinesRunningCount' => <integer>,
'ProgramCount' => <integer>,
'State' => 'CREATING|CREATE_FAILED|IDLE|STARTING|RUNNING|RECOVERING|STOPPING|DELETING|DELETED',
'Tags' => ['<string>', ...],
],
]
Result Details
Members
- Multiplex
-
- Type: Multiplex structure
The multiplex object.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateMultiplexProgram
$result = $client->updateMultiplexProgram([/* ... */]); $promise = $client->updateMultiplexProgramAsync([/* ... */]);
Update a program in a multiplex.
Parameter Syntax
$result = $client->updateMultiplexProgram([
'MultiplexId' => '<string>', // REQUIRED
'MultiplexProgramSettings' => [
'PreferredChannelPipeline' => 'CURRENTLY_ACTIVE|PIPELINE_0|PIPELINE_1',
'ProgramNumber' => <integer>, // REQUIRED
'ServiceDescriptor' => [
'ProviderName' => '<string>', // REQUIRED
'ServiceName' => '<string>', // REQUIRED
],
'VideoSettings' => [
'ConstantBitrate' => <integer>,
'StatmuxSettings' => [
'MaximumBitrate' => <integer>,
'MinimumBitrate' => <integer>,
'Priority' => <integer>,
],
],
],
'ProgramName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MultiplexId
-
- Required: Yes
- Type: string
- MultiplexProgramSettings
-
- Type: MultiplexProgramSettings structure
Multiplex Program settings configuration. - ProgramName
-
- Required: Yes
- Type: string
Result Syntax
[
'MultiplexProgram' => [
'ChannelId' => '<string>',
'MultiplexProgramSettings' => [
'PreferredChannelPipeline' => 'CURRENTLY_ACTIVE|PIPELINE_0|PIPELINE_1',
'ProgramNumber' => <integer>,
'ServiceDescriptor' => [
'ProviderName' => '<string>',
'ServiceName' => '<string>',
],
'VideoSettings' => [
'ConstantBitrate' => <integer>,
'StatmuxSettings' => [
'MaximumBitrate' => <integer>,
'MinimumBitrate' => <integer>,
'Priority' => <integer>,
],
],
],
'PacketIdentifiersMap' => [
'AribCaptionsPid' => <integer>,
'AudioPids' => [<integer>, ...],
'DvbSubPids' => [<integer>, ...],
'DvbTeletextPid' => <integer>,
'DvbTeletextPids' => [<integer>, ...],
'EcmPid' => <integer>,
'EtvPlatformPid' => <integer>,
'EtvSignalPid' => <integer>,
'KlvDataPids' => [<integer>, ...],
'PcrPid' => <integer>,
'PmtPid' => <integer>,
'PrivateMetadataPid' => <integer>,
'Scte27Pids' => [<integer>, ...],
'Scte35Pid' => <integer>,
'Smpte2038Pid' => <integer>,
'TimedMetadataPid' => <integer>,
'VideoPid' => <integer>,
],
'PipelineDetails' => [
[
'ActiveChannelPipeline' => '<string>',
'PipelineId' => '<string>',
],
// ...
],
'ProgramName' => '<string>',
],
]
Result Details
Members
- MultiplexProgram
-
- Type: MultiplexProgram structure
The multiplex program object.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateNetwork
$result = $client->updateNetwork([/* ... */]); $promise = $client->updateNetworkAsync([/* ... */]);
Change the settings for a Network.
Parameter Syntax
$result = $client->updateNetwork([
'IpPools' => [
[
'Cidr' => '<string>',
],
// ...
],
'Name' => '<string>',
'NetworkId' => '<string>', // REQUIRED
'Routes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- IpPools
-
- Type: Array of IpPoolUpdateRequest structures
Include this parameter only if you want to change the pool of IP addresses in the network. An array of IpPoolCreateRequests that identify a collection of IP addresses in this network that you want to reserve for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPoolUpdateRequest specifies one CIDR block. - Name
-
- Type: string
Include this parameter only if you want to change the name of the Network. Specify a name that is unique in the AWS account. Names are case-sensitive. - NetworkId
-
- Required: Yes
- Type: string
- Routes
-
- Type: Array of RouteUpdateRequest structures
Include this parameter only if you want to change or add routes in the Network. An array of Routes that MediaLive Anywhere needs to know about in order to route encoding traffic.
Result Syntax
[
'Arn' => '<string>',
'AssociatedClusterIds' => ['<string>', ...],
'Id' => '<string>',
'IpPools' => [
[
'Cidr' => '<string>',
],
// ...
],
'Name' => '<string>',
'Routes' => [
[
'Cidr' => '<string>',
'Gateway' => '<string>',
],
// ...
],
'State' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING|IDLE|IN_USE|UPDATING|DELETE_FAILED|DELETED',
]
Result Details
Members
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateNode
$result = $client->updateNode([/* ... */]); $promise = $client->updateNodeAsync([/* ... */]);
Change the settings for a Node.
Parameter Syntax
$result = $client->updateNode([
'ClusterId' => '<string>', // REQUIRED
'Name' => '<string>',
'NodeId' => '<string>', // REQUIRED
'Role' => 'BACKUP|ACTIVE',
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
- Name
-
- Type: string
Include this parameter only if you want to change the current name of the Node. Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive. - NodeId
-
- Required: Yes
- Type: string
- Role
-
- Type: string
The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
Result Syntax
[
'Arn' => '<string>',
'ChannelPlacementGroups' => ['<string>', ...],
'ClusterId' => '<string>',
'ConnectionState' => 'CONNECTED|DISCONNECTED',
'Id' => '<string>',
'InstanceArn' => '<string>',
'Name' => '<string>',
'NodeInterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkInterfaceMode' => 'NAT|BRIDGE',
'PhysicalInterfaceName' => '<string>',
],
// ...
],
'Role' => 'BACKUP|ACTIVE',
'State' => 'CREATED|REGISTERING|READY_TO_ACTIVATE|REGISTRATION_FAILED|ACTIVATION_FAILED|ACTIVE|READY|IN_USE|DEREGISTERING|DRAINING|DEREGISTRATION_FAILED|DEREGISTERED',
]
Result Details
Members
- Arn
-
- Type: string
- ChannelPlacementGroups
-
- Type: Array of strings
- ClusterId
-
- Type: string
- ConnectionState
-
- Type: string
Used in DescribeNodeSummary. - Id
-
- Type: string
- InstanceArn
-
- Type: string
- Name
-
- Type: string
- NodeInterfaceMappings
-
- Type: Array of NodeInterfaceMapping structures
- Role
-
- Type: string
Used in CreateNodeRequest, CreateNodeRegistrationScriptRequest, DescribeNodeResult, DescribeNodeSummary, UpdateNodeRequest. - State
-
- Type: string
Used in DescribeNodeSummary.
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateNodeState
$result = $client->updateNodeState([/* ... */]); $promise = $client->updateNodeStateAsync([/* ... */]);
Update the state of a node.
Parameter Syntax
$result = $client->updateNodeState([
'ClusterId' => '<string>', // REQUIRED
'NodeId' => '<string>', // REQUIRED
'State' => 'ACTIVE|DRAINING',
]);
Parameter Details
Members
- ClusterId
-
- Required: Yes
- Type: string
- NodeId
-
- Required: Yes
- Type: string
- State
-
- Type: string
The state to apply to the Node. Set to ACTIVE (COMMISSIONED) to indicate that the Node is deployable. MediaLive Anywhere will consider this node it needs a Node to run a Channel on, or when it needs a Node to promote from a backup node to an active node. Set to DRAINING to isolate the Node so that MediaLive Anywhere won't use it.
Result Syntax
[
'Arn' => '<string>',
'ChannelPlacementGroups' => ['<string>', ...],
'ClusterId' => '<string>',
'ConnectionState' => 'CONNECTED|DISCONNECTED',
'Id' => '<string>',
'InstanceArn' => '<string>',
'Name' => '<string>',
'NodeInterfaceMappings' => [
[
'LogicalInterfaceName' => '<string>',
'NetworkInterfaceMode' => 'NAT|BRIDGE',
'PhysicalInterfaceName' => '<string>',
],
// ...
],
'Role' => 'BACKUP|ACTIVE',
'State' => 'CREATED|REGISTERING|READY_TO_ACTIVATE|REGISTRATION_FAILED|ACTIVATION_FAILED|ACTIVE|READY|IN_USE|DEREGISTERING|DRAINING|DEREGISTRATION_FAILED|DEREGISTERED',
]
Result Details
Members
- Arn
-
- Type: string
- ChannelPlacementGroups
-
- Type: Array of strings
- ClusterId
-
- Type: string
- ConnectionState
-
- Type: string
Used in DescribeNodeSummary. - Id
-
- Type: string
- InstanceArn
-
- Type: string
- Name
-
- Type: string
- NodeInterfaceMappings
-
- Type: Array of NodeInterfaceMapping structures
- Role
-
- Type: string
Used in CreateNodeRequest, CreateNodeRegistrationScriptRequest, DescribeNodeResult, DescribeNodeSummary, UpdateNodeRequest. - State
-
- Type: string
Used in DescribeNodeSummary.
Errors
- BadRequestException:
- This error does not currently have a description.
- UnprocessableEntityException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
UpdateReservation
$result = $client->updateReservation([/* ... */]); $promise = $client->updateReservationAsync([/* ... */]);
Update reservation.
Parameter Syntax
$result = $client->updateReservation([
'Name' => '<string>',
'RenewalSettings' => [
'AutomaticRenewal' => 'DISABLED|ENABLED|UNAVAILABLE',
'RenewalCount' => <integer>,
],
'ReservationId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Name
-
- Type: string
- RenewalSettings
-
- Type: RenewalSettings structure
The Renewal settings for Reservations - ReservationId
-
- Required: Yes
- Type: string
Result Syntax
[
'Reservation' => [
'Arn' => '<string>',
'Count' => <integer>,
'CurrencyCode' => '<string>',
'Duration' => <integer>,
'DurationUnits' => 'MONTHS',
'End' => '<string>',
'FixedPrice' => <float>,
'Name' => '<string>',
'OfferingDescription' => '<string>',
'OfferingId' => '<string>',
'OfferingType' => 'NO_UPFRONT',
'Region' => '<string>',
'RenewalSettings' => [
'AutomaticRenewal' => 'DISABLED|ENABLED|UNAVAILABLE',
'RenewalCount' => <integer>,
],
'ReservationId' => '<string>',
'ResourceSpecification' => [
'ChannelClass' => 'STANDARD|SINGLE_PIPELINE',
'Codec' => 'MPEG2|AVC|HEVC|AUDIO|LINK|AV1',
'MaximumBitrate' => 'MAX_10_MBPS|MAX_20_MBPS|MAX_50_MBPS',
'MaximumFramerate' => 'MAX_30_FPS|MAX_60_FPS',
'Resolution' => 'SD|HD|FHD|UHD',
'ResourceType' => 'INPUT|OUTPUT|MULTIPLEX|CHANNEL',
'SpecialFeature' => 'ADVANCED_AUDIO|AUDIO_NORMALIZATION|MGHD|MGUHD',
'VideoQuality' => 'STANDARD|ENHANCED|PREMIUM',
],
'Start' => '<string>',
'State' => 'ACTIVE|EXPIRED|CANCELED|DELETED',
'Tags' => ['<string>', ...],
'UsagePrice' => <float>,
],
]
Result Details
Members
- Reservation
-
- Type: Reservation structure
Reserved resources available to use
Errors
- BadRequestException:
- This error does not currently have a description.
- InternalServerErrorException:
- This error does not currently have a description.
- ForbiddenException:
- This error does not currently have a description.
- BadGatewayException:
- This error does not currently have a description.
- NotFoundException:
- This error does not currently have a description.
- GatewayTimeoutException:
- This error does not currently have a description.
- TooManyRequestsException:
- This error does not currently have a description.
- ConflictException:
- This error does not currently have a description.
Shapes
AacSettings
Description
Aac Settings
Members
- Bitrate
-
- Type: double
Average bitrate in bits/second. Valid values depend on rate control mode and profile. - CodingMode
-
- Type: string
Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. - InputType
-
- Type: string
Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd.Leave set to "normal" when input does not contain pre-mixed audio + AD. - Profile
-
- Type: string
AAC Profile. - RateControlMode
-
- Type: string
Rate Control Mode. - RawFormat
-
- Type: string
Sets LATM / LOAS AAC output for raw containers. - SampleRate
-
- Type: double
Sample rate in Hz. Valid values depend on rate control mode and profile. - Spec
-
- Type: string
Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. - VbrQuality
-
- Type: string
VBR Quality Level - Only used if rateControlMode is VBR.
Ac3Settings
Description
Ac3 Settings
Members
- AttenuationControl
-
- Type: string
Applies a 3 dB attenuation to the surround channels. Applies only when the coding mode parameter is CODING_MODE_3_2_LFE. - Bitrate
-
- Type: double
Average bitrate in bits/second. Valid bitrates depend on the coding mode. - BitstreamMode
-
- Type: string
Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. - CodingMode
-
- Type: string
Dolby Digital coding mode. Determines number of channels. - Dialnorm
-
- Type: int
Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through. - DrcProfile
-
- Type: string
If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. - LfeFilter
-
- Type: string
When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. - MetadataControl
-
- Type: string
When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
AccessDenied
Members
- Message
-
- Type: string
AccountConfiguration
Members
- KmsKeyId
-
- Type: string
Specifies the KMS key to use for all features that use key encryption. Specify the ARN of a KMS key that you have created. Or leave blank to use the key that MediaLive creates and manages for you.
AncillarySourceSettings
Description
Ancillary Source Settings
Members
- SourceAncillaryChannelNumber
-
- Type: int
Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field.
AnywhereSettings
Description
Elemental anywhere settings
Members
- ChannelPlacementGroupId
-
- Type: string
The ID of the channel placement group for the channel. - ClusterId
-
- Type: string
The ID of the cluster for the channel.
ArchiveCdnSettings
Description
Archive Cdn Settings
Members
- ArchiveS3Settings
-
- Type: ArchiveS3Settings structure
Archive S3 Settings
ArchiveContainerSettings
Description
Archive Container Settings
Members
- M2tsSettings
-
- Type: M2tsSettings structure
M2ts Settings - RawSettings
-
- Type: RawSettings structure
Raw Settings
ArchiveGroupSettings
Description
Archive Group Settings
Members
- ArchiveCdnSettings
-
- Type: ArchiveCdnSettings structure
Parameters that control interactions with the CDN. - Destination
-
- Required: Yes
- Type: OutputLocationRef structure
A directory and base filename where archive files should be written. - RolloverInterval
-
- Type: int
Number of seconds to write to archive file before closing and starting a new one.
ArchiveOutputSettings
Description
Archive Output Settings
Members
- ContainerSettings
-
- Required: Yes
- Type: ArchiveContainerSettings structure
Settings specific to the container type of the file. - Extension
-
- Type: string
Output file extension. If excluded, this will be auto-selected from the container type. - NameModifier
-
- Type: string
String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
ArchiveS3Settings
Description
Archive S3 Settings
Members
- CannedAcl
-
- Type: string
Specify the canned ACL to apply to each S3 request. Defaults to none.
AribDestinationSettings
Description
Arib Destination Settings
Members
AribSourceSettings
Description
Arib Source Settings
Members
AudioChannelMapping
Description
Audio Channel Mapping
Members
- InputChannelLevels
-
- Required: Yes
- Type: Array of InputChannelLevel structures
Indices and gain values for each input channel that should be remixed into this output channel. - OutputChannel
-
- Required: Yes
- Type: int
The index of the output channel being produced.
AudioCodecSettings
Description
Audio Codec Settings
Members
- AacSettings
-
- Type: AacSettings structure
Aac Settings - Ac3Settings
-
- Type: Ac3Settings structure
Ac3 Settings - Eac3AtmosSettings
-
- Type: Eac3AtmosSettings structure
Eac3 Atmos Settings - Eac3Settings
-
- Type: Eac3Settings structure
Eac3 Settings - Mp2Settings
-
- Type: Mp2Settings structure
Mp2 Settings - PassThroughSettings
-
- Type: PassThroughSettings structure
Pass Through Settings - WavSettings
-
- Type: WavSettings structure
Wav Settings
AudioDescription
Description
Audio Description
Members
- AudioDashRoles
-
- Type: Array of strings
Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling. - AudioNormalizationSettings
-
- Type: AudioNormalizationSettings structure
Advanced audio normalization settings. - AudioSelectorName
-
- Required: Yes
- Type: string
The name of the AudioSelector used as the source for this AudioDescription. - AudioType
-
- Type: string
Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. - AudioTypeControl
-
- Type: string
Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output.Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. - AudioWatermarkingSettings
-
- Type: AudioWatermarkSettings structure
Settings to configure one or more solutions that insert audio watermarks in the audio encode - CodecSettings
-
- Type: AudioCodecSettings structure
Audio codec settings. - DvbDashAccessibility
-
- Type: string
Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers. - LanguageCode
-
- Type: string
RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input. - LanguageCodeControl
-
- Type: string
Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. - Name
-
- Required: Yes
- Type: string
The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event. - RemixSettings
-
- Type: RemixSettings structure
Settings that control how input audio channels are remixed into the output audio channels. - StreamName
-
- Type: string
Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
AudioDolbyEDecode
Description
Audio Dolby EDecode
Members
- ProgramSelection
-
- Required: Yes
- Type: string
Applies only to Dolby E. Enter the program ID (according to the metadata in the audio) of the Dolby E program to extract from the specified track. One program extracted per audio selector. To select multiple programs, create multiple selectors with the same Track and different Program numbers. “All channels” means to ignore the program IDs and include all the channels in this selector; useful if metadata is known to be incorrect.
AudioHlsRenditionSelection
Description
Audio Hls Rendition Selection
Members
- GroupId
-
- Required: Yes
- Type: string
Specifies the GROUP-ID in the #EXT-X-MEDIA tag of the target HLS audio rendition. - Name
-
- Required: Yes
- Type: string
Specifies the NAME in the #EXT-X-MEDIA tag of the target HLS audio rendition.
AudioLanguageSelection
Description
Audio Language Selection
Members
- LanguageCode
-
- Required: Yes
- Type: string
Selects a specific three-letter language code from within an audio source. - LanguageSelectionPolicy
-
- Type: string
When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
AudioNormalizationSettings
Description
Audio Normalization Settings
Members
- Algorithm
-
- Type: string
Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. - AlgorithmControl
-
- Type: string
When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. - TargetLkfs
-
- Type: double
Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
AudioOnlyHlsSettings
Description
Audio Only Hls Settings
Members
- AudioGroupId
-
- Type: string
Specifies the group to which the audio Rendition belongs. - AudioOnlyImage
-
- Type: InputLocation structure
Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth.The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard. - AudioTrackType
-
- Type: string
Four types of audio-only tracks are supported:Audio-Only Variant StreamThe client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest.Alternate Audio, Auto Select, DefaultAlternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YESAlternate Audio, Auto Select, Not DefaultAlternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YESAlternate Audio, not Auto SelectAlternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO - SegmentType
-
- Type: string
Specifies the segment type.
AudioPidSelection
Description
Audio Pid Selection
Members
- Pid
-
- Required: Yes
- Type: int
Selects a specific PID from within a source.
AudioSelector
Description
Audio Selector
Members
- Name
-
- Required: Yes
- Type: string
The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input. - SelectorSettings
-
- Type: AudioSelectorSettings structure
The audio selector settings.
AudioSelectorSettings
Description
Audio Selector Settings
Members
- AudioHlsRenditionSelection
-
- Type: AudioHlsRenditionSelection structure
Audio Hls Rendition Selection - AudioLanguageSelection
-
- Type: AudioLanguageSelection structure
Audio Language Selection - AudioPidSelection
-
- Type: AudioPidSelection structure
Audio Pid Selection - AudioTrackSelection
-
- Type: AudioTrackSelection structure
Audio Track Selection
AudioSilenceFailoverSettings
Members
- AudioSelectorName
-
- Required: Yes
- Type: string
The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank. - AudioSilenceThresholdMsec
-
- Type: int
The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS.
AudioTrack
Description
Audio Track
Members
- Track
-
- Required: Yes
- Type: int
1-based integer value that maps to a specific audio track
AudioTrackSelection
Description
Audio Track Selection
Members
- DolbyEDecode
-
- Type: AudioDolbyEDecode structure
Configure decoding options for Dolby E streams - these should be Dolby E frames carried in PCM streams tagged with SMPTE-337 - Tracks
-
- Required: Yes
- Type: Array of AudioTrack structures
Selects one or more unique audio tracks from within a source.
AudioWatermarkSettings
Description
Audio Watermark Settings
Members
- NielsenWatermarksSettings
-
- Type: NielsenWatermarksSettings structure
Settings to configure Nielsen Watermarks in the audio encode
AutomaticInputFailoverSettings
Description
The settings for Automatic Input Failover.
Members
- ErrorClearTimeMsec
-
- Type: int
This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input. - FailoverConditions
-
- Type: Array of FailoverCondition structures
A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input. - InputPreference
-
- Type: string
Input preference when deciding which input to make active when a previously failed input has recovered. - SecondaryInputId
-
- Required: Yes
- Type: string
The input ID of the secondary input in the automatic input failover pair.
Av1ColorSpaceSettings
Description
Av1 Color Space Settings
Members
- ColorSpacePassthroughSettings
-
- Type: ColorSpacePassthroughSettings structure
Passthrough applies no color space conversion to the output - Hdr10Settings
-
- Type: Hdr10Settings structure
Hdr10 Settings - Rec601Settings
-
- Type: Rec601Settings structure
Rec601 Settings - Rec709Settings
-
- Type: Rec709Settings structure
Rec709 Settings
Av1Settings
Description
Av1 Settings
Members
- AfdSignaling
-
- Type: string
Configures whether MediaLive will write AFD values into the video.AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid).FIXED: the AFD value will be the value configured in the fixedAfd parameter.NONE: MediaLive won't write AFD into the video - BufSize
-
- Type: int
The size of the buffer (HRD buffer model) in bits. - ColorSpaceSettings
-
- Type: Av1ColorSpaceSettings structure
Color Space settings - FixedAfd
-
- Type: string
Complete this property only if you set the afdSignaling property to FIXED. Choose the AFD value (4 bits) to write on all frames of the video encode. - FramerateDenominator
-
- Required: Yes
- Type: int
The denominator for the framerate. Framerate is a fraction, for example, 24000 / 1001. - FramerateNumerator
-
- Required: Yes
- Type: int
The numerator for the framerate. Framerate is a fraction, for example, 24000 / 1001. - GopSize
-
- Type: double
The GOP size (keyframe interval).If GopSizeUnits is frames, GopSize must be a whole number and must be greater than or equal to 1.If GopSizeUnits is seconds, GopSize must be greater than 0, but it can be a decimal. - GopSizeUnits
-
- Type: string
Choose the units for the GOP size: FRAMES or SECONDS. For SECONDS, MediaLive converts the size into a frame count at run time. - Level
-
- Type: string
Sets the level. This parameter is one of the properties of the encoding scheme for AV1. - LookAheadRateControl
-
- Type: string
Sets the amount of lookahead. A value of LOW can decrease latency and memory usage. A value of HIGH can produce better quality for certain content. - MaxBitrate
-
- Type: int
The maximum bitrate to assign.For recommendations, see the description for qvbrQualityLevel. - MinIInterval
-
- Type: int
Applies only if you enable SceneChangeDetect. Sets the interval between frames. This property ensures a minimum separation between repeated (cadence) I-frames and any I-frames inserted by scene change detection (SCD frames).Enter a number for the interval, measured in number of frames.If an SCD frame and a cadence frame are closer than the specified number of frames, MediaLive shrinks or stretches the GOP to include the SCD frame. Then normal cadence resumes in the next GOP. For GOP stretch to succeed, you must enable LookAheadRateControl.Note that the maximum GOP stretch = (GOP size) + (Minimum I-interval) - 1 - ParDenominator
-
- Type: int
The denominator for the output pixel aspect ratio (PAR). - ParNumerator
-
- Type: int
The numerator for the output pixel aspect ratio (PAR). - QvbrQualityLevel
-
- Type: int
Controls the target quality for the video encode. With QVBR rate control mode, the final quality is the target quality, constrained by the maxBitrate.Set values for the qvbrQualityLevel property and maxBitrate property that suit your most important viewing devices.To let MediaLive set the quality level (AUTO mode), leave the qvbrQualityLevel field empty. In this case, MediaLive uses the maximum bitrate, and the quality follows from that: more complex content might have a lower quality.Or set a target quality level and a maximum bitrate. With more complex content, MediaLive will try to achieve the target quality, but it won't exceed the maximum bitrate. With less complex content, This option will use only the bitrate needed to reach the target quality.Recommended values are:Primary screen: qvbrQualityLevel: Leave empty. maxBitrate: 4,000,000PC or tablet: qvbrQualityLevel: Leave empty. maxBitrate: 1,500,000 to 3,000,000Smartphone: qvbrQualityLevel: Leave empty. maxBitrate: 1,000,000 to 1,500,000 - SceneChangeDetect
-
- Type: string
Controls whether MediaLive inserts I-frames when it detects a scene change. ENABLED or DISABLED. - TimecodeBurninSettings
-
- Type: TimecodeBurninSettings structure
Configures the timecode burn-in feature. If you enable this feature, the timecode will become part of the video.
AvailBlanking
Description
Avail Blanking
Members
- AvailBlankingImage
-
- Type: InputLocation structure
Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported. - State
-
- Type: string
When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.
AvailConfiguration
Description
Avail Configuration
Members
- AvailSettings
-
- Type: AvailSettings structure
Controls how SCTE-35 messages create cues. Splice Insert mode treats all segmentation signals traditionally. With Time Signal APOS mode only Time Signal Placement Opportunity and Break messages create segment breaks. With ESAM mode, signals are forwarded to an ESAM server for possible update. - Scte35SegmentationScope
-
- Type: string
Configures whether SCTE 35 passthrough triggers segment breaks in all output groups that use segmented outputs. Insertion of a SCTE 35 message typically results in a segment break, in addition to the regular cadence of breaks. The segment breaks appear in video outputs, audio outputs, and captions outputs (if any).ALL_OUTPUT_GROUPS: Default. Insert the segment break in in all output groups that have segmented outputs. This is the legacy behavior.SCTE35_ENABLED_OUTPUT_GROUPS: Insert the segment break only in output groups that have SCTE 35 passthrough enabled. This is the recommended value, because it reduces unnecessary segment breaks.
AvailSettings
Description
Avail Settings
Members
- Esam
-
- Type: Esam structure
Esam - Scte35SpliceInsert
-
- Type: Scte35SpliceInsert structure
Typical configuration that applies breaks on splice inserts in addition to time signal placement opportunities, breaks, and advertisements. - Scte35TimeSignalApos
-
- Type: Scte35TimeSignalApos structure
Atypical configuration that applies segment breaks only on SCTE-35 time signal placement opportunities and breaks.
BadGatewayException
Members
- Message
-
- Type: string
BadRequestException
Members
- Message
-
- Type: string
BadRequestExceptionResponseContent
Description
The input fails to satisfy the constraints specified by an AWS service.
Members
- Message
-
- Type: string
Exception error message.
BandwidthReductionFilterSettings
Description
Bandwidth Reduction Filter Settings
Members
- PostFilterSharpening
-
- Type: string
Configures the sharpening control, which is available when the bandwidth reduction filter is enabled. Thiscontrol sharpens edges and contours, which produces a specific artistic effect that you might want.We recommend that you test each of the values (including DISABLED) to observe the sharpening effect on thecontent. - Strength
-
- Type: string
Enables the bandwidth reduction filter. The filter strengths range from 1 to 4. We recommend that you alwaysenable this filter and use AUTO, to let MediaLive apply the optimum filtering for the context.
BatchDelete
Description
Batch delete resource request
Members
- ChannelIds
-
- Type: Array of strings
List of channel IDs - InputIds
-
- Type: Array of strings
List of input IDs - InputSecurityGroupIds
-
- Type: Array of strings
List of input security group IDs - MultiplexIds
-
- Type: Array of strings
List of multiplex IDs
BatchDeleteResultModel
Description
Batch delete resource results
Members
- Failed
-
- Type: Array of BatchFailedResultModel structures
List of failed operations - Successful
-
- Type: Array of BatchSuccessfulResultModel structures
List of successful operations
BatchFailedResultModel
Description
Details from a failed operation
Members
- Arn
-
- Type: string
ARN of the resource - Code
-
- Type: string
Error code for the failed operation - Id
-
- Type: string
ID of the resource - Message
-
- Type: string
Error message for the failed operation
BatchScheduleActionCreateRequest
Description
A list of schedule actions to create (in a request) or that have been created (in a response).
Members
- ScheduleActions
-
- Required: Yes
- Type: Array of ScheduleAction structures
A list of schedule actions to create.
BatchScheduleActionCreateResult
Description
List of actions that have been created in the schedule.
Members
- ScheduleActions
-
- Required: Yes
- Type: Array of ScheduleAction structures
List of actions that have been created in the schedule.
BatchScheduleActionDeleteRequest
Description
A list of schedule actions to delete.
Members
- ActionNames
-
- Required: Yes
- Type: Array of strings
A list of schedule actions to delete.
BatchScheduleActionDeleteResult
Description
List of actions that have been deleted from the schedule.
Members
- ScheduleActions
-
- Required: Yes
- Type: Array of ScheduleAction structures
List of actions that have been deleted from the schedule.
BatchStart
Description
Batch start resource request
Members
- ChannelIds
-
- Type: Array of strings
List of channel IDs - MultiplexIds
-
- Type: Array of strings
List of multiplex IDs
BatchStartResultModel
Description
Batch start resource results
Members
- Failed
-
- Type: Array of BatchFailedResultModel structures
List of failed operations - Successful
-
- Type: Array of BatchSuccessfulResultModel structures
List of successful operations
BatchStop
Description
Batch stop resource request
Members
- ChannelIds
-
- Type: Array of strings
List of channel IDs - MultiplexIds
-
- Type: Array of strings
List of multiplex IDs
BatchStopResultModel
Description
Batch stop resource results
Members
- Failed
-
- Type: Array of BatchFailedResultModel structures
List of failed operations - Successful
-
- Type: Array of BatchSuccessfulResultModel structures
List of successful operations
BatchSuccessfulResultModel
Description
Details from a successful operation
Members
- Arn
-
- Type: string
ARN of the resource - Id
-
- Type: string
ID of the resource - State
-
- Type: string
Current state of the resource
BatchUpdateScheduleResult
Description
Results of a batch schedule update.
Members
- Creates
-
- Type: BatchScheduleActionCreateResult structure
Schedule actions created in the schedule. - Deletes
-
- Type: BatchScheduleActionDeleteResult structure
Schedule actions deleted from the schedule.
BlackoutSlate
Description
Blackout Slate
Members
- BlackoutSlateImage
-
- Type: InputLocation structure
Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported. - NetworkEndBlackout
-
- Type: string
Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". - NetworkEndBlackoutImage
-
- Type: InputLocation structure
Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster. - NetworkId
-
- Type: string
Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C"). - State
-
- Type: string
When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
BurnInDestinationSettings
Description
Burn In Destination Settings
Members
- Alignment
-
- Type: string
If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. - BackgroundColor
-
- Type: string
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. - BackgroundOpacity
-
- Type: int
Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. - Font
-
- Type: InputLocation structure
External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. - FontColor
-
- Type: string
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. - FontOpacity
-
- Type: int
Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. - FontResolution
-
- Type: int
Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. - FontSize
-
- Type: string
When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. - OutlineColor
-
- Type: string
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. - OutlineSize
-
- Type: int
Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. - ShadowColor
-
- Type: string
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. - ShadowOpacity
-
- Type: int
Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. - ShadowXOffset
-
- Type: int
Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. - ShadowYOffset
-
- Type: int
Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. - TeletextGridControl
-
- Type: string
Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. - XPosition
-
- Type: int
Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. - YPosition
-
- Type: int
Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
CaptionDescription
Description
Caption Description
Members
- Accessibility
-
- Type: string
Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group. - CaptionDashRoles
-
- Type: Array of strings
Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling. - CaptionSelectorName
-
- Required: Yes
- Type: string
Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name. - DestinationSettings
-
- Type: CaptionDestinationSettings structure
Additional settings for captions destination that depend on the destination type. - DvbDashAccessibility
-
- Type: string
Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers. - LanguageCode
-
- Type: string
ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/ - LanguageDescription
-
- Type: string
Human readable information to indicate captions available for players (eg. English, or Spanish). - Name
-
- Required: Yes
- Type: string
Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
CaptionDestinationSettings
Description
Caption Destination Settings
Members
- AribDestinationSettings
-
- Type: AribDestinationSettings structure
Arib Destination Settings - BurnInDestinationSettings
-
- Type: BurnInDestinationSettings structure
Burn In Destination Settings - DvbSubDestinationSettings
-
- Type: DvbSubDestinationSettings structure
Dvb Sub Destination Settings - EbuTtDDestinationSettings
-
- Type: EbuTtDDestinationSettings structure
Ebu Tt DDestination Settings - EmbeddedDestinationSettings
-
- Type: EmbeddedDestinationSettings structure
Embedded Destination Settings - EmbeddedPlusScte20DestinationSettings
-
- Type: EmbeddedPlusScte20DestinationSettings structure
Embedded Plus Scte20 Destination Settings - RtmpCaptionInfoDestinationSettings
-
- Type: RtmpCaptionInfoDestinationSettings structure
Rtmp Caption Info Destination Settings - Scte20PlusEmbeddedDestinationSettings
-
- Type: Scte20PlusEmbeddedDestinationSettings structure
Scte20 Plus Embedded Destination Settings - Scte27DestinationSettings
-
- Type: Scte27DestinationSettings structure
Scte27 Destination Settings - SmpteTtDestinationSettings
-
- Type: SmpteTtDestinationSettings structure
Smpte Tt Destination Settings - TeletextDestinationSettings
-
- Type: TeletextDestinationSettings structure
Teletext Destination Settings - TtmlDestinationSettings
-
- Type: TtmlDestinationSettings structure
Ttml Destination Settings - WebvttDestinationSettings
-
- Type: WebvttDestinationSettings structure
Webvtt Destination Settings
CaptionLanguageMapping
Description
Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.
Members
- CaptionChannel
-
- Required: Yes
- Type: int
The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4) - LanguageCode
-
- Required: Yes
- Type: string
Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2) - LanguageDescription
-
- Required: Yes
- Type: string
Textual description of language
CaptionRectangle
Description
Caption Rectangle
Members
- Height
-
- Required: Yes
- Type: double
See the description in leftOffset.For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \"80\" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less.This field corresponds to tts:extent - Y in the TTML standard. - LeftOffset
-
- Required: Yes
- Type: double
Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages.If you specify a value for one of these fields, you must specify a value for all of them.For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame.This field corresponds to tts:origin - X in the TTML standard. - TopOffset
-
- Required: Yes
- Type: double
See the description in leftOffset.For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame.This field corresponds to tts:origin - Y in the TTML standard. - Width
-
- Required: Yes
- Type: double
See the description in leftOffset.For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \"80\" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less.This field corresponds to tts:extent - X in the TTML standard.
CaptionSelector
Description
Caption Selector
Members
- LanguageCode
-
- Type: string
When specified this field indicates the three letter language code of the caption track to extract from the source. - Name
-
- Required: Yes
- Type: string
Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event. - SelectorSettings
-
- Type: CaptionSelectorSettings structure
Caption selector settings.
CaptionSelectorSettings
Description
Caption Selector Settings
Members
- AncillarySourceSettings
-
- Type: AncillarySourceSettings structure
Ancillary Source Settings - AribSourceSettings
-
- Type: AribSourceSettings structure
Arib Source Settings - DvbSubSourceSettings
-
- Type: DvbSubSourceSettings structure
Dvb Sub Source Settings - EmbeddedSourceSettings
-
- Type: EmbeddedSourceSettings structure
Embedded Source Settings - Scte20SourceSettings
-
- Type: Scte20SourceSettings structure
Scte20 Source Settings - Scte27SourceSettings
-
- Type: Scte27SourceSettings structure
Scte27 Source Settings - TeletextSourceSettings
-
- Type: TeletextSourceSettings structure
Teletext Source Settings
CdiInputSpecification
Members
- Resolution
-
- Type: string
Maximum CDI input resolution
Channel
Members
- AnywhereSettings
-
- Type: DescribeAnywhereSettings structure
Anywhere settings for this channel. - Arn
-
- Type: string
The unique arn of the channel. - CdiInputSpecification
-
- Type: CdiInputSpecification structure
Specification of CDI inputs for this channel - ChannelClass
-
- Type: string
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. - Destinations
-
- Type: Array of OutputDestination structures
A list of destinations of the channel. For UDP outputs, there is onedestination per output. For other types (HLS, for example), there isone destination per packager. - EgressEndpoints
-
- Type: Array of ChannelEgressEndpoint structures
The endpoints where outgoing connections initiate from - EncoderSettings
-
- Type: EncoderSettings structure
Encoder Settings - Id
-
- Type: string
The unique id of the channel. - InputAttachments
-
- Type: Array of InputAttachment structures
List of input attachments for channel. - InputSpecification
-
- Type: InputSpecification structure
Specification of network and file inputs for this channel - LogLevel
-
- Type: string
The log level being written to CloudWatch Logs. - Maintenance
-
- Type: MaintenanceStatus structure
Maintenance settings for this channel. - Name
-
- Type: string
The name of the channel. (user-mutable) - PipelineDetails
-
- Type: Array of PipelineDetail structures
Runtime details for the pipelines of a running channel. - PipelinesRunningCount
-
- Type: int
The number of currently healthy pipelines. - RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role assumed when running the Channel. - State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs. - Vpc
-
- Type: VpcOutputSettingsDescription structure
Settings for VPC output
ChannelConfigurationValidationError
Members
- Message
-
- Type: string
- ValidationErrors
-
- Type: Array of ValidationError structures
A collection of validation error responses.
ChannelEgressEndpoint
Members
- SourceIp
-
- Type: string
Public IP of where a channel's output comes from
ChannelSummary
Members
- AnywhereSettings
-
- Type: DescribeAnywhereSettings structure
AnywhereSettings settings for this channel. - Arn
-
- Type: string
The unique arn of the channel. - CdiInputSpecification
-
- Type: CdiInputSpecification structure
Specification of CDI inputs for this channel - ChannelClass
-
- Type: string
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. - Destinations
-
- Type: Array of OutputDestination structures
A list of destinations of the channel. For UDP outputs, there is onedestination per output. For other types (HLS, for example), there isone destination per packager. - EgressEndpoints
-
- Type: Array of ChannelEgressEndpoint structures
The endpoints where outgoing connections initiate from - Id
-
- Type: string
The unique id of the channel. - InputAttachments
-
- Type: Array of InputAttachment structures
List of input attachments for channel. - InputSpecification
-
- Type: InputSpecification structure
Specification of network and file inputs for this channel - LogLevel
-
- Type: string
The log level being written to CloudWatch Logs. - Maintenance
-
- Type: MaintenanceStatus structure
Maintenance settings for this channel. - Name
-
- Type: string
The name of the channel. (user-mutable) - PipelinesRunningCount
-
- Type: int
The number of currently healthy pipelines. - RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role assumed when running the Channel. - State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs. - Vpc
-
- Type: VpcOutputSettingsDescription structure
Settings for any VPC outputs.
CloudWatchAlarmTemplateGroupSummary
Members
- Arn
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - Id
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource. - TemplateCount
-
- Required: Yes
- Type: int
The number of templates in a group.
CloudWatchAlarmTemplateSummary
Members
- Arn
-
- Required: Yes
- Type: string
A cloudwatch alarm template's ARN (Amazon Resource Name) - ComparisonOperator
-
- Required: Yes
- Type: string
The comparison operator used to compare the specified statistic and the threshold. - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DatapointsToAlarm
-
- Type: int
The number of datapoints within the evaluation period that must be breaching to trigger the alarm. - Description
-
- Type: string
A resource's optional description. - EvaluationPeriods
-
- Required: Yes
- Type: int
The number of periods over which data is compared to the specified threshold. - GroupId
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` - Id
-
- Required: Yes
- Type: string
A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-` - MetricName
-
- Required: Yes
- Type: string
The name of the metric associated with the alarm. Must be compatible with targetResourceType. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Period
-
- Required: Yes
- Type: int
The period, in seconds, over which the specified statistic is applied. - Statistic
-
- Required: Yes
- Type: string
The statistic to apply to the alarm's metric data. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource. - TargetResourceType
-
- Required: Yes
- Type: string
The resource type this template should dynamically generate cloudwatch metric alarms for. - Threshold
-
- Required: Yes
- Type: double
The threshold value to compare with the specified statistic. - TreatMissingData
-
- Required: Yes
- Type: string
Specifies how missing data points are treated when evaluating the alarm's condition.
ClusterNetworkSettings
Description
Used in DescribeClusterResult, DescribeClusterSummary, UpdateClusterResult.
Members
- DefaultRoute
-
- Type: string
The network interface that is the default route for traffic to and from the node. MediaLive Anywhere uses this default when the destination for the traffic isn't covered by the route table for any of the networks. Specify the value of the appropriate logicalInterfaceName parameter that you create in the interfaceMappings. - InterfaceMappings
-
- Type: Array of InterfaceMapping structures
An array of interfaceMapping objects for this Cluster. Each mapping logically connects one interface on the nodes with one Network. You need only one mapping for each interface because all the Nodes share the mapping.
ClusterNetworkSettingsCreateRequest
Description
Used in a CreateClusterRequest.
Members
- DefaultRoute
-
- Type: string
Specify one network interface as the default route for traffic to and from the Node. MediaLive Anywhere uses this default when the destination for the traffic isn't covered by the route table for any of the networks. Specify the value of the appropriate logicalInterfaceName parameter that you create in the interfaceMappings. - InterfaceMappings
-
- Type: Array of InterfaceMappingCreateRequest structures
An array of interfaceMapping objects for this Cluster. You must create a mapping for node interfaces that you plan to use for encoding traffic. You typically don't create a mapping for the management interface. You define this mapping in the Cluster so that the mapping can be used by all the Nodes. Each mapping logically connects one interface on the nodes with one Network. Each mapping consists of a pair of parameters. The logicalInterfaceName parameter creates a logical name for the Node interface that handles a specific type of traffic. For example, my-Inputs-Interface. The networkID parameter refers to the ID of the network. When you create the Nodes in this Cluster, you will associate the logicalInterfaceName with the appropriate physical interface.
ClusterNetworkSettingsUpdateRequest
Members
- DefaultRoute
-
- Type: string
Include this parameter only if you want to change the default route for the Cluster. Specify one network interface as the default route for traffic to and from the node. MediaLive Anywhere uses this default when the destination for the traffic isn't covered by the route table for any of the networks. Specify the value of the appropriate logicalInterfaceName parameter that you create in the interfaceMappings. - InterfaceMappings
-
- Type: Array of InterfaceMappingUpdateRequest structures
An array of interfaceMapping objects for this Cluster. Include this parameter only if you want to change the interface mappings for the Cluster. Typically, you change the interface mappings only to fix an error you made when creating the mapping. In an update request, make sure that you enter the entire set of mappings again, not just the mappings that you want to add or change. You define this mapping so that the mapping can be used by all the Nodes. Each mapping logically connects one interface on the nodes with one Network. Each mapping consists of a pair of parameters. The logicalInterfaceName parameter creates a logical name for the Node interface that handles a specific type of traffic. For example, my-Inputs-Interface. The networkID parameter refers to the ID of the network. When you create the Nodes in this Cluster, you will associate the logicalInterfaceName with the appropriate physical interface.
CmafIngestGroupSettings
Description
Cmaf Ingest Group Settings
Members
- Destination
-
- Required: Yes
- Type: OutputLocationRef structure
A HTTP destination for the tracks - KlvBehavior
-
- Type: string
If set to passthrough, passes any KLV data from the input source to this output. - KlvNameModifier
-
- Type: string
Change the modifier that MediaLive automatically adds to the Streams() name that identifies a KLV track. The default is "klv", which means the default name will be Streams(klv.cmfm). Any string you enter here will replace the "klv" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters. - NielsenId3Behavior
-
- Type: string
If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. - NielsenId3NameModifier
-
- Type: string
Change the modifier that MediaLive automatically adds to the Streams() name that identifies a Nielsen ID3 track. The default is "nid3", which means the default name will be Streams(nid3.cmfm). Any string you enter here will replace the "nid3" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters. - Scte35NameModifier
-
- Type: string
Change the modifier that MediaLive automatically adds to the Streams() name for a SCTE 35 track. The default is "scte", which means the default name will be Streams(scte.cmfm). Any string you enter here will replace the "scte" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters. - Scte35Type
-
- Type: string
Type of scte35 track to add. none or scte35WithoutSegmentation - SegmentLength
-
- Type: int
The nominal duration of segments. The units are specified in SegmentLengthUnits. The segments will end on the next keyframe after the specified duration, so the actual segment length might be longer, and it might be a fraction of the units. - SegmentLengthUnits
-
- Type: string
Time unit for segment length parameter. - SendDelayMs
-
- Type: int
Number of milliseconds to delay the output from the second pipeline.
CmafIngestOutputSettings
Description
Cmaf Ingest Output Settings
Members
- NameModifier
-
- Type: string
String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
ColorCorrection
Description
Property of ColorCorrectionSettings. Used for custom color space conversion. The object identifies one 3D LUT file and specifies the input/output color space combination that the file will be used for.
Members
- InputColorSpace
-
- Required: Yes
- Type: string
The color space of the input. - OutputColorSpace
-
- Required: Yes
- Type: string
The color space of the output. - Uri
-
- Required: Yes
- Type: string
The URI of the 3D LUT file. The protocol must be 's3:' or 's3ssl:':.
ColorCorrectionSettings
Description
Property of encoderSettings. Controls color conversion when you are using 3D LUT files to perform color conversion on video.
Members
- GlobalColorCorrections
-
- Required: Yes
- Type: Array of ColorCorrection structures
An array of colorCorrections that applies when you are using 3D LUT files to perform color conversion on video. Each colorCorrection contains one 3D LUT file (that defines the color mapping for converting an input color space to an output color space), and the input/output combination that this 3D LUT file applies to. MediaLive reads the color space in the input metadata, determines the color space that you have specified for the output, and finds and uses the LUT file that applies to this combination.
ColorSpacePassthroughSettings
Description
Passthrough applies no color space conversion to the output
Members
ConflictException
Members
- Message
-
- Type: string
ConflictExceptionResponseContent
Description
Updating or deleting a resource can cause an inconsistent state.
Members
- Message
-
- Type: string
Exception error message.
CreateChannel
Members
- AnywhereSettings
-
- Type: AnywhereSettings structure
The Elemental Anywhere settings for this channel. - CdiInputSpecification
-
- Type: CdiInputSpecification structure
Specification of CDI inputs for this channel - ChannelClass
-
- Type: string
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. - Destinations
-
- Type: Array of OutputDestination structures
- EncoderSettings
-
- Type: EncoderSettings structure
Encoder Settings - InputAttachments
-
- Type: Array of InputAttachment structures
List of input attachments for channel. - InputSpecification
-
- Type: InputSpecification structure
Specification of network and file inputs for this channel - LogLevel
-
- Type: string
The log level to write to CloudWatch Logs. - Maintenance
-
- Type: MaintenanceCreateSettings structure
Maintenance settings for this channel. - Name
-
- Type: string
Name of channel. - RequestId
-
- Type: string
Unique request ID to be specified. This is needed to prevent retries fromcreating multiple resources. - Reserved
-
- Type: string
Deprecated field that's only usable by whitelisted customers. - RoleArn
-
- Type: string
An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs. - Vpc
-
- Type: VpcOutputSettings structure
Settings for the VPC outputs
CreateChannelResultModel
Members
- Channel
-
- Type: Channel structure
CreateCloudWatchAlarmTemplateGroupRequestContent
Members
- Description
-
- Type: string
A resource's optional description. - Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
CreateCloudWatchAlarmTemplateGroupResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - Id
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
CreateCloudWatchAlarmTemplateRequestContent
Members
- ComparisonOperator
-
- Required: Yes
- Type: string
The comparison operator used to compare the specified statistic and the threshold. - DatapointsToAlarm
-
- Type: int
The number of datapoints within the evaluation period that must be breaching to trigger the alarm. - Description
-
- Type: string
A resource's optional description. - EvaluationPeriods
-
- Required: Yes
- Type: int
The number of periods over which data is compared to the specified threshold. - GroupIdentifier
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's identifier. Can be either be its id or current name. - MetricName
-
- Required: Yes
- Type: string
The name of the metric associated with the alarm. Must be compatible with targetResourceType. - Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Period
-
- Required: Yes
- Type: int
The period, in seconds, over which the specified statistic is applied. - Statistic
-
- Required: Yes
- Type: string
The statistic to apply to the alarm's metric data. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource. - TargetResourceType
-
- Required: Yes
- Type: string
The resource type this template should dynamically generate cloudwatch metric alarms for. - Threshold
-
- Required: Yes
- Type: double
The threshold value to compare with the specified statistic. - TreatMissingData
-
- Required: Yes
- Type: string
Specifies how missing data points are treated when evaluating the alarm's condition.
CreateCloudWatchAlarmTemplateResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
A cloudwatch alarm template's ARN (Amazon Resource Name) - ComparisonOperator
-
- Required: Yes
- Type: string
The comparison operator used to compare the specified statistic and the threshold. - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DatapointsToAlarm
-
- Type: int
The number of datapoints within the evaluation period that must be breaching to trigger the alarm. - Description
-
- Type: string
A resource's optional description. - EvaluationPeriods
-
- Required: Yes
- Type: int
The number of periods over which data is compared to the specified threshold. - GroupId
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` - Id
-
- Required: Yes
- Type: string
A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-` - MetricName
-
- Required: Yes
- Type: string
The name of the metric associated with the alarm. Must be compatible with targetResourceType. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Period
-
- Required: Yes
- Type: int
The period, in seconds, over which the specified statistic is applied. - Statistic
-
- Required: Yes
- Type: string
The statistic to apply to the alarm's metric data. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource. - TargetResourceType
-
- Required: Yes
- Type: string
The resource type this template should dynamically generate cloudwatch metric alarms for. - Threshold
-
- Required: Yes
- Type: double
The threshold value to compare with the specified statistic. - TreatMissingData
-
- Required: Yes
- Type: string
Specifies how missing data points are treated when evaluating the alarm's condition.
CreateEventBridgeRuleTemplateGroupRequestContent
Members
- Description
-
- Type: string
A resource's optional description. - Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
CreateEventBridgeRuleTemplateGroupResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
An eventbridge rule template group's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - Id
-
- Required: Yes
- Type: string
An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
CreateEventBridgeRuleTemplateRequestContent
Members
- Description
-
- Type: string
A resource's optional description. - EventTargets
-
- Type: Array of EventBridgeRuleTemplateTarget structures
- EventType
-
- Required: Yes
- Type: string
The type of event to match with the rule. - GroupIdentifier
-
- Required: Yes
- Type: string
An eventbridge rule template group's identifier. Can be either be its id or current name. - Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
CreateEventBridgeRuleTemplateResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
An eventbridge rule template's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - EventTargets
-
- Type: Array of EventBridgeRuleTemplateTarget structures
- EventType
-
- Required: Yes
- Type: string
The type of event to match with the rule. - GroupId
-
- Required: Yes
- Type: string
An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` - Id
-
- Required: Yes
- Type: string
An eventbridge rule template's id. AWS provided templates have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
CreateInput
Members
- Destinations
-
- Type: Array of InputDestinationRequest structures
Destination settings for PUSH type inputs. - InputDevices
-
- Type: Array of InputDeviceSettings structures
Settings for the devices. - InputNetworkLocation
-
- Type: string
The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem foran input in a customer network. - InputSecurityGroups
-
- Type: Array of strings
A list of security groups referenced by IDs to attach to the input. - MediaConnectFlows
-
- Type: Array of MediaConnectFlowRequest structures
A list of the MediaConnect Flows that you want to use in this input. You can specify as few as oneFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in aseparate Availability Zone as this ensures your EML input is redundant to AZ issues. - MulticastSettings
-
- Type: MulticastSettingsCreateRequest structure
Multicast Input settings. - Name
-
- Type: string
Name of the input. - RequestId
-
- Type: string
Unique identifier of the request to ensure the request is handledexactly once in case of retries. - RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role this input assumes during and after creation. - Sources
-
- Type: Array of InputSourceRequest structures
The source URLs for a PULL-type input. Every PULL type input needsexactly two source URLs for redundancy.Only specify sources for PULL type Inputs. Leave Destinations empty. - SrtSettings
-
- Type: SrtSettingsRequest structure
The settings associated with an SRT input. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs. - Type
-
- Type: string
The different types of inputs that AWS Elemental MediaLive supports. - Vpc
-
- Type: InputVpcRequest structure
Settings for a private VPC Input.When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses.This property requires setting the roleArn property on Input creation.Not compatible with the inputSecurityGroups property.
CreateInputResultModel
Members
- Input
-
- Type: Input structure
CreateInputSecurityGroupResultModel
Members
- SecurityGroup
-
- Type: InputSecurityGroup structure
An Input Security Group
CreateMultiplex
Members
- AvailabilityZones
-
- Required: Yes
- Type: Array of strings
A list of availability zones for the multiplex. You must specify exactly two. - MultiplexSettings
-
- Required: Yes
- Type: MultiplexSettings structure
Configuration for a multiplex event. - Name
-
- Required: Yes
- Type: string
Name of multiplex. - RequestId
-
- Required: Yes
- Type: string
Unique request ID. This prevents retries from creating multipleresources. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs.
CreateMultiplexProgram
Members
- MultiplexProgramSettings
-
- Required: Yes
- Type: MultiplexProgramSettings structure
The settings for this multiplex program. - ProgramName
-
- Required: Yes
- Type: string
Name of multiplex program. - RequestId
-
- Required: Yes
- Type: string
Unique request ID. This prevents retries from creating multipleresources.
CreateMultiplexProgramResultModel
Members
- MultiplexProgram
-
- Type: MultiplexProgram structure
The newly created multiplex program.
CreateMultiplexResultModel
Members
- Multiplex
-
- Type: Multiplex structure
The newly created multiplex.
CreateNodeRegistrationScriptResult
Description
Contains the response for CreateNodeRegistrationScript.
Members
- NodeRegistrationScript
-
- Type: string
A script that can be run on a Bring Your Own Device Elemental Anywhere system to create a node in a cluster.
CreatePartnerInput
Members
- RequestId
-
- Type: string
Unique identifier of the request to ensure the request is handledexactly once in case of retries. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs.
CreatePartnerInputResultModel
Members
- Input
-
- Type: Input structure
CreateSignalMapRequestContent
Members
- CloudWatchAlarmTemplateGroupIdentifiers
-
- Type: Array of strings
- Description
-
- Type: string
A resource's optional description. - DiscoveryEntryPointArn
-
- Required: Yes
- Type: string
A top-level supported AWS resource ARN to discovery a signal map from. - EventBridgeRuleTemplateGroupIdentifiers
-
- Type: Array of strings
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
CreateSignalMapResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
A signal map's ARN (Amazon Resource Name) - CloudWatchAlarmTemplateGroupIds
-
- Type: Array of strings
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - DiscoveryEntryPointArn
-
- Required: Yes
- Type: string
A top-level supported AWS resource ARN to discovery a signal map from. - ErrorMessage
-
- Type: string
Error message associated with a failed creation or failed update attempt of a signal map. - EventBridgeRuleTemplateGroupIds
-
- Type: Array of strings
- FailedMediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an incomplete AWS media workflow as a graph. - Id
-
- Required: Yes
- Type: string
A signal map's id. - LastDiscoveredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastSuccessfulMonitorDeployment
-
- Type: SuccessfulMonitorDeployment structure
Represents the latest successful monitor deployment of a signal map. - MediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an AWS media workflow as a graph. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- MonitorChangesPendingDeployment
-
- Required: Yes
- Type: boolean
If true, there are pending monitor changes for this signal map that can be deployed. - MonitorDeployment
-
- Type: MonitorDeployment structure
Represents the latest monitor deployment of a signal map. - Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Status
-
- Required: Yes
- Type: string
A signal map's current status which is dependent on its lifecycle actions or associated jobs. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
DescribeAccountConfigurationResultModel
Description
The account's configuration.
Members
- AccountConfiguration
-
- Type: AccountConfiguration structure
DescribeAnywhereSettings
Description
Elemental anywhere settings
Members
- ChannelPlacementGroupId
-
- Type: string
The ID of the channel placement group for the channel. - ClusterId
-
- Type: string
The ID of the cluster for the channel.
DescribeChannelPlacementGroupResult
Description
Contains the response for CreateChannelPlacementGroup, DescribeChannelPlacementGroup, DeleteChannelPlacementGroup, UpdateChannelPlacementGroup
Members
- Arn
-
- Type: string
The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created. - Channels
-
- Type: Array of strings
Used in ListChannelPlacementGroupsResult - ClusterId
-
- Type: string
The ID of the Cluster that the Node belongs to. - Id
-
- Type: string
The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN. - Name
-
- Type: string
The name that you specified for the ChannelPlacementGroup. - Nodes
-
- Type: Array of strings
An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup. - State
-
- Type: string
The current state of the ChannelPlacementGroup.
DescribeChannelPlacementGroupSummary
Description
Contains the response for ListChannelPlacementGroups
Members
- Arn
-
- Type: string
The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created. - Channels
-
- Type: Array of strings
Used in ListChannelPlacementGroupsResult - ClusterId
-
- Type: string
The ID of the Cluster that the Node belongs to. - Id
-
- Type: string
The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN. - Name
-
- Type: string
The name that you specified for the ChannelPlacementGroup. - Nodes
-
- Type: Array of strings
An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup. - State
-
- Type: string
The current state of the ChannelPlacementGroup.
DescribeClusterResult
Description
Contains the response for CreateCluster, DescribeCluster, DeleteCluster, UpdateCluster
Members
- Arn
-
- Type: string
The ARN of this Cluster. It is automatically assigned when the Cluster is created. - ChannelIds
-
- Type: Array of strings
- ClusterType
-
- Type: string
The hardware type for the Cluster - Id
-
- Type: string
The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN. - InstanceRoleArn
-
- Type: string
The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform. - Name
-
- Type: string
The name that you specified for the Cluster. - NetworkSettings
-
- Type: ClusterNetworkSettings structure
Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with. - State
-
- Type: string
The current state of the Cluster.
DescribeClusterSummary
Description
Used in ListClustersResult.
Members
- Arn
-
- Type: string
The ARN of this Cluster. It is automatically assigned when the Cluster is created. - ChannelIds
-
- Type: Array of strings
An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster. - ClusterType
-
- Type: string
The hardware type for the Cluster. - Id
-
- Type: string
The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN. - InstanceRoleArn
-
- Type: string
The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform. - Name
-
- Type: string
The name that you specified for the Cluster. - NetworkSettings
-
- Type: ClusterNetworkSettings structure
Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with. - State
-
- Type: string
The current state of the Cluster.
DescribeNetworkResult
Description
Contains the response for CreateNetwork, DescribeNetwork, DeleteNetwork, UpdateNetwork.
Members
- Arn
-
- Type: string
The ARN of this Network. It is automatically assigned when the Network is created. - AssociatedClusterIds
-
- Type: Array of strings
- Id
-
- Type: string
The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN. - IpPools
-
- Type: Array of IpPool structures
An array of IpPools in your organization's network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block. - Name
-
- Type: string
The name that you specified for the Network. - Routes
-
- Type: Array of Route structures
An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic. - State
-
- Type: string
The current state of the Network. Only MediaLive Anywhere can change the state.
DescribeNetworkSummary
Description
Used in ListNetworksResult.
Members
- Arn
-
- Type: string
The ARN of this Network. It is automatically assigned when the Network is created. - AssociatedClusterIds
-
- Type: Array of strings
- Id
-
- Type: string
The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN. - IpPools
-
- Type: Array of IpPool structures
An array of IpPools in your organization's network that identify a collection of IP addresses in your organization's network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block. - Name
-
- Type: string
The name that you specified for this Network. - Routes
-
- Type: Array of Route structures
An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic. - State
-
- Type: string
The current state of the Network. Only MediaLive Anywhere can change the state.
DescribeNodeResult
Description
Contains the response for CreateNode, DescribeNode, DeleteNode, UpdateNode
Members
- Arn
-
- Type: string
The ARN of the Node. It is automatically assigned when the Node is created. - ChannelPlacementGroups
-
- Type: Array of strings
An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups. - ClusterId
-
- Type: string
The ID of the Cluster that the Node belongs to. - ConnectionState
-
- Type: string
The current connection state of the Node. - Id
-
- Type: string
The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN. - InstanceArn
-
- Type: string
The ARN of the EC2 instance hosting the Node. - Name
-
- Type: string
The name that you specified for the Node. - NodeInterfaceMappings
-
- Type: Array of NodeInterfaceMapping structures
An array of interface mappings for the Node. Each mapping logically connects one physical interface on the node hardware with one logical interface name.This mapping associates a node interface with a network. The association works as follows: Node physicalInterfaceName > Node logicalInterfaceName = Cluster logicalInterfaceName > networkId. - Role
-
- Type: string
The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails. - State
-
- Type: string
The current state of the Node.
DescribeNodeSummary
Members
- Arn
-
- Type: string
The ARN of the Node. It is automatically assigned when the Node is created. - ChannelPlacementGroups
-
- Type: Array of strings
An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups. - ClusterId
-
- Type: string
The ID of the Cluster that the Node belongs to. - ConnectionState
-
- Type: string
The current connection state of the Node. - Id
-
- Type: string
The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN. - InstanceArn
-
- Type: string
The EC2 ARN of the Instance associated with the Node. - ManagedInstanceId
-
- Type: string
At the routing layer will get it from the callerId/context for use with bring your own device. - Name
-
- Type: string
The name that you specified for the Node. - NodeInterfaceMappings
-
- Type: Array of NodeInterfaceMapping structures
An array of interface mappings for the Node. Each mapping logically connects one physical interface on the node hardware with one logical interface name. This mapping associates a node interface with a network. The association works as follows: Node physicalInterfaceName > Node logicalInterfaceName = Cluster logicalInterfaceName > networkId. - Role
-
- Type: string
The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails. - State
-
- Type: string
The current state of the Node.
DescribeThumbnailsResultModel
Description
Thumbnail details for all the pipelines of a running channel.
Members
- ThumbnailDetails
-
- Type: Array of ThumbnailDetail structures
DolbyVision81Settings
Description
Dolby Vision81 Settings
Members
DvbNitSettings
Description
DVB Network Information Table (NIT)
Members
- NetworkId
-
- Required: Yes
- Type: int
The numeric value placed in the Network Information Table (NIT). - NetworkName
-
- Required: Yes
- Type: string
The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters. - RepInterval
-
- Type: int
The number of milliseconds between instances of this table in the output transport stream.
DvbSdtSettings
Description
DVB Service Description Table (SDT)
Members
- OutputSdt
-
- Type: string
Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. - RepInterval
-
- Type: int
The number of milliseconds between instances of this table in the output transport stream. - ServiceName
-
- Type: string
The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. - ServiceProviderName
-
- Type: string
The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
DvbSubDestinationSettings
Description
Dvb Sub Destination Settings
Members
- Alignment
-
- Type: string
If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. - BackgroundColor
-
- Type: string
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. - BackgroundOpacity
-
- Type: int
Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. - Font
-
- Type: InputLocation structure
External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. - FontColor
-
- Type: string
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. - FontOpacity
-
- Type: int
Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. - FontResolution
-
- Type: int
Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. - FontSize
-
- Type: string
When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. - OutlineColor
-
- Type: string
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. - OutlineSize
-
- Type: int
Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. - ShadowColor
-
- Type: string
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. - ShadowOpacity
-
- Type: int
Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. - ShadowXOffset
-
- Type: int
Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. - ShadowYOffset
-
- Type: int
Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. - TeletextGridControl
-
- Type: string
Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. - XPosition
-
- Type: int
Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. - YPosition
-
- Type: int
Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
DvbSubSourceSettings
Description
Dvb Sub Source Settings
Members
- OcrLanguage
-
- Type: string
If you will configure a WebVTT caption description that references this caption selector, use this field toprovide the language to consider when translating the image-based source to text. - Pid
-
- Type: int
When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
DvbTdtSettings
Description
DVB Time and Date Table (SDT)
Members
- RepInterval
-
- Type: int
The number of milliseconds between instances of this table in the output transport stream.
Eac3AtmosSettings
Description
Eac3 Atmos Settings
Members
- Bitrate
-
- Type: double
Average bitrate in bits/second. Valid bitrates depend on the coding mode. - CodingMode
-
- Type: string
Dolby Digital Plus with Dolby Atmos coding mode. Determines number of channels. - Dialnorm
-
- Type: int
Sets the dialnorm for the output. Default 23. - DrcLine
-
- Type: string
Sets the Dolby dynamic range compression profile. - DrcRf
-
- Type: string
Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. - HeightTrim
-
- Type: double
Height dimensional trim. Sets the maximum amount to attenuate the height channels when the downstream player isn??t configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels. - SurroundTrim
-
- Type: double
Surround dimensional trim. Sets the maximum amount to attenuate the surround channels when the downstream player isn't configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels.
Eac3Settings
Description
Eac3 Settings
Members
- AttenuationControl
-
- Type: string
When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. - Bitrate
-
- Type: double
Average bitrate in bits/second. Valid bitrates depend on the coding mode. - BitstreamMode
-
- Type: string
Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. - CodingMode
-
- Type: string
Dolby Digital Plus coding mode. Determines number of channels. - DcFilter
-
- Type: string
When set to enabled, activates a DC highpass filter for all input channels. - Dialnorm
-
- Type: int
Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through. - DrcLine
-
- Type: string
Sets the Dolby dynamic range compression profile. - DrcRf
-
- Type: string
Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. - LfeControl
-
- Type: string
When encoding 3/2 audio, setting to lfe enables the LFE channel - LfeFilter
-
- Type: string
When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. - LoRoCenterMixLevel
-
- Type: double
Left only/Right only center mix level. Only used for 3/2 coding mode. - LoRoSurroundMixLevel
-
- Type: double
Left only/Right only surround mix level. Only used for 3/2 coding mode. - LtRtCenterMixLevel
-
- Type: double
Left total/Right total center mix level. Only used for 3/2 coding mode. - LtRtSurroundMixLevel
-
- Type: double
Left total/Right total surround mix level. Only used for 3/2 coding mode. - MetadataControl
-
- Type: string
When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. - PassthroughControl
-
- Type: string
When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. - PhaseControl
-
- Type: string
When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. - StereoDownmix
-
- Type: string
Stereo downmix preference. Only used for 3/2 coding mode. - SurroundExMode
-
- Type: string
When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. - SurroundMode
-
- Type: string
When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
EbuTtDDestinationSettings
Description
Ebu Tt DDestination Settings
Members
- CopyrightHolder
-
- Type: string
Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata. - FillLineGap
-
- Type: string
Specifies how to handle the gap between the lines (in multi-line captions).- enabled: Fill with the captions background color (as specified in the input captions).- disabled: Leave the gap unfilled. - FontFamily
-
- Type: string
Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".)You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size.- Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font).- Leave blank to set the family to “monospace”. - StyleControl
-
- Type: string
Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions.- include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext.- exclude: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information.
EmbeddedDestinationSettings
Description
Embedded Destination Settings
Members
EmbeddedPlusScte20DestinationSettings
Description
Embedded Plus Scte20 Destination Settings
Members
EmbeddedSourceSettings
Description
Embedded Source Settings
Members
- Convert608To708
-
- Type: string
If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. - Scte20Detection
-
- Type: string
Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. - Source608ChannelNumber
-
- Type: int
Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. - Source608TrackNumber
-
- Type: int
This field is unused and deprecated.
Empty
Members
EncoderSettings
Description
Encoder Settings
Members
- AudioDescriptions
-
- Required: Yes
- Type: Array of AudioDescription structures
- AvailBlanking
-
- Type: AvailBlanking structure
Settings for ad avail blanking. - AvailConfiguration
-
- Type: AvailConfiguration structure
Event-wide configuration settings for ad avail insertion. - BlackoutSlate
-
- Type: BlackoutSlate structure
Settings for blackout slate. - CaptionDescriptions
-
- Type: Array of CaptionDescription structures
Settings for caption decriptions - ColorCorrectionSettings
-
- Type: ColorCorrectionSettings structure
Color Correction Settings - FeatureActivations
-
- Type: FeatureActivations structure
Feature Activations - GlobalConfiguration
-
- Type: GlobalConfiguration structure
Configuration settings that apply to the event as a whole. - MotionGraphicsConfiguration
-
- Type: MotionGraphicsConfiguration structure
Settings for motion graphics. - NielsenConfiguration
-
- Type: NielsenConfiguration structure
Nielsen configuration settings. - OutputGroups
-
- Required: Yes
- Type: Array of OutputGroup structures
- ThumbnailConfiguration
-
- Type: ThumbnailConfiguration structure
Thumbnail configuration settings. - TimecodeConfig
-
- Required: Yes
- Type: TimecodeConfig structure
Contains settings used to acquire and adjust timecode information from inputs. - VideoDescriptions
-
- Required: Yes
- Type: Array of VideoDescription structures
EpochLockingSettings
Description
Epoch Locking Settings
Members
- CustomEpoch
-
- Type: string
Optional. Enter a value here to use a custom epoch, instead of the standard epoch (which started at 1970-01-01T00:00:00 UTC). Specify the start time of the custom epoch, in YYYY-MM-DDTHH:MM:SS in UTC. The time must be 2000-01-01T00:00:00 or later. Always set the MM:SS portion to 00:00. - JamSyncTime
-
- Type: string
Optional. Enter a time for the jam sync. The default is midnight UTC. When epoch locking is enabled, MediaLive performs a daily jam sync on every output encode to ensure timecodes don’t diverge from the wall clock. The jam sync applies only to encodes with frame rate of 29.97 or 59.94 FPS. To override, enter a time in HH:MM:SS in UTC. Always set the MM:SS portion to 00:00.
Esam
Description
Esam
Members
- AcquisitionPointId
-
- Required: Yes
- Type: string
Sent as acquisitionPointIdentity to identify the MediaLive channel to the POIS. - AdAvailOffset
-
- Type: int
When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. - PasswordParam
-
- Type: string
Reference to an AWS parameter store name from which the password can be retrieved if credentials are required to access the POIS endpoint. AWS Parameter store format: "ssm://" - PoisEndpoint
-
- Required: Yes
- Type: string
The URL of the signal conditioner endpoint on the Placement Opportunity Information System (POIS). MediaLive sends SignalProcessingEvents here when SCTE-35 messages are read. - Username
-
- Type: string
Username if credentials are required to access the POIS endpoint. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://" - ZoneIdentity
-
- Type: string
Optional data sent as zoneIdentity to identify the MediaLive channel to the POIS.
EventBridgeRuleTemplateGroupSummary
Members
- Arn
-
- Required: Yes
- Type: string
An eventbridge rule template group's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - Id
-
- Required: Yes
- Type: string
An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource. - TemplateCount
-
- Required: Yes
- Type: int
The number of templates in a group.
EventBridgeRuleTemplateSummary
Members
- Arn
-
- Required: Yes
- Type: string
An eventbridge rule template's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - EventTargetCount
-
- Required: Yes
- Type: int
The number of targets configured to send matching events. - EventType
-
- Required: Yes
- Type: string
The type of event to match with the rule. - GroupId
-
- Required: Yes
- Type: string
An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` - Id
-
- Required: Yes
- Type: string
An eventbridge rule template's id. AWS provided templates have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
EventBridgeRuleTemplateTarget
Description
The target to which to send matching events.
Members
- Arn
-
- Required: Yes
- Type: string
Target ARNs must be either an SNS topic or CloudWatch log group.
FailoverCondition
Description
Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings.
Members
- FailoverConditionSettings
-
- Type: FailoverConditionSettings structure
Failover condition type-specific settings.
FailoverConditionSettings
Description
Settings for one failover condition.
Members
- AudioSilenceSettings
-
- Type: AudioSilenceFailoverSettings structure
MediaLive will perform a failover if the specified audio selector is silent for the specified period. - InputLossSettings
-
- Type: InputLossFailoverSettings structure
MediaLive will perform a failover if content is not detected in this input for the specified period. - VideoBlackSettings
-
- Type: VideoBlackFailoverSettings structure
MediaLive will perform a failover if content is considered black for the specified period.
FeatureActivations
Description
Feature Activations
Members
- InputPrepareScheduleActions
-
- Type: string
Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled.If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule. - OutputStaticImageOverlayScheduleActions
-
- Type: string
Enables the output static image overlay feature. Enabling this feature allows you to send channel schedule updatesto display/clear/modify image overlays on an output-by-output bases.
FecOutputSettings
Description
Fec Output Settings
Members
- ColumnDepth
-
- Type: int
Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive. - IncludeFec
-
- Type: string
Enables column only or column and row based FEC - RowLength
-
- Type: int
Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
FixedModeScheduleActionStartSettings
Description
Start time for the action.
Members
- Time
-
- Required: Yes
- Type: string
Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format".
Fmp4HlsSettings
Description
Fmp4 Hls Settings
Members
- AudioRenditionSets
-
- Type: string
List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. - NielsenId3Behavior
-
- Type: string
If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. - TimedMetadataBehavior
-
- Type: string
Set to PASSTHROUGH to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group or individual outputs, or you add an ID3 action to the channel schedule.
FollowModeScheduleActionStartSettings
Description
Settings to specify if an action follows another.
Members
- FollowPoint
-
- Required: Yes
- Type: string
Identifies whether this action starts relative to the start or relative to the end of the reference action. - ReferenceActionName
-
- Required: Yes
- Type: string
The action name of another action that this one refers to.
ForbiddenException
Members
- Message
-
- Type: string
ForbiddenExceptionResponseContent
Description
User does not have sufficient access to perform this action.
Members
- Message
-
- Type: string
Exception error message.
FrameCaptureCdnSettings
Description
Frame Capture Cdn Settings
Members
- FrameCaptureS3Settings
-
- Type: FrameCaptureS3Settings structure
Frame Capture S3 Settings
FrameCaptureGroupSettings
Description
Frame Capture Group Settings
Members
- Destination
-
- Required: Yes
- Type: OutputLocationRef structure
The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, "curling-") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curling-low.00001.jpg - FrameCaptureCdnSettings
-
- Type: FrameCaptureCdnSettings structure
Parameters that control interactions with the CDN.
FrameCaptureHlsSettings
Description
Frame Capture Hls Settings
Members
FrameCaptureOutputSettings
Description
Frame Capture Output Settings
Members
- NameModifier
-
- Type: string
Required if the output group contains more than one output. This modifier forms part of the output file name.
FrameCaptureS3Settings
Description
Frame Capture S3 Settings
Members
- CannedAcl
-
- Type: string
Specify the canned ACL to apply to each S3 request. Defaults to none.
FrameCaptureSettings
Description
Frame Capture Settings
Members
- CaptureInterval
-
- Type: int
The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits. - CaptureIntervalUnits
-
- Type: string
Unit for the frame capture interval. - TimecodeBurninSettings
-
- Type: TimecodeBurninSettings structure
Timecode burn-in settings
GatewayTimeoutException
Members
- Message
-
- Type: string
GetCloudWatchAlarmTemplateGroupResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - Id
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
GetCloudWatchAlarmTemplateResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
A cloudwatch alarm template's ARN (Amazon Resource Name) - ComparisonOperator
-
- Required: Yes
- Type: string
The comparison operator used to compare the specified statistic and the threshold. - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DatapointsToAlarm
-
- Type: int
The number of datapoints within the evaluation period that must be breaching to trigger the alarm. - Description
-
- Type: string
A resource's optional description. - EvaluationPeriods
-
- Required: Yes
- Type: int
The number of periods over which data is compared to the specified threshold. - GroupId
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` - Id
-
- Required: Yes
- Type: string
A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-` - MetricName
-
- Required: Yes
- Type: string
The name of the metric associated with the alarm. Must be compatible with targetResourceType. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Period
-
- Required: Yes
- Type: int
The period, in seconds, over which the specified statistic is applied. - Statistic
-
- Required: Yes
- Type: string
The statistic to apply to the alarm's metric data. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource. - TargetResourceType
-
- Required: Yes
- Type: string
The resource type this template should dynamically generate cloudwatch metric alarms for. - Threshold
-
- Required: Yes
- Type: double
The threshold value to compare with the specified statistic. - TreatMissingData
-
- Required: Yes
- Type: string
Specifies how missing data points are treated when evaluating the alarm's condition.
GetEventBridgeRuleTemplateGroupResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
An eventbridge rule template group's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - Id
-
- Required: Yes
- Type: string
An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
GetEventBridgeRuleTemplateResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
An eventbridge rule template's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - EventTargets
-
- Type: Array of EventBridgeRuleTemplateTarget structures
- EventType
-
- Required: Yes
- Type: string
The type of event to match with the rule. - GroupId
-
- Required: Yes
- Type: string
An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` - Id
-
- Required: Yes
- Type: string
An eventbridge rule template's id. AWS provided templates have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
GetSignalMapResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
A signal map's ARN (Amazon Resource Name) - CloudWatchAlarmTemplateGroupIds
-
- Type: Array of strings
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - DiscoveryEntryPointArn
-
- Required: Yes
- Type: string
A top-level supported AWS resource ARN to discovery a signal map from. - ErrorMessage
-
- Type: string
Error message associated with a failed creation or failed update attempt of a signal map. - EventBridgeRuleTemplateGroupIds
-
- Type: Array of strings
- FailedMediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an incomplete AWS media workflow as a graph. - Id
-
- Required: Yes
- Type: string
A signal map's id. - LastDiscoveredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastSuccessfulMonitorDeployment
-
- Type: SuccessfulMonitorDeployment structure
Represents the latest successful monitor deployment of a signal map. - MediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an AWS media workflow as a graph. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- MonitorChangesPendingDeployment
-
- Required: Yes
- Type: boolean
If true, there are pending monitor changes for this signal map that can be deployed. - MonitorDeployment
-
- Type: MonitorDeployment structure
Represents the latest monitor deployment of a signal map. - Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Status
-
- Required: Yes
- Type: string
A signal map's current status which is dependent on its lifecycle actions or associated jobs. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
GlobalConfiguration
Description
Global Configuration
Members
- InitialAudioGain
-
- Type: int
Value to set the initial audio gain for the Live Event. - InputEndAction
-
- Type: string
Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). - InputLossBehavior
-
- Type: InputLossBehavior structure
Settings for system actions when input is lost. - OutputLockingMode
-
- Type: string
Indicates how MediaLive pipelines are synchronized.PIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other.EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. - OutputLockingSettings
-
- Type: OutputLockingSettings structure
Advanced output locking settings - OutputTimingSource
-
- Type: string
Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. - SupportLowFramerateInputs
-
- Type: string
Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
H264ColorSpaceSettings
Description
H264 Color Space Settings
Members
- ColorSpacePassthroughSettings
-
- Type: ColorSpacePassthroughSettings structure
Passthrough applies no color space conversion to the output - Rec601Settings
-
- Type: Rec601Settings structure
Rec601 Settings - Rec709Settings
-
- Type: Rec709Settings structure
Rec709 Settings
H264FilterSettings
Description
H264 Filter Settings
Members
- BandwidthReductionFilterSettings
-
- Type: BandwidthReductionFilterSettings structure
Bandwidth Reduction Filter Settings - TemporalFilterSettings
-
- Type: TemporalFilterSettings structure
Temporal Filter Settings
H264Settings
Description
H264 Settings
Members
- AdaptiveQuantization
-
- Type: string
Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization. - AfdSignaling
-
- Type: string
Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. - Bitrate
-
- Type: int
Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. - BufFillPct
-
- Type: int
Percentage of the buffer that should initially be filled (HRD buffer model). - BufSize
-
- Type: int
Size of buffer (HRD buffer model) in bits. - ColorMetadata
-
- Type: string
Includes colorspace metadata in the output. - ColorSpaceSettings
-
- Type: H264ColorSpaceSettings structure
Color Space settings - EntropyEncoding
-
- Type: string
Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. - FilterSettings
-
- Type: H264FilterSettings structure
Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. Werecommend that you try both filters and observe the results to decide which one to use.The Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptualfiltering and motion compensated temporal filtering (MCTF). It operates independently of the compression level.The Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the currentcompression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower. - FixedAfd
-
- Type: string
Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. - FlickerAq
-
- Type: string
Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ. - ForceFieldPictures
-
- Type: string
This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.)enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately.disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content. - FramerateControl
-
- Type: string
This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. - FramerateDenominator
-
- Type: int
Framerate denominator. - FramerateNumerator
-
- Type: int
Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. - GopBReference
-
- Type: string
If enabled, use reference B frames for GOP structures that have B frames > 1. - GopClosedCadence
-
- Type: int
Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. - GopNumBFrames
-
- Type: int
Number of B-frames between reference frames. - GopSize
-
- Type: double
GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. - GopSizeUnits
-
- Type: string
Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. - Level
-
- Type: string
H.264 Level. - LookAheadRateControl
-
- Type: string
Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. - MaxBitrate
-
- Type: int
For QVBR: See the tooltip for Quality levelFor VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video. - MinIInterval
-
- Type: int
Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 - MinQp
-
- Type: int
Sets the minimum QP. If you aren't familiar with quantization adjustment, leave the field empty. MediaLive willapply an appropriate value. - NumRefFrames
-
- Type: int
Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding. - ParControl
-
- Type: string
This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. - ParDenominator
-
- Type: int
Pixel Aspect Ratio denominator. - ParNumerator
-
- Type: int
Pixel Aspect Ratio numerator. - Profile
-
- Type: string
H.264 Profile. - QualityLevel
-
- Type: string
Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel).- ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY.- STANDARD_QUALITY: Valid for any Rate control mode. - QvbrQualityLevel
-
- Type: int
Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are:- Primary screen: Quality level: 8 to 10. Max bitrate: 4M- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5MTo let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called "Video - rate control mode" in the MediaLive user guide - RateControlMode
-
- Type: string
Rate control mode.QVBR: Quality will match the specified quality level except when it is constrained by themaximum bitrate. Recommended if you or your viewers pay for bandwidth.VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBRif you want to maintain a specific average bitrate over the duration of the channel.CBR: Quality varies, depending on the video complexity. Recommended only if you distributeyour assets to devices that cannot handle variable bitrates.Multiplex: This rate control mode is only supported (and is required) when the video is beingdelivered to a MediaLive Multiplex in which case the rate control configuration is controlledby the properties within the Multiplex Program. - ScanType
-
- Type: string
Sets the scan type of the output to progressive or top-field-first interlaced. - SceneChangeDetect
-
- Type: string
Scene change detection.- On: inserts I-frames when scene change is detected.- Off: does not force an I-frame when scene change is detected. - Slices
-
- Type: int
Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. - Softness
-
- Type: int
Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15. - SpatialAq
-
- Type: string
Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ. - SubgopLength
-
- Type: string
If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. - Syntax
-
- Type: string
Produces a bitstream compliant with SMPTE RP-2027. - TemporalAq
-
- Type: string
Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ. - TimecodeBurninSettings
-
- Type: TimecodeBurninSettings structure
Timecode burn-in settings - TimecodeInsertion
-
- Type: string
Determines how timecodes should be inserted into the video elementary stream.- 'disabled': Do not include timecodes- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
H265ColorSpaceSettings
Description
H265 Color Space Settings
Members
- ColorSpacePassthroughSettings
-
- Type: ColorSpacePassthroughSettings structure
Passthrough applies no color space conversion to the output - DolbyVision81Settings
-
- Type: DolbyVision81Settings structure
Dolby Vision81 Settings - Hdr10Settings
-
- Type: Hdr10Settings structure
Hdr10 Settings - Rec601Settings
-
- Type: Rec601Settings structure
Rec601 Settings - Rec709Settings
-
- Type: Rec709Settings structure
Rec709 Settings
H265FilterSettings
Description
H265 Filter Settings
Members
- BandwidthReductionFilterSettings
-
- Type: BandwidthReductionFilterSettings structure
Bandwidth Reduction Filter Settings - TemporalFilterSettings
-
- Type: TemporalFilterSettings structure
Temporal Filter Settings
H265Settings
Description
H265 Settings
Members
- AdaptiveQuantization
-
- Type: string
Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. - AfdSignaling
-
- Type: string
Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. - AlternativeTransferFunction
-
- Type: string
Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays. - Bitrate
-
- Type: int
Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. - BufSize
-
- Type: int
Size of buffer (HRD buffer model) in bits. - ColorMetadata
-
- Type: string
Includes colorspace metadata in the output. - ColorSpaceSettings
-
- Type: H265ColorSpaceSettings structure
Color Space settings - Deblocking
-
- Type: string
Enable or disable the deblocking filter for this codec. The filter reduces blocking artifacts at block boundaries,which improves overall video quality. If the filter is disabled, visible block edges might appear in the output,especially at lower bitrates. - FilterSettings
-
- Type: H265FilterSettings structure
Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. Werecommend that you try both filters and observe the results to decide which one to use.The Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptualfiltering and motion compensated temporal filtering (MCTF). It operates independently of the compression level.The Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the currentcompression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower. - FixedAfd
-
- Type: string
Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. - FlickerAq
-
- Type: string
If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. - FramerateDenominator
-
- Required: Yes
- Type: int
Framerate denominator. - FramerateNumerator
-
- Required: Yes
- Type: int
Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. - GopClosedCadence
-
- Type: int
Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. - GopSize
-
- Type: double
GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. - GopSizeUnits
-
- Type: string
Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. - Level
-
- Type: string
H.265 Level. - LookAheadRateControl
-
- Type: string
Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. - MaxBitrate
-
- Type: int
For QVBR: See the tooltip for Quality level - MinIInterval
-
- Type: int
Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 - MinQp
-
- Type: int
Sets the minimum QP. If you aren't familiar with quantization adjustment, leave the field empty. MediaLive willapply an appropriate value. - MvOverPictureBoundaries
-
- Type: string
If you are setting up the picture as a tile, you must set this to "disabled". In all other configurations, you typically enter "enabled". - MvTemporalPredictor
-
- Type: string
If you are setting up the picture as a tile, you must set this to "disabled". In other configurations, you typically enter "enabled". - ParDenominator
-
- Type: int
Pixel Aspect Ratio denominator. - ParNumerator
-
- Type: int
Pixel Aspect Ratio numerator. - Profile
-
- Type: string
H.265 Profile. - QvbrQualityLevel
-
- Type: int
Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:- Primary screen: Quality level: 8 to 10. Max bitrate: 4M- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M - RateControlMode
-
- Type: string
Rate control mode.QVBR: Quality will match the specified quality level except when it is constrained by themaximum bitrate. Recommended if you or your viewers pay for bandwidth.CBR: Quality varies, depending on the video complexity. Recommended only if you distributeyour assets to devices that cannot handle variable bitrates.Multiplex: This rate control mode is only supported (and is required) when the video is beingdelivered to a MediaLive Multiplex in which case the rate control configuration is controlledby the properties within the Multiplex Program. - ScanType
-
- Type: string
Sets the scan type of the output to progressive or top-field-first interlaced. - SceneChangeDetect
-
- Type: string
Scene change detection. - Slices
-
- Type: int
Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. - Tier
-
- Type: string
H.265 Tier. - TileHeight
-
- Type: int
Set this field to set up the picture as a tile. You must also set tileWidth.The tile height must result in 22 or fewer rows in the frame. The tile widthmust result in 20 or fewer columns in the frame. And finally, the product of thecolumn count and row count must be 64 of less.If the tile width and height are specified, MediaLive will override the videocodec slices field with a value that MediaLive calculates - TilePadding
-
- Type: string
Set to "padded" to force MediaLive to add padding to the frame, to obtain a frame that is a whole multiple of the tile size.If you are setting up the picture as a tile, you must enter "padded".In all other configurations, you typically enter "none". - TileWidth
-
- Type: int
Set this field to set up the picture as a tile. See tileHeight for more information. - TimecodeBurninSettings
-
- Type: TimecodeBurninSettings structure
Timecode burn-in settings - TimecodeInsertion
-
- Type: string
Determines how timecodes should be inserted into the video elementary stream.- 'disabled': Do not include timecodes- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config - TreeblockSize
-
- Type: string
Select the tree block size used for encoding. If you enter "auto", the encoder will pick the best size. If you are setting up the picture as a tile, you must set this to 32x32. In all other configurations, you typically enter "auto".
Hdr10Settings
Description
Hdr10 Settings
Members
- MaxCll
-
- Type: int
Maximum Content Light LevelAn integer metadata value defining the maximum light level, in nits,of any single pixel within an encoded HDR video stream or file. - MaxFall
-
- Type: int
Maximum Frame Average Light LevelAn integer metadata value defining the maximum average light level, in nits,for any single frame within an encoded HDR video stream or file.
HlsAkamaiSettings
Description
Hls Akamai Settings
Members
- ConnectionRetryInterval
-
- Type: int
Number of seconds to wait before retrying connection to the CDN if the connection is lost. - FilecacheDuration
-
- Type: int
Size in seconds of file cache for streaming outputs. - HttpTransferMode
-
- Type: string
Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. - NumRetries
-
- Type: int
Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3. - RestartDelay
-
- Type: int
If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. - Salt
-
- Type: string
Salt for authenticated Akamai. - Token
-
- Type: string
Token parameter for authenticated akamai. If not specified, _gda_ is used.
HlsBasicPutSettings
Description
Hls Basic Put Settings
Members
- ConnectionRetryInterval
-
- Type: int
Number of seconds to wait before retrying connection to the CDN if the connection is lost. - FilecacheDuration
-
- Type: int
Size in seconds of file cache for streaming outputs. - NumRetries
-
- Type: int
Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3. - RestartDelay
-
- Type: int
If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsCdnSettings
Description
Hls Cdn Settings
Members
- HlsAkamaiSettings
-
- Type: HlsAkamaiSettings structure
Hls Akamai Settings - HlsBasicPutSettings
-
- Type: HlsBasicPutSettings structure
Hls Basic Put Settings - HlsMediaStoreSettings
-
- Type: HlsMediaStoreSettings structure
Hls Media Store Settings - HlsS3Settings
-
- Type: HlsS3Settings structure
Hls S3 Settings - HlsWebdavSettings
-
- Type: HlsWebdavSettings structure
Hls Webdav Settings
HlsGroupSettings
Description
Hls Group Settings
Members
- AdMarkers
-
- Type: Array of strings
Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs. - BaseUrlContent
-
- Type: string
A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. - BaseUrlContent1
-
- Type: string
Optional. One value per output group.This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0. - BaseUrlManifest
-
- Type: string
A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. - BaseUrlManifest1
-
- Type: string
Optional. One value per output group.Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0. - CaptionLanguageMappings
-
- Type: Array of CaptionLanguageMapping structures
Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert". - CaptionLanguageSetting
-
- Type: string
Applies only to 608 Embedded output captions.insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions.none: Include CLOSED-CAPTIONS=NONE line in the manifest.omit: Omit any CLOSED-CAPTIONS line from the manifest. - ClientCache
-
- Type: string
When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. - CodecSpecification
-
- Type: string
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. - ConstantIv
-
- Type: string
For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption. - Destination
-
- Required: Yes
- Type: OutputLocationRef structure
A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled). - DirectoryStructure
-
- Type: string
Place segments in subdirectories. - DiscontinuityTags
-
- Type: string
Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose.Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags. - EncryptionType
-
- Type: string
Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. - HlsCdnSettings
-
- Type: HlsCdnSettings structure
Parameters that control interactions with the CDN. - HlsId3SegmentTagging
-
- Type: string
State of HLS ID3 Segment Tagging - IFrameOnlyPlaylists
-
- Type: string
DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888" - IncompleteSegmentBehavior
-
- Type: string
Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups.Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior. - IndexNSegments
-
- Type: int
Applies only if Mode field is LIVE.Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field. - InputLossAction
-
- Type: string
Parameter that control output group behavior on input loss. - IvInManifest
-
- Type: string
For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. - IvSource
-
- Type: string
For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. - KeepSegments
-
- Type: int
Applies only if Mode field is LIVE.Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1).If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player. - KeyFormat
-
- Type: string
The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given. - KeyFormatVersions
-
- Type: string
Either a single positive integer version value or a slash delimited list of version values (1/2/3). - KeyProviderSettings
-
- Type: KeyProviderSettings structure
The key provider settings. - ManifestCompression
-
- Type: string
When set to gzip, compresses HLS playlist. - ManifestDurationFormat
-
- Type: string
Indicates whether the output manifest should use floating point or integer values for segment duration. - MinSegmentLength
-
- Type: int
Minimum length of MPEG-2 Transport Stream segments in seconds. When set, minimum segment length is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed. - Mode
-
- Type: string
If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event.VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. - OutputSelection
-
- Type: string
MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group.VARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest.SEGMENTS_ONLY: Does not generate any manifests for this output group. - ProgramDateTime
-
- Type: string
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock. - ProgramDateTimeClock
-
- Type: string
Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include:INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment.SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock. - ProgramDateTimePeriod
-
- Type: int
Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. - RedundantManifest
-
- Type: string
ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines.DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only.For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. - SegmentLength
-
- Type: int
Length of MPEG-2 Transport Stream segments to create in seconds. Note that segments will end on the next keyframe after this duration, so actual segment length may be longer. - SegmentationMode
-
- Type: string
useInputSegmentation has been deprecated. The configured segment size is always used. - SegmentsPerSubdirectory
-
- Type: int
Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect. - StreamInfResolution
-
- Type: string
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. - TimedMetadataId3Frame
-
- Type: string
Indicates ID3 frame that has the timecode. - TimedMetadataId3Period
-
- Type: int
Timed Metadata interval in seconds. - TimestampDeltaMilliseconds
-
- Type: int
Provides an extra millisecond delta offset to fine tune the timestamps. - TsFileMode
-
- Type: string
SEGMENTED_FILES: Emit the program as segments - multiple .ts media files.SINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
HlsId3SegmentTaggingScheduleActionSettings
Description
Settings for the action to insert ID3 metadata in every segment, in HLS output groups.
Members
- Id3
-
- Type: string
Complete this parameter if you want to specify the entire ID3 metadata. Enter a base64 string that contains one or more fully formed ID3 tags, according to the ID3 specification: http://id3.org/id3v2.4.0-structure - Tag
-
- Type: string
Complete this parameter if you want to specify only the metadata, not the entire frame. MediaLive will insert the metadata in a TXXX frame. Enter the value as plain text. You can include standard MediaLive variable data such as the current segment number.
HlsInputSettings
Description
Hls Input Settings
Members
- Bandwidth
-
- Type: int
When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest. - BufferSegments
-
- Type: int
When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8. - Retries
-
- Type: int
The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable. - RetryInterval
-
- Type: int
The number of seconds between retries when an attempt to read a manifest or segment fails. - Scte35Source
-
- Type: string
Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected.
HlsMediaStoreSettings
Description
Hls Media Store Settings
Members
- ConnectionRetryInterval
-
- Type: int
Number of seconds to wait before retrying connection to the CDN if the connection is lost. - FilecacheDuration
-
- Type: int
Size in seconds of file cache for streaming outputs. - MediaStoreStorageClass
-
- Type: string
When set to temporal, output files are stored in non-persistent memory for faster reading and writing. - NumRetries
-
- Type: int
Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3. - RestartDelay
-
- Type: int
If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HlsOutputSettings
Description
Hls Output Settings
Members
- H265PackagingType
-
- Type: string
Only applicable when this output is referencing an H.265 video description.Specifies whether MP4 segments should be packaged as HEV1 or HVC1. - HlsSettings
-
- Required: Yes
- Type: HlsSettings structure
Settings regarding the underlying stream. These settings are different for audio-only outputs. - NameModifier
-
- Type: string
String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters. - SegmentModifier
-
- Type: string
String concatenated to end of segment filenames.
HlsS3Settings
Description
Hls S3 Settings
Members
- CannedAcl
-
- Type: string
Specify the canned ACL to apply to each S3 request. Defaults to none.
HlsSettings
Description
Hls Settings
Members
- AudioOnlyHlsSettings
-
- Type: AudioOnlyHlsSettings structure
Audio Only Hls Settings - Fmp4HlsSettings
-
- Type: Fmp4HlsSettings structure
Fmp4 Hls Settings - FrameCaptureHlsSettings
-
- Type: FrameCaptureHlsSettings structure
Frame Capture Hls Settings - StandardHlsSettings
-
- Type: StandardHlsSettings structure
Standard Hls Settings
HlsTimedMetadataScheduleActionSettings
Description
Settings for the action to insert ID3 metadata (as a one-time action) in HLS output groups.
Members
- Id3
-
- Required: Yes
- Type: string
Enter a base64 string that contains one or more fully formed ID3 tags.See the ID3 specification: http://id3.org/id3v2.4.0-structure
HlsWebdavSettings
Description
Hls Webdav Settings
Members
- ConnectionRetryInterval
-
- Type: int
Number of seconds to wait before retrying connection to the CDN if the connection is lost. - FilecacheDuration
-
- Type: int
Size in seconds of file cache for streaming outputs. - HttpTransferMode
-
- Type: string
Specify whether or not to use chunked transfer encoding to WebDAV. - NumRetries
-
- Type: int
Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3. - RestartDelay
-
- Type: int
If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
HtmlMotionGraphicsSettings
Description
Html Motion Graphics Settings
Members
ImmediateModeScheduleActionStartSettings
Description
Settings to configure an action so that it occurs as soon as possible.
Members
Input
Members
- Arn
-
- Type: string
The Unique ARN of the input (generated, immutable). - AttachedChannels
-
- Type: Array of strings
A list of channel IDs that that input is attached to (currently an input can only be attached to one channel). - Destinations
-
- Type: Array of InputDestination structures
A list of the destinations of the input (PUSH-type). - Id
-
- Type: string
The generated ID of the input (unique for user account, immutable). - InputClass
-
- Type: string
STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input. - InputDevices
-
- Type: Array of InputDeviceSettings structures
Settings for the input devices. - InputNetworkLocation
-
- Type: string
The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem foran input in a customer network. - InputPartnerIds
-
- Type: Array of strings
A list of IDs for all Inputs which are partners of this one. - InputSourceType
-
- Type: string
Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changesduring input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs. - MediaConnectFlows
-
- Type: Array of MediaConnectFlow structures
A list of MediaConnect Flows for this input. - MulticastSettings
-
- Type: MulticastSettings structure
Multicast Input settings. - Name
-
- Type: string
The user-assigned name (This is a mutable value). - RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role this input assumes during and after creation. - SecurityGroups
-
- Type: Array of strings
A list of IDs for all the Input Security Groups attached to the input. - Sources
-
- Type: Array of InputSource structures
A list of the sources of the input (PULL-type). - SrtSettings
-
- Type: SrtSettings structure
The settings associated with an SRT input. - State
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs. - Type
-
- Type: string
The different types of inputs that AWS Elemental MediaLive supports.
InputAttachment
Members
- AutomaticInputFailoverSettings
-
- Type: AutomaticInputFailoverSettings structure
User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input. - InputAttachmentName
-
- Type: string
User-specified name for the attachment. This is required if the user wants to use this input in an input switch action. - InputId
-
- Type: string
The ID of the input - InputSettings
-
- Type: InputSettings structure
Settings of an input (caption selector, etc.) - LogicalInterfaceNames
-
- Type: Array of strings
Optional assignment of an input to a logical interface on the Node. Only applies to on premises channels.
InputChannelLevel
Description
Input Channel Level
Members
- Gain
-
- Required: Yes
- Type: int
Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB. - InputChannel
-
- Required: Yes
- Type: int
The index of the input channel used as a source.
InputClippingSettings
Description
Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.
Members
- InputTimecodeSource
-
- Required: Yes
- Type: string
The source of the timecodes in the source being clipped. - StartTimecode
-
- Type: StartTimecode structure
Settings to identify the start of the clip. - StopTimecode
-
- Type: StopTimecode structure
Settings to identify the end of the clip.
InputDestination
Description
The settings for a PUSH type input.
Members
- Ip
-
- Type: string
The system-generated static IP address of endpoint.It remains fixed for the lifetime of the input. - Network
-
- Type: string
The ID of the attached network. - NetworkRoutes
-
- Type: Array of InputDestinationRoute structures
If the push input has an input location of ON-PREM it's a requirement to specify what the route of the inputis going to be on the customer local network. - Port
-
- Type: string
The port number for the input. - Url
-
- Type: string
This represents the endpoint that the customer stream will bepushed to. - Vpc
-
- Type: InputDestinationVpc structure
The properties for a VPC type input destination.
InputDestinationRequest
Description
Endpoint settings for a PUSH type input.
Members
- Network
-
- Type: string
If the push input has an input location of ON-PREM, ID the ID of the attached network. - NetworkRoutes
-
- Type: Array of InputRequestDestinationRoute structures
If the push input has an input location of ON-PREM it's a requirement to specify what the route of the inputis going to be on the customer local network. - StaticIpAddress
-
- Type: string
If the push input has an input location of ON-PREM it's optional to specify what the ip addressof the input is going to be on the customer local network. - StreamName
-
- Type: string
A unique name for the location the RTMP stream is being pushedto.
InputDestinationRoute
Description
A network route configuration.
Members
- Cidr
-
- Type: string
The CIDR of the route. - Gateway
-
- Type: string
An optional gateway for the route.
InputDestinationVpc
Description
The properties for a VPC type input destination.
Members
- AvailabilityZone
-
- Type: string
The availability zone of the Input destination. - NetworkInterfaceId
-
- Type: string
The network interface ID of the Input destination in the VPC.
InputDevice
Description
An input device.
Members
- Arn
-
- Type: string
The unique ARN of the input device. - AvailabilityZone
-
- Type: string
The Availability Zone associated with this input device. - ConnectionState
-
- Type: string
The state of the connection between the input device and AWS. - DeviceSettingsSyncState
-
- Type: string
The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration. - DeviceUpdateStatus
-
- Type: string
The status of software on the input device. - HdDeviceSettings
-
- Type: InputDeviceHdSettings structure
Settings that describe an input device that is type HD. - Id
-
- Type: string
The unique ID of the input device. - MacAddress
-
- Type: string
The network MAC address of the input device. - MedialiveInputArns
-
- Type: Array of strings
An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT. - Name
-
- Type: string
A name that you specify for the input device. - NetworkSettings
-
- Type: InputDeviceNetworkSettings structure
The network settings for the input device. - OutputType
-
- Type: string
The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input. - SerialNumber
-
- Type: string
The unique serial number of the input device. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs. - Type
-
- Type: string
The type of the input device. - UhdDeviceSettings
-
- Type: InputDeviceUhdSettings structure
Settings that describe an input device that is type UHD.
InputDeviceConfigurableAudioChannelPairConfig
Description
One audio configuration that specifies the format for one audio pair that the device produces as output.
Members
- Id
-
- Type: int
The ID for one audio pair configuration, a value from 1 to 8. - Profile
-
- Type: string
The profile to set for one audio pair configuration. Choose an enumeration value. Each value describes one audio configuration using the format (rate control algorithm)-(codec)_(quality)-(bitrate in bytes). For example, CBR-AAC_HQ-192000. Or choose DISABLED, in which case the device won't produce audio for this pair.
InputDeviceConfigurableSettings
Description
Configurable settings for the input device.
Members
- AudioChannelPairs
-
- Type: Array of InputDeviceConfigurableAudioChannelPairConfig structures
An array of eight audio configurations, one for each audio pair in the source. Set up each audio configuration either to exclude the pair, or to format it and include it in the output from the device. This parameter applies only to UHD devices, and only when the device is configured as the source for a MediaConnect flow. For an HD device, you configure the audio by setting up audio selectors in the channel configuration. - Codec
-
- Type: string
Choose the codec for the video that the device produces. Only UHD devices can specify this parameter. - ConfiguredInput
-
- Type: string
The input source that you want to use. If the device has a source connected to only one of its input ports, or if you don't care which source the device sends, specify Auto. If the device has sources connected to both its input ports, and you want to use a specific source, specify the source. - LatencyMs
-
- Type: int
The Link device's buffer size (latency) in milliseconds (ms). - MaxBitrate
-
- Type: int
The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video. - MediaconnectSettings
-
- Type: InputDeviceMediaConnectConfigurableSettings structure
To attach this device to a MediaConnect flow, specify these parameters. To detach an existing flow, enter {} for the value of mediaconnectSettings. Only UHD devices can specify this parameter.
InputDeviceConfigurationValidationError
Members
- Message
-
- Type: string
The error message. - ValidationErrors
-
- Type: Array of ValidationError structures
A collection of validation error responses.
InputDeviceHdSettings
Description
Settings that describe the active source from the input device, and the video characteristics of that source.
Members
- ActiveInput
-
- Type: string
If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI). - ConfiguredInput
-
- Type: string
The source at the input device that is currently active. You can specify this source. - DeviceState
-
- Type: string
The state of the input device. - Framerate
-
- Type: double
The frame rate of the video source. - Height
-
- Type: int
The height of the video source, in pixels. - LatencyMs
-
- Type: int
The Link device's buffer size (latency) in milliseconds (ms). You can specify this value. - MaxBitrate
-
- Type: int
The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum. - ScanType
-
- Type: string
The scan type of the video source. - Width
-
- Type: int
The width of the video source, in pixels.
InputDeviceMediaConnectConfigurableSettings
Description
Parameters required to attach a MediaConnect flow to the device.
Members
- FlowArn
-
- Type: string
The ARN of the MediaConnect flow to attach this device to. - RoleArn
-
- Type: string
The ARN for the role that MediaLive assumes to access the attached flow and secret. For more information about how to create this role, see the MediaLive user guide. - SecretArn
-
- Type: string
The ARN for the secret that holds the encryption key to encrypt the content output by the device. - SourceName
-
- Type: string
The name of the MediaConnect Flow source to stream to.
InputDeviceMediaConnectSettings
Description
Information about the MediaConnect flow attached to the device.
Members
- FlowArn
-
- Type: string
The ARN of the MediaConnect flow. - RoleArn
-
- Type: string
The ARN for the role that MediaLive assumes to access the attached flow and secret. - SecretArn
-
- Type: string
The ARN of the secret used to encrypt the stream. - SourceName
-
- Type: string
The name of the MediaConnect flow source.
InputDeviceNetworkSettings
Description
The network settings for the input device.
Members
- DnsAddresses
-
- Type: Array of strings
The DNS addresses of the input device. - Gateway
-
- Type: string
The network gateway IP address. - IpAddress
-
- Type: string
The IP address of the input device. - IpScheme
-
- Type: string
Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address. - SubnetMask
-
- Type: string
The subnet mask of the input device.
InputDeviceRequest
Description
Settings for an input device.
Members
- Id
-
- Type: string
The unique ID for the device.
InputDeviceSettings
Description
Settings for an input device.
Members
- Id
-
- Type: string
The unique ID for the device.
InputDeviceSummary
Description
Details of the input device.
Members
- Arn
-
- Type: string
The unique ARN of the input device. - AvailabilityZone
-
- Type: string
The Availability Zone associated with this input device. - ConnectionState
-
- Type: string
The state of the connection between the input device and AWS. - DeviceSettingsSyncState
-
- Type: string
The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration. - DeviceUpdateStatus
-
- Type: string
The status of software on the input device. - HdDeviceSettings
-
- Type: InputDeviceHdSettings structure
Settings that describe an input device that is type HD. - Id
-
- Type: string
The unique ID of the input device. - MacAddress
-
- Type: string
The network MAC address of the input device. - MedialiveInputArns
-
- Type: Array of strings
An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT. - Name
-
- Type: string
A name that you specify for the input device. - NetworkSettings
-
- Type: InputDeviceNetworkSettings structure
Network settings for the input device. - OutputType
-
- Type: string
The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input. - SerialNumber
-
- Type: string
The unique serial number of the input device. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs. - Type
-
- Type: string
The type of the input device. - UhdDeviceSettings
-
- Type: InputDeviceUhdSettings structure
Settings that describe an input device that is type UHD.
InputDeviceUhdAudioChannelPairConfig
Description
One audio configuration that specifies the format for one audio pair that the device produces as output.
Members
- Id
-
- Type: int
The ID for one audio pair configuration, a value from 1 to 8. - Profile
-
- Type: string
The profile for one audio pair configuration. This property describes one audio configuration in the format (rate control algorithm)-(codec)_(quality)-(bitrate in bytes). For example, CBR-AAC_HQ-192000. Or DISABLED, in which case the device won't produce audio for this pair.
InputDeviceUhdSettings
Description
Settings that describe the active source from the input device, and the video characteristics of that source.
Members
- ActiveInput
-
- Type: string
If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI). - AudioChannelPairs
-
- Type: Array of InputDeviceUhdAudioChannelPairConfig structures
An array of eight audio configurations, one for each audio pair in the source. Each audio configuration specifies either to exclude the pair, or to format it and include it in the output from the UHD device. Applies only when the device is configured as the source for a MediaConnect flow. - Codec
-
- Type: string
The codec for the video that the device produces. - ConfiguredInput
-
- Type: string
The source at the input device that is currently active. You can specify this source. - DeviceState
-
- Type: string
The state of the input device. - Framerate
-
- Type: double
The frame rate of the video source. - Height
-
- Type: int
The height of the video source, in pixels. - LatencyMs
-
- Type: int
The Link device's buffer size (latency) in milliseconds (ms). You can specify this value. - MaxBitrate
-
- Type: int
The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum. - MediaconnectSettings
-
- Type: InputDeviceMediaConnectSettings structure
Information about the MediaConnect flow attached to the device. Returned only if the outputType is MEDIACONNECT_FLOW. - ScanType
-
- Type: string
The scan type of the video source. - Width
-
- Type: int
The width of the video source, in pixels.
InputLocation
Description
Input Location
Members
- PasswordParam
-
- Type: string
key used to extract the password from EC2 Parameter store - Uri
-
- Required: Yes
- Type: string
Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live". - Username
-
- Type: string
Username if credentials are required to access a file or publishing point. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://"
InputLossBehavior
Description
Input Loss Behavior
Members
- BlackFrameMsec
-
- Type: int
On input loss, the number of milliseconds to substitute black into the output before switching to the frame specified by inputLossImageType. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. - InputLossImageColor
-
- Type: string
When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB. - InputLossImageSlate
-
- Type: InputLocation structure
When input loss image type is "slate" these fields specify the parameters for accessing the slate. - InputLossImageType
-
- Type: string
Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. - RepeatFrameMsec
-
- Type: int
On input loss, the number of milliseconds to repeat the previous picture before substituting black into the output. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite.
InputLossFailoverSettings
Description
MediaLive will perform a failover if content is not detected in this input for the specified period.
Members
- InputLossThresholdMsec
-
- Type: int
The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur.
InputPrepareScheduleActionSettings
Description
Action to prepare an input for a future immediate input switch.
Members
- InputAttachmentNameReference
-
- Type: string
The name of the input attachment that should be prepared by this action. If no name is provided, the action will stop the most recent prepare (if any) when activated. - InputClippingSettings
-
- Type: InputClippingSettings structure
Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file. - UrlPath
-
- Type: Array of strings
The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source.
InputRequestDestinationRoute
Description
A network route configuration.
Members
- Cidr
-
- Type: string
The CIDR of the route. - Gateway
-
- Type: string
An optional gateway for the route.
InputSecurityGroup
Description
An Input Security Group
Members
- Arn
-
- Type: string
Unique ARN of Input Security Group - Id
-
- Type: string
The Id of the Input Security Group - Inputs
-
- Type: Array of strings
The list of inputs currently using this Input Security Group. - State
-
- Type: string
The current state of the Input Security Group. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs. - WhitelistRules
-
- Type: Array of InputWhitelistRule structures
Whitelist rules and their sync status
InputSecurityGroupWhitelistRequest
Description
Request of IPv4 CIDR addresses to whitelist in a security group.
Members
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs. - WhitelistRules
-
- Type: Array of InputWhitelistRuleCidr structures
List of IPv4 CIDR addresses to whitelist
InputSettings
Description
Live Event input parameters. There can be multiple inputs in a single Live Event.
Members
- AudioSelectors
-
- Type: Array of AudioSelector structures
Used to select the audio stream to decode for inputs that have multiple available. - CaptionSelectors
-
- Type: Array of CaptionSelector structures
Used to select the caption input to use for inputs that have multiple available. - DeblockFilter
-
- Type: string
Enable or disable the deblock filter when filtering. - DenoiseFilter
-
- Type: string
Enable or disable the denoise filter when filtering. - FilterStrength
-
- Type: int
Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest). - InputFilter
-
- Type: string
Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default.1) auto - filtering will be applied depending on input type/quality2) disabled - no filtering will be applied to the input3) forced - filtering will be applied regardless of input type - NetworkInputSettings
-
- Type: NetworkInputSettings structure
Input settings. - Scte35Pid
-
- Type: int
PID from which to read SCTE-35 messages. If left undefined, EML will select the first SCTE-35 PID found in the input. - Smpte2038DataPreference
-
- Type: string
Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages.- PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any).- IGNORE: Never extract any ancillary data from SMPTE-2038. - SourceEndBehavior
-
- Type: string
Loop input if it is a file. This allows a file input to be streamed indefinitely. - VideoSelector
-
- Type: VideoSelector structure
Informs which video elementary stream to decode for input types that have multiple available.
InputSource
Description
The settings for a PULL type input.
Members
- PasswordParam
-
- Type: string
The key used to extract the password from EC2 Parameter store. - Url
-
- Type: string
This represents the customer's source URL where stream ispulled from. - Username
-
- Type: string
The username for the input source.
InputSourceRequest
Description
Settings for for a PULL type input.
Members
- PasswordParam
-
- Type: string
The key used to extract the password from EC2 Parameter store. - Url
-
- Type: string
This represents the customer's source URL where stream ispulled from. - Username
-
- Type: string
The username for the input source.
InputSpecification
Members
- Codec
-
- Type: string
Input codec - MaximumBitrate
-
- Type: string
Maximum input bitrate, categorized coarsely - Resolution
-
- Type: string
Input resolution, categorized coarsely
InputSwitchScheduleActionSettings
Description
Settings for the "switch input" action: to switch from ingesting one input to ingesting another input.
Members
- InputAttachmentNameReference
-
- Required: Yes
- Type: string
The name of the input attachment (not the name of the input!) to switch to. The name is specified in the channel configuration. - InputClippingSettings
-
- Type: InputClippingSettings structure
Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file. - UrlPath
-
- Type: Array of strings
The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source.
InputVpcRequest
Description
Settings for a private VPC Input.When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses.This property requires setting the roleArn property on Input creation.Not compatible with the inputSecurityGroups property.
Members
- SecurityGroupIds
-
- Type: Array of strings
A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces.Requires subnetIds. If none are specified then the VPC default security group will be used. - SubnetIds
-
- Required: Yes
- Type: Array of strings
A list of 2 VPC subnet IDs from the same VPC.Subnet IDs must be mapped to two unique availability zones (AZ).
InputWhitelistRule
Description
Whitelist rule
Members
- Cidr
-
- Type: string
The IPv4 CIDR that's whitelisted.
InputWhitelistRuleCidr
Description
An IPv4 CIDR to whitelist.
Members
- Cidr
-
- Type: string
The IPv4 CIDR to whitelist.
InterfaceMapping
Description
Used in ClusterNetworkSettings
Members
- LogicalInterfaceName
-
- Type: string
The logical name for one interface (on every Node) that handles a specific type of traffic. We recommend that the name hints at the physical interface it applies to. For example, it could refer to the traffic that the physical interface handles. For example, my-Inputs-Interface. - NetworkId
-
- Type: string
The ID of the network that you want to connect to the specified logicalInterfaceName.
InterfaceMappingCreateRequest
Description
Used in ClusterNetworkSettingsCreateRequest.
Members
- LogicalInterfaceName
-
- Type: string
The logical name for one interface (on every Node) that handles a specific type of traffic. We recommend that the name hints at the physical interface it applies to. For example, it could refer to the traffic that the physical interface handles. For example, my-Inputs-Interface. - NetworkId
-
- Type: string
The ID of the network that you want to connect to the specified logicalInterfaceName.
InterfaceMappingUpdateRequest
Members
- LogicalInterfaceName
-
- Type: string
The logical name for one interface (on every Node) that handles a specific type of traffic. We recommend that the name hints at the physical interface it applies to. For example, it could refer to the traffic that the physical interface handles. For example, my-Inputs-Interface. - NetworkId
-
- Type: string
The ID of the network that you want to connect to the specified logicalInterfaceName. You can use the ListNetworks operation to discover all the IDs.
InternalServerErrorException
Members
- Message
-
- Type: string
InternalServerErrorExceptionResponseContent
Description
Unexpected error during processing of request.
Members
- Message
-
- Type: string
Exception error message.
InternalServiceError
Members
- Message
-
- Type: string
InvalidRequest
Members
- Message
-
- Type: string
IpPool
Description
Used in DescribeNetworkResult, DescribeNetworkSummary, UpdateNetworkResult.
Members
- Cidr
-
- Type: string
A CIDR block of IP addresses that are reserved for MediaLive Anywhere.
IpPoolCreateRequest
Description
Used in CreateNetworkRequest.
Members
- Cidr
-
- Type: string
A CIDR block of IP addresses to reserve for MediaLive Anywhere.
IpPoolUpdateRequest
Description
Used in UpdateNetworkRequest.
Members
- Cidr
-
- Type: string
A CIDR block of IP addresses to reserve for MediaLive Anywhere.
KeyProviderSettings
Description
Key Provider Settings
Members
- StaticKeySettings
-
- Type: StaticKeySettings structure
Static Key Settings
LimitExceeded
Members
- Message
-
- Type: string
ListChannelPlacementGroupsResult
Description
Contains the response for ListChannelPlacementGroups.
Members
- ChannelPlacementGroups
-
- Type: Array of DescribeChannelPlacementGroupSummary structures
An array of ChannelPlacementGroups that exist in the Cluster. - NextToken
-
- Type: string
Token for the next result.
ListChannelsResultModel
Members
- Channels
-
- Type: Array of ChannelSummary structures
- NextToken
-
- Type: string
ListCloudWatchAlarmTemplateGroupsResponseContent
Members
- CloudWatchAlarmTemplateGroups
-
- Required: Yes
- Type: Array of CloudWatchAlarmTemplateGroupSummary structures
- NextToken
-
- Type: string
A token used to retrieve the next set of results in paginated list responses.
ListCloudWatchAlarmTemplatesResponseContent
Members
- CloudWatchAlarmTemplates
-
- Required: Yes
- Type: Array of CloudWatchAlarmTemplateSummary structures
- NextToken
-
- Type: string
A token used to retrieve the next set of results in paginated list responses.
ListClustersResult
Description
Contains the response for ListClusters.
Members
- Clusters
-
- Type: Array of DescribeClusterSummary structures
A list of the Clusters that exist in your AWS account. - NextToken
-
- Type: string
Token for the next result.
ListEventBridgeRuleTemplateGroupsResponseContent
Members
- EventBridgeRuleTemplateGroups
-
- Required: Yes
- Type: Array of EventBridgeRuleTemplateGroupSummary structures
- NextToken
-
- Type: string
A token used to retrieve the next set of results in paginated list responses.
ListEventBridgeRuleTemplatesResponseContent
Members
- EventBridgeRuleTemplates
-
- Required: Yes
- Type: Array of EventBridgeRuleTemplateSummary structures
- NextToken
-
- Type: string
A token used to retrieve the next set of results in paginated list responses.
ListInputDeviceTransfersResultModel
Description
The list of input devices in the transferred state. The recipient hasn't yet accepted or rejected the transfer.
Members
- InputDeviceTransfers
-
- Type: Array of TransferringInputDeviceSummary structures
The list of devices that you are transferring or are being transferred to you. - NextToken
-
- Type: string
A token to get additional list results.
ListInputDevicesResultModel
Description
The list of input devices owned by the AWS account.
Members
- InputDevices
-
- Type: Array of InputDeviceSummary structures
The list of input devices. - NextToken
-
- Type: string
A token to get additional list results.
ListInputSecurityGroupsResultModel
Description
Result of input security group list request
Members
- InputSecurityGroups
-
- Type: Array of InputSecurityGroup structures
List of input security groups - NextToken
-
- Type: string
ListInputsResultModel
Members
- Inputs
-
- Type: Array of Input structures
- NextToken
-
- Type: string
ListMultiplexProgramsResultModel
Members
- MultiplexPrograms
-
- Type: Array of MultiplexProgramSummary structures
List of multiplex programs. - NextToken
-
- Type: string
Token for the next ListMultiplexProgram request.
ListMultiplexesResultModel
Members
- Multiplexes
-
- Type: Array of MultiplexSummary structures
List of multiplexes. - NextToken
-
- Type: string
Token for the next ListMultiplexes request.
ListNetworksResult
Description
Contains the response for ListNetworks
Members
- Networks
-
- Type: Array of DescribeNetworkSummary structures
An array of networks that you have created. - NextToken
-
- Type: string
Token for the next ListNetworks request.
ListNodesResult
Description
Contains the response for ListNodes.
Members
- NextToken
-
- Type: string
Token for the next result. - Nodes
-
- Type: Array of DescribeNodeSummary structures
An array of Nodes that exist in the Cluster.
ListOfferingsResultModel
Description
ListOfferings response
Members
- NextToken
-
- Type: string
Token to retrieve the next page of results - Offerings
-
- Type: Array of Offering structures
List of offerings
ListReservationsResultModel
Description
ListReservations response
Members
- NextToken
-
- Type: string
Token to retrieve the next page of results - Reservations
-
- Type: Array of Reservation structures
List of reservations
ListSignalMapsResponseContent
Members
- NextToken
-
- Type: string
A token used to retrieve the next set of results in paginated list responses. - SignalMaps
-
- Required: Yes
- Type: Array of SignalMapSummary structures
M2tsSettings
Description
M2ts Settings
Members
- AbsentInputAudioBehavior
-
- Type: string
When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. - Arib
-
- Type: string
When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. - AribCaptionsPid
-
- Type: string
Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). - AribCaptionsPidControl
-
- Type: string
If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. - AudioBufferModel
-
- Type: string
When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. - AudioFramesPerPes
-
- Type: int
The number of audio frames to insert for each PES packet. - AudioPids
-
- Type: string
Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). - AudioStreamType
-
- Type: string
When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. - Bitrate
-
- Type: int
The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. - BufferModel
-
- Type: string
Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices. - CcDescriptor
-
- Type: string
When set to enabled, generates captionServiceDescriptor in PMT. - DvbNitSettings
-
- Type: DvbNitSettings structure
Inserts DVB Network Information Table (NIT) at the specified table repetition interval. - DvbSdtSettings
-
- Type: DvbSdtSettings structure
Inserts DVB Service Description Table (SDT) at the specified table repetition interval. - DvbSubPids
-
- Type: string
Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). - DvbTdtSettings
-
- Type: DvbTdtSettings structure
Inserts DVB Time and Date Table (TDT) at the specified table repetition interval. - DvbTeletextPid
-
- Type: string
Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). - Ebif
-
- Type: string
If set to passthrough, passes any EBIF data from the input source to this output. - EbpAudioInterval
-
- Type: string
When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. - EbpLookaheadMs
-
- Type: int
When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate. - EbpPlacement
-
- Type: string
Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. - EcmPid
-
- Type: string
This field is unused and deprecated. - EsRateInPes
-
- Type: string
Include or exclude the ES Rate field in the PES header. - EtvPlatformPid
-
- Type: string
Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). - EtvSignalPid
-
- Type: string
Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). - FragmentTime
-
- Type: double
The length in seconds of each fragment. Only used with EBP markers. - Klv
-
- Type: string
If set to passthrough, passes any KLV data from the input source to this output. - KlvDataPids
-
- Type: string
Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). - NielsenId3Behavior
-
- Type: string
If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. - NullPacketBitrate
-
- Type: double
Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets. - PatInterval
-
- Type: int
The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. - PcrControl
-
- Type: string
When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. - PcrPeriod
-
- Type: int
Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream. - PcrPid
-
- Type: string
Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). - PmtInterval
-
- Type: int
The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. - PmtPid
-
- Type: string
Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). - ProgramNum
-
- Type: int
The value of the program number field in the Program Map Table. - RateMode
-
- Type: string
When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. - Scte27Pids
-
- Type: string
Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). - Scte35Control
-
- Type: string
Optionally pass SCTE-35 signals from the input source to this output. - Scte35Pid
-
- Type: string
Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). - Scte35PrerollPullupMilliseconds
-
- Type: double
Defines the amount SCTE-35 preroll will be increased (in milliseconds) on the output. Preroll is the amount of time between the presence of a SCTE-35 indication in a transport stream and the PTS of the video frame it references. Zero means don't add pullup (it doesn't mean set the preroll to zero). Negative pullup is not supported, which means that you can't make the preroll shorter. Be aware that latency in the output will increase by the pullup amount. - SegmentationMarkers
-
- Type: string
Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. - SegmentationStyle
-
- Type: string
The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted.When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds.When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. - SegmentationTime
-
- Type: double
The length in seconds of each segment. Required unless markers is set to _none_. - TimedMetadataBehavior
-
- Type: string
When set to passthrough, timed metadata will be passed through from input to output. - TimedMetadataPid
-
- Type: string
Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). - TransportStreamId
-
- Type: int
The value of the transport stream ID field in the Program Map Table. - VideoPid
-
- Type: string
Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
M3u8Settings
Description
Settings information for the .m3u8 container
Members
- AudioFramesPerPes
-
- Type: int
The number of audio frames to insert for each PES packet. - AudioPids
-
- Type: string
Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. - EcmPid
-
- Type: string
This parameter is unused and deprecated. - KlvBehavior
-
- Type: string
If set to passthrough, passes any KLV data from the input source to this output. - KlvDataPids
-
- Type: string
Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). - NielsenId3Behavior
-
- Type: string
If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. - PatInterval
-
- Type: int
The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file. - PcrControl
-
- Type: string
When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. - PcrPeriod
-
- Type: int
Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream. - PcrPid
-
- Type: string
Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. - PmtInterval
-
- Type: int
The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file. - PmtPid
-
- Type: string
Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. - ProgramNum
-
- Type: int
The value of the program number field in the Program Map Table. - Scte35Behavior
-
- Type: string
If set to passthrough, passes any SCTE-35 signals from the input source to this output. - Scte35Pid
-
- Type: string
Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. - TimedMetadataBehavior
-
- Type: string
Set to PASSTHROUGH to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group or individual outputs, or you add an ID3 action to the channel schedule. - TimedMetadataPid
-
- Type: string
Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). - TransportStreamId
-
- Type: int
The value of the transport stream ID field in the Program Map Table. - VideoPid
-
- Type: string
Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
MaintenanceCreateSettings
Members
- MaintenanceDay
-
- Type: string
Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows. - MaintenanceStartTime
-
- Type: string
Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows.
MaintenanceStatus
Members
- MaintenanceDay
-
- Type: string
The currently selected maintenance day. - MaintenanceDeadline
-
- Type: string
Maintenance is required by the displayed date and time. Date and time is in ISO. - MaintenanceScheduledDate
-
- Type: string
The currently scheduled maintenance date and time. Date and time is in ISO. - MaintenanceStartTime
-
- Type: string
The currently selected maintenance start time. Time is in UTC.
MaintenanceUpdateSettings
Members
- MaintenanceDay
-
- Type: string
Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows. - MaintenanceScheduledDate
-
- Type: string
Choose a specific date for maintenance to occur. The chosen date is used for the next maintenance window only. - MaintenanceStartTime
-
- Type: string
Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows.
MediaConnectFlow
Description
The settings for a MediaConnect Flow.
Members
- FlowArn
-
- Type: string
The unique ARN of the MediaConnect Flow being used as a source.
MediaConnectFlowRequest
Description
The settings for a MediaConnect Flow.
Members
- FlowArn
-
- Type: string
The ARN of the MediaConnect Flow that you want to use as a source.
MediaPackageGroupSettings
Description
Media Package Group Settings
Members
- Destination
-
- Required: Yes
- Type: OutputLocationRef structure
MediaPackage channel destination.
MediaPackageOutputDestinationSettings
Description
MediaPackage Output Destination Settings
Members
- ChannelGroup
-
- Type: string
Name of the channel group in MediaPackageV2. Only use if you are sending CMAF Ingest output to a CMAF ingest endpoint on a MediaPackage channel that uses MediaPackage v2. - ChannelId
-
- Type: string
ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region. - ChannelName
-
- Type: string
Name of the channel in MediaPackageV2. Only use if you are sending CMAF Ingest output to a CMAF ingest endpoint on a MediaPackage channel that uses MediaPackage v2.
MediaPackageOutputSettings
Description
Media Package Output Settings
Members
MediaResource
Description
An AWS resource used in media workflows.
Members
- Destinations
-
- Type: Array of MediaResourceNeighbor structures
- Name
-
- Type: string
The logical name of an AWS media resource. - Sources
-
- Type: Array of MediaResourceNeighbor structures
MediaResourceNeighbor
Description
A direct source or destination neighbor to an AWS media resource.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of a resource used in AWS media workflows. - Name
-
- Type: string
The logical name of an AWS media resource.
MonitorDeployment
Description
Represents the latest monitor deployment of a signal map.
Members
- DetailsUri
-
- Type: string
URI associated with a signal map's monitor deployment. - ErrorMessage
-
- Type: string
Error message associated with a failed monitor deployment of a signal map. - Status
-
- Required: Yes
- Type: string
A signal map's monitor deployment status.
MotionGraphicsActivateScheduleActionSettings
Description
Settings to specify the rendering of motion graphics into the video stream.
Members
- Duration
-
- Type: long (int|float)
Duration (in milliseconds) that motion graphics should render on to the video stream. Leaving out this property or setting to 0 will result in rendering continuing until a deactivate action is processed. - PasswordParam
-
- Type: string
Key used to extract the password from EC2 Parameter store - Url
-
- Type: string
URI of the HTML5 content to be rendered into the live stream. - Username
-
- Type: string
Username if credentials are required to access a file. This must be a reference to an AWS parameter store name from which the password can be retrieved. AWS Parameter store format: \"ssm://\"
MotionGraphicsConfiguration
Description
Motion Graphics Configuration
Members
- MotionGraphicsInsertion
-
- Type: string
Motion Graphics Insertion - MotionGraphicsSettings
-
- Required: Yes
- Type: MotionGraphicsSettings structure
Motion Graphics Settings
MotionGraphicsDeactivateScheduleActionSettings
Description
Settings to specify the ending of rendering motion graphics into the video stream.
Members
MotionGraphicsSettings
Description
Motion Graphics Settings
Members
- HtmlMotionGraphicsSettings
-
- Type: HtmlMotionGraphicsSettings structure
Html Motion Graphics Settings
Mp2Settings
Description
Mp2 Settings
Members
- Bitrate
-
- Type: double
Average bitrate in bits/second. - CodingMode
-
- Type: string
The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). - SampleRate
-
- Type: double
Sample rate in Hz.
Mpeg2FilterSettings
Description
Mpeg2 Filter Settings
Members
- TemporalFilterSettings
-
- Type: TemporalFilterSettings structure
Temporal Filter Settings
Mpeg2Settings
Description
Mpeg2 Settings
Members
- AdaptiveQuantization
-
- Type: string
Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality. - AfdSignaling
-
- Type: string
Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO.AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid).FIXED: MediaLive will use the value you specify in fixedAFD. - ColorMetadata
-
- Type: string
Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata. - ColorSpace
-
- Type: string
Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \"MediaLive Features - Video - color space\" in the MediaLive User Guide.PASSTHROUGH: Keep the color space of the input content - do not convert it.AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709. - DisplayAspectRatio
-
- Type: string
Sets the pixel aspect ratio for the encode. - FilterSettings
-
- Type: Mpeg2FilterSettings structure
Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied.TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean.When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise.When the content is reasonably clean, the filter tends to decrease the bitrate. - FixedAfd
-
- Type: string
Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode. - FramerateDenominator
-
- Required: Yes
- Type: int
description": "The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. - FramerateNumerator
-
- Required: Yes
- Type: int
The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. - GopClosedCadence
-
- Type: int
MPEG2: default is open GOP. - GopNumBFrames
-
- Type: int
Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default. - GopSize
-
- Type: double
Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default.If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1.If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer. - GopSizeUnits
-
- Type: string
Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count. - ScanType
-
- Type: string
Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first). - SubgopLength
-
- Type: string
Relates to the GOP structure. If you do not know what GOP is, use the default.FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames.DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality. - TimecodeBurninSettings
-
- Type: TimecodeBurninSettings structure
Timecode burn-in settings - TimecodeInsertion
-
- Type: string
Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \"MediaLive Features - Timecode configuration\" in the MediaLive User Guide.DISABLED: do not include timecodes.GOP_TIMECODE: Include timecode metadata in the GOP header.
MsSmoothGroupSettings
Description
Ms Smooth Group Settings
Members
- AcquisitionPointId
-
- Type: string
The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE. - AudioOnlyTimecodeControl
-
- Type: string
If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. - CertificateMode
-
- Type: string
If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. - ConnectionRetryInterval
-
- Type: int
Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established. - Destination
-
- Required: Yes
- Type: OutputLocationRef structure
Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS. - EventId
-
- Type: string
MS Smooth event ID to be sent to the IIS server.Should only be specified if eventIdMode is set to useConfigured. - EventIdMode
-
- Type: string
Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run.Options:- "useConfigured" - use the value provided in eventId- "useTimestamp" - generate and send an event ID based on the current timestamp- "noEventId" - do not send an event ID to the IIS server. - EventStopBehavior
-
- Type: string
When set to sendEos, send EOS signal to IIS server when stopping the event - FilecacheDuration
-
- Type: int
Size in seconds of file cache for streaming outputs. - FragmentLength
-
- Type: int
Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate. - InputLossAction
-
- Type: string
Parameter that control output group behavior on input loss. - NumRetries
-
- Type: int
Number of retry attempts. - RestartDelay
-
- Type: int
Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration. - SegmentationMode
-
- Type: string
useInputSegmentation has been deprecated. The configured segment size is always used. - SendDelayMs
-
- Type: int
Number of milliseconds to delay the output from the second pipeline. - SparseTrackType
-
- Type: string
Identifies the type of data to place in the sparse track:- SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment.- SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment.- NONE: Don't generate a sparse track for any outputs in this output group. - StreamManifestBehavior
-
- Type: string
When set to send, send stream manifest so publishing point doesn't start until all streams start. - TimestampOffset
-
- Type: string
Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset. - TimestampOffsetMode
-
- Type: string
Type of timestamp date offset to use.- useEventStartDate: Use the date the event was started as the offset- useConfiguredOffset: Use an explicitly configured date as the offset
MsSmoothOutputSettings
Description
Ms Smooth Output Settings
Members
- H265PackagingType
-
- Type: string
Only applicable when this output is referencing an H.265 video description.Specifies whether MP4 segments should be packaged as HEV1 or HVC1. - NameModifier
-
- Type: string
String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
MulticastInputSettings
Description
Multicast-specific input settings.
Members
- SourceIpAddress
-
- Type: string
Optionally, a source ip address to filter by for Source-specific Multicast (SSM)
MulticastSettings
Description
Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses.
Members
- Sources
-
- Type: Array of MulticastSource structures
MulticastSettingsCreateRequest
Description
Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses.
Members
- Sources
-
- Type: Array of MulticastSourceCreateRequest structures
MulticastSettingsUpdateRequest
Description
Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses.
Members
- Sources
-
- Type: Array of MulticastSourceUpdateRequest structures
MulticastSource
Description
Pair of multicast url and source ip address (optional) that make up a multicast source.
Members
- SourceIp
-
- Type: string
This represents the ip address of the device sending the multicast stream. - Url
-
- Required: Yes
- Type: string
This represents the customer's source URL where multicast stream is pulled from.
MulticastSourceCreateRequest
Description
Pair of multicast url and source ip address (optional) that make up a multicast source.
Members
- SourceIp
-
- Type: string
This represents the ip address of the device sending the multicast stream. - Url
-
- Required: Yes
- Type: string
This represents the customer's source URL where multicast stream is pulled from.
MulticastSourceUpdateRequest
Description
Pair of multicast url and source ip address (optional) that make up a multicast source.
Members
- SourceIp
-
- Type: string
This represents the ip address of the device sending the multicast stream. - Url
-
- Required: Yes
- Type: string
This represents the customer's source URL where multicast stream is pulled from.
Multiplex
Description
The multiplex object.
Members
- Arn
-
- Type: string
The unique arn of the multiplex. - AvailabilityZones
-
- Type: Array of strings
A list of availability zones for the multiplex. - Destinations
-
- Type: Array of MultiplexOutputDestination structures
A list of the multiplex output destinations. - Id
-
- Type: string
The unique id of the multiplex. - MultiplexSettings
-
- Type: MultiplexSettings structure
Configuration for a multiplex event. - Name
-
- Type: string
The name of the multiplex. - PipelinesRunningCount
-
- Type: int
The number of currently healthy pipelines. - ProgramCount
-
- Type: int
The number of programs in the multiplex. - State
-
- Type: string
The current state of the multiplex. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs.
MultiplexConfigurationValidationError
Members
- Message
-
- Type: string
The error message. - ValidationErrors
-
- Type: Array of ValidationError structures
A collection of validation error responses.
MultiplexContainerSettings
Description
Multiplex Container Settings
Members
- MultiplexM2tsSettings
-
- Type: MultiplexM2tsSettings structure
Multiplex M2ts Settings
MultiplexGroupSettings
Description
Multiplex Group Settings
Members
MultiplexM2tsSettings
Description
Multiplex M2ts Settings
Members
- AbsentInputAudioBehavior
-
- Type: string
When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. - Arib
-
- Type: string
When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. - AudioBufferModel
-
- Type: string
When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. - AudioFramesPerPes
-
- Type: int
The number of audio frames to insert for each PES packet. - AudioStreamType
-
- Type: string
When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. - CcDescriptor
-
- Type: string
When set to enabled, generates captionServiceDescriptor in PMT. - Ebif
-
- Type: string
If set to passthrough, passes any EBIF data from the input source to this output. - EsRateInPes
-
- Type: string
Include or exclude the ES Rate field in the PES header. - Klv
-
- Type: string
If set to passthrough, passes any KLV data from the input source to this output. - NielsenId3Behavior
-
- Type: string
If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. - PcrControl
-
- Type: string
When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. - PcrPeriod
-
- Type: int
Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream. - Scte35Control
-
- Type: string
Optionally pass SCTE-35 signals from the input source to this output. - Scte35PrerollPullupMilliseconds
-
- Type: double
Defines the amount SCTE-35 preroll will be increased (in milliseconds) on the output. Preroll is the amount of time between the presence of a SCTE-35 indication in a transport stream and the PTS of the video frame it references. Zero means don't add pullup (it doesn't mean set the preroll to zero). Negative pullup is not supported, which means that you can't make the preroll shorter. Be aware that latency in the output will increase by the pullup amount.
MultiplexMediaConnectOutputDestinationSettings
Description
Multiplex MediaConnect output destination settings.
Members
- EntitlementArn
-
- Type: string
The MediaConnect entitlement ARN available as a Flow source.
MultiplexOutputDestination
Description
Multiplex output destination settings
Members
- MediaConnectSettings
-
- Type: MultiplexMediaConnectOutputDestinationSettings structure
Multiplex MediaConnect output destination settings.
MultiplexOutputSettings
Description
Multiplex Output Settings
Members
- ContainerSettings
-
- Type: MultiplexContainerSettings structure
Multiplex Container Settings - Destination
-
- Required: Yes
- Type: OutputLocationRef structure
Destination is a Multiplex.
MultiplexProgram
Description
The multiplex program object.
Members
- ChannelId
-
- Type: string
The MediaLive channel associated with the program. - MultiplexProgramSettings
-
- Type: MultiplexProgramSettings structure
The settings for this multiplex program. - PacketIdentifiersMap
-
- Type: MultiplexProgramPacketIdentifiersMap structure
The packet identifier map for this multiplex program. - PipelineDetails
-
- Type: Array of MultiplexProgramPipelineDetail structures
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. - ProgramName
-
- Type: string
The name of the multiplex program.
MultiplexProgramChannelDestinationSettings
Description
Multiplex Program Input Destination Settings for outputting a Channel to a Multiplex
Members
- MultiplexId
-
- Type: string
The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances.The Multiplex must be in the same region as the Channel. - ProgramName
-
- Type: string
The program name of the Multiplex program that the encoder is providing output to.
MultiplexProgramPacketIdentifiersMap
Description
Packet identifiers map for a given Multiplex program.
Members
- AribCaptionsPid
-
- Type: int
- AudioPids
-
- Type: Array of ints
- DvbSubPids
-
- Type: Array of ints
- DvbTeletextPid
-
- Type: int
- DvbTeletextPids
-
- Type: Array of ints
- EcmPid
-
- Type: int
- EtvPlatformPid
-
- Type: int
- EtvSignalPid
-
- Type: int
- KlvDataPids
-
- Type: Array of ints
- PcrPid
-
- Type: int
- PmtPid
-
- Type: int
- PrivateMetadataPid
-
- Type: int
- Scte27Pids
-
- Type: Array of ints
- Scte35Pid
-
- Type: int
- Smpte2038Pid
-
- Type: int
- TimedMetadataPid
-
- Type: int
- VideoPid
-
- Type: int
MultiplexProgramPipelineDetail
Description
The current source for one of the pipelines in the multiplex.
Members
- ActiveChannelPipeline
-
- Type: string
Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex. - PipelineId
-
- Type: string
Identifies a specific pipeline in the multiplex.
MultiplexProgramServiceDescriptor
Description
Transport stream service descriptor configuration for the Multiplex program.
Members
- ProviderName
-
- Required: Yes
- Type: string
Name of the provider. - ServiceName
-
- Required: Yes
- Type: string
Name of the service.
MultiplexProgramSettings
Description
Multiplex Program settings configuration.
Members
- PreferredChannelPipeline
-
- Type: string
Indicates which pipeline is preferred by the multiplex for program ingest. - ProgramNumber
-
- Required: Yes
- Type: int
Unique program number. - ServiceDescriptor
-
- Type: MultiplexProgramServiceDescriptor structure
Transport stream service descriptor configuration for the Multiplex program. - VideoSettings
-
- Type: MultiplexVideoSettings structure
Program video settings configuration.
MultiplexProgramSummary
Members
- ChannelId
-
- Type: string
The MediaLive Channel associated with the program. - ProgramName
-
- Type: string
The name of the multiplex program.
MultiplexSettings
Description
Contains configuration for a Multiplex event
Members
- MaximumVideoBufferDelayMilliseconds
-
- Type: int
Maximum video buffer delay in milliseconds. - TransportStreamBitrate
-
- Required: Yes
- Type: int
Transport stream bit rate. - TransportStreamId
-
- Required: Yes
- Type: int
Transport stream ID. - TransportStreamReservedBitrate
-
- Type: int
Transport stream reserved bit rate.
MultiplexSettingsSummary
Description
Contains summary configuration for a Multiplex event.
Members
- TransportStreamBitrate
-
- Type: int
Transport stream bit rate.
MultiplexStatmuxVideoSettings
Description
Statmux rate control settings
Members
- MaximumBitrate
-
- Type: int
Maximum statmux bitrate. - MinimumBitrate
-
- Type: int
Minimum statmux bitrate. - Priority
-
- Type: int
The purpose of the priority is to use a combination of the\nmultiplex rate control algorithm and the QVBR capability of the\nencoder to prioritize the video quality of some channels in a\nmultiplex over others. Channels that have a higher priority will\nget higher video quality at the expense of the video quality of\nother channels in the multiplex with lower priority.
MultiplexSummary
Members
- Arn
-
- Type: string
The unique arn of the multiplex. - AvailabilityZones
-
- Type: Array of strings
A list of availability zones for the multiplex. - Id
-
- Type: string
The unique id of the multiplex. - MultiplexSettings
-
- Type: MultiplexSettingsSummary structure
Configuration for a multiplex event. - Name
-
- Type: string
The name of the multiplex. - PipelinesRunningCount
-
- Type: int
The number of currently healthy pipelines. - ProgramCount
-
- Type: int
The number of programs in the multiplex. - State
-
- Type: string
The current state of the multiplex. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs.
MultiplexVideoSettings
Description
The video configuration for each program in a multiplex.
Members
- ConstantBitrate
-
- Type: int
The constant bitrate configuration for the video encode.When this field is defined, StatmuxSettings must be undefined. - StatmuxSettings
-
- Type: MultiplexStatmuxVideoSettings structure
Statmux rate control settings.When this field is defined, ConstantBitrate must be undefined.
NetworkInputSettings
Description
Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection.
Members
- HlsInputSettings
-
- Type: HlsInputSettings structure
Specifies HLS input settings when the uri is for a HLS manifest. - MulticastInputSettings
-
- Type: MulticastInputSettings structure
Specifies multicast input settings when the uri is for a multicast event. - ServerValidation
-
- Type: string
Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
NielsenCBET
Description
Nielsen CBET
Members
- CbetCheckDigitString
-
- Required: Yes
- Type: string
Enter the CBET check digits to use in the watermark. - CbetStepaside
-
- Required: Yes
- Type: string
Determines the method of CBET insertion mode when prior encoding is detected on the same layer. - Csid
-
- Required: Yes
- Type: string
Enter the CBET Source ID (CSID) to use in the watermark
NielsenConfiguration
Description
Nielsen Configuration
Members
- DistributorId
-
- Type: string
Enter the Distributor ID assigned to your organization by Nielsen. - NielsenPcmToId3Tagging
-
- Type: string
Enables Nielsen PCM to ID3 tagging
NielsenNaesIiNw
Description
Nielsen Naes Ii Nw
Members
- CheckDigitString
-
- Required: Yes
- Type: string
Enter the check digit string for the watermark - Sid
-
- Required: Yes
- Type: double
Enter the Nielsen Source ID (SID) to include in the watermark - Timezone
-
- Type: string
Choose the timezone for the time stamps in the watermark. If not provided,the timestamps will be in Coordinated Universal Time (UTC)
NielsenWatermarksSettings
Description
Nielsen Watermarks Settings
Members
- NielsenCbetSettings
-
- Type: NielsenCBET structure
Complete these fields only if you want to insert watermarks of type Nielsen CBET - NielsenDistributionType
-
- Type: string
Choose the distribution types that you want to assign to the watermarks:- PROGRAM_CONTENT- FINAL_DISTRIBUTOR - NielsenNaesIiNwSettings
-
- Type: NielsenNaesIiNw structure
Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW).
NodeConfigurationValidationError
Description
Details about a configuration error on the Node.
Members
- Message
-
- Type: string
The error message. - ValidationErrors
-
- Type: Array of ValidationError structures
A collection of validation error responses.
NodeInterfaceMapping
Description
A mapping that's used to pair a logical network interface name on a Node with the physical interface name exposed in the operating system.
Members
- LogicalInterfaceName
-
- Type: string
A uniform logical interface name to address in a MediaLive channel configuration. - NetworkInterfaceMode
-
- Type: string
Used in NodeInterfaceMapping and NodeInterfaceMappingCreateRequest - PhysicalInterfaceName
-
- Type: string
The name of the physical interface on the hardware that will be running Elemental anywhere.
NodeInterfaceMappingCreateRequest
Description
Used in CreateNodeRequest.
Members
- LogicalInterfaceName
-
- Type: string
Specify one of the logicalInterfaceNames that you created in the Cluster that this node belongs to. For example, my-Inputs-Interface. - NetworkInterfaceMode
-
- Type: string
The style of the network -- NAT or BRIDGE. - PhysicalInterfaceName
-
- Type: string
Specify the physical name that corresponds to the logicalInterfaceName that you specified in this interface mapping. For example, Eth1 or ENO1234EXAMPLE.
NotFoundException
Members
- Message
-
- Type: string
NotFoundExceptionResponseContent
Description
Request references a resource which does not exist.
Members
- Message
-
- Type: string
Exception error message.
Offering
Description
Reserved resources available for purchase
Members
- Arn
-
- Type: string
Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321' - CurrencyCode
-
- Type: string
Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' - Duration
-
- Type: int
Lease duration, e.g. '12' - DurationUnits
-
- Type: string
Units for duration, e.g. 'MONTHS' - FixedPrice
-
- Type: double
One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering - OfferingDescription
-
- Type: string
Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' - OfferingId
-
- Type: string
Unique offering ID, e.g. '87654321' - OfferingType
-
- Type: string
Offering type, e.g. 'NO_UPFRONT' - Region
-
- Type: string
AWS region, e.g. 'us-west-2' - ResourceSpecification
-
- Type: ReservationResourceSpecification structure
Resource configuration details - UsagePrice
-
- Type: double
Recurring usage charge for each reserved resource, e.g. '157.0'
Output
Description
Output settings. There can be multiple outputs within a group.
Members
- AudioDescriptionNames
-
- Type: Array of strings
The names of the AudioDescriptions used as audio sources for this output. - CaptionDescriptionNames
-
- Type: Array of strings
The names of the CaptionDescriptions used as caption sources for this output. - OutputName
-
- Type: string
The name used to identify an output. - OutputSettings
-
- Required: Yes
- Type: OutputSettings structure
Output type-specific settings. - VideoDescriptionName
-
- Type: string
The name of the VideoDescription used as the source for this output.
OutputDestination
Members
- Id
-
- Type: string
User-specified id. This is used in an output group or an output. - MediaPackageSettings
-
- Type: Array of MediaPackageOutputDestinationSettings structures
Destination settings for a MediaPackage output; one destination for both encoders. - MultiplexSettings
-
- Type: MultiplexProgramChannelDestinationSettings structure
Destination settings for a Multiplex output; one destination for both encoders. - Settings
-
- Type: Array of OutputDestinationSettings structures
Destination settings for a standard output; one destination for each redundant encoder. - SrtSettings
-
- Type: Array of SrtOutputDestinationSettings structures
SRT settings for an SRT output; one destination for each redundant encoder.
OutputDestinationSettings
Members
- PasswordParam
-
- Type: string
key used to extract the password from EC2 Parameter store - StreamName
-
- Type: string
Stream name for RTMP destinations (URLs of type rtmp://) - Url
-
- Type: string
A URL specifying a destination - Username
-
- Type: string
username for destination
OutputGroup
Description
Output groups for this Live Event. Output groups contain information about where streams should be distributed.
Members
- Name
-
- Type: string
Custom output group name optionally defined by the user. - OutputGroupSettings
-
- Required: Yes
- Type: OutputGroupSettings structure
Settings associated with the output group. - Outputs
-
- Required: Yes
- Type: Array of Output structures
OutputGroupSettings
Description
Output Group Settings
Members
- ArchiveGroupSettings
-
- Type: ArchiveGroupSettings structure
Archive Group Settings - CmafIngestGroupSettings
-
- Type: CmafIngestGroupSettings structure
Cmaf Ingest Group Settings - FrameCaptureGroupSettings
-
- Type: FrameCaptureGroupSettings structure
Frame Capture Group Settings - HlsGroupSettings
-
- Type: HlsGroupSettings structure
Hls Group Settings - MediaPackageGroupSettings
-
- Type: MediaPackageGroupSettings structure
Media Package Group Settings - MsSmoothGroupSettings
-
- Type: MsSmoothGroupSettings structure
Ms Smooth Group Settings - MultiplexGroupSettings
-
- Type: MultiplexGroupSettings structure
Multiplex Group Settings - RtmpGroupSettings
-
- Type: RtmpGroupSettings structure
Rtmp Group Settings - SrtGroupSettings
-
- Type: SrtGroupSettings structure
Srt Group Settings - UdpGroupSettings
-
- Type: UdpGroupSettings structure
Udp Group Settings
OutputLocationRef
Description
Reference to an OutputDestination ID defined in the channel
Members
- DestinationRefId
-
- Type: string
OutputLockingSettings
Description
Output Locking Settings
Members
- EpochLockingSettings
-
- Type: EpochLockingSettings structure
Epoch Locking Settings - PipelineLockingSettings
-
- Type: PipelineLockingSettings structure
Pipeline Locking Settings
OutputSettings
Description
Output Settings
Members
- ArchiveOutputSettings
-
- Type: ArchiveOutputSettings structure
Archive Output Settings - CmafIngestOutputSettings
-
- Type: CmafIngestOutputSettings structure
Cmaf Ingest Output Settings - FrameCaptureOutputSettings
-
- Type: FrameCaptureOutputSettings structure
Frame Capture Output Settings - HlsOutputSettings
-
- Type: HlsOutputSettings structure
Hls Output Settings - MediaPackageOutputSettings
-
- Type: MediaPackageOutputSettings structure
Media Package Output Settings - MsSmoothOutputSettings
-
- Type: MsSmoothOutputSettings structure
Ms Smooth Output Settings - MultiplexOutputSettings
-
- Type: MultiplexOutputSettings structure
Multiplex Output Settings - RtmpOutputSettings
-
- Type: RtmpOutputSettings structure
Rtmp Output Settings - SrtOutputSettings
-
- Type: SrtOutputSettings structure
Srt Output Settings - UdpOutputSettings
-
- Type: UdpOutputSettings structure
Udp Output Settings
PassThroughSettings
Description
Pass Through Settings
Members
PauseStateScheduleActionSettings
Description
Settings for the action to set pause state of a channel.
Members
- Pipelines
-
- Type: Array of PipelinePauseStateSettings structures
PipelineDetail
Description
Runtime details of a pipeline when a channel is running.
Members
- ActiveInputAttachmentName
-
- Type: string
The name of the active input attachment currently being ingested by this pipeline. - ActiveInputSwitchActionName
-
- Type: string
The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline. - ActiveMotionGraphicsActionName
-
- Type: string
The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline. - ActiveMotionGraphicsUri
-
- Type: string
The current URI being used for HTML5 motion graphics for this pipeline. - PipelineId
-
- Type: string
Pipeline ID
PipelineLockingSettings
Description
Pipeline Locking Settings
Members
PipelinePauseStateSettings
Description
Settings for pausing a pipeline.
Members
- PipelineId
-
- Required: Yes
- Type: string
Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1").
PurchaseOffering
Description
PurchaseOffering request
Members
- Count
-
- Required: Yes
- Type: int
Number of resources - Name
-
- Type: string
Name for the new reservation - RenewalSettings
-
- Type: RenewalSettings structure
Renewal settings for the reservation - RequestId
-
- Type: string
Unique request ID to be specified. This is needed to prevent retries from creating multiple resources. - Start
-
- Type: string
Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs
PurchaseOfferingResultModel
Description
PurchaseOffering response
Members
- Reservation
-
- Type: Reservation structure
Reserved resources available to use
RawSettings
Description
Raw Settings
Members
RebootInputDevice
Members
- Force
-
- Type: string
Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes.
Rec601Settings
Description
Rec601 Settings
Members
Rec709Settings
Description
Rec709 Settings
Members
RemixSettings
Description
Remix Settings
Members
- ChannelMappings
-
- Required: Yes
- Type: Array of AudioChannelMapping structures
Mapping of input channels to output channels, with appropriate gain adjustments. - ChannelsIn
-
- Type: int
Number of input channels to be used. - ChannelsOut
-
- Type: int
Number of output channels to be produced.Valid values: 1, 2, 4, 6, 8
RenewalSettings
Description
The Renewal settings for Reservations
Members
- AutomaticRenewal
-
- Type: string
Automatic renewal status for the reservation - RenewalCount
-
- Type: int
Count for the reservation renewal
Reservation
Description
Reserved resources available to use
Members
- Arn
-
- Type: string
Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' - Count
-
- Type: int
Number of reserved resources - CurrencyCode
-
- Type: string
Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' - Duration
-
- Type: int
Lease duration, e.g. '12' - DurationUnits
-
- Type: string
Units for duration, e.g. 'MONTHS' - End
-
- Type: string
Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' - FixedPrice
-
- Type: double
One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering - Name
-
- Type: string
User specified reservation name - OfferingDescription
-
- Type: string
Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' - OfferingId
-
- Type: string
Unique offering ID, e.g. '87654321' - OfferingType
-
- Type: string
Offering type, e.g. 'NO_UPFRONT' - Region
-
- Type: string
AWS region, e.g. 'us-west-2' - RenewalSettings
-
- Type: RenewalSettings structure
Renewal settings for the reservation - ReservationId
-
- Type: string
Unique reservation ID, e.g. '1234567' - ResourceSpecification
-
- Type: ReservationResourceSpecification structure
Resource configuration details - Start
-
- Type: string
Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00' - State
-
- Type: string
Current state of reservation, e.g. 'ACTIVE' - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of key-value pairs - UsagePrice
-
- Type: double
Recurring usage charge for each reserved resource, e.g. '157.0'
ReservationResourceSpecification
Description
Resource configuration (codec, resolution, bitrate, ...)
Members
- ChannelClass
-
- Type: string
Channel class, e.g. 'STANDARD' - Codec
-
- Type: string
Codec, e.g. 'AVC' - MaximumBitrate
-
- Type: string
Maximum bitrate, e.g. 'MAX_20_MBPS' - MaximumFramerate
-
- Type: string
Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) - Resolution
-
- Type: string
Resolution, e.g. 'HD' - ResourceType
-
- Type: string
Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' - SpecialFeature
-
- Type: string
Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) - VideoQuality
-
- Type: string
Video quality, e.g. 'STANDARD' (Outputs only)
ResourceConflict
Members
- Message
-
- Type: string
ResourceNotFound
Members
- Message
-
- Type: string
Route
Description
Used in DescribeNetworkResult, DescribeNetworkSummary, UpdateNetworkResult.
Members
- Cidr
-
- Type: string
A CIDR block for one Route. - Gateway
-
- Type: string
The IP address of the Gateway for this route, if applicable.
RouteCreateRequest
Description
Used in CreateNetworkRequest.
Members
- Cidr
-
- Type: string
A CIDR block for one Route. - Gateway
-
- Type: string
The IP address of the Gateway for this route, if applicable.
RouteUpdateRequest
Description
Used in UpdateNetworkRequest.
Members
- Cidr
-
- Type: string
A CIDR block for one Route. - Gateway
-
- Type: string
The IP address of the Gateway for this route, if applicable.
RtmpCaptionInfoDestinationSettings
Description
Rtmp Caption Info Destination Settings
Members
RtmpGroupSettings
Description
Rtmp Group Settings
Members
- AdMarkers
-
- Type: Array of strings
Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream. - AuthenticationScheme
-
- Type: string
Authentication scheme to use when connecting with CDN - CacheFullBehavior
-
- Type: string
Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. - CacheLength
-
- Type: int
Cache length, in seconds, is used to calculate buffer size. - CaptionData
-
- Type: string
Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. - IncludeFillerNalUnits
-
- Type: string
Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto. - InputLossAction
-
- Type: string
Controls the behavior of this RTMP group if input becomes unavailable.- emitOutput: Emit a slate until input returns.- pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. - RestartDelay
-
- Type: int
If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
RtmpOutputSettings
Description
Rtmp Output Settings
Members
- CertificateMode
-
- Type: string
If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. - ConnectionRetryInterval
-
- Type: int
Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost. - Destination
-
- Required: Yes
- Type: OutputLocationRef structure
The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers. - NumRetries
-
- Type: int
Number of retry attempts.
ScheduleAction
Description
Contains information on a single schedule action.
Members
- ActionName
-
- Required: Yes
- Type: string
The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused. - ScheduleActionSettings
-
- Required: Yes
- Type: ScheduleActionSettings structure
Settings for this schedule action. - ScheduleActionStartSettings
-
- Required: Yes
- Type: ScheduleActionStartSettings structure
The time for the action to start in the channel.
ScheduleActionSettings
Description
Holds the settings for a single schedule action.
Members
- HlsId3SegmentTaggingSettings
-
- Type: HlsId3SegmentTaggingScheduleActionSettings structure
Action to insert ID3 metadata in every segment, in HLS output groups - HlsTimedMetadataSettings
-
- Type: HlsTimedMetadataScheduleActionSettings structure
Action to insert ID3 metadata once, in HLS output groups - InputPrepareSettings
-
- Type: InputPrepareScheduleActionSettings structure
Action to prepare an input for a future immediate input switch - InputSwitchSettings
-
- Type: InputSwitchScheduleActionSettings structure
Action to switch the input - MotionGraphicsImageActivateSettings
-
- Type: MotionGraphicsActivateScheduleActionSettings structure
Action to activate a motion graphics image overlay - MotionGraphicsImageDeactivateSettings
-
- Type: MotionGraphicsDeactivateScheduleActionSettings structure
Action to deactivate a motion graphics image overlay - PauseStateSettings
-
- Type: PauseStateScheduleActionSettings structure
Action to pause or unpause one or both channel pipelines - Scte35InputSettings
-
- Type: Scte35InputScheduleActionSettings structure
Action to specify scte35 input - Scte35ReturnToNetworkSettings
-
- Type: Scte35ReturnToNetworkScheduleActionSettings structure
Action to insert SCTE-35 return_to_network message - Scte35SpliceInsertSettings
-
- Type: Scte35SpliceInsertScheduleActionSettings structure
Action to insert SCTE-35 splice_insert message - Scte35TimeSignalSettings
-
- Type: Scte35TimeSignalScheduleActionSettings structure
Action to insert SCTE-35 time_signal message - StaticImageActivateSettings
-
- Type: StaticImageActivateScheduleActionSettings structure
Action to activate a static image overlay - StaticImageDeactivateSettings
-
- Type: StaticImageDeactivateScheduleActionSettings structure
Action to deactivate a static image overlay - StaticImageOutputActivateSettings
-
- Type: StaticImageOutputActivateScheduleActionSettings structure
Action to activate a static image overlay in one or more specified outputs - StaticImageOutputDeactivateSettings
-
- Type: StaticImageOutputDeactivateScheduleActionSettings structure
Action to deactivate a static image overlay in one or more specified outputs
ScheduleActionStartSettings
Description
Settings to specify when an action should occur. Only one of the options must be selected.
Members
- FixedModeScheduleActionStartSettings
-
- Type: FixedModeScheduleActionStartSettings structure
Option for specifying the start time for an action. - FollowModeScheduleActionStartSettings
-
- Type: FollowModeScheduleActionStartSettings structure
Option for specifying an action as relative to another action. - ImmediateModeScheduleActionStartSettings
-
- Type: ImmediateModeScheduleActionStartSettings structure
Option for specifying an action that should be applied immediately.
ScheduleDeleteResultModel
Description
Result of a schedule deletion.
Members
ScheduleDescribeResultModel
Description
Results of a schedule describe.
Members
- NextToken
-
- Type: string
The next token; for use in pagination. - ScheduleActions
-
- Required: Yes
- Type: Array of ScheduleAction structures
The list of actions in the schedule.
Scte20PlusEmbeddedDestinationSettings
Description
Scte20 Plus Embedded Destination Settings
Members
Scte20SourceSettings
Description
Scte20 Source Settings
Members
- Convert608To708
-
- Type: string
If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. - Source608ChannelNumber
-
- Type: int
Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
Scte27DestinationSettings
Description
Scte27 Destination Settings
Members
Scte27SourceSettings
Description
Scte27 Source Settings
Members
- OcrLanguage
-
- Type: string
If you will configure a WebVTT caption description that references this caption selector, use this field toprovide the language to consider when translating the image-based source to text. - Pid
-
- Type: int
The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
Scte35DeliveryRestrictions
Description
Corresponds to SCTE-35 delivery_not_restricted_flag parameter. To declare delivery restrictions, include this element and its four "restriction" flags. To declare that there are no restrictions, omit this element.
Members
- ArchiveAllowedFlag
-
- Required: Yes
- Type: string
Corresponds to SCTE-35 archive_allowed_flag. - DeviceRestrictions
-
- Required: Yes
- Type: string
Corresponds to SCTE-35 device_restrictions parameter. - NoRegionalBlackoutFlag
-
- Required: Yes
- Type: string
Corresponds to SCTE-35 no_regional_blackout_flag parameter. - WebDeliveryAllowedFlag
-
- Required: Yes
- Type: string
Corresponds to SCTE-35 web_delivery_allowed_flag parameter.
Scte35Descriptor
Description
Holds one set of SCTE-35 Descriptor Settings.
Members
- Scte35DescriptorSettings
-
- Required: Yes
- Type: Scte35DescriptorSettings structure
SCTE-35 Descriptor Settings.
Scte35DescriptorSettings
Description
SCTE-35 Descriptor settings.
Members
- SegmentationDescriptorScte35DescriptorSettings
-
- Required: Yes
- Type: Scte35SegmentationDescriptor structure
SCTE-35 Segmentation Descriptor.
Scte35InputScheduleActionSettings
Description
Scte35Input Schedule Action Settings
Members
- InputAttachmentNameReference
-
- Type: string
In fixed mode, enter the name of the input attachment that you want to use as a SCTE-35 input. (Don't enter the ID of the input.)" - Mode
-
- Required: Yes
- Type: string
Whether the SCTE-35 input should be the active input or a fixed input.
Scte35ReturnToNetworkScheduleActionSettings
Description
Settings for a SCTE-35 return_to_network message.
Members
- SpliceEventId
-
- Required: Yes
- Type: long (int|float)
The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
Scte35SegmentationDescriptor
Description
Corresponds to SCTE-35 segmentation_descriptor.
Members
- DeliveryRestrictions
-
- Type: Scte35DeliveryRestrictions structure
Holds the four SCTE-35 delivery restriction parameters. - SegmentNum
-
- Type: int
Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id. - SegmentationCancelIndicator
-
- Required: Yes
- Type: string
Corresponds to SCTE-35 segmentation_event_cancel_indicator. - SegmentationDuration
-
- Type: long (int|float)
Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message. - SegmentationEventId
-
- Required: Yes
- Type: long (int|float)
Corresponds to SCTE-35 segmentation_event_id. - SegmentationTypeId
-
- Type: int
Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52"). - SegmentationUpid
-
- Type: string
Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e. - SegmentationUpidType
-
- Type: int
Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12"). - SegmentsExpected
-
- Type: int
Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id. - SubSegmentNum
-
- Type: int
Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id. - SubSegmentsExpected
-
- Type: int
Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.
Scte35SpliceInsert
Description
Typical configuration that applies breaks on splice inserts in addition to time signal placement opportunities, breaks, and advertisements.
Members
- AdAvailOffset
-
- Type: int
When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. - NoRegionalBlackoutFlag
-
- Type: string
When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates - WebDeliveryAllowedFlag
-
- Type: string
When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
Scte35SpliceInsertScheduleActionSettings
Description
Settings for a SCTE-35 splice_insert message.
Members
- Duration
-
- Type: long (int|float)
Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time. - SpliceEventId
-
- Required: Yes
- Type: long (int|float)
The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
Scte35TimeSignalApos
Description
Atypical configuration that applies segment breaks only on SCTE-35 time signal placement opportunities and breaks.
Members
- AdAvailOffset
-
- Type: int
When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. - NoRegionalBlackoutFlag
-
- Type: string
When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates - WebDeliveryAllowedFlag
-
- Type: string
When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
Scte35TimeSignalScheduleActionSettings
Description
Settings for a SCTE-35 time_signal.
Members
- Scte35Descriptors
-
- Required: Yes
- Type: Array of Scte35Descriptor structures
The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.
SignalMapSummary
Members
- Arn
-
- Required: Yes
- Type: string
A signal map's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - Id
-
- Required: Yes
- Type: string
A signal map's id. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- MonitorDeploymentStatus
-
- Required: Yes
- Type: string
A signal map's monitor deployment status. - Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Status
-
- Required: Yes
- Type: string
A signal map's current status which is dependent on its lifecycle actions or associated jobs. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
SmpteTtDestinationSettings
Description
Smpte Tt Destination Settings
Members
SrtCallerDecryption
Description
The decryption settings for the SRT caller source. Present only if the source has decryption enabled.
Members
- Algorithm
-
- Type: string
The algorithm used to encrypt content. - PassphraseSecretArn
-
- Type: string
The ARN for the secret in Secrets Manager. Someone in your organization must create a secret and provide you with its ARN. The secret holds the passphrase that MediaLive uses to decrypt the source content.
SrtCallerDecryptionRequest
Description
Complete these parameters only if the content is encrypted.
Members
- Algorithm
-
- Type: string
The algorithm used to encrypt content. - PassphraseSecretArn
-
- Type: string
The ARN for the secret in Secrets Manager. Someone in your organization must create a secret and provide you with its ARN. This secret holds the passphrase that MediaLive will use to decrypt the source content.
SrtCallerSource
Description
The configuration for a source that uses SRT as the connection protocol. In terms of establishing the connection, MediaLive is always caller and the upstream system is always the listener. In terms of transmission of the source content, MediaLive is always the receiver and the upstream system is always the sender.
Members
- Decryption
-
- Type: SrtCallerDecryption structure
The decryption settings for the SRT caller source. Present only if the source has decryption enabled. - MinimumLatency
-
- Type: int
The preferred latency (in milliseconds) for implementing packet loss and recovery. Packet recovery is a key feature of SRT. - SrtListenerAddress
-
- Type: string
The IP address at the upstream system (the listener) that MediaLive (the caller) connects to. - SrtListenerPort
-
- Type: string
The port at the upstream system (the listener) that MediaLive (the caller) connects to. - StreamId
-
- Type: string
The stream ID, if the upstream system uses this identifier.
SrtCallerSourceRequest
Description
Configures the connection for a source that uses SRT as the connection protocol. In terms of establishing the connection, MediaLive is always the caller and the upstream system is always the listener. In terms of transmission of the source content, MediaLive is always the receiver and the upstream system is always the sender.
Members
- Decryption
-
- Type: SrtCallerDecryptionRequest structure
Complete these parameters only if the content is encrypted. - MinimumLatency
-
- Type: int
The preferred latency (in milliseconds) for implementing packet loss and recovery. Packet recovery is a key feature of SRT. Obtain this value from the operator at the upstream system. - SrtListenerAddress
-
- Type: string
The IP address at the upstream system (the listener) that MediaLive (the caller) will connect to. - SrtListenerPort
-
- Type: string
The port at the upstream system (the listener) that MediaLive (the caller) will connect to. - StreamId
-
- Type: string
This value is required if the upstream system uses this identifier because without it, the SRT handshake between MediaLive (the caller) and the upstream system (the listener) might fail.
SrtGroupSettings
Description
Srt Group Settings
Members
- InputLossAction
-
- Type: string
Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.
SrtOutputDestinationSettings
Members
- EncryptionPassphraseSecretArn
-
- Type: string
Arn used to extract the password from Secrets Manager - StreamId
-
- Type: string
Stream id for SRT destinations (URLs of type srt://) - Url
-
- Type: string
A URL specifying a destination
SrtOutputSettings
Description
Srt Output Settings
Members
- BufferMsec
-
- Type: int
SRT output buffering in milliseconds. A higher value increases latency through the encoder. But the benefits are that it helps to maintain a constant, low-jitter SRT output, and it accommodates clock recovery, input switching, input disruptions, picture reordering, and so on. Range: 0-10000 milliseconds. - ContainerSettings
-
- Required: Yes
- Type: UdpContainerSettings structure
Udp Container Settings - Destination
-
- Required: Yes
- Type: OutputLocationRef structure
Reference to an OutputDestination ID defined in the channel - EncryptionType
-
- Type: string
The encryption level for the content. Valid values are AES128, AES192, AES256. You and the downstream system should plan how to set this field because the values must not conflict with each other. - Latency
-
- Type: int
The latency value, in milliseconds, that is proposed during the SRT connection handshake. SRT will choose the maximum of the values proposed by the sender and receiver. On the sender side, latency is the amount of time a packet is held to give it a chance to be delivered successfully. On the receiver side, latency is the amount of time the packet is held before delivering to the application, aiding in packet recovery and matching as closely as possible the packet timing of the sender. Range: 40-16000 milliseconds.
SrtSettings
Description
The configured sources for this SRT input.
Members
- SrtCallerSources
-
- Type: Array of SrtCallerSource structures
SrtSettingsRequest
Description
Configures the sources for this SRT input. For a single-pipeline input, include one srtCallerSource in the array. For a standard-pipeline input, include two srtCallerSource.
Members
- SrtCallerSources
-
- Type: Array of SrtCallerSourceRequest structures
StandardHlsSettings
Description
Standard Hls Settings
Members
- AudioRenditionSets
-
- Type: string
List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. - M3u8Settings
-
- Required: Yes
- Type: M3u8Settings structure
Settings information for the .m3u8 container
StartDeleteMonitorDeploymentResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
A signal map's ARN (Amazon Resource Name) - CloudWatchAlarmTemplateGroupIds
-
- Type: Array of strings
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - DiscoveryEntryPointArn
-
- Required: Yes
- Type: string
A top-level supported AWS resource ARN to discovery a signal map from. - ErrorMessage
-
- Type: string
Error message associated with a failed creation or failed update attempt of a signal map. - EventBridgeRuleTemplateGroupIds
-
- Type: Array of strings
- FailedMediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an incomplete AWS media workflow as a graph. - Id
-
- Required: Yes
- Type: string
A signal map's id. - LastDiscoveredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastSuccessfulMonitorDeployment
-
- Type: SuccessfulMonitorDeployment structure
Represents the latest successful monitor deployment of a signal map. - MediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an AWS media workflow as a graph. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- MonitorChangesPendingDeployment
-
- Required: Yes
- Type: boolean
If true, there are pending monitor changes for this signal map that can be deployed. - MonitorDeployment
-
- Type: MonitorDeployment structure
Represents the latest monitor deployment of a signal map. - Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Status
-
- Required: Yes
- Type: string
A signal map's current status which is dependent on its lifecycle actions or associated jobs. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
StartMonitorDeploymentRequestContent
Members
- DryRun
-
- Type: boolean
StartMonitorDeploymentResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
A signal map's ARN (Amazon Resource Name) - CloudWatchAlarmTemplateGroupIds
-
- Type: Array of strings
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - DiscoveryEntryPointArn
-
- Required: Yes
- Type: string
A top-level supported AWS resource ARN to discovery a signal map from. - ErrorMessage
-
- Type: string
Error message associated with a failed creation or failed update attempt of a signal map. - EventBridgeRuleTemplateGroupIds
-
- Type: Array of strings
- FailedMediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an incomplete AWS media workflow as a graph. - Id
-
- Required: Yes
- Type: string
A signal map's id. - LastDiscoveredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastSuccessfulMonitorDeployment
-
- Type: SuccessfulMonitorDeployment structure
Represents the latest successful monitor deployment of a signal map. - MediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an AWS media workflow as a graph. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- MonitorChangesPendingDeployment
-
- Required: Yes
- Type: boolean
If true, there are pending monitor changes for this signal map that can be deployed. - MonitorDeployment
-
- Type: MonitorDeployment structure
Represents the latest monitor deployment of a signal map. - Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Status
-
- Required: Yes
- Type: string
A signal map's current status which is dependent on its lifecycle actions or associated jobs. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
StartTimecode
Description
Settings to identify the start of the clip.
Members
- Timecode
-
- Type: string
The timecode for the frame where you want to start the clip. Optional; if not specified, the clip starts at first frame in the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.
StartUpdateSignalMapRequestContent
Members
- CloudWatchAlarmTemplateGroupIdentifiers
-
- Type: Array of strings
- Description
-
- Type: string
A resource's optional description. - DiscoveryEntryPointArn
-
- Type: string
A top-level supported AWS resource ARN to discovery a signal map from. - EventBridgeRuleTemplateGroupIdentifiers
-
- Type: Array of strings
- ForceRediscovery
-
- Type: boolean
If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided. - Name
-
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region.
StartUpdateSignalMapResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
A signal map's ARN (Amazon Resource Name) - CloudWatchAlarmTemplateGroupIds
-
- Type: Array of strings
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - DiscoveryEntryPointArn
-
- Required: Yes
- Type: string
A top-level supported AWS resource ARN to discovery a signal map from. - ErrorMessage
-
- Type: string
Error message associated with a failed creation or failed update attempt of a signal map. - EventBridgeRuleTemplateGroupIds
-
- Type: Array of strings
- FailedMediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an incomplete AWS media workflow as a graph. - Id
-
- Required: Yes
- Type: string
A signal map's id. - LastDiscoveredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LastSuccessfulMonitorDeployment
-
- Type: SuccessfulMonitorDeployment structure
Represents the latest successful monitor deployment of a signal map. - MediaResourceMap
-
- Type: Associative array of custom strings keys (__string) to MediaResource structures
A map representing an AWS media workflow as a graph. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- MonitorChangesPendingDeployment
-
- Required: Yes
- Type: boolean
If true, there are pending monitor changes for this signal map that can be deployed. - MonitorDeployment
-
- Type: MonitorDeployment structure
Represents the latest monitor deployment of a signal map. - Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Status
-
- Required: Yes
- Type: string
A signal map's current status which is dependent on its lifecycle actions or associated jobs. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
StaticImageActivateScheduleActionSettings
Description
Settings for the action to activate a static image.
Members
- Duration
-
- Type: int
The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated. - FadeIn
-
- Type: int
The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in). - FadeOut
-
- Type: int
Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out). - Height
-
- Type: int
The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay. - Image
-
- Required: Yes
- Type: InputLocation structure
The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video. - ImageX
-
- Type: int
Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right. - ImageY
-
- Type: int
Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom. - Layer
-
- Type: int
The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0. - Opacity
-
- Type: int
Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100. - Width
-
- Type: int
The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.
StaticImageDeactivateScheduleActionSettings
Description
Settings for the action to deactivate the image in a specific layer.
Members
- FadeOut
-
- Type: int
The time in milliseconds for the image to fade out. Default is 0 (no fade-out). - Layer
-
- Type: int
The image overlay layer to deactivate, 0 to 7. Default is 0.
StaticImageOutputActivateScheduleActionSettings
Description
Settings for the action to activate a static image.
Members
- Duration
-
- Type: int
The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated. - FadeIn
-
- Type: int
The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in). - FadeOut
-
- Type: int
Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out). - Height
-
- Type: int
The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay. - Image
-
- Required: Yes
- Type: InputLocation structure
The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video. - ImageX
-
- Type: int
Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right. - ImageY
-
- Type: int
Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom. - Layer
-
- Type: int
The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0. - Opacity
-
- Type: int
Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100. - OutputNames
-
- Required: Yes
- Type: Array of strings
The name(s) of the output(s) the activation should apply to. - Width
-
- Type: int
The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.
StaticImageOutputDeactivateScheduleActionSettings
Description
Settings for the action to deactivate the image in a specific layer.
Members
- FadeOut
-
- Type: int
The time in milliseconds for the image to fade out. Default is 0 (no fade-out). - Layer
-
- Type: int
The image overlay layer to deactivate, 0 to 7. Default is 0. - OutputNames
-
- Required: Yes
- Type: Array of strings
The name(s) of the output(s) the deactivation should apply to.
StaticKeySettings
Description
Static Key Settings
Members
- KeyProviderServer
-
- Type: InputLocation structure
The URL of the license server used for protecting content. - StaticKeyValue
-
- Required: Yes
- Type: string
Static key value as a 32 character hexadecimal string.
StopTimecode
Description
Settings to identify the end of the clip.
Members
- LastFrameClippingBehavior
-
- Type: string
If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode. - Timecode
-
- Type: string
The timecode for the frame where you want to stop the clip. Optional; if not specified, the clip continues to the end of the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.
SuccessfulMonitorDeployment
Description
Represents the latest successful monitor deployment of a signal map.
Members
- DetailsUri
-
- Required: Yes
- Type: string
URI associated with a signal map's monitor deployment. - Status
-
- Required: Yes
- Type: string
A signal map's monitor deployment status.
TagsModel
Members
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
TeletextDestinationSettings
Description
Teletext Destination Settings
Members
TeletextSourceSettings
Description
Teletext Source Settings
Members
- OutputRectangle
-
- Type: CaptionRectangle structure
Optionally defines a region where TTML style captions will be displayed - PageNumber
-
- Type: string
Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
TemporalFilterSettings
Description
Temporal Filter Settings
Members
- PostFilterSharpening
-
- Type: string
If you enable this filter, the results are the following:- If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source.- If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR. - Strength
-
- Type: string
Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft.
Thumbnail
Description
Details of a single thumbnail
Members
- Body
-
- Type: string
The binary data for the latest thumbnail. - ContentType
-
- Type: string
The content type for the latest thumbnail. - ThumbnailType
-
- Type: string
Thumbnail Type - TimeStamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
ThumbnailConfiguration
Description
Thumbnail Configuration
Members
- State
-
- Required: Yes
- Type: string
Enables the thumbnail feature. The feature generates thumbnails of the incoming video in each pipeline in the channel. AUTO turns the feature on, DISABLE turns the feature off.
ThumbnailData
Description
The binary data for the thumbnail that the Link device has most recently sent to MediaLive.
Members
- Body
-
- Type: string
The binary data for the thumbnail that the Link device has most recently sent to MediaLive.
ThumbnailDetail
Description
Thumbnail details for one pipeline of a running channel.
Members
- PipelineId
-
- Type: string
Pipeline ID - Thumbnails
-
- Type: Array of Thumbnail structures
thumbnails of a single pipeline
ThumbnailNoData
Description
Response when thumbnail has no data. It should have no message.
Members
TimecodeBurninSettings
Description
Timecode Burnin Settings
Members
- FontSize
-
- Required: Yes
- Type: string
Choose a timecode burn-in font size - Position
-
- Required: Yes
- Type: string
Choose a timecode burn-in output position - Prefix
-
- Type: string
Create a timecode burn-in prefix (optional)
TimecodeConfig
Description
Timecode Config
Members
- Source
-
- Required: Yes
- Type: string
Identifies the source for the timecode that will be associated with the events outputs.-Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased).-System Clock (systemclock): Use the UTC time.-Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. - SyncThreshold
-
- Type: int
Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
TooManyRequestsException
Members
- Message
-
- Type: string
TooManyRequestsExceptionResponseContent
Description
Request was denied due to request throttling.
Members
- Message
-
- Type: string
Exception error message.
TransferInputDevice
Description
The transfer details of the input device.
Members
- TargetCustomerId
-
- Type: string
The AWS account ID (12 digits) for the recipient of the device transfer. - TargetRegion
-
- Type: string
The target AWS region to transfer the device. - TransferMessage
-
- Type: string
An optional message for the recipient. Maximum 280 characters.
TransferringInputDeviceSummary
Description
Details about the input device that is being transferred.
Members
- Id
-
- Type: string
The unique ID of the input device. - Message
-
- Type: string
The optional message that the sender has attached to the transfer. - TargetCustomerId
-
- Type: string
The AWS account ID for the recipient of the input device transfer. - TransferType
-
- Type: string
The type (direction) of the input device transfer.
TtmlDestinationSettings
Description
Ttml Destination Settings
Members
- StyleControl
-
- Type: string
This field is not currently supported and will not affect the output styling. Leave the default value.
UdpContainerSettings
UdpGroupSettings
Description
Udp Group Settings
Members
- InputLossAction
-
- Type: string
Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. - TimedMetadataId3Frame
-
- Type: string
Indicates ID3 frame that has the timecode. - TimedMetadataId3Period
-
- Type: int
Timed Metadata interval in seconds.
UdpOutputSettings
Description
Udp Output Settings
Members
- BufferMsec
-
- Type: int
UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc. - ContainerSettings
-
- Required: Yes
- Type: UdpContainerSettings structure
Udp Container Settings - Destination
-
- Required: Yes
- Type: OutputLocationRef structure
Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002). - FecOutputSettings
-
- Type: FecOutputSettings structure
Settings for enabling and adjusting Forward Error Correction on UDP outputs.
UnprocessableEntityException
Members
- ElementPath
-
- Type: string
- ErrorMessage
-
- Type: string
UpdateAccountConfigurationRequestModel
Description
The desired new account configuration.
Members
- AccountConfiguration
-
- Type: AccountConfiguration structure
UpdateAccountConfigurationResultModel
Description
The account's updated configuration.
Members
- AccountConfiguration
-
- Type: AccountConfiguration structure
UpdateChannel
Members
- CdiInputSpecification
-
- Type: CdiInputSpecification structure
Specification of CDI inputs for this channel - Destinations
-
- Type: Array of OutputDestination structures
A list of output destinations for this channel. - EncoderSettings
-
- Type: EncoderSettings structure
The encoder settings for this channel. - InputAttachments
-
- Type: Array of InputAttachment structures
- InputSpecification
-
- Type: InputSpecification structure
Specification of network and file inputs for this channel - LogLevel
-
- Type: string
The log level to write to CloudWatch Logs. - Maintenance
-
- Type: MaintenanceUpdateSettings structure
Maintenance settings for this channel. - Name
-
- Type: string
The name of the channel. - RoleArn
-
- Type: string
An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed.
UpdateChannelClass
Members
- ChannelClass
-
- Required: Yes
- Type: string
The channel class that you wish to update this channel to use. - Destinations
-
- Type: Array of OutputDestination structures
A list of output destinations for this channel.
UpdateChannelResultModel
UpdateCloudWatchAlarmTemplateGroupRequestContent
Members
- Description
-
- Type: string
A resource's optional description.
UpdateCloudWatchAlarmTemplateGroupResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - Id
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
UpdateCloudWatchAlarmTemplateRequestContent
Members
- ComparisonOperator
-
- Type: string
The comparison operator used to compare the specified statistic and the threshold. - DatapointsToAlarm
-
- Type: int
The number of datapoints within the evaluation period that must be breaching to trigger the alarm. - Description
-
- Type: string
A resource's optional description. - EvaluationPeriods
-
- Type: int
The number of periods over which data is compared to the specified threshold. - GroupIdentifier
-
- Type: string
A cloudwatch alarm template group's identifier. Can be either be its id or current name. - MetricName
-
- Type: string
The name of the metric associated with the alarm. Must be compatible with targetResourceType. - Name
-
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Period
-
- Type: int
The period, in seconds, over which the specified statistic is applied. - Statistic
-
- Type: string
The statistic to apply to the alarm's metric data. - TargetResourceType
-
- Type: string
The resource type this template should dynamically generate cloudwatch metric alarms for. - Threshold
-
- Type: double
The threshold value to compare with the specified statistic. - TreatMissingData
-
- Type: string
Specifies how missing data points are treated when evaluating the alarm's condition.
UpdateCloudWatchAlarmTemplateResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
A cloudwatch alarm template's ARN (Amazon Resource Name) - ComparisonOperator
-
- Required: Yes
- Type: string
The comparison operator used to compare the specified statistic and the threshold. - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DatapointsToAlarm
-
- Type: int
The number of datapoints within the evaluation period that must be breaching to trigger the alarm. - Description
-
- Type: string
A resource's optional description. - EvaluationPeriods
-
- Required: Yes
- Type: int
The number of periods over which data is compared to the specified threshold. - GroupId
-
- Required: Yes
- Type: string
A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` - Id
-
- Required: Yes
- Type: string
A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-` - MetricName
-
- Required: Yes
- Type: string
The name of the metric associated with the alarm. Must be compatible with targetResourceType. - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Period
-
- Required: Yes
- Type: int
The period, in seconds, over which the specified statistic is applied. - Statistic
-
- Required: Yes
- Type: string
The statistic to apply to the alarm's metric data. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource. - TargetResourceType
-
- Required: Yes
- Type: string
The resource type this template should dynamically generate cloudwatch metric alarms for. - Threshold
-
- Required: Yes
- Type: double
The threshold value to compare with the specified statistic. - TreatMissingData
-
- Required: Yes
- Type: string
Specifies how missing data points are treated when evaluating the alarm's condition.
UpdateClusterResult
Description
The name that you specified for the Cluster.
Members
- Arn
-
- Type: string
The ARN of the Cluster. - ChannelIds
-
- Type: Array of strings
An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster. - ClusterType
-
- Type: string
The hardware type for the Cluster - Id
-
- Type: string
The unique ID of the Cluster. - Name
-
- Type: string
The user-specified name of the Cluster. - NetworkSettings
-
- Type: ClusterNetworkSettings structure
Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with. - State
-
- Type: string
The current state of the Cluster.
UpdateEventBridgeRuleTemplateGroupRequestContent
Members
- Description
-
- Type: string
A resource's optional description.
UpdateEventBridgeRuleTemplateGroupResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
An eventbridge rule template group's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - Id
-
- Required: Yes
- Type: string
An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
UpdateEventBridgeRuleTemplateRequestContent
Members
- Description
-
- Type: string
A resource's optional description. - EventTargets
-
- Type: Array of EventBridgeRuleTemplateTarget structures
- EventType
-
- Type: string
The type of event to match with the rule. - GroupIdentifier
-
- Type: string
An eventbridge rule template group's identifier. Can be either be its id or current name. - Name
-
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region.
UpdateEventBridgeRuleTemplateResponseContent
Members
- Arn
-
- Required: Yes
- Type: string
An eventbridge rule template's ARN (Amazon Resource Name) - CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A resource's optional description. - EventTargets
-
- Type: Array of EventBridgeRuleTemplateTarget structures
- EventType
-
- Required: Yes
- Type: string
The type of event to match with the rule. - GroupId
-
- Required: Yes
- Type: string
An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` - Id
-
- Required: Yes
- Type: string
An eventbridge rule template's id. AWS provided templates have ids that start with `aws-` - ModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Required: Yes
- Type: string
A resource's name. Names must be unique within the scope of a resource type in a specific region. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the tags associated with a resource.
UpdateInput
Members
- Destinations
-
- Type: Array of InputDestinationRequest structures
Destination settings for PUSH type inputs. - InputDevices
-
- Type: Array of InputDeviceRequest structures
Settings for the devices. - InputSecurityGroups
-
- Type: Array of strings
A list of security groups referenced by IDs to attach to the input. - MediaConnectFlows
-
- Type: Array of MediaConnectFlowRequest structures
A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as oneFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in aseparate Availability Zone as this ensures your EML input is redundant to AZ issues. - MulticastSettings
-
- Type: MulticastSettingsUpdateRequest structure
Multicast Input settings. - Name
-
- Type: string
Name of the input. - RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role this input assumes during and after creation. - Sources
-
- Type: Array of InputSourceRequest structures
The source URLs for a PULL-type input. Every PULL type input needsexactly two source URLs for redundancy.Only specify sources for PULL type Inputs. Leave Destinations empty. - SrtSettings
-
- Type: SrtSettingsRequest structure
The settings associated with an SRT input.
UpdateInputDevice
Description
Updates an input device.
Members
- AvailabilityZone
-
- Type: string
The Availability Zone you want associated with this input device. - HdDeviceSettings
-
- Type: InputDeviceConfigurableSettings structure
The settings that you want to apply to the HD input device. - Name
-
- Type: string
The name that you assigned to this input device (not the unique ID). - UhdDeviceSettings
-
- Type: InputDeviceConfigurableSettings structure
The settings that you want to apply to the UHD input device.
UpdateInputResultModel
Members
- Input
-
- Type: Input structure
UpdateInputSecurityGroupResultModel
Members
- SecurityGroup
-
- Type: InputSecurityGroup structure
An Input Security Group
UpdateMultiplex
Members
- MultiplexSettings
-
- Type: MultiplexSettings structure
The new settings for a multiplex. - Name
-
- Type: string
Name of the multiplex. - PacketIdentifiersMapping
-
- Type: Associative array of custom strings keys (__string) to MultiplexProgramPacketIdentifiersMap structures
UpdateMultiplexProgram
Members
- MultiplexProgramSettings
-
- Type: MultiplexProgramSettings structure
The new settings for a multiplex program.
UpdateMultiplexProgramResultModel
Members
- MultiplexProgram
-
- Type: MultiplexProgram structure
The updated multiplex program.
UpdateMultiplexResultModel
Members
- Multiplex
-
- Type: Multiplex structure
The updated multiplex.
UpdateNetworkResult
Description
Contains the response for the UpdateNetwork
Members
- Arn
-
- Type: string
The ARN of this Network. It is automatically assigned when the Network is created. - AssociatedClusterIds
-
- Type: Array of strings
- Id
-
- Type: string
The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN. - IpPools
-
- Type: Array of IpPool structures
An array of IpPools in your organization's network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block. - Name
-
- Type: string
The name that you specified for the Network. - Routes
-
- Type: Array of Route structures
An array of Routes that MediaLive Anywhere needs to know about in order to route encoding traffic. - State
-
- Type: string
The current state of the Network. Only MediaLive Anywhere can change the state.
UpdateReservation
Description
UpdateReservation request
Members
- Name
-
- Type: string
Name of the reservation - RenewalSettings
-
- Type: RenewalSettings structure
Renewal settings for the reservation
UpdateReservationResultModel
Description
UpdateReservation response
Members
- Reservation
-
- Type: Reservation structure
Reserved resources available to use
ValidationError
Members
- ElementPath
-
- Type: string
Path to the source of the error. - ErrorMessage
-
- Type: string
The error message.
VideoBlackFailoverSettings
Members
- BlackDetectThreshold
-
- Type: double
A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023*0.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255*0.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places. - VideoBlackThresholdMsec
-
- Type: int
The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs.
VideoCodecSettings
Description
Video Codec Settings
Members
- Av1Settings
-
- Type: Av1Settings structure
Av1 Settings - FrameCaptureSettings
-
- Type: FrameCaptureSettings structure
Frame Capture Settings - H264Settings
-
- Type: H264Settings structure
H264 Settings - H265Settings
-
- Type: H265Settings structure
H265 Settings - Mpeg2Settings
-
- Type: Mpeg2Settings structure
Mpeg2 Settings
VideoDescription
Description
Video settings for this stream.
Members
- CodecSettings
-
- Type: VideoCodecSettings structure
Video codec settings. - Height
-
- Type: int
Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. - Name
-
- Required: Yes
- Type: string
The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event. - RespondToAfd
-
- Type: string
Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH.RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE.PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output.NONE: MediaLive does not clip the input video and does not include the AFD values in the output - ScalingBehavior
-
- Type: string
STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. - Sharpness
-
- Type: int
Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content. - Width
-
- Type: int
Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
VideoSelector
Description
Specifies a particular video stream within an input source. An input may have only a single video selector.
Members
- ColorSpace
-
- Type: string
Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed. - ColorSpaceSettings
-
- Type: VideoSelectorColorSpaceSettings structure
Color space settings - ColorSpaceUsage
-
- Type: string
Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. - SelectorSettings
-
- Type: VideoSelectorSettings structure
The video selector settings.
VideoSelectorColorSpaceSettings
Description
Video Selector Color Space Settings
Members
- Hdr10Settings
-
- Type: Hdr10Settings structure
Hdr10 Settings
VideoSelectorPid
Description
Video Selector Pid
Members
- Pid
-
- Type: int
Selects a specific PID from within a video source.
VideoSelectorProgramId
Description
Video Selector Program Id
Members
- ProgramId
-
- Type: int
Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
VideoSelectorSettings
Description
Video Selector Settings
Members
- VideoSelectorPid
-
- Type: VideoSelectorPid structure
Video Selector Pid - VideoSelectorProgramId
-
- Type: VideoSelectorProgramId structure
Video Selector Program Id
VpcOutputSettings
Description
The properties for a private VPC OutputWhen this property is specified, the output egress addresses will be created in a user specified VPC
Members
- PublicAddressAllocationIds
-
- Type: Array of strings
List of public address allocation ids to associate with ENIs that will be created in Output VPC.Must specify one for SINGLE_PIPELINE, two for STANDARD channels - SecurityGroupIds
-
- Type: Array of strings
A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network interfaces.If none are specified then the VPC default security group will be used - SubnetIds
-
- Required: Yes
- Type: Array of strings
A list of VPC subnet IDs from the same VPC.If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).
VpcOutputSettingsDescription
Description
The properties for a private VPC Output
Members
- AvailabilityZones
-
- Type: Array of strings
The Availability Zones where the vpc subnets are located.The first Availability Zone applies to the first subnet in the list of subnets.The second Availability Zone applies to the second subnet. - NetworkInterfaceIds
-
- Type: Array of strings
A list of Elastic Network Interfaces created by MediaLive in the customer's VPC - SecurityGroupIds
-
- Type: Array of strings
A list of up EC2 VPC security group IDs attached to the Output VPC network interfaces. - SubnetIds
-
- Type: Array of strings
A list of VPC subnet IDs from the same VPC.If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).
WavSettings
Description
Wav Settings
Members
- BitDepth
-
- Type: double
Bits per sample. - CodingMode
-
- Type: string
The audio coding mode for the WAV audio. The mode determines the number of channels in the audio. - SampleRate
-
- Type: double
Sample rate in Hz.
WebvttDestinationSettings
Description
Webvtt Destination Settings
Members
- StyleControl
-
- Type: string
Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO_STYLE_DATA - Don't pass through the style. The output captions will not contain any font styling information.