SDK for PHP 3.x

Client: Aws\MediaPackageV2\MediaPackageV2Client
Service ID: mediapackagev2
Version: 2022-12-25

This page describes the parameters and results for the operations of the AWS Elemental MediaPackage v2 (2022-12-25), and shows how to use the Aws\MediaPackageV2\MediaPackageV2Client object to call the described operations. This documentation is specific to the 2022-12-25 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 */).

CreateChannel ( array $params = [] )
Create a channel to start receiving content streams.
CreateChannelGroup ( array $params = [] )
Create a channel group to group your channels and origin endpoints.
CreateOriginEndpoint ( array $params = [] )
The endpoint is attached to a channel, and represents the output of the live content.
DeleteChannel ( array $params = [] )
Delete a channel to stop AWS Elemental MediaPackage from receiving further content.
DeleteChannelGroup ( array $params = [] )
Delete a channel group.
DeleteChannelPolicy ( array $params = [] )
Delete a channel policy.
DeleteOriginEndpoint ( array $params = [] )
Origin endpoints can serve content until they're deleted.
DeleteOriginEndpointPolicy ( array $params = [] )
Delete an origin endpoint policy.
GetChannel ( array $params = [] )
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
GetChannelGroup ( array $params = [] )
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
GetChannelPolicy ( array $params = [] )
Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage.
GetOriginEndpoint ( array $params = [] )
Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.
GetOriginEndpointPolicy ( array $params = [] )
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
ListChannelGroups ( array $params = [] )
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
ListChannels ( array $params = [] )
Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
ListOriginEndpoints ( array $params = [] )
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
ListTagsForResource ( array $params = [] )
Lists the tags assigned to a resource.
PutChannelPolicy ( array $params = [] )
Attaches an IAM policy to the specified channel.
PutOriginEndpointPolicy ( array $params = [] )
Attaches an IAM policy to the specified origin endpoint.
TagResource ( array $params = [] )
Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
UntagResource ( array $params = [] )
Removes one or more tags from the specified resource.
UpdateChannel ( array $params = [] )
Update the specified channel.
UpdateChannelGroup ( array $params = [] )
Update the specified channel group.
UpdateOriginEndpoint ( array $params = [] )
Update the specified origin endpoint.

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:

ListChannelGroups
ListChannels
ListOriginEndpoints

Operations

CreateChannel

$result = $client->createChannel([/* ... */]);
$promise = $client->createChannelAsync([/* ... */]);

Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.

Parameter Syntax

