ConfigureLogsForChannel

$result = $client->configureLogsForChannel([/* ... */]);
$promise = $client->configureLogsForChannelAsync([/* ... */]);

Configures Amazon CloudWatch log settings for a channel.

Parameter Syntax

$result = $client->configureLogsForChannel([
    'ChannelName' => '<string>', // REQUIRED
    'LogTypes' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChannelName' => '<string>',
    'LogTypes' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

ConfigureLogsForPlaybackConfiguration

$result = $client->configureLogsForPlaybackConfiguration([/* ... */]);
$promise = $client->configureLogsForPlaybackConfigurationAsync([/* ... */]);

Amazon CloudWatch log settings for a playback configuration.

Parameter Syntax

$result = $client->configureLogsForPlaybackConfiguration([
    'PercentEnabled' => <integer>, // REQUIRED
    'PlaybackConfigurationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PercentEnabled' => <integer>,
    'PlaybackConfigurationName' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

CreateChannel

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

Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Parameter Syntax

$result = $client->createChannel([
    'Audiences' => ['<string>', ...],
    'ChannelName' => '<string>', // REQUIRED
    'FillerSlate' => [
        'SourceLocationName' => '<string>',
        'VodSourceName' => '<string>',
    ],
    'Outputs' => [ // REQUIRED
        [
            'DashPlaylistSettings' => [
                'ManifestWindowSeconds' => <integer>,
                'MinBufferTimeSeconds' => <integer>,
                'MinUpdatePeriodSeconds' => <integer>,
                'SuggestedPresentationDelaySeconds' => <integer>,
            ],
            'HlsPlaylistSettings' => [
                'AdMarkupType' => ['<string>', ...],
                'ManifestWindowSeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'SourceGroup' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'PlaybackMode' => 'LOOP|LINEAR', // REQUIRED
    'Tags' => ['<string>', ...],
    'Tier' => 'BASIC|STANDARD',
    'TimeShiftConfiguration' => [
        'MaxTimeDelaySeconds' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Audiences' => ['<string>', ...],
    'ChannelName' => '<string>',
    'ChannelState' => 'RUNNING|STOPPED',
    'CreationTime' => <DateTime>,
    'FillerSlate' => [
        'SourceLocationName' => '<string>',
        'VodSourceName' => '<string>',
    ],
    'LastModifiedTime' => <DateTime>,
    'Outputs' => [
        [
            'DashPlaylistSettings' => [
                'ManifestWindowSeconds' => <integer>,
                'MinBufferTimeSeconds' => <integer>,
                'MinUpdatePeriodSeconds' => <integer>,
                'SuggestedPresentationDelaySeconds' => <integer>,
            ],
            'HlsPlaylistSettings' => [
                'AdMarkupType' => ['<string>', ...],
                'ManifestWindowSeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'PlaybackUrl' => '<string>',
            'SourceGroup' => '<string>',
        ],
        // ...
    ],
    'PlaybackMode' => '<string>',
    'Tags' => ['<string>', ...],
    'Tier' => '<string>',
    'TimeShiftConfiguration' => [
        'MaxTimeDelaySeconds' => <integer>,
    ],
]

Result Details

Errors

There are no errors described for this operation.

CreateLiveSource

$result = $client->createLiveSource([/* ... */]);
$promise = $client->createLiveSourceAsync([/* ... */]);

The live source configuration.

Parameter Syntax

$result = $client->createLiveSource([
    'HttpPackageConfigurations' => [ // REQUIRED
        [
            'Path' => '<string>', // REQUIRED
            'SourceGroup' => '<string>', // REQUIRED
            'Type' => 'DASH|HLS', // REQUIRED
        ],
        // ...
    ],
    'LiveSourceName' => '<string>', // REQUIRED
    'SourceLocationName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'HttpPackageConfigurations' => [
        [
            'Path' => '<string>',
            'SourceGroup' => '<string>',
            'Type' => 'DASH|HLS',
        ],
        // ...
    ],
    'LastModifiedTime' => <DateTime>,
    'LiveSourceName' => '<string>',
    'SourceLocationName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

CreatePrefetchSchedule

$result = $client->createPrefetchSchedule([/* ... */]);
$promise = $client->createPrefetchScheduleAsync([/* ... */]);

Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

Parameter Syntax

$result = $client->createPrefetchSchedule([
    'Consumption' => [ // REQUIRED
        'AvailMatchingCriteria' => [
            [
                'DynamicVariable' => '<string>', // REQUIRED
                'Operator' => 'EQUALS', // REQUIRED
            ],
            // ...
        ],
        'EndTime' => <integer || string || DateTime>, // REQUIRED
        'StartTime' => <integer || string || DateTime>,
    ],
    'Name' => '<string>', // REQUIRED
    'PlaybackConfigurationName' => '<string>', // REQUIRED
    'Retrieval' => [ // REQUIRED
        'DynamicVariables' => ['<string>', ...],
        'EndTime' => <integer || string || DateTime>, // REQUIRED
        'StartTime' => <integer || string || DateTime>,
    ],
    'StreamId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Consumption' => [
        'AvailMatchingCriteria' => [
            [
                'DynamicVariable' => '<string>',
                'Operator' => 'EQUALS',
            ],
            // ...
        ],
        'EndTime' => <DateTime>,
        'StartTime' => <DateTime>,
    ],
    'Name' => '<string>',
    'PlaybackConfigurationName' => '<string>',
    'Retrieval' => [
        'DynamicVariables' => ['<string>', ...],
        'EndTime' => <DateTime>,
        'StartTime' => <DateTime>,
    ],
    'StreamId' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

CreateProgram

$result = $client->createProgram([/* ... */]);
$promise = $client->createProgramAsync([/* ... */]);

Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

Parameter Syntax

$result = $client->createProgram([
    'AdBreaks' => [
        [
            'AdBreakMetadata' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'MessageType' => 'SPLICE_INSERT|TIME_SIGNAL',
            'OffsetMillis' => <integer>, // REQUIRED
            'Slate' => [
                'SourceLocationName' => '<string>',
                'VodSourceName' => '<string>',
            ],
            'SpliceInsertMessage' => [
                'AvailNum' => <integer>,
                'AvailsExpected' => <integer>,
                'SpliceEventId' => <integer>,
                'UniqueProgramId' => <integer>,
            ],
            'TimeSignalMessage' => [
                'SegmentationDescriptors' => [
                    [
                        'SegmentNum' => <integer>,
                        'SegmentationEventId' => <integer>,
                        'SegmentationTypeId' => <integer>,
                        'SegmentationUpid' => '<string>',
                        'SegmentationUpidType' => <integer>,
                        'SegmentsExpected' => <integer>,
                        'SubSegmentNum' => <integer>,
                        'SubSegmentsExpected' => <integer>,
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'AudienceMedia' => [
        [
            'AlternateMedia' => [
                [
                    'AdBreaks' => [
                        [
                            'AdBreakMetadata' => [
                                [
                                    'Key' => '<string>', // REQUIRED
                                    'Value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'MessageType' => 'SPLICE_INSERT|TIME_SIGNAL',
                            'OffsetMillis' => <integer>, // REQUIRED
                            'Slate' => [
                                'SourceLocationName' => '<string>',
                                'VodSourceName' => '<string>',
                            ],
                            'SpliceInsertMessage' => [
                                'AvailNum' => <integer>,
                                'AvailsExpected' => <integer>,
                                'SpliceEventId' => <integer>,
                                'UniqueProgramId' => <integer>,
                            ],
                            'TimeSignalMessage' => [
                                'SegmentationDescriptors' => [
                                    [
                                        'SegmentNum' => <integer>,
                                        'SegmentationEventId' => <integer>,
                                        'SegmentationTypeId' => <integer>,
                                        'SegmentationUpid' => '<string>',
                                        'SegmentationUpidType' => <integer>,
                                        'SegmentsExpected' => <integer>,
                                        'SubSegmentNum' => <integer>,
                                        'SubSegmentsExpected' => <integer>,
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'ClipRange' => [
                        'EndOffsetMillis' => <integer>,
                        'StartOffsetMillis' => <integer>,
                    ],
                    'DurationMillis' => <integer>,
                    'LiveSourceName' => '<string>',
                    'ScheduledStartTimeMillis' => <integer>,
                    'SourceLocationName' => '<string>',
                    'VodSourceName' => '<string>',
                ],
                // ...
            ],
            'Audience' => '<string>',
        ],
        // ...
    ],
    'ChannelName' => '<string>', // REQUIRED
    'LiveSourceName' => '<string>',
    'ProgramName' => '<string>', // REQUIRED
    'ScheduleConfiguration' => [ // REQUIRED
        'ClipRange' => [
            'EndOffsetMillis' => <integer>,
            'StartOffsetMillis' => <integer>,
        ],
        'Transition' => [ // REQUIRED
            'DurationMillis' => <integer>,
            'RelativePosition' => 'BEFORE_PROGRAM|AFTER_PROGRAM', // REQUIRED
            'RelativeProgram' => '<string>',
            'ScheduledStartTimeMillis' => <integer>,
            'Type' => '<string>', // REQUIRED
        ],
    ],
    'SourceLocationName' => '<string>', // REQUIRED
    'VodSourceName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AdBreaks' => [
        [
            'AdBreakMetadata' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'MessageType' => 'SPLICE_INSERT|TIME_SIGNAL',
            'OffsetMillis' => <integer>,
            'Slate' => [
                'SourceLocationName' => '<string>',
                'VodSourceName' => '<string>',
            ],
            'SpliceInsertMessage' => [
                'AvailNum' => <integer>,
                'AvailsExpected' => <integer>,
                'SpliceEventId' => <integer>,
                'UniqueProgramId' => <integer>,
            ],
            'TimeSignalMessage' => [
                'SegmentationDescriptors' => [
                    [
                        'SegmentNum' => <integer>,
                        'SegmentationEventId' => <integer>,
                        'SegmentationTypeId' => <integer>,
                        'SegmentationUpid' => '<string>',
                        'SegmentationUpidType' => <integer>,
                        'SegmentsExpected' => <integer>,
                        'SubSegmentNum' => <integer>,
                        'SubSegmentsExpected' => <integer>,
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'Arn' => '<string>',
    'AudienceMedia' => [
        [
            'AlternateMedia' => [
                [
                    'AdBreaks' => [
                        [
                            'AdBreakMetadata' => [
                                [
                                    'Key' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'MessageType' => 'SPLICE_INSERT|TIME_SIGNAL',
                            'OffsetMillis' => <integer>,
                            'Slate' => [
                                'SourceLocationName' => '<string>',
                                'VodSourceName' => '<string>',
                            ],
                            'SpliceInsertMessage' => [
                                'AvailNum' => <integer>,
                                'AvailsExpected' => <integer>,
                                'SpliceEventId' => <integer>,
                                'UniqueProgramId' => <integer>,
                            ],
                            'TimeSignalMessage' => [
                                'SegmentationDescriptors' => [
                                    [
                                        'SegmentNum' => <integer>,
                                        'SegmentationEventId' => <integer>,
                                        'SegmentationTypeId' => <integer>,
                                        'SegmentationUpid' => '<string>',
                                        'SegmentationUpidType' => <integer>,
                                        'SegmentsExpected' => <integer>,
                                        'SubSegmentNum' => <integer>,
                                        'SubSegmentsExpected' => <integer>,
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'ClipRange' => [
                        'EndOffsetMillis' => <integer>,
                        'StartOffsetMillis' => <integer>,
                    ],
                    'DurationMillis' => <integer>,
                    'LiveSourceName' => '<string>',
                    'ScheduledStartTimeMillis' => <integer>,
                    'SourceLocationName' => '<string>',
                    'VodSourceName' => '<string>',
                ],
                // ...
            ],
            'Audience' => '<string>',
        ],
        // ...
    ],
    'ChannelName' => '<string>',
    'ClipRange' => [
        'EndOffsetMillis' => <integer>,
        'StartOffsetMillis' => <integer>,
    ],
    'CreationTime' => <DateTime>,
    'DurationMillis' => <integer>,
    'LiveSourceName' => '<string>',
    'ProgramName' => '<string>',
    'ScheduledStartTime' => <DateTime>,
    'SourceLocationName' => '<string>',
    'VodSourceName' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

CreateSourceLocation

$result = $client->createSourceLocation([/* ... */]);
$promise = $client->createSourceLocationAsync([/* ... */]);

Creates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

Parameter Syntax

$result = $client->createSourceLocation([
    'AccessConfiguration' => [
        'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN|AUTODETECT_SIGV4',
        'SecretsManagerAccessTokenConfiguration' => [
            'HeaderName' => '<string>',
            'SecretArn' => '<string>',
            'SecretStringKey' => '<string>',
        ],
    ],
    'DefaultSegmentDeliveryConfiguration' => [
        'BaseUrl' => '<string>',
    ],
    'HttpConfiguration' => [ // REQUIRED
        'BaseUrl' => '<string>', // REQUIRED
    ],
    'SegmentDeliveryConfigurations' => [
        [
            'BaseUrl' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'SourceLocationName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'AccessConfiguration' => [
        'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN|AUTODETECT_SIGV4',
        'SecretsManagerAccessTokenConfiguration' => [
            'HeaderName' => '<string>',
            'SecretArn' => '<string>',
            'SecretStringKey' => '<string>',
        ],
    ],
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'DefaultSegmentDeliveryConfiguration' => [
        'BaseUrl' => '<string>',
    ],
    'HttpConfiguration' => [
        'BaseUrl' => '<string>',
    ],
    'LastModifiedTime' => <DateTime>,
    'SegmentDeliveryConfigurations' => [
        [
            'BaseUrl' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'SourceLocationName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

CreateVodSource

$result = $client->createVodSource([/* ... */]);
$promise = $client->createVodSourceAsync([/* ... */]);

The VOD source configuration parameters.

Parameter Syntax

$result = $client->createVodSource([
    'HttpPackageConfigurations' => [ // REQUIRED
        [
            'Path' => '<string>', // REQUIRED
            'SourceGroup' => '<string>', // REQUIRED
            'Type' => 'DASH|HLS', // REQUIRED
        ],
        // ...
    ],
    'SourceLocationName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'VodSourceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'HttpPackageConfigurations' => [
        [
            'Path' => '<string>',
            'SourceGroup' => '<string>',
            'Type' => 'DASH|HLS',
        ],
        // ...
    ],
    'LastModifiedTime' => <DateTime>,
    'SourceLocationName' => '<string>',
    'Tags' => ['<string>', ...],
    'VodSourceName' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

DeleteChannel

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

Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteChannelPolicy

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

The channel policy to delete.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteLiveSource

$result = $client->deleteLiveSource([/* ... */]);
$promise = $client->deleteLiveSourceAsync([/* ... */]);

The live source to delete.

Parameter Syntax

$result = $client->deleteLiveSource([
    'LiveSourceName' => '<string>', // REQUIRED
    'SourceLocationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeletePlaybackConfiguration

$result = $client->deletePlaybackConfiguration([/* ... */]);
$promise = $client->deletePlaybackConfigurationAsync([/* ... */]);

Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeletePrefetchSchedule

$result = $client->deletePrefetchSchedule([/* ... */]);
$promise = $client->deletePrefetchScheduleAsync([/* ... */]);

Deletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

Parameter Syntax

$result = $client->deletePrefetchSchedule([
    'Name' => '<string>', // REQUIRED
    'PlaybackConfigurationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteProgram

$result = $client->deleteProgram([/* ... */]);
$promise = $client->deleteProgramAsync([/* ... */]);

Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteSourceLocation

$result = $client->deleteSourceLocation([/* ... */]);
$promise = $client->deleteSourceLocationAsync([/* ... */]);

Deletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteVodSource

$result = $client->deleteVodSource([/* ... */]);
$promise = $client->deleteVodSourceAsync([/* ... */]);

The video on demand (VOD) source to delete.

Parameter Syntax

$result = $client->deleteVodSource([
    'SourceLocationName' => '<string>', // REQUIRED
    'VodSourceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DescribeChannel

$result = $client->describeChannel([/* ... */]);
$promise = $client->describeChannelAsync([/* ... */]);

Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Audiences' => ['<string>', ...],
    'ChannelName' => '<string>',
    'ChannelState' => 'RUNNING|STOPPED',
    'CreationTime' => <DateTime>,
    'FillerSlate' => [
        'SourceLocationName' => '<string>',
        'VodSourceName' => '<string>',
    ],
    'LastModifiedTime' => <DateTime>,
    'LogConfiguration' => [
        'LogTypes' => ['<string>', ...],
    ],
    'Outputs' => [
        [
            'DashPlaylistSettings' => [
                'ManifestWindowSeconds' => <integer>,
                'MinBufferTimeSeconds' => <integer>,
                'MinUpdatePeriodSeconds' => <integer>,
                'SuggestedPresentationDelaySeconds' => <integer>,
            ],
            'HlsPlaylistSettings' => [
                'AdMarkupType' => ['<string>', ...],
                'ManifestWindowSeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'PlaybackUrl' => '<string>',
            'SourceGroup' => '<string>',
        ],
        // ...
    ],
    'PlaybackMode' => '<string>',
    'Tags' => ['<string>', ...],
    'Tier' => '<string>',
    'TimeShiftConfiguration' => [
        'MaxTimeDelaySeconds' => <integer>,
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeLiveSource

$result = $client->describeLiveSource([/* ... */]);
$promise = $client->describeLiveSourceAsync([/* ... */]);

The live source to describe.

Parameter Syntax

$result = $client->describeLiveSource([
    'LiveSourceName' => '<string>', // REQUIRED
    'SourceLocationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'HttpPackageConfigurations' => [
        [
            'Path' => '<string>',
            'SourceGroup' => '<string>',
            'Type' => 'DASH|HLS',
        ],
        // ...
    ],
    'LastModifiedTime' => <DateTime>,
    'LiveSourceName' => '<string>',
    'SourceLocationName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

DescribeProgram

$result = $client->describeProgram([/* ... */]);
$promise = $client->describeProgramAsync([/* ... */]);

Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AdBreaks' => [
        [
            'AdBreakMetadata' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'MessageType' => 'SPLICE_INSERT|TIME_SIGNAL',
            'OffsetMillis' => <integer>,
            'Slate' => [
                'SourceLocationName' => '<string>',
                'VodSourceName' => '<string>',
            ],
            'SpliceInsertMessage' => [
                'AvailNum' => <integer>,
                'AvailsExpected' => <integer>,
                'SpliceEventId' => <integer>,
                'UniqueProgramId' => <integer>,
            ],
            'TimeSignalMessage' => [
                'SegmentationDescriptors' => [
                    [
                        'SegmentNum' => <integer>,
                        'SegmentationEventId' => <integer>,
                        'SegmentationTypeId' => <integer>,
                        'SegmentationUpid' => '<string>',
                        'SegmentationUpidType' => <integer>,
                        'SegmentsExpected' => <integer>,
                        'SubSegmentNum' => <integer>,
                        'SubSegmentsExpected' => <integer>,
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'Arn' => '<string>',
    'AudienceMedia' => [
        [
            'AlternateMedia' => [
                [
                    'AdBreaks' => [
                        [
                            'AdBreakMetadata' => [
                                [
                                    'Key' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'MessageType' => 'SPLICE_INSERT|TIME_SIGNAL',
                            'OffsetMillis' => <integer>,
                            'Slate' => [
                                'SourceLocationName' => '<string>',
                                'VodSourceName' => '<string>',
                            ],
                            'SpliceInsertMessage' => [
                                'AvailNum' => <integer>,
                                'AvailsExpected' => <integer>,
                                'SpliceEventId' => <integer>,
                                'UniqueProgramId' => <integer>,
                            ],
                            'TimeSignalMessage' => [
                                'SegmentationDescriptors' => [
                                    [
                                        'SegmentNum' => <integer>,
                                        'SegmentationEventId' => <integer>,
                                        'SegmentationTypeId' => <integer>,
                                        'SegmentationUpid' => '<string>',
                                        'SegmentationUpidType' => <integer>,
                                        'SegmentsExpected' => <integer>,
                                        'SubSegmentNum' => <integer>,
                                        'SubSegmentsExpected' => <integer>,
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'ClipRange' => [
                        'EndOffsetMillis' => <integer>,
                        'StartOffsetMillis' => <integer>,
                    ],
                    'DurationMillis' => <integer>,
                    'LiveSourceName' => '<string>',
                    'ScheduledStartTimeMillis' => <integer>,
                    'SourceLocationName' => '<string>',
                    'VodSourceName' => '<string>',
                ],
                // ...
            ],
            'Audience' => '<string>',
        ],
        // ...
    ],
    'ChannelName' => '<string>',
    'ClipRange' => [
        'EndOffsetMillis' => <integer>,
        'StartOffsetMillis' => <integer>,
    ],
    'CreationTime' => <DateTime>,
    'DurationMillis' => <integer>,
    'LiveSourceName' => '<string>',
    'ProgramName' => '<string>',
    'ScheduledStartTime' => <DateTime>,
    'SourceLocationName' => '<string>',
    'VodSourceName' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

DescribeSourceLocation

$result = $client->describeSourceLocation([/* ... */]);
$promise = $client->describeSourceLocationAsync([/* ... */]);

Describes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccessConfiguration' => [
        'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN|AUTODETECT_SIGV4',
        'SecretsManagerAccessTokenConfiguration' => [
            'HeaderName' => '<string>',
            'SecretArn' => '<string>',
            'SecretStringKey' => '<string>',
        ],
    ],
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'DefaultSegmentDeliveryConfiguration' => [
        'BaseUrl' => '<string>',
    ],
    'HttpConfiguration' => [
        'BaseUrl' => '<string>',
    ],
    'LastModifiedTime' => <DateTime>,
    'SegmentDeliveryConfigurations' => [
        [
            'BaseUrl' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'SourceLocationName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

DescribeVodSource

$result = $client->describeVodSource([/* ... */]);
$promise = $client->describeVodSourceAsync([/* ... */]);

Provides details about a specific video on demand (VOD) source in a specific source location.

Parameter Syntax

$result = $client->describeVodSource([
    'SourceLocationName' => '<string>', // REQUIRED
    'VodSourceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AdBreakOpportunities' => [
        [
            'OffsetMillis' => <integer>,
        ],
        // ...
    ],
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'HttpPackageConfigurations' => [
        [
            'Path' => '<string>',
            'SourceGroup' => '<string>',
            'Type' => 'DASH|HLS',
        ],
        // ...
    ],
    'LastModifiedTime' => <DateTime>,
    'SourceLocationName' => '<string>',
    'Tags' => ['<string>', ...],
    'VodSourceName' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

GetChannelPolicy

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

Returns the channel's IAM policy. IAM policies are used to control access to your channel.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

GetChannelSchedule

$result = $client->getChannelSchedule([/* ... */]);
$promise = $client->getChannelScheduleAsync([/* ... */]);

Retrieves information about your channel's schedule.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'ApproximateDurationSeconds' => <integer>,
            'ApproximateStartTime' => <DateTime>,
            'Arn' => '<string>',
            'Audiences' => ['<string>', ...],
            'ChannelName' => '<string>',
            'LiveSourceName' => '<string>',
            'ProgramName' => '<string>',
            'ScheduleAdBreaks' => [
                [
                    'ApproximateDurationSeconds' => <integer>,
                    'ApproximateStartTime' => <DateTime>,
                    'SourceLocationName' => '<string>',
                    'VodSourceName' => '<string>',
                ],
                // ...
            ],
            'ScheduleEntryType' => 'PROGRAM|FILLER_SLATE|ALTERNATE_MEDIA',
            'SourceLocationName' => '<string>',
            'VodSourceName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

GetPlaybackConfiguration

$result = $client->getPlaybackConfiguration([/* ... */]);
$promise = $client->getPlaybackConfigurationAsync([/* ... */]);

Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AdDecisionServerUrl' => '<string>',
    'AvailSuppression' => [
        'FillPolicy' => 'FULL_AVAIL_ONLY|PARTIAL_AVAIL',
        'Mode' => 'OFF|BEHIND_LIVE_EDGE|AFTER_LIVE_EDGE',
        'Value' => '<string>',
    ],
    'Bumper' => [
        'EndUrl' => '<string>',
        'StartUrl' => '<string>',
    ],
    'CdnConfiguration' => [
        'AdSegmentUrlPrefix' => '<string>',
        'ContentSegmentUrlPrefix' => '<string>',
    ],
    'ConfigurationAliases' => [
        '<__string>' => ['<string>', ...],
        // ...
    ],
    'DashConfiguration' => [
        'ManifestEndpointPrefix' => '<string>',
        'MpdLocation' => '<string>',
        'OriginManifestType' => 'SINGLE_PERIOD|MULTI_PERIOD',
    ],
    'HlsConfiguration' => [
        'ManifestEndpointPrefix' => '<string>',
    ],
    'InsertionMode' => 'STITCHED_ONLY|PLAYER_SELECT',
    'LivePreRollConfiguration' => [
        'AdDecisionServerUrl' => '<string>',
        'MaxDurationSeconds' => <integer>,
    ],
    'LogConfiguration' => [
        'PercentEnabled' => <integer>,
    ],
    'ManifestProcessingRules' => [
        'AdMarkerPassthrough' => [
            'Enabled' => true || false,
        ],
    ],
    'Name' => '<string>',
    'PersonalizationThresholdSeconds' => <integer>,
    'PlaybackConfigurationArn' => '<string>',
    'PlaybackEndpointPrefix' => '<string>',
    'SessionInitializationEndpointPrefix' => '<string>',
    'SlateAdUrl' => '<string>',
    'Tags' => ['<string>', ...],
    'TranscodeProfileName' => '<string>',
    'VideoContentSourceUrl' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

GetPrefetchSchedule

$result = $client->getPrefetchSchedule([/* ... */]);
$promise = $client->getPrefetchScheduleAsync([/* ... */]);

Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

Parameter Syntax

$result = $client->getPrefetchSchedule([
    'Name' => '<string>', // REQUIRED
    'PlaybackConfigurationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Consumption' => [
        'AvailMatchingCriteria' => [
            [
                'DynamicVariable' => '<string>',
                'Operator' => 'EQUALS',
            ],
            // ...
        ],
        'EndTime' => <DateTime>,
        'StartTime' => <DateTime>,
    ],
    'Name' => '<string>',
    'PlaybackConfigurationName' => '<string>',
    'Retrieval' => [
        'DynamicVariables' => ['<string>', ...],
        'EndTime' => <DateTime>,
        'StartTime' => <DateTime>,
    ],
    'StreamId' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListAlerts

$result = $client->listAlerts([/* ... */]);
$promise = $client->listAlertsAsync([/* ... */]);

Lists the alerts that are associated with a MediaTailor channel assembly resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'AlertCode' => '<string>',
            'AlertMessage' => '<string>',
            'Category' => 'SCHEDULING_ERROR|PLAYBACK_WARNING|INFO',
            'LastModifiedTime' => <DateTime>,
            'RelatedResourceArns' => ['<string>', ...],
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListChannels

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

Retrieves information about the channels that are associated with the current AWS account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'Arn' => '<string>',
            'Audiences' => ['<string>', ...],
            'ChannelName' => '<string>',
            'ChannelState' => '<string>',
            'CreationTime' => <DateTime>,
            'FillerSlate' => [
                'SourceLocationName' => '<string>',
                'VodSourceName' => '<string>',
            ],
            'LastModifiedTime' => <DateTime>,
            'LogConfiguration' => [
                'LogTypes' => ['<string>', ...],
            ],
            'Outputs' => [
                [
                    'DashPlaylistSettings' => [
                        'ManifestWindowSeconds' => <integer>,
                        'MinBufferTimeSeconds' => <integer>,
                        'MinUpdatePeriodSeconds' => <integer>,
                        'SuggestedPresentationDelaySeconds' => <integer>,
                    ],
                    'HlsPlaylistSettings' => [
                        'AdMarkupType' => ['<string>', ...],
                        'ManifestWindowSeconds' => <integer>,
                    ],
                    'ManifestName' => '<string>',
                    'PlaybackUrl' => '<string>',
                    'SourceGroup' => '<string>',
                ],
                // ...
            ],
            'PlaybackMode' => '<string>',
            'Tags' => ['<string>', ...],
            'Tier' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListLiveSources

$result = $client->listLiveSources([/* ... */]);
$promise = $client->listLiveSourcesAsync([/* ... */]);

Lists the live sources contained in a source location. A source represents a piece of content.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'HttpPackageConfigurations' => [
                [
                    'Path' => '<string>',
                    'SourceGroup' => '<string>',
                    'Type' => 'DASH|HLS',
                ],
                // ...
            ],
            'LastModifiedTime' => <DateTime>,
            'LiveSourceName' => '<string>',
            'SourceLocationName' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListPlaybackConfigurations

$result = $client->listPlaybackConfigurations([/* ... */]);
$promise = $client->listPlaybackConfigurationsAsync([/* ... */]);

Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'AdDecisionServerUrl' => '<string>',
            'AvailSuppression' => [
                'FillPolicy' => 'FULL_AVAIL_ONLY|PARTIAL_AVAIL',
                'Mode' => 'OFF|BEHIND_LIVE_EDGE|AFTER_LIVE_EDGE',
                'Value' => '<string>',
            ],
            'Bumper' => [
                'EndUrl' => '<string>',
                'StartUrl' => '<string>',
            ],
            'CdnConfiguration' => [
                'AdSegmentUrlPrefix' => '<string>',
                'ContentSegmentUrlPrefix' => '<string>',
            ],
            'ConfigurationAliases' => [
                '<__string>' => ['<string>', ...],
                // ...
            ],
            'DashConfiguration' => [
                'ManifestEndpointPrefix' => '<string>',
                'MpdLocation' => '<string>',
                'OriginManifestType' => 'SINGLE_PERIOD|MULTI_PERIOD',
            ],
            'HlsConfiguration' => [
                'ManifestEndpointPrefix' => '<string>',
            ],
            'InsertionMode' => 'STITCHED_ONLY|PLAYER_SELECT',
            'LivePreRollConfiguration' => [
                'AdDecisionServerUrl' => '<string>',
                'MaxDurationSeconds' => <integer>,
            ],
            'LogConfiguration' => [
                'PercentEnabled' => <integer>,
            ],
            'ManifestProcessingRules' => [
                'AdMarkerPassthrough' => [
                    'Enabled' => true || false,
                ],
            ],
            'Name' => '<string>',
            'PersonalizationThresholdSeconds' => <integer>,
            'PlaybackConfigurationArn' => '<string>',
            'PlaybackEndpointPrefix' => '<string>',
            'SessionInitializationEndpointPrefix' => '<string>',
            'SlateAdUrl' => '<string>',
            'Tags' => ['<string>', ...],
            'TranscodeProfileName' => '<string>',
            'VideoContentSourceUrl' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListPrefetchSchedules

$result = $client->listPrefetchSchedules([/* ... */]);
$promise = $client->listPrefetchSchedulesAsync([/* ... */]);

Lists the prefetch schedules for a playback configuration.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'Arn' => '<string>',
            'Consumption' => [
                'AvailMatchingCriteria' => [
                    [
                        'DynamicVariable' => '<string>',
                        'Operator' => 'EQUALS',
                    ],
                    // ...
                ],
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'Name' => '<string>',
            'PlaybackConfigurationName' => '<string>',
            'Retrieval' => [
                'DynamicVariables' => ['<string>', ...],
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'StreamId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListSourceLocations

$result = $client->listSourceLocations([/* ... */]);
$promise = $client->listSourceLocationsAsync([/* ... */]);

Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'AccessConfiguration' => [
                'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN|AUTODETECT_SIGV4',
                'SecretsManagerAccessTokenConfiguration' => [
                    'HeaderName' => '<string>',
                    'SecretArn' => '<string>',
                    'SecretStringKey' => '<string>',
                ],
            ],
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'DefaultSegmentDeliveryConfiguration' => [
                'BaseUrl' => '<string>',
            ],
            'HttpConfiguration' => [
                'BaseUrl' => '<string>',
            ],
            'LastModifiedTime' => <DateTime>,
            'SegmentDeliveryConfigurations' => [
                [
                    'BaseUrl' => '<string>',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'SourceLocationName' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListTagsForResource

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

A list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

A request contains unexpected data.

ListVodSources

$result = $client->listVodSources([/* ... */]);
$promise = $client->listVodSourcesAsync([/* ... */]);

Lists the VOD sources contained in a source location. A source represents a piece of content.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'HttpPackageConfigurations' => [
                [
                    'Path' => '<string>',
                    'SourceGroup' => '<string>',
                    'Type' => 'DASH|HLS',
                ],
                // ...
            ],
            'LastModifiedTime' => <DateTime>,
            'SourceLocationName' => '<string>',
            'Tags' => ['<string>', ...],
            'VodSourceName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

PutChannelPolicy

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

Creates an IAM policy for the channel. IAM policies are used to control access to your channel.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

PutPlaybackConfiguration

$result = $client->putPlaybackConfiguration([/* ... */]);
$promise = $client->putPlaybackConfigurationAsync([/* ... */]);

Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

Parameter Syntax

$result = $client->putPlaybackConfiguration([
    'AdDecisionServerUrl' => '<string>',
    'AvailSuppression' => [
        'FillPolicy' => 'FULL_AVAIL_ONLY|PARTIAL_AVAIL',
        'Mode' => 'OFF|BEHIND_LIVE_EDGE|AFTER_LIVE_EDGE',
        'Value' => '<string>',
    ],
    'Bumper' => [
        'EndUrl' => '<string>',
        'StartUrl' => '<string>',
    ],
    'CdnConfiguration' => [
        'AdSegmentUrlPrefix' => '<string>',
        'ContentSegmentUrlPrefix' => '<string>',
    ],
    'ConfigurationAliases' => [
        '<__string>' => ['<string>', ...],
        // ...
    ],
    'DashConfiguration' => [
        'MpdLocation' => '<string>',
        'OriginManifestType' => 'SINGLE_PERIOD|MULTI_PERIOD',
    ],
    'InsertionMode' => 'STITCHED_ONLY|PLAYER_SELECT',
    'LivePreRollConfiguration' => [
        'AdDecisionServerUrl' => '<string>',
        'MaxDurationSeconds' => <integer>,
    ],
    'ManifestProcessingRules' => [
        'AdMarkerPassthrough' => [
            'Enabled' => true || false,
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'PersonalizationThresholdSeconds' => <integer>,
    'SlateAdUrl' => '<string>',
    'Tags' => ['<string>', ...],
    'TranscodeProfileName' => '<string>',
    'VideoContentSourceUrl' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AdDecisionServerUrl' => '<string>',
    'AvailSuppression' => [
        'FillPolicy' => 'FULL_AVAIL_ONLY|PARTIAL_AVAIL',
        'Mode' => 'OFF|BEHIND_LIVE_EDGE|AFTER_LIVE_EDGE',
        'Value' => '<string>',
    ],
    'Bumper' => [
        'EndUrl' => '<string>',
        'StartUrl' => '<string>',
    ],
    'CdnConfiguration' => [
        'AdSegmentUrlPrefix' => '<string>',
        'ContentSegmentUrlPrefix' => '<string>',
    ],
    'ConfigurationAliases' => [
        '<__string>' => ['<string>', ...],
        // ...
    ],
    'DashConfiguration' => [
        'ManifestEndpointPrefix' => '<string>',
        'MpdLocation' => '<string>',
        'OriginManifestType' => 'SINGLE_PERIOD|MULTI_PERIOD',
    ],
    'HlsConfiguration' => [
        'ManifestEndpointPrefix' => '<string>',
    ],
    'InsertionMode' => 'STITCHED_ONLY|PLAYER_SELECT',
    'LivePreRollConfiguration' => [
        'AdDecisionServerUrl' => '<string>',
        'MaxDurationSeconds' => <integer>,
    ],
    'LogConfiguration' => [
        'PercentEnabled' => <integer>,
    ],
    'ManifestProcessingRules' => [
        'AdMarkerPassthrough' => [
            'Enabled' => true || false,
        ],
    ],
    'Name' => '<string>',
    'PersonalizationThresholdSeconds' => <integer>,
    'PlaybackConfigurationArn' => '<string>',
    'PlaybackEndpointPrefix' => '<string>',
    'SessionInitializationEndpointPrefix' => '<string>',
    'SlateAdUrl' => '<string>',
    'Tags' => ['<string>', ...],
    'TranscodeProfileName' => '<string>',
    'VideoContentSourceUrl' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

StartChannel

$result = $client->startChannel([/* ... */]);
$promise = $client->startChannelAsync([/* ... */]);

Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

StopChannel

$result = $client->stopChannel([/* ... */]);
$promise = $client->stopChannelAsync([/* ... */]);

Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

TagResource

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

The resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

A request contains unexpected data.

UntagResource

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

The resource to untag.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

A request contains unexpected data.

UpdateChannel

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

Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Parameter Syntax

$result = $client->updateChannel([
    'Audiences' => ['<string>', ...],
    'ChannelName' => '<string>', // REQUIRED
    'FillerSlate' => [
        'SourceLocationName' => '<string>',
        'VodSourceName' => '<string>',
    ],
    'Outputs' => [ // REQUIRED
        [
            'DashPlaylistSettings' => [
                'ManifestWindowSeconds' => <integer>,
                'MinBufferTimeSeconds' => <integer>,
                'MinUpdatePeriodSeconds' => <integer>,
                'SuggestedPresentationDelaySeconds' => <integer>,
            ],
            'HlsPlaylistSettings' => [
                'AdMarkupType' => ['<string>', ...],
                'ManifestWindowSeconds' => <integer>,
            ],
            'ManifestName' => '<string>', // REQUIRED
            'SourceGroup' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TimeShiftConfiguration' => [
        'MaxTimeDelaySeconds' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Audiences' => ['<string>', ...],
    'ChannelName' => '<string>',
    'ChannelState' => 'RUNNING|STOPPED',
    'CreationTime' => <DateTime>,
    'FillerSlate' => [
        'SourceLocationName' => '<string>',
        'VodSourceName' => '<string>',
    ],
    'LastModifiedTime' => <DateTime>,
    'Outputs' => [
        [
            'DashPlaylistSettings' => [
                'ManifestWindowSeconds' => <integer>,
                'MinBufferTimeSeconds' => <integer>,
                'MinUpdatePeriodSeconds' => <integer>,
                'SuggestedPresentationDelaySeconds' => <integer>,
            ],
            'HlsPlaylistSettings' => [
                'AdMarkupType' => ['<string>', ...],
                'ManifestWindowSeconds' => <integer>,
            ],
            'ManifestName' => '<string>',
            'PlaybackUrl' => '<string>',
            'SourceGroup' => '<string>',
        ],
        // ...
    ],
    'PlaybackMode' => '<string>',
    'Tags' => ['<string>', ...],
    'Tier' => '<string>',
    'TimeShiftConfiguration' => [
        'MaxTimeDelaySeconds' => <integer>,
    ],
]

Result Details

Errors

There are no errors described for this operation.

UpdateLiveSource

$result = $client->updateLiveSource([/* ... */]);
$promise = $client->updateLiveSourceAsync([/* ... */]);

Updates a live source's configuration.

Parameter Syntax

$result = $client->updateLiveSource([
    'HttpPackageConfigurations' => [ // REQUIRED
        [
            'Path' => '<string>', // REQUIRED
            'SourceGroup' => '<string>', // REQUIRED
            'Type' => 'DASH|HLS', // REQUIRED
        ],
        // ...
    ],
    'LiveSourceName' => '<string>', // REQUIRED
    'SourceLocationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'HttpPackageConfigurations' => [
        [
            'Path' => '<string>',
            'SourceGroup' => '<string>',
            'Type' => 'DASH|HLS',
        ],
        // ...
    ],
    'LastModifiedTime' => <DateTime>,
    'LiveSourceName' => '<string>',
    'SourceLocationName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

UpdateProgram

$result = $client->updateProgram([/* ... */]);
$promise = $client->updateProgramAsync([/* ... */]);

Updates a program within a channel.

Parameter Syntax

$result = $client->updateProgram([
    'AdBreaks' => [
        [
            'AdBreakMetadata' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'MessageType' => 'SPLICE_INSERT|TIME_SIGNAL',
            'OffsetMillis' => <integer>, // REQUIRED
            'Slate' => [
                'SourceLocationName' => '<string>',
                'VodSourceName' => '<string>',
            ],
            'SpliceInsertMessage' => [
                'AvailNum' => <integer>,
                'AvailsExpected' => <integer>,
                'SpliceEventId' => <integer>,
                'UniqueProgramId' => <integer>,
            ],
            'TimeSignalMessage' => [
                'SegmentationDescriptors' => [
                    [
                        'SegmentNum' => <integer>,
                        'SegmentationEventId' => <integer>,
                        'SegmentationTypeId' => <integer>,
                        'SegmentationUpid' => '<string>',
                        'SegmentationUpidType' => <integer>,
                        'SegmentsExpected' => <integer>,
                        'SubSegmentNum' => <integer>,
                        'SubSegmentsExpected' => <integer>,
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'AudienceMedia' => [
        [
            'AlternateMedia' => [
                [
                    'AdBreaks' => [
                        [
                            'AdBreakMetadata' => [
                                [
                                    'Key' => '<string>', // REQUIRED
                                    'Value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'MessageType' => 'SPLICE_INSERT|TIME_SIGNAL',
                            'OffsetMillis' => <integer>, // REQUIRED
                            'Slate' => [
                                'SourceLocationName' => '<string>',
                                'VodSourceName' => '<string>',
                            ],
                            'SpliceInsertMessage' => [
                                'AvailNum' => <integer>,
                                'AvailsExpected' => <integer>,
                                'SpliceEventId' => <integer>,
                                'UniqueProgramId' => <integer>,
                            ],
                            'TimeSignalMessage' => [
                                'SegmentationDescriptors' => [
                                    [
                                        'SegmentNum' => <integer>,
                                        'SegmentationEventId' => <integer>,
                                        'SegmentationTypeId' => <integer>,
                                        'SegmentationUpid' => '<string>',
                                        'SegmentationUpidType' => <integer>,
                                        'SegmentsExpected' => <integer>,
                                        'SubSegmentNum' => <integer>,
                                        'SubSegmentsExpected' => <integer>,
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'ClipRange' => [
                        'EndOffsetMillis' => <integer>,
                        'StartOffsetMillis' => <integer>,
                    ],
                    'DurationMillis' => <integer>,
                    'LiveSourceName' => '<string>',
                    'ScheduledStartTimeMillis' => <integer>,
                    'SourceLocationName' => '<string>',
                    'VodSourceName' => '<string>',
                ],
                // ...
            ],
            'Audience' => '<string>',
        ],
        // ...
    ],
    'ChannelName' => '<string>', // REQUIRED
    'ProgramName' => '<string>', // REQUIRED
    'ScheduleConfiguration' => [ // REQUIRED
        'ClipRange' => [
            'EndOffsetMillis' => <integer>,
            'StartOffsetMillis' => <integer>,
        ],
        'Transition' => [
            'DurationMillis' => <integer>,
            'ScheduledStartTimeMillis' => <integer>,
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'AdBreaks' => [
        [
            'AdBreakMetadata' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'MessageType' => 'SPLICE_INSERT|TIME_SIGNAL',
            'OffsetMillis' => <integer>,
            'Slate' => [
                'SourceLocationName' => '<string>',
                'VodSourceName' => '<string>',
            ],
            'SpliceInsertMessage' => [
                'AvailNum' => <integer>,
                'AvailsExpected' => <integer>,
                'SpliceEventId' => <integer>,
                'UniqueProgramId' => <integer>,
            ],
            'TimeSignalMessage' => [
                'SegmentationDescriptors' => [
                    [
                        'SegmentNum' => <integer>,
                        'SegmentationEventId' => <integer>,
                        'SegmentationTypeId' => <integer>,
                        'SegmentationUpid' => '<string>',
                        'SegmentationUpidType' => <integer>,
                        'SegmentsExpected' => <integer>,
                        'SubSegmentNum' => <integer>,
                        'SubSegmentsExpected' => <integer>,
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'Arn' => '<string>',
    'AudienceMedia' => [
        [
            'AlternateMedia' => [
                [
                    'AdBreaks' => [
                        [
                            'AdBreakMetadata' => [
                                [
                                    'Key' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'MessageType' => 'SPLICE_INSERT|TIME_SIGNAL',
                            'OffsetMillis' => <integer>,
                            'Slate' => [
                                'SourceLocationName' => '<string>',
                                'VodSourceName' => '<string>',
                            ],
                            'SpliceInsertMessage' => [
                                'AvailNum' => <integer>,
                                'AvailsExpected' => <integer>,
                                'SpliceEventId' => <integer>,
                                'UniqueProgramId' => <integer>,
                            ],
                            'TimeSignalMessage' => [
                                'SegmentationDescriptors' => [
                                    [
                                        'SegmentNum' => <integer>,
                                        'SegmentationEventId' => <integer>,
                                        'SegmentationTypeId' => <integer>,
                                        'SegmentationUpid' => '<string>',
                                        'SegmentationUpidType' => <integer>,
                                        'SegmentsExpected' => <integer>,
                                        'SubSegmentNum' => <integer>,
                                        'SubSegmentsExpected' => <integer>,
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'ClipRange' => [
                        'EndOffsetMillis' => <integer>,
                        'StartOffsetMillis' => <integer>,
                    ],
                    'DurationMillis' => <integer>,
                    'LiveSourceName' => '<string>',
                    'ScheduledStartTimeMillis' => <integer>,
                    'SourceLocationName' => '<string>',
                    'VodSourceName' => '<string>',
                ],
                // ...
            ],
            'Audience' => '<string>',
        ],
        // ...
    ],
    'ChannelName' => '<string>',
    'ClipRange' => [
        'EndOffsetMillis' => <integer>,
        'StartOffsetMillis' => <integer>,
    ],
    'CreationTime' => <DateTime>,
    'DurationMillis' => <integer>,
    'LiveSourceName' => '<string>',
    'ProgramName' => '<string>',
    'ScheduledStartTime' => <DateTime>,
    'SourceLocationName' => '<string>',
    'VodSourceName' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

UpdateSourceLocation

$result = $client->updateSourceLocation([/* ... */]);
$promise = $client->updateSourceLocationAsync([/* ... */]);

Updates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

Parameter Syntax

$result = $client->updateSourceLocation([
    'AccessConfiguration' => [
        'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN|AUTODETECT_SIGV4',
        'SecretsManagerAccessTokenConfiguration' => [
            'HeaderName' => '<string>',
            'SecretArn' => '<string>',
            'SecretStringKey' => '<string>',
        ],
    ],
    'DefaultSegmentDeliveryConfiguration' => [
        'BaseUrl' => '<string>',
    ],
    'HttpConfiguration' => [ // REQUIRED
        'BaseUrl' => '<string>', // REQUIRED
    ],
    'SegmentDeliveryConfigurations' => [
        [
            'BaseUrl' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'SourceLocationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccessConfiguration' => [
        'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN|AUTODETECT_SIGV4',
        'SecretsManagerAccessTokenConfiguration' => [
            'HeaderName' => '<string>',
            'SecretArn' => '<string>',
            'SecretStringKey' => '<string>',
        ],
    ],
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'DefaultSegmentDeliveryConfiguration' => [
        'BaseUrl' => '<string>',
    ],
    'HttpConfiguration' => [
        'BaseUrl' => '<string>',
    ],
    'LastModifiedTime' => <DateTime>,
    'SegmentDeliveryConfigurations' => [
        [
            'BaseUrl' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'SourceLocationName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

UpdateVodSource

$result = $client->updateVodSource([/* ... */]);
$promise = $client->updateVodSourceAsync([/* ... */]);

Updates a VOD source's configuration.

Parameter Syntax

$result = $client->updateVodSource([
    'HttpPackageConfigurations' => [ // REQUIRED
        [
            'Path' => '<string>', // REQUIRED
            'SourceGroup' => '<string>', // REQUIRED
            'Type' => 'DASH|HLS', // REQUIRED
        ],
        // ...
    ],
    'SourceLocationName' => '<string>', // REQUIRED
    'VodSourceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'HttpPackageConfigurations' => [
        [
            'Path' => '<string>',
            'SourceGroup' => '<string>',
            'Type' => 'DASH|HLS',
        ],
        // ...
    ],
    'LastModifiedTime' => <DateTime>,
    'SourceLocationName' => '<string>',
    'Tags' => ['<string>', ...],
    'VodSourceName' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.