CancelHarvestJob

$result = $client->cancelHarvestJob([/* ... */]);
$promise = $client->cancelHarvestJobAsync([/* ... */]);

Cancels an in-progress harvest job.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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: Cancel a Harvest Job

$result = $client->cancelHarvestJob([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannelName',
    'HarvestJobName' => 'HarvestJobName',
    'OriginEndpointName' => 'exampleOriginEndpointName',
]);

Result syntax:

[
]

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>',
    'InputSwitchConfiguration' => [
        'MQCSInputSwitching' => true || false,
    ],
    'InputType' => 'HLS|CMAF',
    'OutputHeaderConfiguration' => [
        'PublishMQCS' => true || false,
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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',
    ],
]

CreateHarvestJob

$result = $client->createHarvestJob([/* ... */]);
$promise = $client->createHarvestJobAsync([/* ... */]);

Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.

Parameter Syntax

$result = $client->createHarvestJob([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Destination' => [ // REQUIRED
        'S3Destination' => [ // REQUIRED
            'BucketName' => '<string>', // REQUIRED
            'DestinationPath' => '<string>', // REQUIRED
        ],
    ],
    'HarvestJobName' => '<string>',
    'HarvestedManifests' => [ // REQUIRED
        'DashManifests' => [
            [
                'ManifestName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'HlsManifests' => [
            [
                'ManifestName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'LowLatencyHlsManifests' => [
            [
                'ManifestName' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'OriginEndpointName' => '<string>', // REQUIRED
    'ScheduleConfiguration' => [ // REQUIRED
        'EndTime' => <integer || string || DateTime>, // REQUIRED
        'StartTime' => <integer || string || DateTime>, // REQUIRED
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Destination' => [
        'S3Destination' => [
            'BucketName' => '<string>',
            'DestinationPath' => '<string>',
        ],
    ],
    'ETag' => '<string>',
    'ErrorMessage' => '<string>',
    'HarvestJobName' => '<string>',
    'HarvestedManifests' => [
        'DashManifests' => [
            [
                'ManifestName' => '<string>',
            ],
            // ...
        ],
        'HlsManifests' => [
            [
                'ManifestName' => '<string>',
            ],
            // ...
        ],
        'LowLatencyHlsManifests' => [
            [
                'ManifestName' => '<string>',
            ],
            // ...
        ],
    ],
    'ModifiedAt' => <DateTime>,
    'OriginEndpointName' => '<string>',
    'ScheduleConfiguration' => [
        'EndTime' => <DateTime>,
        'StartTime' => <DateTime>,
    ],
    'Status' => 'QUEUED|IN_PROGRESS|CANCELLED|COMPLETED|FAILED',
    'Tags' => ['<string>', ...],
]

Result Details

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 Harvest Job

$result = $client->createHarvestJob([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannelName',
    'Description' => 'Example HarvestJob description',
    'Destination' => [
        'S3Destination' => [
            'BucketName' => 'harvestJobS3DestinationBucket',
            'DestinationPath' => 'manifests',
        ],
    ],
    'HarvestedManifests' => [
        'DashManifests' => [
            [
                'ManifestName' => 'DashManifest',
            ],
        ],
        'HlsManifests' => [
            [
                'ManifestName' => 'HlsManifest',
            ],
        ],
        'LowLatencyHlsManifests' => [
            [
                'ManifestName' => 'LowLatencyHlsManifest',
            ],
        ],
    ],
    'OriginEndpointName' => 'exampleOriginEndpointName',
    'ScheduleConfiguration' => [
        'EndTime' => ,
        'StartTime' => ,
    ],
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName',
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannelName',
    'CreatedAt' => ,
    'Description' => 'Example HarvestJob description',
    'Destination' => [
        'S3Destination' => [
            'BucketName' => 'harvestJobS3DestinationBucket',
            'DestinationPath' => 'manifests',
        ],
    ],
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'HarvestJobName' => 'HarvestJobName',
    'HarvestedManifests' => [
        'DashManifests' => [
            [
                'ManifestName' => 'DashManifest',
            ],
        ],
        'HlsManifests' => [
            [
                'ManifestName' => 'HlsManifest',
            ],
        ],
        'LowLatencyHlsManifests' => [
            [
                'ManifestName' => 'LowLatencyHlsManifest',
            ],
        ],
    ],
    'ModifiedAt' => ,
    'OriginEndpointName' => 'exampleOriginEndpointName',
    'ScheduleConfiguration' => [
        'EndTime' => ,
        'StartTime' => ,
    ],
    'Status' => 'QUEUED',
    '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' => [
                'ClipStartTime' => <integer || string || DateTime>,
                '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' => [
                'ClipStartTime' => <integer || string || DateTime>,
                'End' => <integer || string || DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <integer || string || DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'StartTag' => [
                'Precise' => true || false,
                'TimeOffset' => <float>, // REQUIRED
            ],
        ],
        // ...
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'ClipStartTime' => <integer || string || DateTime>,
                'End' => <integer || string || DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <integer || string || DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'StartTag' => [
                'Precise' => true || false,
                'TimeOffset' => <float>, // REQUIRED
            ],
        ],
        // ...
    ],
    '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

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'ContainerType' => 'TS|CMAF',
    'CreatedAt' => <DateTime>,
    'DashManifests' => [
        [
            'DrmSignaling' => 'INDIVIDUAL|REFERENCED',
            'FilterConfiguration' => [
                'ClipStartTime' => <DateTime>,
                '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' => [
                'ClipStartTime' => <DateTime>,
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'StartTag' => [
                'Precise' => true || false,
                'TimeOffset' => <float>,
            ],
            'Url' => '<string>',
        ],
        // ...
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'ClipStartTime' => <DateTime>,
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'StartTag' => [
                'Precise' => true || false,
                'TimeOffset' => <float>,
            ],
            '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

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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' => '{...}',
]

GetHarvestJob

$result = $client->getHarvestJob([/* ... */]);
$promise = $client->getHarvestJobAsync([/* ... */]);

Retrieves the details of a specific harvest job.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Destination' => [
        'S3Destination' => [
            'BucketName' => '<string>',
            'DestinationPath' => '<string>',
        ],
    ],
    'ETag' => '<string>',
    'ErrorMessage' => '<string>',
    'HarvestJobName' => '<string>',
    'HarvestedManifests' => [
        'DashManifests' => [
            [
                'ManifestName' => '<string>',
            ],
            // ...
        ],
        'HlsManifests' => [
            [
                'ManifestName' => '<string>',
            ],
            // ...
        ],
        'LowLatencyHlsManifests' => [
            [
                'ManifestName' => '<string>',
            ],
            // ...
        ],
    ],
    'ModifiedAt' => <DateTime>,
    'OriginEndpointName' => '<string>',
    'ScheduleConfiguration' => [
        'EndTime' => <DateTime>,
        'StartTime' => <DateTime>,
    ],
    'Status' => 'QUEUED|IN_PROGRESS|CANCELLED|COMPLETED|FAILED',
    'Tags' => ['<string>', ...],
]

Result Details

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 Harvest Job

$result = $client->getHarvestJob([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannelName',
    'HarvestJobName' => 'HarvestJobName',
    'OriginEndpointName' => 'exampleOriginEndpointName',
]);

Result syntax:

[
    'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName',
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannelName',
    'CreatedAt' => ,
    'Description' => 'Example HarvestJob description',
    'Destination' => [
        'S3Destination' => [
            'BucketName' => 'harvestJobS3DestinationBucket',
            'DestinationPath' => 'manifests',
        ],
    ],
    'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
    'HarvestJobName' => 'HarvestJobName',
    'HarvestedManifests' => [
        'DashManifests' => [
            [
                'ManifestName' => 'DashManifest',
            ],
        ],
        'HlsManifests' => [
            [
                'ManifestName' => 'HlsManifest',
            ],
        ],
        'LowLatencyHlsManifests' => [
            [
                'ManifestName' => 'LowLatencyHlsManifest',
            ],
        ],
    ],
    'ModifiedAt' => ,
    'OriginEndpointName' => 'exampleOriginEndpointName',
    'ScheduleConfiguration' => [
        'EndTime' => ,
        'StartTime' => ,
    ],
    'Status' => 'QUEUED',
    'Tags' => [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
]

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

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'ContainerType' => 'TS|CMAF',
    'CreatedAt' => <DateTime>,
    'DashManifests' => [
        [
            'DrmSignaling' => 'INDIVIDUAL|REFERENCED',
            'FilterConfiguration' => [
                'ClipStartTime' => <DateTime>,
                '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' => [
                'ClipStartTime' => <DateTime>,
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'StartTag' => [
                'Precise' => true || false,
                'TimeOffset' => <float>,
            ],
            'Url' => '<string>',
        ],
        // ...
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'ClipStartTime' => <DateTime>,
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'StartTag' => [
                'Precise' => true || false,
                'TimeOffset' => <float>,
            ],
            '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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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' => ,
        ],
    ],
]

ListHarvestJobs

$result = $client->listHarvestJobs([/* ... */]);
$promise = $client->listHarvestJobsAsync([/* ... */]);

Retrieves a list of harvest jobs that match the specified criteria.

Parameter Syntax

$result = $client->listHarvestJobs([
    'ChannelGroupName' => '<string>', // REQUIRED
    'ChannelName' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OriginEndpointName' => '<string>',
    'Status' => 'QUEUED|IN_PROGRESS|CANCELLED|COMPLETED|FAILED',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'Arn' => '<string>',
            'ChannelGroupName' => '<string>',
            'ChannelName' => '<string>',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'Destination' => [
                'S3Destination' => [
                    'BucketName' => '<string>',
                    'DestinationPath' => '<string>',
                ],
            ],
            'ETag' => '<string>',
            'ErrorMessage' => '<string>',
            'HarvestJobName' => '<string>',
            'HarvestedManifests' => [
                'DashManifests' => [
                    [
                        'ManifestName' => '<string>',
                    ],
                    // ...
                ],
                'HlsManifests' => [
                    [
                        'ManifestName' => '<string>',
                    ],
                    // ...
                ],
                'LowLatencyHlsManifests' => [
                    [
                        'ManifestName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ModifiedAt' => <DateTime>,
            'OriginEndpointName' => '<string>',
            'ScheduleConfiguration' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'Status' => 'QUEUED|IN_PROGRESS|CANCELLED|COMPLETED|FAILED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

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: ListHarvestJobs: Specify ChannelGroup only

$result = $client->listHarvestJobs([
    'ChannelGroupName' => 'exampleChannelGroup',
]);

Result syntax:

[
    'Items' => [
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName',
            'ChannelGroupName' => 'exampleChannelGroup',
            'ChannelName' => 'exampleChannelName',
            'CreatedAt' => ,
            'Description' => 'Example HarvestJob description',
            'Destination' => [
                'S3Destination' => [
                    'BucketName' => 'harvestJobS3DestinationBucket',
                    'DestinationPath' => 'manifests',
                ],
            ],
            'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
            'HarvestJobName' => 'HarvestJobName',
            'HarvestedManifests' => [
                'DashManifests' => [
                    [
                        'ManifestName' => 'DashManifest',
                    ],
                ],
                'HlsManifests' => [
                    [
                        'ManifestName' => 'HlsManifest',
                    ],
                ],
                'LowLatencyHlsManifests' => [
                    [
                        'ManifestName' => 'LowLatencyHlsManifest',
                    ],
                ],
            ],
            'ModifiedAt' => ,
            'OriginEndpointName' => 'exampleOriginEndpointName',
            'ScheduleConfiguration' => [
                'EndTime' => ,
                'StartTime' => ,
            ],
            'Status' => 'QUEUED',
        ],
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName2/originEndpoint/exampleOriginEndpointName2/harvestJob/HarvestJobName2',
            'ChannelGroupName' => 'exampleChannelGroup',
            'ChannelName' => 'exampleChannelName2',
            'CreatedAt' => ,
            'Description' => 'Example HarvestJob2 description',
            'Destination' => [
                'S3Destination' => [
                    'BucketName' => 'harvestJobS3DestinationBucket',
                    'DestinationPath' => 'manifests',
                ],
            ],
            'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
            'HarvestJobName' => 'HarvestJobName2',
            'HarvestedManifests' => [
                'DashManifests' => [
                    [
                        'ManifestName' => 'DashManifest',
                    ],
                ],
                'HlsManifests' => [
                    [
                        'ManifestName' => 'HlsManifest',
                    ],
                ],
                'LowLatencyHlsManifests' => [
                    [
                        'ManifestName' => 'LowLatencyHlsManifest',
                    ],
                ],
            ],
            'ModifiedAt' => ,
            'OriginEndpointName' => 'exampleOriginEndpointName2',
            'ScheduleConfiguration' => [
                'EndTime' => ,
                'StartTime' => ,
            ],
            'Status' => 'IN_PROGRESS',
        ],
    ],
    'NextToken' => 'someTokenValue',
]

Example 2: ListHarvestJobs: Specify ChannelGroup, Channel only

$result = $client->listHarvestJobs([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannelName',
]);

Result syntax:

[
    'Items' => [
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName',
            'ChannelGroupName' => 'exampleChannelGroup',
            'ChannelName' => 'exampleChannelName',
            'CreatedAt' => ,
            'Description' => 'Example HarvestJob description',
            'Destination' => [
                'S3Destination' => [
                    'BucketName' => 'harvestJobS3DestinationBucket',
                    'DestinationPath' => 'manifests',
                ],
            ],
            'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
            'HarvestJobName' => 'HarvestJobName',
            'HarvestedManifests' => [
                'DashManifests' => [
                    [
                        'ManifestName' => 'DashManifest',
                    ],
                ],
                'HlsManifests' => [
                    [
                        'ManifestName' => 'HlsManifest',
                    ],
                ],
                'LowLatencyHlsManifests' => [
                    [
                        'ManifestName' => 'LowLatencyHlsManifest',
                    ],
                ],
            ],
            'ModifiedAt' => ,
            'OriginEndpointName' => 'exampleOriginEndpointName',
            'ScheduleConfiguration' => [
                'EndTime' => ,
                'StartTime' => ,
            ],
            'Status' => 'QUEUED',
        ],
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName2/harvestJob/HarvestJobName2',
            'ChannelGroupName' => 'exampleChannelGroup',
            'ChannelName' => 'exampleChannelName',
            'CreatedAt' => ,
            'Description' => 'Example HarvestJob2 description',
            'Destination' => [
                'S3Destination' => [
                    'BucketName' => 'harvestJobS3DestinationBucket',
                    'DestinationPath' => 'manifests',
                ],
            ],
            'HarvestJobName' => 'HarvestJobName2',
            'HarvestedManifests' => [
                'DashManifests' => [
                    [
                        'ManifestName' => 'DashManifest',
                    ],
                ],
                'HlsManifests' => [
                    [
                        'ManifestName' => 'HlsManifest',
                    ],
                ],
                'LowLatencyHlsManifests' => [
                    [
                        'ManifestName' => 'LowLatencyHlsManifest',
                    ],
                ],
            ],
            'ModifiedAt' => ,
            'OriginEndpointName' => 'exampleOriginEndpointName2',
            'ScheduleConfiguration' => [
                'EndTime' => ,
                'StartTime' => ,
            ],
            'Status' => 'IN_PROGRESS',
        ],
    ],
    'NextToken' => 'someTokenValue',
]

Example 3: ListHarvestJobs: Specify ChannelGroup, Channel, OriginEndpoint

$result = $client->listHarvestJobs([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannelName',
    'OriginEndpointName' => 'exampleOriginEndpointName',
]);

Result syntax:

[
    'Items' => [
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName',
            'ChannelGroupName' => 'exampleChannelGroup',
            'ChannelName' => 'exampleChannelName',
            'CreatedAt' => ,
            'Description' => 'Example HarvestJob description',
            'Destination' => [
                'S3Destination' => [
                    'BucketName' => 'harvestJobS3DestinationBucket',
                    'DestinationPath' => 'manifests',
                ],
            ],
            'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
            'HarvestJobName' => 'HarvestJobName',
            'HarvestedManifests' => [
                'DashManifests' => [
                    [
                        'ManifestName' => 'DashManifest',
                    ],
                ],
                'HlsManifests' => [
                    [
                        'ManifestName' => 'HlsManifest',
                    ],
                ],
                'LowLatencyHlsManifests' => [
                    [
                        'ManifestName' => 'LowLatencyHlsManifest',
                    ],
                ],
            ],
            'ModifiedAt' => ,
            'OriginEndpointName' => 'exampleOriginEndpointName',
            'ScheduleConfiguration' => [
                'EndTime' => ,
                'StartTime' => ,
            ],
            'Status' => 'QUEUED',
        ],
    ],
    'NextToken' => 'someTokenValue',
]

Example 4: ListHarvestJobs: Specify ChannelGroup, Channel, OriginEndpoint + Status filter

$result = $client->listHarvestJobs([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannelName',
    'OriginEndpointName' => 'exampleOriginEndpointName',
    'Status' => 'QUEUED',
]);

Result syntax:

[
    'Items' => [
        [
            'Arn' => 'arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName',
            'ChannelGroupName' => 'exampleChannelGroup',
            'ChannelName' => 'exampleChannelName',
            'CreatedAt' => ,
            'Description' => 'Example HarvestJob description',
            'Destination' => [
                'S3Destination' => [
                    'BucketName' => 'harvestJobS3DestinationBucket',
                    'DestinationPath' => 'manifests',
                ],
            ],
            'ETag' => 'GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=',
            'HarvestJobName' => 'HarvestJobName',
            'HarvestedManifests' => [
                'DashManifests' => [
                    [
                        'ManifestName' => 'DashManifest',
                    ],
                ],
                'HlsManifests' => [
                    [
                        'ManifestName' => 'HlsManifest',
                    ],
                ],
                'LowLatencyHlsManifests' => [
                    [
                        'ManifestName' => 'LowLatencyHlsManifest',
                    ],
                ],
            ],
            'ModifiedAt' => ,
            'OriginEndpointName' => 'exampleOriginEndpointName',
            'ScheduleConfiguration' => [
                'EndTime' => ,
                'StartTime' => ,
            ],
            'Status' => 'QUEUED',
        ],
    ],
    'NextToken' => 'someTokenValue',
]

Example 5: ListHarvestJobs: Empty response

$result = $client->listHarvestJobs([
    'ChannelGroupName' => 'exampleChannelGroup',
    'ChannelName' => 'exampleChannelName',
    'OriginEndpointName' => 'exampleOriginEndpointName',
]);

Result syntax:

[
]

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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>',
    'InputSwitchConfiguration' => [
        'MQCSInputSwitching' => true || false,
    ],
    'OutputHeaderConfiguration' => [
        'PublishMQCS' => true || false,
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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' => [
                'ClipStartTime' => <integer || string || DateTime>,
                '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' => [
                'ClipStartTime' => <integer || string || DateTime>,
                'End' => <integer || string || DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <integer || string || DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'StartTag' => [
                'Precise' => true || false,
                'TimeOffset' => <float>, // REQUIRED
            ],
        ],
        // ...
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'ClipStartTime' => <integer || string || DateTime>,
                'End' => <integer || string || DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <integer || string || DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'StartTag' => [
                'Precise' => true || false,
                'TimeOffset' => <float>, // REQUIRED
            ],
        ],
        // ...
    ],
    '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

Result Syntax

[
    'Arn' => '<string>',
    'ChannelGroupName' => '<string>',
    'ChannelName' => '<string>',
    'ContainerType' => 'TS|CMAF',
    'CreatedAt' => <DateTime>,
    'DashManifests' => [
        [
            'DrmSignaling' => 'INDIVIDUAL|REFERENCED',
            'FilterConfiguration' => [
                'ClipStartTime' => <DateTime>,
                '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' => [
                'ClipStartTime' => <DateTime>,
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'StartTag' => [
                'Precise' => true || false,
                'TimeOffset' => <float>,
            ],
            'Url' => '<string>',
        ],
        // ...
    ],
    'LowLatencyHlsManifests' => [
        [
            'ChildManifestName' => '<string>',
            'FilterConfiguration' => [
                'ClipStartTime' => <DateTime>,
                'End' => <DateTime>,
                'ManifestFilter' => '<string>',
                'Start' => <DateTime>,
                'TimeDelaySeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'ManifestWindowSeconds' => <integer>,
            'ProgramDateTimeIntervalSeconds' => <integer>,
            'ScteHls' => [
                'AdMarkerHls' => 'DATERANGE',
            ],
            'StartTag' => [
                'Precise' => true || false,
                'TimeOffset' => <float>,
            ],
            '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

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',
    ],
]