$result = $client->createChannel([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'InputType' => 'HLS|CMAF',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.

ClientToken
Type: string

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

Description
Type: string

Enter any descriptive text that helps you to identify the channel.

InputType
Type: string

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

Tags
Type: Associative array of custom strings keys (TagKey) to strings

A comma-separated list of tag key:value pairs that you define. For example:

"Key1": "Value1",

"Key2": "Value2"

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'ETag' => '<string>',
    'IngestEndpoints' => [
        [
            'Id' => '<string>',
            'Url' => '<string>',
        ],
        // ...
    ],
    'InputType' => 'HLS|CMAF',
    'ModifiedAt' => <DateTime>,
    'Tags' => ['<string>', ...],
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

CreatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel was created.

Description
Type: string

The description for your channel.

ETag
Type: string

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

IngestEndpoints
Type: Array of IngestEndpoint structures

The list of ingest endpoints.

InputType
Type: string

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

ModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel was modified.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The comma-separated list of tag key:value pairs assigned to the channel.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

Examples

Example 1: Creating a Channel
$result = $client->createChannel([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'Description' => 'Description for exampleChannel',
    'InputType' => 'HLS',
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel',
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'CreatedAt' => ,
    'Description' => 'Description for exampleChannel',
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'IngestEndpoints' => [
        [
            'Id' => '1',
            'Url' => 'https://abcde-1.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index',
        ],
        [
            'Id' => '2',
            'Url' => 'https://abcde-2.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index',
        ],
    ],
    'InputType' => 'HLS',
    'ModifiedAt' => ,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]

CreateChannelGroup

$result = $client->createChannelGroup([/* ... */]);
$promise = $client->createChannelGroupAsync([/* ... */]);

Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.

Parameter Syntax

$result = $client->createChannelGroup([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. You can't use spaces in the name. You can't change the name after you create the channel group.

ClientToken
Type: string

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

Description
Type: string

Enter any descriptive text that helps you to identify the channel group.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

A comma-separated list of tag key:value pairs that you define. For example:

"Key1": "Value1",

"Key2": "Value2"

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'ETag' => '<string>',
    'EgressDomain' => '<string>',
    'ModifiedAt' => <DateTime>,
    'Tags' => ['<string>', ...],
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

CreatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel group was created.

Description
Type: string

The description for your channel group.

ETag
Type: string

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

EgressDomain
Required: Yes
Type: string

The output domain where the source stream should be sent. Integrate the egress domain with a downstream CDN (such as Amazon CloudFront) or playback device.

ModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel group was modified.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The comma-separated list of tag key:value pairs assigned to the channel group.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

Examples

Example 1: Creating a Channel Group
$result = $client->createChannelGroup([
    'ChannelGroupName' => 'exampleChannelGroup',
    'Description' => 'Description for exampleChannelGroup',
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup',
    'ChannelGroupName' => 'exampleChannelGroup',
    'CreatedAt' => ,
    'Description' => 'Description for exampleChannelGroup',
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'EgressDomain' => 'abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com',
    'ModifiedAt' => ,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]

CreateOriginEndpoint

$result = $client->createOriginEndpoint([/* ... */]);
$promise = $client->createOriginEndpointAsync([/* ... */]);

The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.

Parameter Syntax

$result = $client->createOriginEndpoint([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'ContainerType' => 'TS|CMAF', // REQUIRED
    'DashManifests' => [
        [
            'DrmSignaling' => 'INDIVIDUAL|REFERENCED',
            'FilterConfiguration' => [
                'End' => <integer || string || DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <integer || string || DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'ManifestWindowSeconds' => <integer>,
            'MinBufferTimeSeconds' => <integer>,
            'MinUpdatePeriodSeconds' => <integer>,
            'PeriodTriggers' => ['<string>', ...],
            'ScteDash' => [
                'AdMarkerDash' => 'BINARY|XML',
            ],
            'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE',
            'SuggestedPresentationDelaySeconds' => <integer>,
            'UtcTiming' => [
                'TimingMode' => 'HTTP_HEAD|HTTP_ISO|HTTP_XSDATE|UTC_DIRECT',
                'TimingSource' => '<string>',
            ],
        ],
        // ...
    ],
    'Description' => '<string>',
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => ['<string>', ...],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'End' => <integer || string || DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <integer || string || DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
        // ...
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'End' => <integer || string || DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <integer || string || DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
        // ...
    ],
    'OriginEndpointName' => '<string>', // REQUIRED
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => '<string>',
            'EncryptionMethod' => [ // REQUIRED
                'CmafEncryptionMethod' => 'CENC|CBCS',
                'TsEncryptionMethod' => 'AES_128|SAMPLE_AES',
            ],
            'KeyRotationIntervalSeconds' => <integer>,
            'SpekeKeyProvider' => [ // REQUIRED
                'DrmSystems' => ['<string>', ...], // REQUIRED
                'EncryptionContractConfiguration' => [ // REQUIRED
                    'PresetSpeke20Audio' => 'PRESET_AUDIO_1|PRESET_AUDIO_2|PRESET_AUDIO_3|SHARED|UNENCRYPTED', // REQUIRED
                    'PresetSpeke20Video' => 'PRESET_VIDEO_1|PRESET_VIDEO_2|PRESET_VIDEO_3|PRESET_VIDEO_4|PRESET_VIDEO_5|PRESET_VIDEO_6|PRESET_VIDEO_7|PRESET_VIDEO_8|SHARED|UNENCRYPTED', // REQUIRED
                ],
                'ResourceId' => '<string>', // REQUIRED
                'RoleArn' => '<string>', // REQUIRED
                'Url' => '<string>', // REQUIRED
            ],
        ],
        'IncludeIframeOnlyStreams' => true || false,
        'Scte' => [
            'ScteFilter' => ['<string>', ...],
        ],
        'SegmentDurationSeconds' => <integer>,
        'SegmentName' => '<string>',
        'TsIncludeDvbSubtitles' => true || false,
        'TsUseAudioRenditionGroup' => true || false,
    ],
    'StartoverWindowSeconds' => <integer>,
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

ClientToken
Type: string

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

ContainerType
Required: Yes
Type: string

The type of container to attach to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. You can't change the container type after you create the endpoint.

DashManifests
Type: Array of CreateDashManifestConfiguration structures

A DASH manifest configuration.

Description
Type: string

Enter any descriptive text that helps you to identify the origin endpoint.

ForceEndpointErrorConfiguration

The failover settings for the endpoint.

HlsManifests
Type: Array of CreateHlsManifestConfiguration structures

An HTTP live streaming (HLS) manifest configuration.

LowLatencyHlsManifests
Type: Array of CreateLowLatencyHlsManifestConfiguration structures

A low-latency HLS manifest configuration.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and must be unique for your account in the AWS Region and channel. You can't use spaces in the name. You can't change the name after you create the endpoint.

Segment
Type: Segment structure

The segment configuration, including the segment name, duration, and other configuration values.

StartoverWindowSeconds
Type: int

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

Tags
Type: Associative array of custom strings keys (TagKey) to strings

A comma-separated list of tag key:value pairs that you define. For example:

"Key1": "Value1",

"Key2": "Value2"

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'ContainerType' => 'TS|CMAF',
    'CreatedAt' => <DateTime>,
    'DashManifests' => [
        [
            'DrmSignaling' => 'INDIVIDUAL|REFERENCED',
            'FilterConfiguration' => [
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'MinBufferTimeSeconds' => <integer>,
            'MinUpdatePeriodSeconds' => <integer>,
            'PeriodTriggers' => ['<string>', ...],
            'ScteDash' => [
                'AdMarkerDash' => 'BINARY|XML',
            ],
            'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE',
            'SuggestedPresentationDelaySeconds' => <integer>,
            'Url' => '<string>',
            'UtcTiming' => [
                'TimingMode' => 'HTTP_HEAD|HTTP_ISO|HTTP_XSDATE|UTC_DIRECT',
                'TimingSource' => '<string>',
            ],
        ],
        // ...
    ],
    'Description' => '<string>',
    'ETag' => '<string>',
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => ['<string>', ...],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => '<string>',
        ],
        // ...
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => '<string>',
        ],
        // ...
    ],
    'ModifiedAt' => <DateTime>,
    'OriginEndpointName' => '<string>',
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => '<string>',
            'EncryptionMethod' => [
                'CmafEncryptionMethod' => 'CENC|CBCS',
                'TsEncryptionMethod' => 'AES_128|SAMPLE_AES',
            ],
            'KeyRotationIntervalSeconds' => <integer>,
            'SpekeKeyProvider' => [
                'DrmSystems' => ['<string>', ...],
                'EncryptionContractConfiguration' => [
                    'PresetSpeke20Audio' => 'PRESET_AUDIO_1|PRESET_AUDIO_2|PRESET_AUDIO_3|SHARED|UNENCRYPTED',
                    'PresetSpeke20Video' => 'PRESET_VIDEO_1|PRESET_VIDEO_2|PRESET_VIDEO_3|PRESET_VIDEO_4|PRESET_VIDEO_5|PRESET_VIDEO_6|PRESET_VIDEO_7|PRESET_VIDEO_8|SHARED|UNENCRYPTED',
                ],
                'ResourceId' => '<string>',
                'RoleArn' => '<string>',
                'Url' => '<string>',
            ],
        ],
        'IncludeIframeOnlyStreams' => true || false,
        'Scte' => [
            'ScteFilter' => ['<string>', ...],
        ],
        'SegmentDurationSeconds' => <integer>,
        'SegmentName' => '<string>',
        'TsIncludeDvbSubtitles' => true || false,
        'TsUseAudioRenditionGroup' => true || false,
    ],
    'StartoverWindowSeconds' => <integer>,
    'Tags' => ['<string>', ...],
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

ContainerType
Required: Yes
Type: string

The type of container attached to this origin endpoint.

CreatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the origin endpoint was created.

DashManifests
Type: Array of GetDashManifestConfiguration structures

A DASH manifest configuration.

Description
Type: string

The description for your origin endpoint.

ETag
Type: string

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

ForceEndpointErrorConfiguration

The failover settings for the endpoint.

HlsManifests
Type: Array of GetHlsManifestConfiguration structures

An HTTP live streaming (HLS) manifest configuration.

LowLatencyHlsManifests
Type: Array of GetLowLatencyHlsManifestConfiguration structures

A low-latency HLS manifest configuration.

ModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the origin endpoint was modified.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Segment
Required: Yes
Type: Segment structure

The segment configuration, including the segment name, duration, and other configuration values.

StartoverWindowSeconds
Type: int

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The comma-separated list of tag key:value pairs assigned to the origin endpoint.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

Examples

Example 1: Creating an OriginEndpoint with container type TS, and encryption enabled
$result = $client->createOriginEndpoint([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'ContainerType' => 'TS',
    'Description' => 'Description for exampleOriginEndpointTS',
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => [
            'STALE_MANIFEST',
            'INCOMPLETE_MANIFEST',
            'MISSING_DRM_KEY',
            'SLATE_INPUT',
        ],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => 'exampleChildManifest1',
            'ManifestName' => 'exampleManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
        [
            'ChildManifestName' => 'exampleManifest2',
            'ManifestName' => 'exampleManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => 'exampleLLChildManifest1',
            'ManifestName' => 'exampleLLManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
        [
            'ChildManifestName' => 'exampleLLManifest2',
            'ManifestName' => 'exampleLLManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
    ],
    'OriginEndpointName' => 'exampleOriginEndpointTS',
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => 'A382A901F3C1F7718512266CFFBB0B7E',
            'EncryptionMethod' => [
                'TsEncryptionMethod' => 'AES_128',
            ],
            'KeyRotationIntervalSeconds' => 300,
            'SpekeKeyProvider' => [
                'DrmSystems' => [
                    'CLEAR_KEY_AES_128',
                ],
                'EncryptionContractConfiguration' => [
                    'PresetSpeke20Audio' => 'SHARED',
                    'PresetSpeke20Video' => 'SHARED',
                ],
                'ResourceId' => 'ResourceId',
                'RoleArn' => 'arn:aws:iam::123456789012:role/empRole',
                'Url' => 'https://foo.com',
            ],
        ],
        'IncludeIframeOnlyStreams' => 1,
        'Scte' => [
            'ScteFilter' => [
                'SPLICE_INSERT',
                'BREAK',
            ],
        ],
        'SegmentDurationSeconds' => 6,
        'SegmentName' => 'segmentName',
        'TsIncludeDvbSubtitles' => 1,
        'TsUseAudioRenditionGroup' => 1,
    ],
    'StartoverWindowSeconds' => 300,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointTS',
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'ContainerType' => 'TS',
    'CreatedAt' => ,
    'Description' => 'Description for exampleOriginEndpointTS',
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => [
            'STALE_MANIFEST',
            'INCOMPLETE_MANIFEST',
            'MISSING_DRM_KEY',
            'SLATE_INPUT',
        ],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => 'exampleChildManifest1',
            'ManifestName' => 'exampleManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest1.m3u8',
        ],
        [
            'ChildManifestName' => 'exampleManifest2',
            'ManifestName' => 'exampleManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest2.m3u8',
        ],
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => 'exampleLLChildManifest1',
            'ManifestName' => 'exampleLLManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest1.m3u8',
        ],
        [
            'ChildManifestName' => 'exampleLLManifest2',
            'ManifestName' => 'exampleLLManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest2.m3u8',
        ],
    ],
    'ModifiedAt' => ,
    'OriginEndpointName' => 'exampleOriginEndpointTS',
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => 'A382A901F3C1F7718512266CFFBB0B7E',
            'EncryptionMethod' => [
                'TsEncryptionMethod' => 'AES_128',
            ],
            'KeyRotationIntervalSeconds' => 300,
            'SpekeKeyProvider' => [
                'DrmSystems' => [
                    'CLEAR_KEY_AES_128',
                ],
                'EncryptionContractConfiguration' => [
                    'PresetSpeke20Audio' => 'SHARED',
                    'PresetSpeke20Video' => 'SHARED',
                ],
                'ResourceId' => 'ResourceId',
                'RoleArn' => 'arn:aws:iam::123456789012:role/empRole',
                'Url' => 'https://foo.com',
            ],
        ],
        'IncludeIframeOnlyStreams' => 1,
        'Scte' => [
            'ScteFilter' => [
                'SPLICE_INSERT',
                'BREAK',
            ],
        ],
        'SegmentDurationSeconds' => 6,
        'SegmentName' => 'segmentName',
        'TsIncludeDvbSubtitles' => 1,
        'TsUseAudioRenditionGroup' => 1,
    ],
    'StartoverWindowSeconds' => 300,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]
