AWS SDK for PHP 3.x

Client: Aws\MediaPackageVod\MediaPackageVodClient

Service ID: mediapackage-vod

Version: 2018-11-07

This page describes the parameters and results for the operations of the AWS Elemental MediaPackage VOD (2018-11-07), and shows how to use the Aws\MediaPackageVod\MediaPackageVodClient object to call the described operations. This documentation is specific to the 2018-11-07 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

ConfigureLogs ( array $params = [] )
Changes the packaging group's properities to configure log subscription
CreateAsset ( array $params = [] )
Creates a new MediaPackage VOD Asset resource.
CreatePackagingConfiguration ( array $params = [] )
Creates a new MediaPackage VOD PackagingConfiguration resource.
CreatePackagingGroup ( array $params = [] )
Creates a new MediaPackage VOD PackagingGroup resource.
DeleteAsset ( array $params = [] )
Deletes an existing MediaPackage VOD Asset resource.
DeletePackagingConfiguration ( array $params = [] )
Deletes a MediaPackage VOD PackagingConfiguration resource.
DeletePackagingGroup ( array $params = [] )
Deletes a MediaPackage VOD PackagingGroup resource.
DescribeAsset ( array $params = [] )
Returns a description of a MediaPackage VOD Asset resource.
DescribePackagingConfiguration ( array $params = [] )
Returns a description of a MediaPackage VOD PackagingConfiguration resource.
DescribePackagingGroup ( array $params = [] )
Returns a description of a MediaPackage VOD PackagingGroup resource.
ListAssets ( array $params = [] )
Returns a collection of MediaPackage VOD Asset resources.
ListPackagingConfigurations ( array $params = [] )
Returns a collection of MediaPackage VOD PackagingConfiguration resources.
ListPackagingGroups ( array $params = [] )
Returns a collection of MediaPackage VOD PackagingGroup resources.
ListTagsForResource ( array $params = [] )
Returns a list of the tags assigned to the specified resource.
TagResource ( array $params = [] )
Adds tags to the specified resource.
UntagResource ( array $params = [] )
Removes tags from the specified resource.
UpdatePackagingGroup ( array $params = [] )
Updates a specific packaging group.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAssets
ListPackagingConfigurations
ListPackagingGroups

Operations

ConfigureLogs

$result = $client->configureLogs([/* ... */]);
$promise = $client->configureLogsAsync([/* ... */]);

Changes the packaging group's properities to configure log subscription

Parameter Syntax