Example 2: Creating an OriginEndpoint with container type CMAF, and encryption enabled
$result = $client->createOriginEndpoint([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'ContainerType' => 'CMAF',
    'DashManifests' => [
        [
            'DrmSignaling' => 'INDIVIDUAL',
            'ManifestName' => 'exampleDashManifest1',
            'ManifestWindowSeconds' => 300,
            'MinBufferTimeSeconds' => 30,
            'MinUpdatePeriodSeconds' => 5,
            'PeriodTriggers' => [
                'AVAILS',
            ],
            'ScteDash' => [
                'AdMarkerDash' => 'XML',
            ],
            'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE',
            'SuggestedPresentationDelaySeconds' => 2,
        ],
        [
            'DrmSignaling' => 'INDIVIDUAL',
            'ManifestName' => 'exampleDashManifest2',
            'ManifestWindowSeconds' => 60,
            'MinBufferTimeSeconds' => 9,
            'MinUpdatePeriodSeconds' => 3,
            'PeriodTriggers' => [
                'AVAILS',
                'DRM_KEY_ROTATION',
                'SOURCE_CHANGES',
                'SOURCE_DISRUPTIONS',
            ],
            'ScteDash' => [
                'AdMarkerDash' => 'XML',
            ],
            'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE',
            'SuggestedPresentationDelaySeconds' => 12,
        ],
    ],
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => [
            'STALE_MANIFEST',
            'INCOMPLETE_MANIFEST',
            'MISSING_DRM_KEY',
            'SLATE_INPUT',
        ],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => 'exampleChildManifest1',
            'ManifestName' => 'exampleManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
        [
            'ChildManifestName' => 'exampleManifest2',
            'ManifestName' => 'exampleManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => 'exampleLLChildManifest1',
            'ManifestName' => 'exampleLLManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
        [
            'ChildManifestName' => 'exampleLLManifest2',
            'ManifestName' => 'exampleLLManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
    ],
    'OriginEndpointName' => 'exampleOriginEndpointCMAF',
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => 'A382A901F3C1F7718512266CFFBB0B9F',
            'EncryptionMethod' => [
                'CmafEncryptionMethod' => 'CBCS',
            ],
            'KeyRotationIntervalSeconds' => 300,
            'SpekeKeyProvider' => [
                'DrmSystems' => [
                    'PLAYREADY',
                    'WIDEVINE',
                ],
                'EncryptionContractConfiguration' => [
                    'PresetSpeke20Audio' => 'PRESET_AUDIO_1',
                    'PresetSpeke20Video' => 'PRESET_VIDEO_1',
                ],
                'ResourceId' => 'ResourceId',
                'RoleArn' => 'arn:aws:iam::123456789012:role/empRole',
                'Url' => 'https://foo.com',
            ],
        ],
        'IncludeIframeOnlyStreams' => 1,
        'Scte' => [
            'ScteFilter' => [
                'SPLICE_INSERT',
                'BREAK',
            ],
        ],
        'SegmentDurationSeconds' => 6,
        'SegmentName' => 'segmentName',
    ],
    'StartoverWindowSeconds' => 300,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointCMAF',
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'ContainerType' => 'CMAF',
    'CreatedAt' => ,
    'DashManifests' => [
        [
            'DrmSignaling' => 'INDIVIDUAL',
            'ManifestName' => 'exampleDashManifest1',
            'ManifestWindowSeconds' => 300,
            'MinBufferTimeSeconds' => 30,
            'MinUpdatePeriodSeconds' => 5,
            'PeriodTriggers' => [
                'AVAILS',
            ],
            'ScteDash' => [
                'AdMarkerDash' => 'XML',
            ],
            'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE',
            'SuggestedPresentationDelaySeconds' => 2,
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest1.mpd',
        ],
        [
            'DrmSignaling' => 'INDIVIDUAL',
            'ManifestName' => 'exampleDashManifest2',
            'ManifestWindowSeconds' => 60,
            'MinBufferTimeSeconds' => 9,
            'MinUpdatePeriodSeconds' => 3,
            'PeriodTriggers' => [
                'AVAILS',
                'DRM_KEY_ROTATION',
                'SOURCE_CHANGES',
                'SOURCE_DISRUPTIONS',
            ],
            'ScteDash' => [
                'AdMarkerDash' => 'XML',
            ],
            'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE',
            'SuggestedPresentationDelaySeconds' => 12,
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest2.mpd',
        ],
    ],
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => [
            'STALE_MANIFEST',
            'INCOMPLETE_MANIFEST',
            'MISSING_DRM_KEY',
            'SLATE_INPUT',
        ],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => 'exampleChildManifest1',
            'ManifestName' => 'exampleManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleManifest1.m3u8',
        ],
        [
            'ChildManifestName' => 'exampleManifest2',
            'ManifestName' => 'exampleManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleManifest2.m3u8',
        ],
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => 'exampleLLChildManifest1',
            'ManifestName' => 'exampleLLManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleLLManifest1.m3u8',
        ],
        [
            'ChildManifestName' => 'exampleLLManifest2',
            'ManifestName' => 'exampleLLManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleLLManifest2.m3u8',
        ],
    ],
    'ModifiedAt' => ,
    'OriginEndpointName' => 'exampleOriginEndpointCMAF',
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => 'A382A901F3C1F7718512266CFFBB0B9F',
            'EncryptionMethod' => [
                'CmafEncryptionMethod' => 'CBCS',
            ],
            'KeyRotationIntervalSeconds' => 300,
            'SpekeKeyProvider' => [
                'DrmSystems' => [
                    'PLAYREADY',
                    'WIDEVINE',
                ],
                'EncryptionContractConfiguration' => [
                    'PresetSpeke20Audio' => 'PRESET_AUDIO_1',
                    'PresetSpeke20Video' => 'PRESET_VIDEO_1',
                ],
                'ResourceId' => 'ResourceId',
                'RoleArn' => 'arn:aws:iam::123456789012:role/empRole',
                'Url' => 'https://foo.com',
            ],
        ],
        'IncludeIframeOnlyStreams' => 1,
        'Scte' => [
            'ScteFilter' => [
                'SPLICE_INSERT',
                'BREAK',
            ],
        ],
        'SegmentDurationSeconds' => 6,
        'SegmentName' => 'segmentName',
    ],
    'StartoverWindowSeconds' => 300,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]

DeleteChannel

$result = $client->deleteChannel([/* ... */]);
$promise = $client->deleteChannelAsync([/* ... */]);

Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.

Parameter Syntax

$result = $client->deleteChannel([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

Examples

Example 1: Deleting a Channel
$result = $client->deleteChannel([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
]);

Result syntax:

[
]

DeleteChannelGroup

$result = $client->deleteChannelGroup([/* ... */]);
$promise = $client->deleteChannelGroupAsync([/* ... */]);

Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.

Parameter Syntax

$result = $client->deleteChannelGroup([
    'ChannelGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

Examples

Example 1: Deleting a Channel Group
$result = $client->deleteChannelGroup([
    'ChannelGroupName' => 'exampleChannelGroup',
]);

Result syntax:

[
]

DeleteChannelPolicy

$result = $client->deleteChannelPolicy([/* ... */]);
$promise = $client->deleteChannelPolicyAsync([/* ... */]);

Delete a channel policy.

Parameter Syntax

$result = $client->deleteChannelPolicy([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

Examples

Example 1: Deleting a Channel Policy
$result = $client->deleteChannelPolicy([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
]);

Result syntax:

[
]

DeleteOriginEndpoint

$result = $client->deleteOriginEndpoint([/* ... */]);
$promise = $client->deleteOriginEndpointAsync([/* ... */]);

Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.

Parameter Syntax

$result = $client->deleteOriginEndpoint([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'OriginEndpointName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request throughput limit was exceeded.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

Examples

Example 1: Deleting an OriginEndpoint
$result = $client->deleteOriginEndpoint([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'OriginEndpointName' => 'exampleOriginEndpointTS',
]);

Result syntax:

[
]

DeleteOriginEndpointPolicy

$result = $client->deleteOriginEndpointPolicy([/* ... */]);
$promise = $client->deleteOriginEndpointPolicyAsync([/* ... */]);

Delete an origin endpoint policy.

Parameter Syntax

$result = $client->deleteOriginEndpointPolicy([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'OriginEndpointName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

Examples

Example 1: Deleting an Origin Endpoint Policy
$result = $client->deleteOriginEndpointPolicy([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'OriginEndpointName' => 'exampleOriginEndpoint',
]);

Result syntax:

[
]

GetChannel

$result = $client->getChannel([/* ... */]);
$promise = $client->getChannelAsync([/* ... */]);

Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

Parameter Syntax

$result = $client->getChannel([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'ETag' => '<string>',
    'IngestEndpoints' => [
        [
            'Id' => '<string>',
            'Url' => '<string>',
        ],
        // ...
    ],
    'InputType' => 'HLS|CMAF',
    'ModifiedAt' => <DateTime>,
    'Tags' => ['<string>', ...],
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

CreatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel was created.

Description
Type: string

The description for your channel.

ETag
Type: string

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

IngestEndpoints
Type: Array of IngestEndpoint structures

The list of ingest endpoints.

InputType
Type: string

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

ModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel was modified.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The comma-separated list of tag key:value pairs assigned to the channel.

Errors

ThrottlingException:

The request throughput limit was exceeded.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

Examples

Example 1: Getting a Channel
$result = $client->getChannel([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel',
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'CreatedAt' => ,
    'Description' => 'Description for exampleChannel',
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'IngestEndpoints' => [
        [
            'Id' => '1',
            'Url' => 'https://abcde-1.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index',
        ],
        [
            'Id' => '2',
            'Url' => 'https://abcde-2.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index',
        ],
    ],
    'InputType' => 'HLS',
    'ModifiedAt' => ,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]

GetChannelGroup

$result = $client->getChannelGroup([/* ... */]);
$promise = $client->getChannelGroupAsync([/* ... */]);

Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.

Parameter Syntax

$result = $client->getChannelGroup([
    'ChannelGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'ETag' => '<string>',
    'EgressDomain' => '<string>',
    'ModifiedAt' => <DateTime>,
    'Tags' => ['<string>', ...],
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

CreatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel group was created.

Description
Type: string

The description for your channel group.

ETag
Type: string

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

EgressDomain
Required: Yes
Type: string

The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.

ModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel group was modified.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The comma-separated list of tag key:value pairs assigned to the channel group.

Errors

ThrottlingException:

The request throughput limit was exceeded.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

Examples

Example 1: Getting a Channel Group
$result = $client->getChannelGroup([
    'ChannelGroupName' => 'exampleChannelGroup',
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup',
    'ChannelGroupName' => 'exampleChannelGroup',
    'CreatedAt' => ,
    'Description' => 'Description for exampleChannelGroup',
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'EgressDomain' => 'abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com',
    'ModifiedAt' => ,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]

GetChannelPolicy

$result = $client->getChannelPolicy([/* ... */]);
$promise = $client->getChannelPolicyAsync([/* ... */]);

Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.

Parameter Syntax

$result = $client->getChannelPolicy([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

Result Syntax

[
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'Policy' => '<string>',
]

Result Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

Policy
Required: Yes
Type: string

The policy assigned to the channel.

Errors

ThrottlingException:

The request throughput limit was exceeded.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

Examples

Example 1: Getting a Channel Policy
$result = $client->getChannelPolicy([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
]);

Result syntax:

[
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'Policy' => '{...}',
]

GetOriginEndpoint

$result = $client->getOriginEndpoint([/* ... */]);
$promise = $client->getOriginEndpointAsync([/* ... */]);

Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.

Parameter Syntax

$result = $client->getOriginEndpoint([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'OriginEndpointName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'ContainerType' => 'TS|CMAF',
    'CreatedAt' => <DateTime>,
    'DashManifests' => [
        [
            'DrmSignaling' => 'INDIVIDUAL|REFERENCED',
            'FilterConfiguration' => [
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'MinBufferTimeSeconds' => <integer>,
            'MinUpdatePeriodSeconds' => <integer>,
            'PeriodTriggers' => ['<string>', ...],
            'ScteDash' => [
                'AdMarkerDash' => 'BINARY|XML',
            ],
            'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE',
            'SuggestedPresentationDelaySeconds' => <integer>,
            'Url' => '<string>',
            'UtcTiming' => [
                'TimingMode' => 'HTTP_HEAD|HTTP_ISO|HTTP_XSDATE|UTC_DIRECT',
                'TimingSource' => '<string>',
            ],
        ],
        // ...
    ],
    'Description' => '<string>',
    'ETag' => '<string>',
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => ['<string>', ...],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => '<string>',
        ],
        // ...
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => '<string>',
        ],
        // ...
    ],
    'ModifiedAt' => <DateTime>,
    'OriginEndpointName' => '<string>',
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => '<string>',
            'EncryptionMethod' => [
                'CmafEncryptionMethod' => 'CENC|CBCS',
                'TsEncryptionMethod' => 'AES_128|SAMPLE_AES',
            ],
            'KeyRotationIntervalSeconds' => <integer>,
            'SpekeKeyProvider' => [
                'DrmSystems' => ['<string>', ...],
                'EncryptionContractConfiguration' => [
                    'PresetSpeke20Audio' => 'PRESET_AUDIO_1|PRESET_AUDIO_2|PRESET_AUDIO_3|SHARED|UNENCRYPTED',
                    'PresetSpeke20Video' => 'PRESET_VIDEO_1|PRESET_VIDEO_2|PRESET_VIDEO_3|PRESET_VIDEO_4|PRESET_VIDEO_5|PRESET_VIDEO_6|PRESET_VIDEO_7|PRESET_VIDEO_8|SHARED|UNENCRYPTED',
                ],
                'ResourceId' => '<string>',
                'RoleArn' => '<string>',
                'Url' => '<string>',
            ],
        ],
        'IncludeIframeOnlyStreams' => true || false,
        'Scte' => [
            'ScteFilter' => ['<string>', ...],
        ],
        'SegmentDurationSeconds' => <integer>,
        'SegmentName' => '<string>',
        'TsIncludeDvbSubtitles' => true || false,
        'TsUseAudioRenditionGroup' => true || false,
    ],
    'StartoverWindowSeconds' => <integer>,
    'Tags' => ['<string>', ...],
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

ContainerType
Required: Yes
Type: string

The type of container attached to this origin endpoint.

CreatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the origin endpoint was created.

DashManifests
Type: Array of GetDashManifestConfiguration structures

A DASH manifest configuration.

Description
Type: string

The description for your origin endpoint.

ETag
Type: string

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

ForceEndpointErrorConfiguration

The failover settings for the endpoint.

HlsManifests
Type: Array of GetHlsManifestConfiguration structures

An HTTP live streaming (HLS) manifest configuration.

LowLatencyHlsManifests
Type: Array of GetLowLatencyHlsManifestConfiguration structures

A low-latency HLS manifest configuration.

ModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the origin endpoint was modified.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Segment
Required: Yes
Type: Segment structure

The segment configuration, including the segment name, duration, and other configuration values.

StartoverWindowSeconds
Type: int

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The comma-separated list of tag key:value pairs assigned to the origin endpoint.

Errors

ThrottlingException:

The request throughput limit was exceeded.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

Examples

Example 1: Getting an OriginEndpoint
$result = $client->getOriginEndpoint([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'OriginEndpointName' => 'exampleOriginEndpointTS',
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointTS',
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'ContainerType' => 'TS',
    'CreatedAt' => ,
    'Description' => 'Description for exampleOriginEndpointTS',
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => [
            'STALE_MANIFEST',
            'INCOMPLETE_MANIFEST',
            'MISSING_DRM_KEY',
            'SLATE_INPUT',
        ],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => 'exampleChildManifest1',
            'ManifestName' => 'exampleManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest1.m3u8',
        ],
        [
            'ChildManifestName' => 'exampleManifest2',
            'ManifestName' => 'exampleManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest2.m3u8',
        ],
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => 'exampleLLChildManifest1',
            'ManifestName' => 'exampleLLManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest1.m3u8',
        ],
        [
            'ChildManifestName' => 'exampleLLManifest2',
            'ManifestName' => 'exampleLLManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest2.m3u8',
        ],
    ],
    'ModifiedAt' => ,
    'OriginEndpointName' => 'exampleOriginEndpointTS',
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => 'A382A901F3C1F7718512266CFFBB0B7E',
            'EncryptionMethod' => [
                'TsEncryptionMethod' => 'AES_128',
            ],
            'KeyRotationIntervalSeconds' => 300,
            'SpekeKeyProvider' => [
                'DrmSystems' => [
                    'CLEAR_KEY_AES_128',
                ],
                'EncryptionContractConfiguration' => [
                    'PresetSpeke20Audio' => 'SHARED',
                    'PresetSpeke20Video' => 'SHARED',
                ],
                'ResourceId' => 'ResourceId',
                'RoleArn' => 'arn:aws:iam::123456789012:role/empRole',
                'Url' => 'https://foo.com',
            ],
        ],
        'IncludeIframeOnlyStreams' => 1,
        'Scte' => [
            'ScteFilter' => [
                'SPLICE_INSERT',
                'BREAK',
            ],
        ],
        'SegmentDurationSeconds' => 6,
        'SegmentName' => 'segmentName',
        'TsIncludeDvbSubtitles' => 1,
        'TsUseAudioRenditionGroup' => 1,
    ],
    'StartoverWindowSeconds' => 300,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]

GetOriginEndpointPolicy

$result = $client->getOriginEndpointPolicy([/* ... */]);
$promise = $client->getOriginEndpointPolicyAsync([/* ... */]);

Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.

Parameter Syntax

$result = $client->getOriginEndpointPolicy([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'OriginEndpointName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Result Syntax

[
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'OriginEndpointName' => '<string>',
    'Policy' => '<string>',
]

Result Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Policy
Required: Yes
Type: string

The policy assigned to the origin endpoint.

Errors

ThrottlingException:

The request throughput limit was exceeded.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

Examples

Example 1: Getting an Origin Endpoint Policy
$result = $client->getOriginEndpointPolicy([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'OriginEndpointName' => 'exampleOriginEndpoint',
]);

Result syntax:

[
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'OriginEndpointName' => 'exampleOriginEndpoint',
    'Policy' => '{...}',
]

ListChannelGroups

$result = $client->listChannelGroups([/* ... */]);
$promise = $client->listChannelGroupsAsync([/* ... */]);

Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.

Parameter Syntax

$result = $client->listChannelGroups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in the response.

NextToken
Type: string

The pagination token from the GET list request. Use the token to fetch the next page of results.

Result Syntax

[
    'Items' => [
        [
            'Arn' => '<string>',
            'ChannelGroupName' => '<string>',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'ModifiedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Items
Type: Array of ChannelGroupListConfiguration structures

The objects being returned.

NextToken
Type: string

The pagination token from the GET list request. Use the token to fetch the next page of results.

Errors

ThrottlingException:

The request throughput limit was exceeded.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

Examples

Example 1: Listing all Channel Groups
$result = $client->listChannelGroups([
]);

Result syntax:

[
    'Items' => [
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup',
            'ChannelGroupName' => 'exampleChannelGroup',
            'CreatedAt' => ,
            'Description' => 'Description for exampleChannelGroup',
            'ModifiedAt' => ,
        ],
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/anotherExampleChannelGroup',
            'ChannelGroupName' => 'anotherExampleChannelGroup',
            'CreatedAt' => ,
            'ModifiedAt' => ,
        ],
    ],
]

ListChannels

$result = $client->listChannels([/* ... */]);
$promise = $client->listChannelsAsync([/* ... */]);

Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

Parameter Syntax

$result = $client->listChannels([
    'ChannelGroupName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

MaxResults
Type: int

The maximum number of results to return in the response.

NextToken
Type: string

The pagination token from the GET list request. Use the token to fetch the next page of results.

Result Syntax

[
    'Items' => [
        [
            'Arn' => '<string>',
            'ChannelGroupName' => '<string>',
            'ChannelName' => '<string>',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'InputType' => 'HLS|CMAF',
            'ModifiedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Items
Type: Array of ChannelListConfiguration structures

The objects being returned.

NextToken
Type: string

The pagination token from the GET list request.

Errors

ThrottlingException:

The request throughput limit was exceeded.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

Examples

Example 1: Listing all Channels
$result = $client->listChannels([
    'ChannelGroupName' => 'exampleChannelGroup',
]);

Result syntax:

[
    'Items' => [
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel',
            'ChannelGroupName' => 'exampleChannelGroup',
            'ChannelName' => 'exampleChannel',
            'CreatedAt' => ,
            'Description' => 'Description for exampleChannel',
            'ModifiedAt' => ,
        ],
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/anotherExampleChannel',
            'ChannelGroupName' => 'exampleChannelGroup',
            'ChannelName' => 'anotherExampleChannel',
            'CreatedAt' => ,
            'ModifiedAt' => ,
        ],
    ],
]

ListOriginEndpoints

$result = $client->listOriginEndpoints([/* ... */]);
$promise = $client->listOriginEndpointsAsync([/* ... */]);

Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.

Parameter Syntax

$result = $client->listOriginEndpoints([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

MaxResults
Type: int

The maximum number of results to return in the response.

NextToken
Type: string

The pagination token from the GET list request. Use the token to fetch the next page of results.

Result Syntax

[
    'Items' => [
        [
            'Arn' => '<string>',
            'ChannelGroupName' => '<string>',
            'ChannelName' => '<string>',
            'ContainerType' => 'TS|CMAF',
            'CreatedAt' => <DateTime>,
            'DashManifests' => [
                [
                    'ManifestName' => '<string>',
                    'Url' => '<string>',
                ],
                // ...
            ],
            'Description' => '<string>',
            'ForceEndpointErrorConfiguration' => [
                'EndpointErrorConditions' => ['<string>', ...],
            ],
            'HlsManifests' => [
                [
                    'ChildManifestName' => '<string>',
                    'ManifestName' => '<string>',
                    'Url' => '<string>',
                ],
                // ...
            ],
            'LowLatencyHlsManifests' => [
                [
                    'ChildManifestName' => '<string>',
                    'ManifestName' => '<string>',
                    'Url' => '<string>',
                ],
                // ...
            ],
            'ModifiedAt' => <DateTime>,
            'OriginEndpointName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Items
Type: Array of OriginEndpointListConfiguration structures

The objects being returned.

NextToken
Type: string

The pagination token from the GET list request. Use the token to fetch the next page of results.

Errors

ThrottlingException:

The request throughput limit was exceeded.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

Examples

Example 1: Listing all OriginEndpoints
$result = $client->listOriginEndpoints([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
]);

Result syntax:

[
    'Items' => [
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointTS',
            'ChannelGroupName' => 'exampleChannelGroup',
            'ChannelName' => 'exampleChannel',
            'ContainerType' => 'TS',
            'CreatedAt' => ,
            'Description' => 'Description for exampleOriginEndpointTS',
            'ForceEndpointErrorConfiguration' => [
                'EndpointErrorConditions' => [
                    'STALE_MANIFEST',
                    'INCOMPLETE_MANIFEST',
                    'MISSING_DRM_KEY',
                    'SLATE_INPUT',
                ],
            ],
            'HlsManifests' => [
                [
                    'ChildManifestName' => 'exampleChildManifest1',
                    'ManifestName' => 'exampleManifest1',
                    'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest1.m3u8',
                ],
                [
                    'ChildManifestName' => 'exampleManifest2',
                    'ManifestName' => 'exampleManifest2',
                    'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest2.m3u8',
                ],
            ],
            'LowLatencyHlsManifests' => [
                [
                    'ChildManifestName' => 'exampleLLChildManifest1',
                    'ManifestName' => 'exampleLLManifest1',
                    'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest1.m3u8',
                ],
                [
                    'ChildManifestName' => 'exampleLLManifest2',
                    'ManifestName' => 'exampleLLManifest2',
                    'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest2.m3u8',
                ],
            ],
            'ModifiedAt' => ,
            'OriginEndpointName' => 'exampleOriginEndpointTS',
        ],
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointCMAF',
            'ChannelGroupName' => 'exampleChannelGroup',
            'ChannelName' => 'exampleChannel',
            'ContainerType' => 'CMAF',
            'CreatedAt' => ,
            'DashManifests' => [
                [
                    'ManifestName' => 'exampleDashManifest1',
                    'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest1.mpd',
                ],
                [
                    'ManifestName' => 'exampleDashManifest2',
                    'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest2.mpd',
                ],
            ],
            'ForceEndpointErrorConfiguration' => [
                'EndpointErrorConditions' => [
                    'STALE_MANIFEST',
                    'INCOMPLETE_MANIFEST',
                    'MISSING_DRM_KEY',
                    'SLATE_INPUT',
                ],
            ],
            'HlsManifests' => [
                [
                    'ChildManifestName' => 'exampleChildManifest1',
                    'ManifestName' => 'exampleManifest1',
                    'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleManifest1.m3u8',
                ],
                [
                    'ChildManifestName' => 'exampleManifest2',
                    'ManifestName' => 'exampleManifest2',
                    'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleManifest2.m3u8',
                ],
            ],
            'LowLatencyHlsManifests' => [
                [
                    'ChildManifestName' => 'exampleLLChildManifest1',
                    'ManifestName' => 'exampleLLManifest1',
                    'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleLLManifest1.m3u8',
                ],
                [
                    'ChildManifestName' => 'exampleLLManifest2',
                    'ManifestName' => 'exampleLLManifest2',
                    'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleLLManifest2.m3u8',
                ],
            ],
            'ModifiedAt' => ,
            'OriginEndpointName' => 'exampleOriginEndpointCMAF',
        ],
    ],
]

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags assigned to a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The ARN of the CloudWatch resource that you want to view tags for.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members
Tags
Type: Associative array of custom strings keys (TagKey) to strings

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Errors

ValidationException:

The input failed to meet the constraints specified by the AWS service.

Examples

Example 1: List all tags for a resource
$result = $client->listTagsForResource([
    'ResourceArn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel',
]);

Result syntax:

[
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]

PutChannelPolicy

$result = $client->putChannelPolicy([/* ... */]);
$promise = $client->putChannelPolicyAsync([/* ... */]);

Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.

Parameter Syntax

$result = $client->putChannelPolicy([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'Policy' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

Policy
Required: Yes
Type: string

The policy to attach to the specified channel.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

Examples

Example 1: Creating a Channel Policy
$result = $client->putChannelPolicy([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'Policy' => '{...}',
]);

Result syntax:

[
]

PutOriginEndpointPolicy

$result = $client->putOriginEndpointPolicy([/* ... */]);
$promise = $client->putOriginEndpointPolicyAsync([/* ... */]);

Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.

Parameter Syntax

$result = $client->putOriginEndpointPolicy([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'OriginEndpointName' => '<string>', // REQUIRED
    'Policy' => '<string>', // REQUIRED
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Policy
Required: Yes
Type: string

The policy to attach to the specified origin endpoint.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

Examples

Example 1: Creating an Origin Endpoint Policy
$result = $client->putOriginEndpointPolicy([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'OriginEndpointName' => 'exampleOriginEndpoint',
    'Policy' => '{...}',
]);

Result syntax:

[
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The ARN of the MediaPackage resource that you're adding tags to.

Tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The input failed to meet the constraints specified by the AWS service.

Examples

Example 1: Add tags to a resource
$result = $client->tagResource([
    'ResourceArn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel',
    'Tags' => [
        'key3' => 'value3',
        'key4' => 'value4',
    ],
]);

Result syntax:

[
]

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The ARN of the MediaPackage resource that you're removing tags from.

TagKeys
Required: Yes
Type: Array of strings

The list of tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The input failed to meet the constraints specified by the AWS service.

Examples

Example 1: Remove tags from a resource
$result = $client->untagResource([
    'ResourceArn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel',
    'TagKeys' => [
        'key3',
        'key4',
    ],
]);

Result syntax:

[
]

UpdateChannel

$result = $client->updateChannel([/* ... */]);
$promise = $client->updateChannelAsync([/* ... */]);

Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.

Any edits you make that impact the video output may not be reflected for a few minutes.

Parameter Syntax

$result = $client->updateChannel([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'ETag' => '<string>',
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

Description
Type: string

Any descriptive information that you want to add to the channel for future identification purposes.

ETag
Type: string

The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'ETag' => '<string>',
    'IngestEndpoints' => [
        [
            'Id' => '<string>',
            'Url' => '<string>',
        ],
        // ...
    ],
    'InputType' => 'HLS|CMAF',
    'ModifiedAt' => <DateTime>,
    'Tags' => ['<string>', ...],
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

CreatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel was created.

Description
Type: string

The description for your channel.

ETag
Type: string

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

IngestEndpoints
Type: Array of IngestEndpoint structures

The list of ingest endpoints.

InputType
Type: string

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

ModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel was modified.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The comma-separated list of tag key:value pairs assigned to the channel.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

Examples

Example 1: Updating a Channel
$result = $client->updateChannel([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'Description' => 'Updated description for exampleChannel',
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel',
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'CreatedAt' => ,
    'Description' => 'Updated description for exampleChannel',
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'IngestEndpoints' => [
        [
            'Id' => '1',
            'Url' => 'https://abcde-1.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index',
        ],
        [
            'Id' => '2',
            'Url' => 'https://abcde-2.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index',
        ],
    ],
    'InputType' => 'HLS',
    'ModifiedAt' => ,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]

UpdateChannelGroup

$result = $client->updateChannelGroup([/* ... */]);
$promise = $client->updateChannelGroupAsync([/* ... */]);

Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.

Any edits you make that impact the video output may not be reflected for a few minutes.

Parameter Syntax

$result = $client->updateChannelGroup([
    'ChannelGroupName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'ETag' => '<string>',
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

Description
Type: string

Any descriptive information that you want to add to the channel group for future identification purposes.

ETag
Type: string

The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'ETag' => '<string>',
    'EgressDomain' => '<string>',
    'ModifiedAt' => <DateTime>,
    'Tags' => ['<string>', ...],
]

Result Details

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

CreatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel group was created.

Description
Type: string

The description for your channel group.

ETag
Type: string

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

EgressDomain
Required: Yes
Type: string

The output domain where the source stream is sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.

ModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel group was modified.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The comma-separated list of tag key:value pairs assigned to the channel group.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

Examples

Example 1: Updating a Channel Group
$result = $client->updateChannelGroup([
    'ChannelGroupName' => 'exampleChannelGroup',
    'Description' => 'Updated description for exampleChannelGroup',
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup',
    'ChannelGroupName' => 'exampleChannelGroup',
    'CreatedAt' => ,
    'Description' => 'Updated description for exampleChannelGroup',
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'EgressDomain' => 'abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com',
    'ModifiedAt' => ,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]

UpdateOriginEndpoint

$result = $client->updateOriginEndpoint([/* ... */]);
$promise = $client->updateOriginEndpointAsync([/* ... */]);

Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint.

Any edits you make that impact the video output may not be reflected for a few minutes.

Parameter Syntax

$result = $client->updateOriginEndpoint([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'ContainerType' => 'TS|CMAF', // REQUIRED
    'DashManifests' => [
        [
            'DrmSignaling' => 'INDIVIDUAL|REFERENCED',
            'FilterConfiguration' => [
                'End' => <integer || string || DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <integer || string || DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'ManifestWindowSeconds' => <integer>,
            'MinBufferTimeSeconds' => <integer>,
            'MinUpdatePeriodSeconds' => <integer>,
            'PeriodTriggers' => ['<string>', ...],
            'ScteDash' => [
                'AdMarkerDash' => 'BINARY|XML',
            ],
            'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE',
            'SuggestedPresentationDelaySeconds' => <integer>,
            'UtcTiming' => [
                'TimingMode' => 'HTTP_HEAD|HTTP_ISO|HTTP_XSDATE|UTC_DIRECT',
                'TimingSource' => '<string>',
            ],
        ],
        // ...
    ],
    'Description' => '<string>',
    'ETag' => '<string>',
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => ['<string>', ...],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'End' => <integer || string || DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <integer || string || DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
        // ...
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'End' => <integer || string || DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <integer || string || DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
        // ...
    ],
    'OriginEndpointName' => '<string>', // REQUIRED
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => '<string>',
            'EncryptionMethod' => [ // REQUIRED
                'CmafEncryptionMethod' => 'CENC|CBCS',
                'TsEncryptionMethod' => 'AES_128|SAMPLE_AES',
            ],
            'KeyRotationIntervalSeconds' => <integer>,
            'SpekeKeyProvider' => [ // REQUIRED
                'DrmSystems' => ['<string>', ...], // REQUIRED
                'EncryptionContractConfiguration' => [ // REQUIRED
                    'PresetSpeke20Audio' => 'PRESET_AUDIO_1|PRESET_AUDIO_2|PRESET_AUDIO_3|SHARED|UNENCRYPTED', // REQUIRED
                    'PresetSpeke20Video' => 'PRESET_VIDEO_1|PRESET_VIDEO_2|PRESET_VIDEO_3|PRESET_VIDEO_4|PRESET_VIDEO_5|PRESET_VIDEO_6|PRESET_VIDEO_7|PRESET_VIDEO_8|SHARED|UNENCRYPTED', // REQUIRED
                ],
                'ResourceId' => '<string>', // REQUIRED
                'RoleArn' => '<string>', // REQUIRED
                'Url' => '<string>', // REQUIRED
            ],
        ],
        'IncludeIframeOnlyStreams' => true || false,
        'Scte' => [
            'ScteFilter' => ['<string>', ...],
        ],
        'SegmentDurationSeconds' => <integer>,
        'SegmentName' => '<string>',
        'TsIncludeDvbSubtitles' => true || false,
        'TsUseAudioRenditionGroup' => true || false,
    ],
    'StartoverWindowSeconds' => <integer>,
]);

Parameter Details

Members
ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

ContainerType
Required: Yes
Type: string

The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.

DashManifests
Type: Array of CreateDashManifestConfiguration structures

A DASH manifest configuration.

Description
Type: string

Any descriptive information that you want to add to the origin endpoint for future identification purposes.

ETag
Type: string

The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.

ForceEndpointErrorConfiguration

The failover settings for the endpoint.

HlsManifests
Type: Array of CreateHlsManifestConfiguration structures

An HTTP live streaming (HLS) manifest configuration.

LowLatencyHlsManifests
Type: Array of CreateLowLatencyHlsManifestConfiguration structures

A low-latency HLS manifest configuration.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Segment
Type: Segment structure

The segment configuration, including the segment name, duration, and other configuration values.

StartoverWindowSeconds
Type: int

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'ContainerType' => 'TS|CMAF',
    'CreatedAt' => <DateTime>,
    'DashManifests' => [
        [
            'DrmSignaling' => 'INDIVIDUAL|REFERENCED',
            'FilterConfiguration' => [
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'MinBufferTimeSeconds' => <integer>,
            'MinUpdatePeriodSeconds' => <integer>,
            'PeriodTriggers' => ['<string>', ...],
            'ScteDash' => [
                'AdMarkerDash' => 'BINARY|XML',
            ],
            'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE',
            'SuggestedPresentationDelaySeconds' => <integer>,
            'Url' => '<string>',
            'UtcTiming' => [
                'TimingMode' => 'HTTP_HEAD|HTTP_ISO|HTTP_XSDATE|UTC_DIRECT',
                'TimingSource' => '<string>',
            ],
        ],
        // ...
    ],
    'Description' => '<string>',
    'ETag' => '<string>',
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => ['<string>', ...],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => '<string>',
        ],
        // ...
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => '<string>',
        ],
        // ...
    ],
    'ModifiedAt' => <DateTime>,
    'OriginEndpointName' => '<string>',
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => '<string>',
            'EncryptionMethod' => [
                'CmafEncryptionMethod' => 'CENC|CBCS',
                'TsEncryptionMethod' => 'AES_128|SAMPLE_AES',
            ],
            'KeyRotationIntervalSeconds' => <integer>,
            'SpekeKeyProvider' => [
                'DrmSystems' => ['<string>', ...],
                'EncryptionContractConfiguration' => [
                    'PresetSpeke20Audio' => 'PRESET_AUDIO_1|PRESET_AUDIO_2|PRESET_AUDIO_3|SHARED|UNENCRYPTED',
                    'PresetSpeke20Video' => 'PRESET_VIDEO_1|PRESET_VIDEO_2|PRESET_VIDEO_3|PRESET_VIDEO_4|PRESET_VIDEO_5|PRESET_VIDEO_6|PRESET_VIDEO_7|PRESET_VIDEO_8|SHARED|UNENCRYPTED',
                ],
                'ResourceId' => '<string>',
                'RoleArn' => '<string>',
                'Url' => '<string>',
            ],
        ],
        'IncludeIframeOnlyStreams' => true || false,
        'Scte' => [
            'ScteFilter' => ['<string>', ...],
        ],
        'SegmentDurationSeconds' => <integer>,
        'SegmentName' => '<string>',
        'TsIncludeDvbSubtitles' => true || false,
        'TsUseAudioRenditionGroup' => true || false,
    ],
    'StartoverWindowSeconds' => <integer>,
    'Tags' => ['<string>', ...],
]

Result Details

Members
Arn
Required: Yes
Type: string

The ARN associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

ContainerType
Required: Yes
Type: string

The type of container attached to this origin endpoint.

CreatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the origin endpoint was created.

DashManifests
Type: Array of GetDashManifestConfiguration structures

A DASH manifest configuration.

Description
Type: string

The description of the origin endpoint.

ETag
Type: string

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

ForceEndpointErrorConfiguration

The failover settings for the endpoint.

HlsManifests
Type: Array of GetHlsManifestConfiguration structures

An HTTP live streaming (HLS) manifest configuration.

LowLatencyHlsManifests
Type: Array of GetLowLatencyHlsManifestConfiguration structures

A low-latency HLS manifest configuration.

ModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the origin endpoint was modified.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Segment
Required: Yes
Type: Segment structure

The segment configuration, including the segment name, duration, and other configuration values.

StartoverWindowSeconds
Type: int

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The comma-separated list of tag key:value pairs assigned to the origin endpoint.

Errors

ThrottlingException:

The request throughput limit was exceeded.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

Indicates that an error from the service occurred while trying to process a request.

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

ValidationException:

The input failed to meet the constraints specified by the AWS service.

ResourceNotFoundException:

The specified resource doesn't exist.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

Examples

Example 1: Updating an OriginEndpoint
$result = $client->updateOriginEndpoint([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'ContainerType' => 'TS',
    'Description' => 'Updated description for exampleOriginEndpointTS',
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => [
            'STALE_MANIFEST',
            'INCOMPLETE_MANIFEST',
            'MISSING_DRM_KEY',
            'SLATE_INPUT',
        ],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => 'exampleChildManifest1',
            'ManifestName' => 'exampleManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
        [
            'ChildManifestName' => 'exampleManifest2',
            'ManifestName' => 'exampleManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => 'exampleLLChildManifest1',
            'ManifestName' => 'exampleLLManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
        [
            'ChildManifestName' => 'exampleLLManifest2',
            'ManifestName' => 'exampleLLManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
        ],
    ],
    'OriginEndpointName' => 'exampleOriginEndpointTS',
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => 'A382A901F3C1F7718512266CFFBB0B7E',
            'EncryptionMethod' => [
                'TsEncryptionMethod' => 'AES_128',
            ],
            'KeyRotationIntervalSeconds' => 300,
            'SpekeKeyProvider' => [
                'DrmSystems' => [
                    'CLEAR_KEY_AES_128',
                ],
                'EncryptionContractConfiguration' => [
                    'PresetSpeke20Audio' => 'SHARED',
                    'PresetSpeke20Video' => 'SHARED',
                ],
                'ResourceId' => 'ResourceId',
                'RoleArn' => 'arn:aws:iam::123456789012:role/empRole',
                'Url' => 'https://foo.com',
            ],
        ],
        'IncludeIframeOnlyStreams' => ,
        'Scte' => [
            'ScteFilter' => [
                'SPLICE_INSERT',
            ],
        ],
        'SegmentDurationSeconds' => 7,
        'SegmentName' => 'segmentName2',
        'TsIncludeDvbSubtitles' => ,
        'TsUseAudioRenditionGroup' => 1,
    ],
    'StartoverWindowSeconds' => 600,
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointTS',
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannel',
    'ContainerType' => 'TS',
    'CreatedAt' => ,
    'Description' => 'Updated description for exampleOriginEndpointTS',
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'ForceEndpointErrorConfiguration' => [
        'EndpointErrorConditions' => [
            'STALE_MANIFEST',
            'INCOMPLETE_MANIFEST',
            'MISSING_DRM_KEY',
            'SLATE_INPUT',
        ],
    ],
    'HlsManifests' => [
        [
            'ChildManifestName' => 'exampleChildManifest1',
            'ManifestName' => 'exampleManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest1.m3u8',
        ],
        [
            'ChildManifestName' => 'exampleManifest2',
            'ManifestName' => 'exampleManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest2.m3u8',
        ],
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => 'exampleLLChildManifest1',
            'ManifestName' => 'exampleLLManifest1',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest1.m3u8',
        ],
        [
            'ChildManifestName' => 'exampleLLManifest2',
            'ManifestName' => 'exampleLLManifest2',
            'ManifestWindowSeconds' => 30,
            'ProgramDateTimeIntervalSeconds' => 60,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'Url' => 'https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest2.m3u8',
        ],
    ],
    'ModifiedAt' => ,
    'OriginEndpointName' => 'exampleOriginEndpointTS',
    'Segment' => [
        'Encryption' => [
            'ConstantInitializationVector' => 'A382A901F3C1F7718512266CFFBB0B7E',
            'EncryptionMethod' => [
                'TsEncryptionMethod' => 'AES_128',
            ],
            'KeyRotationIntervalSeconds' => 300,
            'SpekeKeyProvider' => [
                'DrmSystems' => [
                    'CLEAR_KEY_AES_128',
                ],
                'EncryptionContractConfiguration' => [
                    'PresetSpeke20Audio' => 'SHARED',
                    'PresetSpeke20Video' => 'SHARED',
                ],
                'ResourceId' => 'ResourceId',
                'RoleArn' => 'arn:aws:iam::123456789012:role/empRole',
                'Url' => 'https://foo.com',
            ],
        ],
        'IncludeIframeOnlyStreams' => ,
        'Scte' => [
            'ScteFilter' => [
                'SPLICE_INSERT',
            ],
        ],
        'SegmentDurationSeconds' => 7,
        'SegmentName' => 'segmentName2',
        'TsIncludeDvbSubtitles' => ,
        'TsUseAudioRenditionGroup' => 1,
    ],
    'StartoverWindowSeconds' => 600,
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]

Shapes

AccessDeniedException

Description

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

Members
Message
Type: string

ChannelGroupListConfiguration

Description

The configuration of the channel group.

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

CreatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel group was created.

Description
Type: string

Any descriptive information that you want to add to the channel group for future identification purposes.

ModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel group was modified.

ChannelListConfiguration

Description

The configuration of the channel.

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

CreatedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel was created.

Description
Type: string

Any descriptive information that you want to add to the channel for future identification purposes.

InputType
Type: string

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

ModifiedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the channel was modified.

ConflictException

Description

Updating or deleting this resource can cause an inconsistent state.

Members
ConflictExceptionType
Type: string

The type of ConflictException.

Message
Type: string

CreateDashManifestConfiguration

Description

Create a DASH manifest configuration.

Members
DrmSignaling
Type: string

Determines how the DASH manifest signals the DRM content.

FilterConfiguration
Type: FilterConfiguration structure

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

ManifestName
Required: Yes
Type: string

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.

ManifestWindowSeconds
Type: int

The total duration (in seconds) of the manifest's content.

MinBufferTimeSeconds
Type: int

Minimum amount of content (in seconds) that a player must keep available in the buffer.

MinUpdatePeriodSeconds
Type: int

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

PeriodTriggers
Type: Array of strings

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

ScteDash
Type: ScteDash structure

The SCTE configuration.

SegmentTemplateFormat
Type: string

Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

Value description:

  • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

SuggestedPresentationDelaySeconds
Type: int

The amount of time (in seconds) that the player should be from the end of the manifest.

UtcTiming
Type: DashUtcTiming structure

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

CreateHlsManifestConfiguration

Description

Create an HTTP live streaming (HLS) manifest configuration.

Members
ChildManifestName
Type: string

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

FilterConfiguration
Type: FilterConfiguration structure

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

ManifestName
Required: Yes
Type: string

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

ManifestWindowSeconds
Type: int

The total duration (in seconds) of the manifest's content.

ProgramDateTimeIntervalSeconds
Type: int

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

ScteHls
Type: ScteHls structure

The SCTE configuration.

CreateLowLatencyHlsManifestConfiguration

Description

Create a low-latency HTTP live streaming (HLS) manifest configuration.

Members
ChildManifestName
Type: string

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

FilterConfiguration
Type: FilterConfiguration structure

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

ManifestName
Required: Yes
Type: string

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

ManifestWindowSeconds
Type: int

The total duration (in seconds) of the manifest's content.

ProgramDateTimeIntervalSeconds
Type: int

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

ScteHls
Type: ScteHls structure

The SCTE configuration.

DashUtcTiming

Description

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

Members
TimingMode
Type: string

The UTC timing mode.

TimingSource
Type: string

The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

Encryption

Description

The parameters for encrypting content.

Members
ConstantInitializationVector
Type: string

A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

EncryptionMethod
Required: Yes
Type: EncryptionMethod structure

The encryption method to use.

KeyRotationIntervalSeconds
Type: int

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

The following example setting causes the service to rotate keys every thirty minutes: 1800

SpekeKeyProvider
Required: Yes
Type: SpekeKeyProvider structure

The parameters for the SPEKE key provider.

EncryptionContractConfiguration

Description

Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

Members
PresetSpeke20Audio
Required: Yes
Type: string

A collection of audio encryption presets.

Value description:

  • PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

  • PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

  • PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

  • SHARED - Use the same content key for all of the audio and video tracks in your stream.

  • UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

PresetSpeke20Video
Required: Yes
Type: string

A collection of video encryption presets.

Value description:

  • PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

  • PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

  • PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • SHARED - Use the same content key for all of the video and audio tracks in your stream.

  • UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

EncryptionMethod

Description

The encryption type.

Members
CmafEncryptionMethod
Type: string

The encryption method to use.

TsEncryptionMethod
Type: string

The encryption method to use.

FilterConfiguration

Description

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

Members
End
Type: timestamp (string|DateTime or anything parsable by strtotime)

Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

ManifestFilter
Type: string

Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

Start
Type: timestamp (string|DateTime or anything parsable by strtotime)

Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

TimeDelaySeconds
Type: int

Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

ForceEndpointErrorConfiguration

Description

The failover settings for the endpoint.

Members
EndpointErrorConditions
Type: Array of strings

The failover conditions for the endpoint. The options are:

  • STALE_MANIFEST - The manifest stalled and there are no new segments or parts.

  • INCOMPLETE_MANIFEST - There is a gap in the manifest.

  • MISSING_DRM_KEY - Key rotation is enabled but we're unable to fetch the key for the current key period.

  • SLATE_INPUT - The segments which contain slate content are considered to be missing content.

GetDashManifestConfiguration

Description

Retrieve the DASH manifest configuration.

Members
DrmSignaling
Type: string

Determines how the DASH manifest signals the DRM content.

FilterConfiguration
Type: FilterConfiguration structure

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

ManifestName
Required: Yes
Type: string

A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

ManifestWindowSeconds
Type: int

The total duration (in seconds) of the manifest's content.

MinBufferTimeSeconds
Type: int

Minimum amount of content (in seconds) that a player must keep available in the buffer.

MinUpdatePeriodSeconds
Type: int

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

PeriodTriggers
Type: Array of strings

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

ScteDash
Type: ScteDash structure

The SCTE configuration.

SegmentTemplateFormat
Type: string

Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

Value description:

  • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

SuggestedPresentationDelaySeconds
Type: int

The amount of time (in seconds) that the player should be from the end of the manifest.

Url
Required: Yes
Type: string

The egress domain URL for stream delivery from MediaPackage.

UtcTiming
Type: DashUtcTiming structure

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

GetHlsManifestConfiguration

Description

Retrieve the HTTP live streaming (HLS) manifest configuration.

Members
ChildManifestName
Type: string

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

FilterConfiguration
Type: FilterConfiguration structure

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

ManifestName
Required: Yes
Type: string

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

ManifestWindowSeconds
Type: int

The total duration (in seconds) of the manifest's content.

ProgramDateTimeIntervalSeconds
Type: int

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

ScteHls
Type: ScteHls structure

The SCTE configuration.

Url
Required: Yes
Type: string

The egress domain URL for stream delivery from MediaPackage.

GetLowLatencyHlsManifestConfiguration

Description

Retrieve the low-latency HTTP live streaming (HLS) manifest configuration.

Members
ChildManifestName
Type: string

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

FilterConfiguration
Type: FilterConfiguration structure

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

ManifestName
Required: Yes
Type: string

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

ManifestWindowSeconds
Type: int

The total duration (in seconds) of the manifest's content.

ProgramDateTimeIntervalSeconds
Type: int

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

ScteHls
Type: ScteHls structure

The SCTE configuration.

Url
Required: Yes
Type: string

The egress domain URL for stream delivery from MediaPackage.

IngestEndpoint

Description

The ingest domain URL where the source stream should be sent.

Members
Id
Type: string

The system-generated unique identifier for the IngestEndpoint.

Url
Type: string

The ingest domain URL where the source stream should be sent.

InternalServerException

Description

Indicates that an error from the service occurred while trying to process a request.

Members
Message
Type: string

ListDashManifestConfiguration

Description

List the DASH manifest configuration.

Members
ManifestName
Required: Yes
Type: string

A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

Url
Type: string

The egress domain URL for stream delivery from MediaPackage.

ListHlsManifestConfiguration

Description

List the HTTP live streaming (HLS) manifest configuration.

Members
ChildManifestName
Type: string

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

ManifestName
Required: Yes
Type: string

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

Url
Type: string

The egress domain URL for stream delivery from MediaPackage.

ListLowLatencyHlsManifestConfiguration

Description

List the low-latency HTTP live streaming (HLS) manifest configuration.

Members
ChildManifestName
Type: string

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

ManifestName
Required: Yes
Type: string

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

Url
Type: string

The egress domain URL for stream delivery from MediaPackage.

OriginEndpointListConfiguration

Description

The configuration of the origin endpoint.

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with the resource.

ChannelGroupName
Required: Yes
Type: string

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

ChannelName
Required: Yes
Type: string

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

ContainerType
Required: Yes
Type: string

The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.

CreatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the origin endpoint was created.

DashManifests
Type: Array of ListDashManifestConfiguration structures

A DASH manifest configuration.

Description
Type: string

Any descriptive information that you want to add to the origin endpoint for future identification purposes.

ForceEndpointErrorConfiguration

The failover settings for the endpoint.

HlsManifests
Type: Array of ListHlsManifestConfiguration structures

An HTTP live streaming (HLS) manifest configuration.

LowLatencyHlsManifests
Type: Array of ListLowLatencyHlsManifestConfiguration structures

A low-latency HLS manifest configuration.

ModifiedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the origin endpoint was modified.

OriginEndpointName
Required: Yes
Type: string

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

ResourceNotFoundException

Description

The specified resource doesn't exist.

Members
Message
Type: string
ResourceTypeNotFound
Type: string

The specified resource type wasn't found.

Scte

Description

The SCTE configuration.

Members
ScteFilter
Type: Array of strings

The SCTE-35 message types that you want to be treated as ad markers in the output.

ScteDash

Description

The SCTE configuration.

Members
AdMarkerDash
Type: string

Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.

Value description:

  • Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.

  • XML - The SCTE marker is expressed fully in XML.

ScteHls

Description

The SCTE configuration.

Members
AdMarkerHls
Type: string

Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

Value description:

  • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

Segment

Description

The segment configuration, including the segment name, duration, and other configuration values.

Members
Encryption
Type: Encryption structure

The parameters for encrypting content.

IncludeIframeOnlyStreams
Type: boolean

When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.

Scte
Type: Scte structure

The SCTE configuration options in the segment settings.

SegmentDurationSeconds
Type: int

The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.

SegmentName
Type: string

The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.

TsIncludeDvbSubtitles
Type: boolean

By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

TsUseAudioRenditionGroup
Type: boolean

When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.

ServiceQuotaExceededException

Description

The request would cause a service quota to be exceeded.

Members
Message
Type: string

SpekeKeyProvider

Description

The parameters for the SPEKE key provider.

Members
DrmSystems
Required: Yes
Type: Array of strings

The DRM solution provider you're using to protect your content during distribution.

EncryptionContractConfiguration
Required: Yes
Type: EncryptionContractConfiguration structure

Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

ResourceId
Required: Yes
Type: string

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

The following example shows a resource ID: MovieNight20171126093045

RoleArn
Required: Yes
Type: string

The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess

Url
Required: Yes
Type: string

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

ThrottlingException

Description

The request throughput limit was exceeded.

Members
Message
Type: string

ValidationException

Description

The input failed to meet the constraints specified by the AWS service.

Members
Message
Type: string
ValidationExceptionType
Type: string

The type of ValidationException.