$result = $client->configureLogs([
    'EgressAccessLogs' => [
        'LogGroupName' => '<string>',
    ],
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

EgressAccessLogs

Type: EgressAccessLogs structure

Configure egress access logging.

Id

Required: Yes
Type: string

Result Syntax

[
    'Arn' => '<string>',
    'Authorization' => [
        'CdnIdentifierSecret' => '<string>',
        'SecretsRoleArn' => '<string>',
    ],
    'CreatedAt' => '<string>',
    'DomainName' => '<string>',
    'EgressAccessLogs' => [
        'LogGroupName' => '<string>',
    ],
    'Id' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members

Arn

Type: string

Authorization

Type: Authorization structure

CDN Authorization credentials

CreatedAt

Type: string

DomainName

Type: string

EgressAccessLogs

Type: EgressAccessLogs structure

Configure egress access logging.

Id

Type: string

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

CreateAsset

$result = $client->createAsset([/* ... */]);
$promise = $client->createAssetAsync([/* ... */]);

Creates a new MediaPackage VOD Asset resource.

Parameter Syntax

$result = $client->createAsset([
    'Id' => '<string>', // REQUIRED
    'PackagingGroupId' => '<string>', // REQUIRED
    'ResourceId' => '<string>',
    'SourceArn' => '<string>', // REQUIRED
    'SourceRoleArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

Id

Required: Yes
Type: string

PackagingGroupId

Required: Yes
Type: string

ResourceId

Type: string

SourceArn

Required: Yes
Type: string

SourceRoleArn

Required: Yes
Type: string

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Result Syntax

[
    'Arn' => '<string>',
    'CreatedAt' => '<string>',
    'EgressEndpoints' => [
        [
            'PackagingConfigurationId' => '<string>',
            'Status' => '<string>',
            'Url' => '<string>',
        ],
        // ...
    ],
    'Id' => '<string>',
    'PackagingGroupId' => '<string>',
    'ResourceId' => '<string>',
    'SourceArn' => '<string>',
    'SourceRoleArn' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members

Arn

Type: string

CreatedAt

Type: string

EgressEndpoints

Type: Array of EgressEndpoint structures

Id

Type: string

PackagingGroupId

Type: string

ResourceId

Type: string

SourceArn

Type: string

SourceRoleArn

Type: string

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

CreatePackagingConfiguration

$result = $client->createPackagingConfiguration([/* ... */]);
$promise = $client->createPackagingConfigurationAsync([/* ... */]);

Creates a new MediaPackage VOD PackagingConfiguration resource.

Parameter Syntax

$result = $client->createPackagingConfiguration([
    'CmafPackage' => [
        'Encryption' => [
            'ConstantInitializationVector' => '<string>',
            'SpekeKeyProvider' => [ // REQUIRED
                'EncryptionContractConfiguration' => [
                    '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
                ],
                'RoleArn' => '<string>', // REQUIRED
                'SystemIds' => ['<string>', ...], // REQUIRED
                'Url' => '<string>', // REQUIRED
            ],
        ],
        'HlsManifests' => [ // REQUIRED
            [
                'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH',
                'IncludeIframeOnlyStream' => true || false,
                'ManifestName' => '<string>',
                'ProgramDateTimeIntervalSeconds' => <integer>,
                'RepeatExtXKey' => true || false,
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'IncludeEncoderConfigurationInSegments' => true || false,
        'SegmentDurationSeconds' => <integer>,
    ],
    'DashPackage' => [
        'DashManifests' => [ // REQUIRED
            [
                'ManifestLayout' => 'FULL|COMPACT',
                'ManifestName' => '<string>',
                'MinBufferTimeSeconds' => <integer>,
                'Profile' => 'NONE|HBBTV_1_5',
                'ScteMarkersSource' => 'SEGMENTS|MANIFEST',
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'Encryption' => [
            'SpekeKeyProvider' => [ // REQUIRED
                'EncryptionContractConfiguration' => [
                    '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
                ],
                'RoleArn' => '<string>', // REQUIRED
                'SystemIds' => ['<string>', ...], // REQUIRED
                'Url' => '<string>', // REQUIRED
            ],
        ],
        'IncludeEncoderConfigurationInSegments' => true || false,
        'IncludeIframeOnlyStream' => true || false,
        'PeriodTriggers' => ['<string>', ...],
        'SegmentDurationSeconds' => <integer>,
        'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE|TIME_WITH_TIMELINE|NUMBER_WITH_DURATION',
    ],
    'HlsPackage' => [
        'Encryption' => [
            'ConstantInitializationVector' => '<string>',
            'EncryptionMethod' => 'AES_128|SAMPLE_AES',
            'SpekeKeyProvider' => [ // REQUIRED
                'EncryptionContractConfiguration' => [
                    '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
                ],
                'RoleArn' => '<string>', // REQUIRED
                'SystemIds' => ['<string>', ...], // REQUIRED
                'Url' => '<string>', // REQUIRED
            ],
        ],
        'HlsManifests' => [ // REQUIRED
            [
                'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH',
                'IncludeIframeOnlyStream' => true || false,
                'ManifestName' => '<string>',
                'ProgramDateTimeIntervalSeconds' => <integer>,
                'RepeatExtXKey' => true || false,
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'IncludeDvbSubtitles' => true || false,
        'SegmentDurationSeconds' => <integer>,
        'UseAudioRenditionGroup' => true || false,
    ],
    'Id' => '<string>', // REQUIRED
    'MssPackage' => [
        'Encryption' => [
            'SpekeKeyProvider' => [ // REQUIRED
                'EncryptionContractConfiguration' => [
                    '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
                ],
                'RoleArn' => '<string>', // REQUIRED
                'SystemIds' => ['<string>', ...], // REQUIRED
                'Url' => '<string>', // REQUIRED
            ],
        ],
        'MssManifests' => [ // REQUIRED
            [
                'ManifestName' => '<string>',
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'SegmentDurationSeconds' => <integer>,
    ],
    'PackagingGroupId' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

CmafPackage

Type: CmafPackage structure

A CMAF packaging configuration.

DashPackage

Type: DashPackage structure

A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

HlsPackage

Type: HlsPackage structure

An HTTP Live Streaming (HLS) packaging configuration.

Id

Required: Yes
Type: string

MssPackage

Type: MssPackage structure

A Microsoft Smooth Streaming (MSS) PackagingConfiguration.

PackagingGroupId

Required: Yes
Type: string

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Result Syntax

[
    'Arn' => '<string>',
    'CmafPackage' => [
        'Encryption' => [
            'ConstantInitializationVector' => '<string>',
            'SpekeKeyProvider' => [
                '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',
                ],
                'RoleArn' => '<string>',
                'SystemIds' => ['<string>', ...],
                'Url' => '<string>',
            ],
        ],
        'HlsManifests' => [
            [
                'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH',
                'IncludeIframeOnlyStream' => true || false,
                'ManifestName' => '<string>',
                'ProgramDateTimeIntervalSeconds' => <integer>,
                'RepeatExtXKey' => true || false,
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'IncludeEncoderConfigurationInSegments' => true || false,
        'SegmentDurationSeconds' => <integer>,
    ],
    'CreatedAt' => '<string>',
    'DashPackage' => [
        'DashManifests' => [
            [
                'ManifestLayout' => 'FULL|COMPACT',
                'ManifestName' => '<string>',
                'MinBufferTimeSeconds' => <integer>,
                'Profile' => 'NONE|HBBTV_1_5',
                'ScteMarkersSource' => 'SEGMENTS|MANIFEST',
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'Encryption' => [
            'SpekeKeyProvider' => [
                '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',
                ],
                'RoleArn' => '<string>',
                'SystemIds' => ['<string>', ...],
                'Url' => '<string>',
            ],
        ],
        'IncludeEncoderConfigurationInSegments' => true || false,
        'IncludeIframeOnlyStream' => true || false,
        'PeriodTriggers' => ['<string>', ...],
        'SegmentDurationSeconds' => <integer>,
        'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE|TIME_WITH_TIMELINE|NUMBER_WITH_DURATION',
    ],
    'HlsPackage' => [
        'Encryption' => [
            'ConstantInitializationVector' => '<string>',
            'EncryptionMethod' => 'AES_128|SAMPLE_AES',
            'SpekeKeyProvider' => [
                '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',
                ],
                'RoleArn' => '<string>',
                'SystemIds' => ['<string>', ...],
                'Url' => '<string>',
            ],
        ],
        'HlsManifests' => [
            [
                'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH',
                'IncludeIframeOnlyStream' => true || false,
                'ManifestName' => '<string>',
                'ProgramDateTimeIntervalSeconds' => <integer>,
                'RepeatExtXKey' => true || false,
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'IncludeDvbSubtitles' => true || false,
        'SegmentDurationSeconds' => <integer>,
        'UseAudioRenditionGroup' => true || false,
    ],
    'Id' => '<string>',
    'MssPackage' => [
        'Encryption' => [
            'SpekeKeyProvider' => [
                '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',
                ],
                'RoleArn' => '<string>',
                'SystemIds' => ['<string>', ...],
                'Url' => '<string>',
            ],
        ],
        'MssManifests' => [
            [
                'ManifestName' => '<string>',
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'SegmentDurationSeconds' => <integer>,
    ],
    'PackagingGroupId' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members

Arn

Type: string

CmafPackage

Type: CmafPackage structure

A CMAF packaging configuration.

CreatedAt

Type: string

DashPackage

Type: DashPackage structure

A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

HlsPackage

Type: HlsPackage structure

An HTTP Live Streaming (HLS) packaging configuration.

Id

Type: string

MssPackage

Type: MssPackage structure

A Microsoft Smooth Streaming (MSS) PackagingConfiguration.

PackagingGroupId

Type: string

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

CreatePackagingGroup

$result = $client->createPackagingGroup([/* ... */]);
$promise = $client->createPackagingGroupAsync([/* ... */]);

Creates a new MediaPackage VOD PackagingGroup resource.

Parameter Syntax

$result = $client->createPackagingGroup([
    'Authorization' => [
        'CdnIdentifierSecret' => '<string>', // REQUIRED
        'SecretsRoleArn' => '<string>', // REQUIRED
    ],
    'EgressAccessLogs' => [
        'LogGroupName' => '<string>',
    ],
    'Id' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

Authorization

Type: Authorization structure

CDN Authorization credentials

EgressAccessLogs

Type: EgressAccessLogs structure

Configure egress access logging.

Id

Required: Yes
Type: string

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Result Syntax

[
    'Arn' => '<string>',
    'Authorization' => [
        'CdnIdentifierSecret' => '<string>',
        'SecretsRoleArn' => '<string>',
    ],
    'CreatedAt' => '<string>',
    'DomainName' => '<string>',
    'EgressAccessLogs' => [
        'LogGroupName' => '<string>',
    ],
    'Id' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members

Arn

Type: string

Authorization

Type: Authorization structure

CDN Authorization credentials

CreatedAt

Type: string

DomainName

Type: string

EgressAccessLogs

Type: EgressAccessLogs structure

Configure egress access logging.

Id

Type: string

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

DeleteAsset

$result = $client->deleteAsset([/* ... */]);
$promise = $client->deleteAssetAsync([/* ... */]);

Deletes an existing MediaPackage VOD Asset resource.

Parameter Syntax

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

Parameter Details

Members

Id

Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

DeletePackagingConfiguration

$result = $client->deletePackagingConfiguration([/* ... */]);
$promise = $client->deletePackagingConfigurationAsync([/* ... */]);

Deletes a MediaPackage VOD PackagingConfiguration resource.

Parameter Syntax

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

Parameter Details

Members

Id

Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

DeletePackagingGroup

$result = $client->deletePackagingGroup([/* ... */]);
$promise = $client->deletePackagingGroupAsync([/* ... */]);

Deletes a MediaPackage VOD PackagingGroup resource.

Parameter Syntax

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

Parameter Details

Members

Id

Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

DescribeAsset

$result = $client->describeAsset([/* ... */]);
$promise = $client->describeAssetAsync([/* ... */]);

Returns a description of a MediaPackage VOD Asset resource.

Parameter Syntax

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

Parameter Details

Members

Id

Required: Yes
Type: string

Result Syntax

[
    'Arn' => '<string>',
    'CreatedAt' => '<string>',
    'EgressEndpoints' => [
        [
            'PackagingConfigurationId' => '<string>',
            'Status' => '<string>',
            'Url' => '<string>',
        ],
        // ...
    ],
    'Id' => '<string>',
    'PackagingGroupId' => '<string>',
    'ResourceId' => '<string>',
    'SourceArn' => '<string>',
    'SourceRoleArn' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members

Arn

Type: string

CreatedAt

Type: string

EgressEndpoints

Type: Array of EgressEndpoint structures

Id

Type: string

PackagingGroupId

Type: string

ResourceId

Type: string

SourceArn

Type: string

SourceRoleArn

Type: string

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

DescribePackagingConfiguration

$result = $client->describePackagingConfiguration([/* ... */]);
$promise = $client->describePackagingConfigurationAsync([/* ... */]);

Returns a description of a MediaPackage VOD PackagingConfiguration resource.

Parameter Syntax

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

Parameter Details

Members

Id

Required: Yes
Type: string

Result Syntax

[
    'Arn' => '<string>',
    'CmafPackage' => [
        'Encryption' => [
            'ConstantInitializationVector' => '<string>',
            'SpekeKeyProvider' => [
                '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',
                ],
                'RoleArn' => '<string>',
                'SystemIds' => ['<string>', ...],
                'Url' => '<string>',
            ],
        ],
        'HlsManifests' => [
            [
                'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH',
                'IncludeIframeOnlyStream' => true || false,
                'ManifestName' => '<string>',
                'ProgramDateTimeIntervalSeconds' => <integer>,
                'RepeatExtXKey' => true || false,
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'IncludeEncoderConfigurationInSegments' => true || false,
        'SegmentDurationSeconds' => <integer>,
    ],
    'CreatedAt' => '<string>',
    'DashPackage' => [
        'DashManifests' => [
            [
                'ManifestLayout' => 'FULL|COMPACT',
                'ManifestName' => '<string>',
                'MinBufferTimeSeconds' => <integer>,
                'Profile' => 'NONE|HBBTV_1_5',
                'ScteMarkersSource' => 'SEGMENTS|MANIFEST',
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'Encryption' => [
            'SpekeKeyProvider' => [
                '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',
                ],
                'RoleArn' => '<string>',
                'SystemIds' => ['<string>', ...],
                'Url' => '<string>',
            ],
        ],
        'IncludeEncoderConfigurationInSegments' => true || false,
        'IncludeIframeOnlyStream' => true || false,
        'PeriodTriggers' => ['<string>', ...],
        'SegmentDurationSeconds' => <integer>,
        'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE|TIME_WITH_TIMELINE|NUMBER_WITH_DURATION',
    ],
    'HlsPackage' => [
        'Encryption' => [
            'ConstantInitializationVector' => '<string>',
            'EncryptionMethod' => 'AES_128|SAMPLE_AES',
            'SpekeKeyProvider' => [
                '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',
                ],
                'RoleArn' => '<string>',
                'SystemIds' => ['<string>', ...],
                'Url' => '<string>',
            ],
        ],
        'HlsManifests' => [
            [
                'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH',
                'IncludeIframeOnlyStream' => true || false,
                'ManifestName' => '<string>',
                'ProgramDateTimeIntervalSeconds' => <integer>,
                'RepeatExtXKey' => true || false,
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'IncludeDvbSubtitles' => true || false,
        'SegmentDurationSeconds' => <integer>,
        'UseAudioRenditionGroup' => true || false,
    ],
    'Id' => '<string>',
    'MssPackage' => [
        'Encryption' => [
            'SpekeKeyProvider' => [
                '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',
                ],
                'RoleArn' => '<string>',
                'SystemIds' => ['<string>', ...],
                'Url' => '<string>',
            ],
        ],
        'MssManifests' => [
            [
                'ManifestName' => '<string>',
                'StreamSelection' => [
                    'MaxVideoBitsPerSecond' => <integer>,
                    'MinVideoBitsPerSecond' => <integer>,
                    'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                ],
            ],
            // ...
        ],
        'SegmentDurationSeconds' => <integer>,
    ],
    'PackagingGroupId' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members

Arn

Type: string

CmafPackage

Type: CmafPackage structure

A CMAF packaging configuration.

CreatedAt

Type: string

DashPackage

Type: DashPackage structure

A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

HlsPackage

Type: HlsPackage structure

An HTTP Live Streaming (HLS) packaging configuration.

Id

Type: string

MssPackage

Type: MssPackage structure

A Microsoft Smooth Streaming (MSS) PackagingConfiguration.

PackagingGroupId

Type: string

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

DescribePackagingGroup

$result = $client->describePackagingGroup([/* ... */]);
$promise = $client->describePackagingGroupAsync([/* ... */]);

Returns a description of a MediaPackage VOD PackagingGroup resource.

Parameter Syntax

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

Parameter Details

Members

Id

Required: Yes
Type: string

Result Syntax

[
    'ApproximateAssetCount' => <integer>,
    'Arn' => '<string>',
    'Authorization' => [
        'CdnIdentifierSecret' => '<string>',
        'SecretsRoleArn' => '<string>',
    ],
    'CreatedAt' => '<string>',
    'DomainName' => '<string>',
    'EgressAccessLogs' => [
        'LogGroupName' => '<string>',
    ],
    'Id' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members

ApproximateAssetCount

Type: int

Arn

Type: string

Authorization

Type: Authorization structure

CDN Authorization credentials

CreatedAt

Type: string

DomainName

Type: string

EgressAccessLogs

Type: EgressAccessLogs structure

Configure egress access logging.

Id

Type: string

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

ListAssets

$result = $client->listAssets([/* ... */]);
$promise = $client->listAssetsAsync([/* ... */]);

Returns a collection of MediaPackage VOD Asset resources.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

PackagingGroupId

Type: string

Result Syntax

[
    'Assets' => [
        [
            'Arn' => '<string>',
            'CreatedAt' => '<string>',
            'Id' => '<string>',
            'PackagingGroupId' => '<string>',
            'ResourceId' => '<string>',
            'SourceArn' => '<string>',
            'SourceRoleArn' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Assets

Type: Array of AssetShallow structures

NextToken

Type: string

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

ListPackagingConfigurations

$result = $client->listPackagingConfigurations([/* ... */]);
$promise = $client->listPackagingConfigurationsAsync([/* ... */]);

Returns a collection of MediaPackage VOD PackagingConfiguration resources.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

PackagingGroupId

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'PackagingConfigurations' => [
        [
            'Arn' => '<string>',
            'CmafPackage' => [
                'Encryption' => [
                    'ConstantInitializationVector' => '<string>',
                    'SpekeKeyProvider' => [
                        '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',
                        ],
                        'RoleArn' => '<string>',
                        'SystemIds' => ['<string>', ...],
                        'Url' => '<string>',
                    ],
                ],
                'HlsManifests' => [
                    [
                        'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH',
                        'IncludeIframeOnlyStream' => true || false,
                        'ManifestName' => '<string>',
                        'ProgramDateTimeIntervalSeconds' => <integer>,
                        'RepeatExtXKey' => true || false,
                        'StreamSelection' => [
                            'MaxVideoBitsPerSecond' => <integer>,
                            'MinVideoBitsPerSecond' => <integer>,
                            'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                        ],
                    ],
                    // ...
                ],
                'IncludeEncoderConfigurationInSegments' => true || false,
                'SegmentDurationSeconds' => <integer>,
            ],
            'CreatedAt' => '<string>',
            'DashPackage' => [
                'DashManifests' => [
                    [
                        'ManifestLayout' => 'FULL|COMPACT',
                        'ManifestName' => '<string>',
                        'MinBufferTimeSeconds' => <integer>,
                        'Profile' => 'NONE|HBBTV_1_5',
                        'ScteMarkersSource' => 'SEGMENTS|MANIFEST',
                        'StreamSelection' => [
                            'MaxVideoBitsPerSecond' => <integer>,
                            'MinVideoBitsPerSecond' => <integer>,
                            'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                        ],
                    ],
                    // ...
                ],
                'Encryption' => [
                    'SpekeKeyProvider' => [
                        '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',
                        ],
                        'RoleArn' => '<string>',
                        'SystemIds' => ['<string>', ...],
                        'Url' => '<string>',
                    ],
                ],
                'IncludeEncoderConfigurationInSegments' => true || false,
                'IncludeIframeOnlyStream' => true || false,
                'PeriodTriggers' => ['<string>', ...],
                'SegmentDurationSeconds' => <integer>,
                'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE|TIME_WITH_TIMELINE|NUMBER_WITH_DURATION',
            ],
            'HlsPackage' => [
                'Encryption' => [
                    'ConstantInitializationVector' => '<string>',
                    'EncryptionMethod' => 'AES_128|SAMPLE_AES',
                    'SpekeKeyProvider' => [
                        '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',
                        ],
                        'RoleArn' => '<string>',
                        'SystemIds' => ['<string>', ...],
                        'Url' => '<string>',
                    ],
                ],
                'HlsManifests' => [
                    [
                        'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH',
                        'IncludeIframeOnlyStream' => true || false,
                        'ManifestName' => '<string>',
                        'ProgramDateTimeIntervalSeconds' => <integer>,
                        'RepeatExtXKey' => true || false,
                        'StreamSelection' => [
                            'MaxVideoBitsPerSecond' => <integer>,
                            'MinVideoBitsPerSecond' => <integer>,
                            'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                        ],
                    ],
                    // ...
                ],
                'IncludeDvbSubtitles' => true || false,
                'SegmentDurationSeconds' => <integer>,
                'UseAudioRenditionGroup' => true || false,
            ],
            'Id' => '<string>',
            'MssPackage' => [
                'Encryption' => [
                    'SpekeKeyProvider' => [
                        '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',
                        ],
                        'RoleArn' => '<string>',
                        'SystemIds' => ['<string>', ...],
                        'Url' => '<string>',
                    ],
                ],
                'MssManifests' => [
                    [
                        'ManifestName' => '<string>',
                        'StreamSelection' => [
                            'MaxVideoBitsPerSecond' => <integer>,
                            'MinVideoBitsPerSecond' => <integer>,
                            'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING',
                        ],
                    ],
                    // ...
                ],
                'SegmentDurationSeconds' => <integer>,
            ],
            'PackagingGroupId' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

PackagingConfigurations

Type: Array of PackagingConfiguration structures

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

ListPackagingGroups

$result = $client->listPackagingGroups([/* ... */]);
$promise = $client->listPackagingGroupsAsync([/* ... */]);

Returns a collection of MediaPackage VOD PackagingGroup resources.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'PackagingGroups' => [
        [
            'ApproximateAssetCount' => <integer>,
            'Arn' => '<string>',
            'Authorization' => [
                'CdnIdentifierSecret' => '<string>',
                'SecretsRoleArn' => '<string>',
            ],
            'CreatedAt' => '<string>',
            'DomainName' => '<string>',
            'EgressAccessLogs' => [
                'LogGroupName' => '<string>',
            ],
            'Id' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

PackagingGroups

Type: Array of PackagingGroup structures

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

ListTagsForResource

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

Returns a list of the tags assigned to the specified resource.

Parameter Syntax

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

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

Result Syntax

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

Result Details

Members

Tags

Type: Associative array of custom strings keys (__string) to strings

Errors

There are no errors described for this operation.

TagResource

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

Adds tags to the specified resource. You can specify one or more tags to add.

Parameter Syntax

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

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

Tags

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

UntagResource

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

Removes tags from the specified resource. You can specify one or more tags to remove.

Parameter Syntax

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

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

TagKeys

Required: Yes
Type: Array of strings

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

UpdatePackagingGroup

$result = $client->updatePackagingGroup([/* ... */]);
$promise = $client->updatePackagingGroupAsync([/* ... */]);

Updates a specific packaging group. You can't change the id attribute or any other system-generated attributes.

Parameter Syntax

$result = $client->updatePackagingGroup([
    'Authorization' => [
        'CdnIdentifierSecret' => '<string>', // REQUIRED
        'SecretsRoleArn' => '<string>', // REQUIRED
    ],
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Authorization

Type: Authorization structure

CDN Authorization credentials

Id

Required: Yes
Type: string

Result Syntax

[
    'ApproximateAssetCount' => <integer>,
    'Arn' => '<string>',
    'Authorization' => [
        'CdnIdentifierSecret' => '<string>',
        'SecretsRoleArn' => '<string>',
    ],
    'CreatedAt' => '<string>',
    'DomainName' => '<string>',
    'EgressAccessLogs' => [
        'LogGroupName' => '<string>',
    ],
    'Id' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members

ApproximateAssetCount

Type: int

Arn

Type: string

Authorization

Type: Authorization structure

CDN Authorization credentials

CreatedAt

Type: string

DomainName

Type: string

EgressAccessLogs

Type: EgressAccessLogs structure

Configure egress access logging.

Id

Type: string

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Errors

UnprocessableEntityException:
This error does not currently have a description.
InternalServerErrorException:
This error does not currently have a description.
ForbiddenException:
This error does not currently have a description.
NotFoundException:
This error does not currently have a description.
ServiceUnavailableException:
This error does not currently have a description.
TooManyRequestsException:
This error does not currently have a description.

Shapes

Asset

Description

A MediaPackage VOD Asset resource.

Members

Arn

Type: string

The ARN of the Asset.

CreatedAt

Type: string

The time the Asset was initially submitted for Ingest.

EgressEndpoints

Type: Array of EgressEndpoint structures

The list of egress endpoints available for the Asset.

Id

Type: string

The unique identifier for the Asset.

PackagingGroupId

Type: string

The ID of the PackagingGroup for the Asset.

ResourceId

Type: string

The resource ID to include in SPEKE key requests.

SourceArn

Type: string

ARN of the source object in S3.

SourceRoleArn

Type: string

The IAM role_arn used to access the source S3 bucket.

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

AssetCreateParameters

Description

Parameters used to create a MediaPackage VOD Asset.

Members

Id

Required: Yes
Type: string

The unique identifier for the Asset.

PackagingGroupId

Required: Yes
Type: string

The ID of the PackagingGroup for the Asset.

ResourceId

Type: string

The resource ID to include in SPEKE key requests.

SourceArn

Required: Yes
Type: string

ARN of the source object in S3.

SourceRoleArn

Required: Yes
Type: string

The IAM role ARN used to access the source S3 bucket.

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

AssetList

Description

A collection of MediaPackage VOD Asset resources.

Members

Assets

Type: Array of AssetShallow structures

A list of MediaPackage VOD Asset resources.

NextToken

Type: string

A token that can be used to resume pagination from the end of the collection.

AssetShallow

Description

A MediaPackage VOD Asset resource.

Members

Arn

Type: string

The ARN of the Asset.

CreatedAt

Type: string

The time the Asset was initially submitted for Ingest.

Id

Type: string

The unique identifier for the Asset.

PackagingGroupId

Type: string

The ID of the PackagingGroup for the Asset.

ResourceId

Type: string

The resource ID to include in SPEKE key requests.

SourceArn

Type: string

ARN of the source object in S3.

SourceRoleArn

Type: string

The IAM role ARN used to access the source S3 bucket.

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

Authorization

Description

CDN Authorization credentials

Members

CdnIdentifierSecret

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.

SecretsRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.

CmafEncryption

Description

A CMAF encryption configuration.

Members

ConstantInitializationVector

Type: string

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

SpekeKeyProvider

Required: Yes
Type: SpekeKeyProvider structure

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

CmafPackage

Description

A CMAF packaging configuration.

Members

Encryption

Type: CmafEncryption structure

A CMAF encryption configuration.

HlsManifests

Required: Yes
Type: Array of HlsManifest structures

A list of HLS manifest configurations.

IncludeEncoderConfigurationInSegments

Type: boolean

When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.

SegmentDurationSeconds

Type: int

Duration (in seconds) of each fragment. Actual fragments will berounded to the nearest multiple of the source fragment duration.

ConfigureLogsParameters

Description

The configuration parameters for egress access logging.

Members

EgressAccessLogs

Type: EgressAccessLogs structure

Configure egress access logging.

DashEncryption

Description

A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.

Members

SpekeKeyProvider

Required: Yes
Type: SpekeKeyProvider structure

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

DashManifest

Description

A DASH manifest configuration.

Members

ManifestLayout

Type: string

Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.

ManifestName

Type: string

An optional string to include in the name of the manifest.

MinBufferTimeSeconds

Type: int

Minimum duration (in seconds) that a player will buffer media before starting the presentation.

Profile

Type: string

The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.

ScteMarkersSource

Type: string

The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content.

StreamSelection

Type: StreamSelection structure

A StreamSelection configuration.

DashPackage

Description

A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

Members

DashManifests

Required: Yes
Type: Array of DashManifest structures

A list of DASH manifest configurations.

Encryption

Type: DashEncryption structure

A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.

IncludeEncoderConfigurationInSegments

Type: boolean

IncludeIframeOnlyStream

Type: boolean

When enabled, an I-Frame only stream will be included in the output.

PeriodTriggers

Type: Array of strings

A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH)Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will notbe partitioned into more than one period. If the list contains "ADS", new periods will be created wherethe Asset contains SCTE-35 ad markers.

SegmentDurationSeconds

Type: int

Duration (in seconds) of each segment. Actual segments will berounded to the nearest multiple of the source segment duration.

SegmentTemplateFormat

Type: string

Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.

EgressAccessLogs

Description

Configure egress access logging.

Members

LogGroupName

Type: string

Customize the log group name.

EgressEndpoint

Description

The endpoint URL used to access an Asset using one PackagingConfiguration.

Members

PackagingConfigurationId

Type: string

The ID of the PackagingConfiguration being applied to the Asset.

Status

Type: string

The current processing status of the asset used for the packaging configuration. The status can be either QUEUED, PROCESSING, PLAYABLE, or FAILED. Status information won't be available for most assets ingested before 2021-09-30.

Url

Type: string

The URL of the parent manifest for the repackaged Asset.

EncryptionContractConfiguration

Description

Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 2.0.The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream.To configure the encryption contract, specify which audio and video encryption presets to use.Note the following considerations when using encryptionContractConfiguration:encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification.You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.

Members

PresetSpeke20Audio

Required: Yes
Type: string

A collection of audio encryption presets.

PresetSpeke20Video

Required: Yes
Type: string

A collection of video encryption presets.

ForbiddenException

Members

Message

Type: string

HlsEncryption

Description

An HTTP Live Streaming (HLS) encryption configuration.

Members

ConstantInitializationVector

Type: string

A constant initialization vector for encryption (optional).When not specified the initialization vector will be periodically rotated.

EncryptionMethod

Type: string

The encryption method to use.

SpekeKeyProvider

Required: Yes
Type: SpekeKeyProvider structure

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

HlsManifest

Description

An HTTP Live Streaming (HLS) manifest configuration.

Members

AdMarkers

Type: string

This setting controls how ad markers are included in the packaged OriginEndpoint."NONE" will omit all SCTE-35 ad markers from the output."PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 admarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest."SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35messages in the input source.

IncludeIframeOnlyStream

Type: boolean

When enabled, an I-Frame only stream will be included in the output.

ManifestName

Type: string

An optional string to include in the name of the manifest.

ProgramDateTimeIntervalSeconds

Type: int

The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME taginserted into manifests. Additionally, when an interval is specifiedID3Timed Metadata messages will be generated every 5 seconds using theingest time of the content.If the interval is not specified, or set to 0, thenno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and noID3Timed Metadata messages will be generated. Note that irrespectiveof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,it will be passed through to HLS output.

RepeatExtXKey

Type: boolean

When enabled, the EXT-X-KEY tag will be repeated in output manifests.

StreamSelection

Type: StreamSelection structure

A StreamSelection configuration.

HlsPackage

Description

An HTTP Live Streaming (HLS) packaging configuration.

Members

Encryption

Type: HlsEncryption structure

An HTTP Live Streaming (HLS) encryption configuration.

HlsManifests

Required: Yes
Type: Array of HlsManifest structures

A list of HLS manifest configurations.

IncludeDvbSubtitles

Type: boolean

When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.

SegmentDurationSeconds

Type: int

Duration (in seconds) of each fragment. Actual fragments will berounded to the nearest multiple of the source fragment duration.

UseAudioRenditionGroup

Type: boolean

When enabled, audio streams will be placed in rendition groups in the output.

InternalServerErrorException

Members

Message

Type: string

MssEncryption

Description

A Microsoft Smooth Streaming (MSS) encryption configuration.

Members

SpekeKeyProvider

Required: Yes
Type: SpekeKeyProvider structure

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

MssManifest

Description

A Microsoft Smooth Streaming (MSS) manifest configuration.

Members

ManifestName

Type: string

An optional string to include in the name of the manifest.

StreamSelection

Type: StreamSelection structure

A StreamSelection configuration.

MssPackage

Description

A Microsoft Smooth Streaming (MSS) PackagingConfiguration.

Members

Encryption

Type: MssEncryption structure

A Microsoft Smooth Streaming (MSS) encryption configuration.

MssManifests

Required: Yes
Type: Array of MssManifest structures

A list of MSS manifest configurations.

SegmentDurationSeconds

Type: int

The duration (in seconds) of each segment.

NotFoundException

Members

Message

Type: string

PackagingConfiguration

Description

A MediaPackage VOD PackagingConfiguration resource.

Members

Arn

Type: string

The ARN of the PackagingConfiguration.

CmafPackage

Type: CmafPackage structure

A CMAF packaging configuration.

CreatedAt

Type: string

The time the PackagingConfiguration was created.

DashPackage

Type: DashPackage structure

A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

HlsPackage

Type: HlsPackage structure

An HTTP Live Streaming (HLS) packaging configuration.

Id

Type: string

The ID of the PackagingConfiguration.

MssPackage

Type: MssPackage structure

A Microsoft Smooth Streaming (MSS) PackagingConfiguration.

PackagingGroupId

Type: string

The ID of a PackagingGroup.

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

PackagingConfigurationCreateParameters

Description

Parameters used to create a new MediaPackage VOD PackagingConfiguration resource.

Members

CmafPackage

Type: CmafPackage structure

A CMAF packaging configuration.

DashPackage

Type: DashPackage structure

A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

HlsPackage

Type: HlsPackage structure

An HTTP Live Streaming (HLS) packaging configuration.

Id

Required: Yes
Type: string

The ID of the PackagingConfiguration.

MssPackage

Type: MssPackage structure

A Microsoft Smooth Streaming (MSS) PackagingConfiguration.

PackagingGroupId

Required: Yes
Type: string

The ID of a PackagingGroup.

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

PackagingConfigurationList

Description

A collection of MediaPackage VOD PackagingConfiguration resources.

Members

NextToken

Type: string

A token that can be used to resume pagination from the end of the collection.

PackagingConfigurations

Type: Array of PackagingConfiguration structures

A list of MediaPackage VOD PackagingConfiguration resources.

PackagingGroup

Description

A MediaPackage VOD PackagingGroup resource.

Members

ApproximateAssetCount

Type: int

The approximate asset count of the PackagingGroup.

Arn

Type: string

The ARN of the PackagingGroup.

Authorization

Type: Authorization structure

CDN Authorization credentials

CreatedAt

Type: string

The time the PackagingGroup was created.

DomainName

Type: string

The fully qualified domain name for Assets in the PackagingGroup.

EgressAccessLogs

Type: EgressAccessLogs structure

Configure egress access logging.

Id

Type: string

The ID of the PackagingGroup.

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

PackagingGroupCreateParameters

Description

Parameters used to create a new MediaPackage VOD PackagingGroup resource.

Members

Authorization

Type: Authorization structure

CDN Authorization credentials

EgressAccessLogs

Type: EgressAccessLogs structure

Configure egress access logging.

Id

Required: Yes
Type: string

The ID of the PackagingGroup.

Tags

Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource

PackagingGroupList

Description

A collection of MediaPackage VOD PackagingGroup resources.

Members

NextToken

Type: string

A token that can be used to resume pagination from the end of the collection.

PackagingGroups

Type: Array of PackagingGroup structures

A list of MediaPackage VOD PackagingGroup resources.

PackagingGroupUpdateParameters

Description

Parameters used to update a MediaPackage packaging group.

Members

Authorization

Type: Authorization structure

CDN Authorization credentials

ServiceUnavailableException

Members

Message

Type: string

SpekeKeyProvider

Description

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

Members

EncryptionContractConfiguration

Type: EncryptionContractConfiguration structure

RoleArn

Required: Yes
Type: string

An Amazon Resource Name (ARN) of an IAM role that AWS ElementalMediaPackage will assume when accessing the key provider service.

SystemIds

Required: Yes
Type: Array of strings

The system IDs to include in key requests.

Url

Required: Yes
Type: string

The URL of the external key provider service.

StreamSelection

Description

A StreamSelection configuration.

Members

MaxVideoBitsPerSecond

Type: int

The maximum video bitrate (bps) to include in output.

MinVideoBitsPerSecond

Type: int

The minimum video bitrate (bps) to include in output.

StreamOrder

Type: string

A directive that determines the order of streams in the output.

TagsModel

Members

Tags

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

A collection of tags associated with a resource

TooManyRequestsException

Members

Message

Type: string

UnprocessableEntityException

Members

Message

Type: string

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Elemental MediaPackage VOD 2018-11-07

Operation Summary

Paginators

Operations

ConfigureLogs

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAsset

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreatePackagingConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreatePackagingGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteAsset

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeletePackagingConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeletePackagingGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeAsset

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribePackagingConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribePackagingGroup