AWS Elemental MediaPackage 2017-10-12
- Client: Aws\MediaPackage\MediaPackageClient
- Service ID: mediapackage
- Version: 2017-10-12
This page describes the parameters and results for the operations of the AWS Elemental MediaPackage (2017-10-12), and shows how to use the Aws\MediaPackage\MediaPackageClient object to call the described operations. This documentation is specific to the 2017-10-12 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 Channel's properities to configure log subscription
- CreateChannel ( array $params = [] )
- Creates a new Channel.
- CreateHarvestJob ( array $params = [] )
- Creates a new HarvestJob record.
- CreateOriginEndpoint ( array $params = [] )
- Creates a new OriginEndpoint record.
- DeleteChannel ( array $params = [] )
- Deletes an existing Channel.
- DeleteOriginEndpoint ( array $params = [] )
- Deletes an existing OriginEndpoint.
- DescribeChannel ( array $params = [] )
- Gets details about a Channel.
- DescribeHarvestJob ( array $params = [] )
- Gets details about an existing HarvestJob.
- DescribeOriginEndpoint ( array $params = [] )
- Gets details about an existing OriginEndpoint.
- ListChannels ( array $params = [] )
- Returns a collection of Channels.
- ListHarvestJobs ( array $params = [] )
- Returns a collection of HarvestJob records.
- ListOriginEndpoints ( array $params = [] )
- Returns a collection of OriginEndpoint records.
- ListTagsForResource ( array $params = [] )
- RotateChannelCredentials ( array $params = [] )
- Changes the Channel's first IngestEndpoint's username and password.
- RotateIngestEndpointCredentials ( array $params = [] )
- Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
- TagResource ( array $params = [] )
- UntagResource ( array $params = [] )
- UpdateChannel ( array $params = [] )
- Updates an existing Channel.
- UpdateOriginEndpoint ( array $params = [] )
- Updates an existing OriginEndpoint.
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:
Operations
ConfigureLogs
$result = $client->configureLogs
([/* ... */]); $promise = $client->configureLogsAsync
([/* ... */]);
Changes the Channel's properities to configure log subscription
Parameter Syntax
$result = $client->configureLogs([ 'EgressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'Id' => '<string>', // REQUIRED 'IngressAccessLogs' => [ 'LogGroupName' => '<string>', ], ]);
Parameter Details
Members
- EgressAccessLogs
-
- Type: EgressAccessLogs structure
Configure egress access logging. - Id
-
- Required: Yes
- Type: string
- IngressAccessLogs
-
- Type: IngressAccessLogs structure
Configure ingress access logging.
Result Syntax
[ 'Arn' => '<string>', 'CreatedAt' => '<string>', 'Description' => '<string>', 'EgressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'HlsIngest' => [ 'IngestEndpoints' => [ [ 'Id' => '<string>', 'Password' => '<string>', 'Url' => '<string>', 'Username' => '<string>', ], // ... ], ], 'Id' => '<string>', 'IngressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'Tags' => ['<string>', ...], ]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: string
- Description
-
- Type: string
- EgressAccessLogs
-
- Type: EgressAccessLogs structure
Configure egress access logging. - HlsIngest
-
- Type: HlsIngest structure
An HTTP Live Streaming (HLS) ingest resource configuration. - Id
-
- Type: string
- IngressAccessLogs
-
- Type: IngressAccessLogs structure
Configure ingress access logging. - 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.
CreateChannel
$result = $client->createChannel
([/* ... */]); $promise = $client->createChannelAsync
([/* ... */]);
Creates a new Channel.
Parameter Syntax
$result = $client->createChannel([ 'Description' => '<string>', 'Id' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- Description
-
- Type: string
- 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>', 'CreatedAt' => '<string>', 'Description' => '<string>', 'EgressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'HlsIngest' => [ 'IngestEndpoints' => [ [ 'Id' => '<string>', 'Password' => '<string>', 'Url' => '<string>', 'Username' => '<string>', ], // ... ], ], 'Id' => '<string>', 'IngressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'Tags' => ['<string>', ...], ]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: string
- Description
-
- Type: string
- EgressAccessLogs
-
- Type: EgressAccessLogs structure
Configure egress access logging. - HlsIngest
-
- Type: HlsIngest structure
An HTTP Live Streaming (HLS) ingest resource configuration. - Id
-
- Type: string
- IngressAccessLogs
-
- Type: IngressAccessLogs structure
Configure ingress access logging. - 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.
CreateHarvestJob
$result = $client->createHarvestJob
([/* ... */]); $promise = $client->createHarvestJobAsync
([/* ... */]);
Creates a new HarvestJob record.
Parameter Syntax
$result = $client->createHarvestJob([ 'EndTime' => '<string>', // REQUIRED 'Id' => '<string>', // REQUIRED 'OriginEndpointId' => '<string>', // REQUIRED 'S3Destination' => [ // REQUIRED 'BucketName' => '<string>', // REQUIRED 'ManifestKey' => '<string>', // REQUIRED 'RoleArn' => '<string>', // REQUIRED ], 'StartTime' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EndTime
-
- Required: Yes
- Type: string
- Id
-
- Required: Yes
- Type: string
- OriginEndpointId
-
- Required: Yes
- Type: string
- S3Destination
-
- Required: Yes
- Type: S3Destination structure
Configuration parameters for where in an S3 bucket to place the harvested content - StartTime
-
- Required: Yes
- Type: string
Result Syntax
[ 'Arn' => '<string>', 'ChannelId' => '<string>', 'CreatedAt' => '<string>', 'EndTime' => '<string>', 'Id' => '<string>', 'OriginEndpointId' => '<string>', 'S3Destination' => [ 'BucketName' => '<string>', 'ManifestKey' => '<string>', 'RoleArn' => '<string>', ], 'StartTime' => '<string>', 'Status' => 'IN_PROGRESS|SUCCEEDED|FAILED', ]
Result Details
Members
- Arn
-
- Type: string
- ChannelId
-
- Type: string
- CreatedAt
-
- Type: string
- EndTime
-
- Type: string
- Id
-
- Type: string
- OriginEndpointId
-
- Type: string
- S3Destination
-
- Type: S3Destination structure
Configuration parameters for where in an S3 bucket to place the harvested content - StartTime
-
- Type: string
- Status
-
- 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.
CreateOriginEndpoint
$result = $client->createOriginEndpoint
([/* ... */]); $promise = $client->createOriginEndpointAsync
([/* ... */]);
Creates a new OriginEndpoint record.
Parameter Syntax
$result = $client->createOriginEndpoint([ 'Authorization' => [ 'CdnIdentifierSecret' => '<string>', // REQUIRED 'SecretsRoleArn' => '<string>', // REQUIRED ], 'ChannelId' => '<string>', // REQUIRED 'CmafPackage' => [ 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'SAMPLE_AES|AES_CTR', 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ // REQUIRED 'CertificateArn' => '<string>', '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 ], 'ResourceId' => '<string>', // REQUIRED 'RoleArn' => '<string>', // REQUIRED 'SystemIds' => ['<string>', ...], // REQUIRED 'Url' => '<string>', // REQUIRED ], ], 'HlsManifests' => [ [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Id' => '<string>', // REQUIRED 'IncludeIframeOnlyStream' => true || false, 'ManifestName' => '<string>', 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, ], // ... ], 'SegmentDurationSeconds' => <integer>, 'SegmentPrefix' => '<string>', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'DashPackage' => [ 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ // REQUIRED 'CertificateArn' => '<string>', '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 ], 'ResourceId' => '<string>', // REQUIRED 'RoleArn' => '<string>', // REQUIRED 'SystemIds' => ['<string>', ...], // REQUIRED 'Url' => '<string>', // REQUIRED ], ], 'IncludeIframeOnlyStream' => true || false, 'ManifestLayout' => 'FULL|COMPACT|DRM_TOP_LEVEL_COMPACT', 'ManifestWindowSeconds' => <integer>, 'MinBufferTimeSeconds' => <integer>, 'MinUpdatePeriodSeconds' => <integer>, 'PeriodTriggers' => ['<string>', ...], 'Profile' => 'NONE|HBBTV_1_5|HYBRIDCAST|DVB_DASH_2014', 'SegmentDurationSeconds' => <integer>, 'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE|TIME_WITH_TIMELINE|NUMBER_WITH_DURATION', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'SuggestedPresentationDelaySeconds' => <integer>, 'UtcTiming' => 'NONE|HTTP-HEAD|HTTP-ISO|HTTP-XSDATE', 'UtcTimingUri' => '<string>', ], 'Description' => '<string>', 'HlsPackage' => [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'AES_128|SAMPLE_AES', 'KeyRotationIntervalSeconds' => <integer>, 'RepeatExtXKey' => true || false, 'SpekeKeyProvider' => [ // REQUIRED 'CertificateArn' => '<string>', '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 ], 'ResourceId' => '<string>', // REQUIRED 'RoleArn' => '<string>', // REQUIRED 'SystemIds' => ['<string>', ...], // REQUIRED 'Url' => '<string>', // REQUIRED ], ], 'IncludeDvbSubtitles' => true || false, 'IncludeIframeOnlyStream' => true || false, 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'UseAudioRenditionGroup' => true || false, ], 'Id' => '<string>', // REQUIRED 'ManifestName' => '<string>', 'MssPackage' => [ 'Encryption' => [ 'SpekeKeyProvider' => [ // REQUIRED 'CertificateArn' => '<string>', '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 ], 'ResourceId' => '<string>', // REQUIRED 'RoleArn' => '<string>', // REQUIRED 'SystemIds' => ['<string>', ...], // REQUIRED 'Url' => '<string>', // REQUIRED ], ], 'ManifestWindowSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'Origination' => 'ALLOW|DENY', 'StartoverWindowSeconds' => <integer>, 'Tags' => ['<string>', ...], 'TimeDelaySeconds' => <integer>, 'Whitelist' => ['<string>', ...], ]);
Parameter Details
Members
- Authorization
-
- Type: Authorization structure
CDN Authorization credentials - ChannelId
-
- Required: Yes
- Type: string
- CmafPackage
-
- Type: CmafPackageCreateOrUpdateParameters structure
A Common Media Application Format (CMAF) packaging configuration. - DashPackage
-
- Type: DashPackage structure
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - Description
-
- Type: string
- HlsPackage
-
- Type: HlsPackage structure
An HTTP Live Streaming (HLS) packaging configuration. - Id
-
- Required: Yes
- Type: string
- ManifestName
-
- Type: string
- MssPackage
-
- Type: MssPackage structure
A Microsoft Smooth Streaming (MSS) packaging configuration. - Origination
-
- Type: string
- StartoverWindowSeconds
-
- Type: int
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of tags associated with a resource - TimeDelaySeconds
-
- Type: int
- Whitelist
-
- Type: Array of strings
Result Syntax
[ 'Arn' => '<string>', 'Authorization' => [ 'CdnIdentifierSecret' => '<string>', 'SecretsRoleArn' => '<string>', ], 'ChannelId' => '<string>', 'CmafPackage' => [ 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'SAMPLE_AES|AES_CTR', 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'HlsManifests' => [ [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'Id' => '<string>', 'IncludeIframeOnlyStream' => true || false, 'ManifestName' => '<string>', 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, 'Url' => '<string>', ], // ... ], 'SegmentDurationSeconds' => <integer>, 'SegmentPrefix' => '<string>', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'CreatedAt' => '<string>', 'DashPackage' => [ 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'IncludeIframeOnlyStream' => true || false, 'ManifestLayout' => 'FULL|COMPACT|DRM_TOP_LEVEL_COMPACT', 'ManifestWindowSeconds' => <integer>, 'MinBufferTimeSeconds' => <integer>, 'MinUpdatePeriodSeconds' => <integer>, 'PeriodTriggers' => ['<string>', ...], 'Profile' => 'NONE|HBBTV_1_5|HYBRIDCAST|DVB_DASH_2014', 'SegmentDurationSeconds' => <integer>, 'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE|TIME_WITH_TIMELINE|NUMBER_WITH_DURATION', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'SuggestedPresentationDelaySeconds' => <integer>, 'UtcTiming' => 'NONE|HTTP-HEAD|HTTP-ISO|HTTP-XSDATE', 'UtcTimingUri' => '<string>', ], 'Description' => '<string>', 'HlsPackage' => [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'AES_128|SAMPLE_AES', 'KeyRotationIntervalSeconds' => <integer>, 'RepeatExtXKey' => true || false, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'IncludeDvbSubtitles' => true || false, 'IncludeIframeOnlyStream' => true || false, 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'UseAudioRenditionGroup' => true || false, ], 'Id' => '<string>', 'ManifestName' => '<string>', 'MssPackage' => [ 'Encryption' => [ 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'ManifestWindowSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'Origination' => 'ALLOW|DENY', 'StartoverWindowSeconds' => <integer>, 'Tags' => ['<string>', ...], 'TimeDelaySeconds' => <integer>, 'Url' => '<string>', 'Whitelist' => ['<string>', ...], ]
Result Details
Members
- Arn
-
- Type: string
- Authorization
-
- Type: Authorization structure
CDN Authorization credentials - ChannelId
-
- Type: string
- CmafPackage
-
- Type: CmafPackage structure
A Common Media Application Format (CMAF) packaging configuration. - CreatedAt
-
- Type: string
- DashPackage
-
- Type: DashPackage structure
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - Description
-
- Type: string
- HlsPackage
-
- Type: HlsPackage structure
An HTTP Live Streaming (HLS) packaging configuration. - Id
-
- Type: string
- ManifestName
-
- Type: string
- MssPackage
-
- Type: MssPackage structure
A Microsoft Smooth Streaming (MSS) packaging configuration. - Origination
-
- Type: string
- StartoverWindowSeconds
-
- Type: int
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of tags associated with a resource - TimeDelaySeconds
-
- Type: int
- Url
-
- Type: string
- Whitelist
-
- Type: Array of strings
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.
DeleteChannel
$result = $client->deleteChannel
([/* ... */]); $promise = $client->deleteChannelAsync
([/* ... */]);
Deletes an existing Channel.
Parameter Syntax
$result = $client->deleteChannel([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
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.
DeleteOriginEndpoint
$result = $client->deleteOriginEndpoint
([/* ... */]); $promise = $client->deleteOriginEndpointAsync
([/* ... */]);
Deletes an existing OriginEndpoint.
Parameter Syntax
$result = $client->deleteOriginEndpoint([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
Result Syntax
[]
Result Details
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.
DescribeChannel
$result = $client->describeChannel
([/* ... */]); $promise = $client->describeChannelAsync
([/* ... */]);
Gets details about a Channel.
Parameter Syntax
$result = $client->describeChannel([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
Result Syntax
[ 'Arn' => '<string>', 'CreatedAt' => '<string>', 'Description' => '<string>', 'EgressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'HlsIngest' => [ 'IngestEndpoints' => [ [ 'Id' => '<string>', 'Password' => '<string>', 'Url' => '<string>', 'Username' => '<string>', ], // ... ], ], 'Id' => '<string>', 'IngressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'Tags' => ['<string>', ...], ]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: string
- Description
-
- Type: string
- EgressAccessLogs
-
- Type: EgressAccessLogs structure
Configure egress access logging. - HlsIngest
-
- Type: HlsIngest structure
An HTTP Live Streaming (HLS) ingest resource configuration. - Id
-
- Type: string
- IngressAccessLogs
-
- Type: IngressAccessLogs structure
Configure ingress access logging. - 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.
DescribeHarvestJob
$result = $client->describeHarvestJob
([/* ... */]); $promise = $client->describeHarvestJobAsync
([/* ... */]);
Gets details about an existing HarvestJob.
Parameter Syntax
$result = $client->describeHarvestJob([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
Result Syntax
[ 'Arn' => '<string>', 'ChannelId' => '<string>', 'CreatedAt' => '<string>', 'EndTime' => '<string>', 'Id' => '<string>', 'OriginEndpointId' => '<string>', 'S3Destination' => [ 'BucketName' => '<string>', 'ManifestKey' => '<string>', 'RoleArn' => '<string>', ], 'StartTime' => '<string>', 'Status' => 'IN_PROGRESS|SUCCEEDED|FAILED', ]
Result Details
Members
- Arn
-
- Type: string
- ChannelId
-
- Type: string
- CreatedAt
-
- Type: string
- EndTime
-
- Type: string
- Id
-
- Type: string
- OriginEndpointId
-
- Type: string
- S3Destination
-
- Type: S3Destination structure
Configuration parameters for where in an S3 bucket to place the harvested content - StartTime
-
- Type: string
- Status
-
- 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.
DescribeOriginEndpoint
$result = $client->describeOriginEndpoint
([/* ... */]); $promise = $client->describeOriginEndpointAsync
([/* ... */]);
Gets details about an existing OriginEndpoint.
Parameter Syntax
$result = $client->describeOriginEndpoint([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
Result Syntax
[ 'Arn' => '<string>', 'Authorization' => [ 'CdnIdentifierSecret' => '<string>', 'SecretsRoleArn' => '<string>', ], 'ChannelId' => '<string>', 'CmafPackage' => [ 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'SAMPLE_AES|AES_CTR', 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'HlsManifests' => [ [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'Id' => '<string>', 'IncludeIframeOnlyStream' => true || false, 'ManifestName' => '<string>', 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, 'Url' => '<string>', ], // ... ], 'SegmentDurationSeconds' => <integer>, 'SegmentPrefix' => '<string>', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'CreatedAt' => '<string>', 'DashPackage' => [ 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'IncludeIframeOnlyStream' => true || false, 'ManifestLayout' => 'FULL|COMPACT|DRM_TOP_LEVEL_COMPACT', 'ManifestWindowSeconds' => <integer>, 'MinBufferTimeSeconds' => <integer>, 'MinUpdatePeriodSeconds' => <integer>, 'PeriodTriggers' => ['<string>', ...], 'Profile' => 'NONE|HBBTV_1_5|HYBRIDCAST|DVB_DASH_2014', 'SegmentDurationSeconds' => <integer>, 'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE|TIME_WITH_TIMELINE|NUMBER_WITH_DURATION', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'SuggestedPresentationDelaySeconds' => <integer>, 'UtcTiming' => 'NONE|HTTP-HEAD|HTTP-ISO|HTTP-XSDATE', 'UtcTimingUri' => '<string>', ], 'Description' => '<string>', 'HlsPackage' => [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'AES_128|SAMPLE_AES', 'KeyRotationIntervalSeconds' => <integer>, 'RepeatExtXKey' => true || false, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'IncludeDvbSubtitles' => true || false, 'IncludeIframeOnlyStream' => true || false, 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'UseAudioRenditionGroup' => true || false, ], 'Id' => '<string>', 'ManifestName' => '<string>', 'MssPackage' => [ 'Encryption' => [ 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'ManifestWindowSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'Origination' => 'ALLOW|DENY', 'StartoverWindowSeconds' => <integer>, 'Tags' => ['<string>', ...], 'TimeDelaySeconds' => <integer>, 'Url' => '<string>', 'Whitelist' => ['<string>', ...], ]
Result Details
Members
- Arn
-
- Type: string
- Authorization
-
- Type: Authorization structure
CDN Authorization credentials - ChannelId
-
- Type: string
- CmafPackage
-
- Type: CmafPackage structure
A Common Media Application Format (CMAF) packaging configuration. - CreatedAt
-
- Type: string
- DashPackage
-
- Type: DashPackage structure
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - Description
-
- Type: string
- HlsPackage
-
- Type: HlsPackage structure
An HTTP Live Streaming (HLS) packaging configuration. - Id
-
- Type: string
- ManifestName
-
- Type: string
- MssPackage
-
- Type: MssPackage structure
A Microsoft Smooth Streaming (MSS) packaging configuration. - Origination
-
- Type: string
- StartoverWindowSeconds
-
- Type: int
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of tags associated with a resource - TimeDelaySeconds
-
- Type: int
- Url
-
- Type: string
- Whitelist
-
- Type: Array of strings
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.
ListChannels
$result = $client->listChannels
([/* ... */]); $promise = $client->listChannelsAsync
([/* ... */]);
Returns a collection of Channels.
Parameter Syntax
$result = $client->listChannels([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[ 'Channels' => [ [ 'Arn' => '<string>', 'CreatedAt' => '<string>', 'Description' => '<string>', 'EgressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'HlsIngest' => [ 'IngestEndpoints' => [ [ 'Id' => '<string>', 'Password' => '<string>', 'Url' => '<string>', 'Username' => '<string>', ], // ... ], ], 'Id' => '<string>', 'IngressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'Tags' => ['<string>', ...], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Channels
-
- Type: Array of Channel 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.
ListHarvestJobs
$result = $client->listHarvestJobs
([/* ... */]); $promise = $client->listHarvestJobsAsync
([/* ... */]);
Returns a collection of HarvestJob records.
Parameter Syntax
$result = $client->listHarvestJobs([ 'IncludeChannelId' => '<string>', 'IncludeStatus' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- IncludeChannelId
-
- Type: string
- IncludeStatus
-
- Type: string
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[ 'HarvestJobs' => [ [ 'Arn' => '<string>', 'ChannelId' => '<string>', 'CreatedAt' => '<string>', 'EndTime' => '<string>', 'Id' => '<string>', 'OriginEndpointId' => '<string>', 'S3Destination' => [ 'BucketName' => '<string>', 'ManifestKey' => '<string>', 'RoleArn' => '<string>', ], 'StartTime' => '<string>', 'Status' => 'IN_PROGRESS|SUCCEEDED|FAILED', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- HarvestJobs
-
- Type: Array of HarvestJob 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.
ListOriginEndpoints
$result = $client->listOriginEndpoints
([/* ... */]); $promise = $client->listOriginEndpointsAsync
([/* ... */]);
Returns a collection of OriginEndpoint records.
Parameter Syntax
$result = $client->listOriginEndpoints([ 'ChannelId' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ChannelId
-
- Type: string
- MaxResults
-
- Type: int
- NextToken
-
- Type: string
Result Syntax
[ 'NextToken' => '<string>', 'OriginEndpoints' => [ [ 'Arn' => '<string>', 'Authorization' => [ 'CdnIdentifierSecret' => '<string>', 'SecretsRoleArn' => '<string>', ], 'ChannelId' => '<string>', 'CmafPackage' => [ 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'SAMPLE_AES|AES_CTR', 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'HlsManifests' => [ [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'Id' => '<string>', 'IncludeIframeOnlyStream' => true || false, 'ManifestName' => '<string>', 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, 'Url' => '<string>', ], // ... ], 'SegmentDurationSeconds' => <integer>, 'SegmentPrefix' => '<string>', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'CreatedAt' => '<string>', 'DashPackage' => [ 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'IncludeIframeOnlyStream' => true || false, 'ManifestLayout' => 'FULL|COMPACT|DRM_TOP_LEVEL_COMPACT', 'ManifestWindowSeconds' => <integer>, 'MinBufferTimeSeconds' => <integer>, 'MinUpdatePeriodSeconds' => <integer>, 'PeriodTriggers' => ['<string>', ...], 'Profile' => 'NONE|HBBTV_1_5|HYBRIDCAST|DVB_DASH_2014', 'SegmentDurationSeconds' => <integer>, 'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE|TIME_WITH_TIMELINE|NUMBER_WITH_DURATION', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'SuggestedPresentationDelaySeconds' => <integer>, 'UtcTiming' => 'NONE|HTTP-HEAD|HTTP-ISO|HTTP-XSDATE', 'UtcTimingUri' => '<string>', ], 'Description' => '<string>', 'HlsPackage' => [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'AES_128|SAMPLE_AES', 'KeyRotationIntervalSeconds' => <integer>, 'RepeatExtXKey' => true || false, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'IncludeDvbSubtitles' => true || false, 'IncludeIframeOnlyStream' => true || false, 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'UseAudioRenditionGroup' => true || false, ], 'Id' => '<string>', 'ManifestName' => '<string>', 'MssPackage' => [ 'Encryption' => [ 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'ManifestWindowSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'Origination' => 'ALLOW|DENY', 'StartoverWindowSeconds' => <integer>, 'Tags' => ['<string>', ...], 'TimeDelaySeconds' => <integer>, 'Url' => '<string>', 'Whitelist' => ['<string>', ...], ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
- OriginEndpoints
-
- Type: Array of OriginEndpoint 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
([/* ... */]);
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.
RotateChannelCredentials
$result = $client->rotateChannelCredentials
([/* ... */]); $promise = $client->rotateChannelCredentialsAsync
([/* ... */]);
Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead
Parameter Syntax
$result = $client->rotateChannelCredentials([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
Result Syntax
[ 'Arn' => '<string>', 'CreatedAt' => '<string>', 'Description' => '<string>', 'EgressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'HlsIngest' => [ 'IngestEndpoints' => [ [ 'Id' => '<string>', 'Password' => '<string>', 'Url' => '<string>', 'Username' => '<string>', ], // ... ], ], 'Id' => '<string>', 'IngressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'Tags' => ['<string>', ...], ]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: string
- Description
-
- Type: string
- EgressAccessLogs
-
- Type: EgressAccessLogs structure
Configure egress access logging. - HlsIngest
-
- Type: HlsIngest structure
An HTTP Live Streaming (HLS) ingest resource configuration. - Id
-
- Type: string
- IngressAccessLogs
-
- Type: IngressAccessLogs structure
Configure ingress access logging. - 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.
RotateIngestEndpointCredentials
$result = $client->rotateIngestEndpointCredentials
([/* ... */]); $promise = $client->rotateIngestEndpointCredentialsAsync
([/* ... */]);
Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
Parameter Syntax
$result = $client->rotateIngestEndpointCredentials([ 'Id' => '<string>', // REQUIRED 'IngestEndpointId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
- IngestEndpointId
-
- Required: Yes
- Type: string
Result Syntax
[ 'Arn' => '<string>', 'CreatedAt' => '<string>', 'Description' => '<string>', 'EgressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'HlsIngest' => [ 'IngestEndpoints' => [ [ 'Id' => '<string>', 'Password' => '<string>', 'Url' => '<string>', 'Username' => '<string>', ], // ... ], ], 'Id' => '<string>', 'IngressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'Tags' => ['<string>', ...], ]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: string
- Description
-
- Type: string
- EgressAccessLogs
-
- Type: EgressAccessLogs structure
Configure egress access logging. - HlsIngest
-
- Type: HlsIngest structure
An HTTP Live Streaming (HLS) ingest resource configuration. - Id
-
- Type: string
- IngressAccessLogs
-
- Type: IngressAccessLogs structure
Configure ingress access logging. - 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.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
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
Errors
There are no errors described for this operation.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
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
Errors
There are no errors described for this operation.
UpdateChannel
$result = $client->updateChannel
([/* ... */]); $promise = $client->updateChannelAsync
([/* ... */]);
Updates an existing Channel.
Parameter Syntax
$result = $client->updateChannel([ 'Description' => '<string>', 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Description
-
- Type: string
- Id
-
- Required: Yes
- Type: string
Result Syntax
[ 'Arn' => '<string>', 'CreatedAt' => '<string>', 'Description' => '<string>', 'EgressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'HlsIngest' => [ 'IngestEndpoints' => [ [ 'Id' => '<string>', 'Password' => '<string>', 'Url' => '<string>', 'Username' => '<string>', ], // ... ], ], 'Id' => '<string>', 'IngressAccessLogs' => [ 'LogGroupName' => '<string>', ], 'Tags' => ['<string>', ...], ]
Result Details
Members
- Arn
-
- Type: string
- CreatedAt
-
- Type: string
- Description
-
- Type: string
- EgressAccessLogs
-
- Type: EgressAccessLogs structure
Configure egress access logging. - HlsIngest
-
- Type: HlsIngest structure
An HTTP Live Streaming (HLS) ingest resource configuration. - Id
-
- Type: string
- IngressAccessLogs
-
- Type: IngressAccessLogs structure
Configure ingress access logging. - 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.
UpdateOriginEndpoint
$result = $client->updateOriginEndpoint
([/* ... */]); $promise = $client->updateOriginEndpointAsync
([/* ... */]);
Updates an existing OriginEndpoint.
Parameter Syntax
$result = $client->updateOriginEndpoint([ 'Authorization' => [ 'CdnIdentifierSecret' => '<string>', // REQUIRED 'SecretsRoleArn' => '<string>', // REQUIRED ], 'CmafPackage' => [ 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'SAMPLE_AES|AES_CTR', 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ // REQUIRED 'CertificateArn' => '<string>', '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 ], 'ResourceId' => '<string>', // REQUIRED 'RoleArn' => '<string>', // REQUIRED 'SystemIds' => ['<string>', ...], // REQUIRED 'Url' => '<string>', // REQUIRED ], ], 'HlsManifests' => [ [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Id' => '<string>', // REQUIRED 'IncludeIframeOnlyStream' => true || false, 'ManifestName' => '<string>', 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, ], // ... ], 'SegmentDurationSeconds' => <integer>, 'SegmentPrefix' => '<string>', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'DashPackage' => [ 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ // REQUIRED 'CertificateArn' => '<string>', '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 ], 'ResourceId' => '<string>', // REQUIRED 'RoleArn' => '<string>', // REQUIRED 'SystemIds' => ['<string>', ...], // REQUIRED 'Url' => '<string>', // REQUIRED ], ], 'IncludeIframeOnlyStream' => true || false, 'ManifestLayout' => 'FULL|COMPACT|DRM_TOP_LEVEL_COMPACT', 'ManifestWindowSeconds' => <integer>, 'MinBufferTimeSeconds' => <integer>, 'MinUpdatePeriodSeconds' => <integer>, 'PeriodTriggers' => ['<string>', ...], 'Profile' => 'NONE|HBBTV_1_5|HYBRIDCAST|DVB_DASH_2014', 'SegmentDurationSeconds' => <integer>, 'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE|TIME_WITH_TIMELINE|NUMBER_WITH_DURATION', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'SuggestedPresentationDelaySeconds' => <integer>, 'UtcTiming' => 'NONE|HTTP-HEAD|HTTP-ISO|HTTP-XSDATE', 'UtcTimingUri' => '<string>', ], 'Description' => '<string>', 'HlsPackage' => [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'AES_128|SAMPLE_AES', 'KeyRotationIntervalSeconds' => <integer>, 'RepeatExtXKey' => true || false, 'SpekeKeyProvider' => [ // REQUIRED 'CertificateArn' => '<string>', '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 ], 'ResourceId' => '<string>', // REQUIRED 'RoleArn' => '<string>', // REQUIRED 'SystemIds' => ['<string>', ...], // REQUIRED 'Url' => '<string>', // REQUIRED ], ], 'IncludeDvbSubtitles' => true || false, 'IncludeIframeOnlyStream' => true || false, 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'UseAudioRenditionGroup' => true || false, ], 'Id' => '<string>', // REQUIRED 'ManifestName' => '<string>', 'MssPackage' => [ 'Encryption' => [ 'SpekeKeyProvider' => [ // REQUIRED 'CertificateArn' => '<string>', '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 ], 'ResourceId' => '<string>', // REQUIRED 'RoleArn' => '<string>', // REQUIRED 'SystemIds' => ['<string>', ...], // REQUIRED 'Url' => '<string>', // REQUIRED ], ], 'ManifestWindowSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'Origination' => 'ALLOW|DENY', 'StartoverWindowSeconds' => <integer>, 'TimeDelaySeconds' => <integer>, 'Whitelist' => ['<string>', ...], ]);
Parameter Details
Members
- Authorization
-
- Type: Authorization structure
CDN Authorization credentials - CmafPackage
-
- Type: CmafPackageCreateOrUpdateParameters structure
A Common Media Application Format (CMAF) packaging configuration. - DashPackage
-
- Type: DashPackage structure
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - Description
-
- Type: string
- HlsPackage
-
- Type: HlsPackage structure
An HTTP Live Streaming (HLS) packaging configuration. - Id
-
- Required: Yes
- Type: string
- ManifestName
-
- Type: string
- MssPackage
-
- Type: MssPackage structure
A Microsoft Smooth Streaming (MSS) packaging configuration. - Origination
-
- Type: string
- StartoverWindowSeconds
-
- Type: int
- TimeDelaySeconds
-
- Type: int
- Whitelist
-
- Type: Array of strings
Result Syntax
[ 'Arn' => '<string>', 'Authorization' => [ 'CdnIdentifierSecret' => '<string>', 'SecretsRoleArn' => '<string>', ], 'ChannelId' => '<string>', 'CmafPackage' => [ 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'SAMPLE_AES|AES_CTR', 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'HlsManifests' => [ [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'Id' => '<string>', 'IncludeIframeOnlyStream' => true || false, 'ManifestName' => '<string>', 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, 'Url' => '<string>', ], // ... ], 'SegmentDurationSeconds' => <integer>, 'SegmentPrefix' => '<string>', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'CreatedAt' => '<string>', 'DashPackage' => [ 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'KeyRotationIntervalSeconds' => <integer>, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'IncludeIframeOnlyStream' => true || false, 'ManifestLayout' => 'FULL|COMPACT|DRM_TOP_LEVEL_COMPACT', 'ManifestWindowSeconds' => <integer>, 'MinBufferTimeSeconds' => <integer>, 'MinUpdatePeriodSeconds' => <integer>, 'PeriodTriggers' => ['<string>', ...], 'Profile' => 'NONE|HBBTV_1_5|HYBRIDCAST|DVB_DASH_2014', 'SegmentDurationSeconds' => <integer>, 'SegmentTemplateFormat' => 'NUMBER_WITH_TIMELINE|TIME_WITH_TIMELINE|NUMBER_WITH_DURATION', 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'SuggestedPresentationDelaySeconds' => <integer>, 'UtcTiming' => 'NONE|HTTP-HEAD|HTTP-ISO|HTTP-XSDATE', 'UtcTimingUri' => '<string>', ], 'Description' => '<string>', 'HlsPackage' => [ 'AdMarkers' => 'NONE|SCTE35_ENHANCED|PASSTHROUGH|DATERANGE', 'AdTriggers' => ['<string>', ...], 'AdsOnDeliveryRestrictions' => 'NONE|RESTRICTED|UNRESTRICTED|BOTH', 'Encryption' => [ 'ConstantInitializationVector' => '<string>', 'EncryptionMethod' => 'AES_128|SAMPLE_AES', 'KeyRotationIntervalSeconds' => <integer>, 'RepeatExtXKey' => true || false, 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'IncludeDvbSubtitles' => true || false, 'IncludeIframeOnlyStream' => true || false, 'PlaylistType' => 'NONE|EVENT|VOD', 'PlaylistWindowSeconds' => <integer>, 'ProgramDateTimeIntervalSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], 'UseAudioRenditionGroup' => true || false, ], 'Id' => '<string>', 'ManifestName' => '<string>', 'MssPackage' => [ 'Encryption' => [ 'SpekeKeyProvider' => [ 'CertificateArn' => '<string>', 'EncryptionContractConfiguration' => [ 'PresetSpeke20Audio' => 'PRESET-AUDIO-1|PRESET-AUDIO-2|PRESET-AUDIO-3|SHARED|UNENCRYPTED', 'PresetSpeke20Video' => 'PRESET-VIDEO-1|PRESET-VIDEO-2|PRESET-VIDEO-3|PRESET-VIDEO-4|PRESET-VIDEO-5|PRESET-VIDEO-6|PRESET-VIDEO-7|PRESET-VIDEO-8|SHARED|UNENCRYPTED', ], 'ResourceId' => '<string>', 'RoleArn' => '<string>', 'SystemIds' => ['<string>', ...], 'Url' => '<string>', ], ], 'ManifestWindowSeconds' => <integer>, 'SegmentDurationSeconds' => <integer>, 'StreamSelection' => [ 'MaxVideoBitsPerSecond' => <integer>, 'MinVideoBitsPerSecond' => <integer>, 'StreamOrder' => 'ORIGINAL|VIDEO_BITRATE_ASCENDING|VIDEO_BITRATE_DESCENDING', ], ], 'Origination' => 'ALLOW|DENY', 'StartoverWindowSeconds' => <integer>, 'Tags' => ['<string>', ...], 'TimeDelaySeconds' => <integer>, 'Url' => '<string>', 'Whitelist' => ['<string>', ...], ]
Result Details
Members
- Arn
-
- Type: string
- Authorization
-
- Type: Authorization structure
CDN Authorization credentials - ChannelId
-
- Type: string
- CmafPackage
-
- Type: CmafPackage structure
A Common Media Application Format (CMAF) packaging configuration. - CreatedAt
-
- Type: string
- DashPackage
-
- Type: DashPackage structure
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - Description
-
- Type: string
- HlsPackage
-
- Type: HlsPackage structure
An HTTP Live Streaming (HLS) packaging configuration. - Id
-
- Type: string
- ManifestName
-
- Type: string
- MssPackage
-
- Type: MssPackage structure
A Microsoft Smooth Streaming (MSS) packaging configuration. - Origination
-
- Type: string
- StartoverWindowSeconds
-
- Type: int
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of tags associated with a resource - TimeDelaySeconds
-
- Type: int
- Url
-
- Type: string
- Whitelist
-
- Type: Array of strings
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
Authorization
Description
Members
- CdnIdentifierSecret
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint. - SecretsRoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
Channel
Description
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) assigned to the Channel. - CreatedAt
-
- Type: string
The date and time the Channel was created. - Description
-
- Type: string
A short text description of the Channel. - EgressAccessLogs
-
- Type: EgressAccessLogs structure
Configure egress access logging. - HlsIngest
-
- Type: HlsIngest structure
An HTTP Live Streaming (HLS) ingest resource configuration. - Id
-
- Type: string
The ID of the Channel. - IngressAccessLogs
-
- Type: IngressAccessLogs structure
Configure ingress access logging. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of tags associated with a resource
ChannelCreateParameters
Description
Members
- Description
-
- Type: string
A short text description of the Channel. - Id
-
- Required: Yes
- Type: string
The ID of the Channel. The ID must be unique within the region and itcannot be changed after a Channel is created. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of tags associated with a resource
ChannelList
Description
Members
- Channels
-
- Type: Array of Channel structures
A list of Channel records. - NextToken
-
- Type: string
A token that can be used to resume pagination from the end of the collection.
ChannelUpdateParameters
Description
Members
- Description
-
- Type: string
A short text description of the Channel.
CmafEncryption
Description
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). - EncryptionMethod
-
- Type: string
The encryption method to use. - KeyRotationIntervalSeconds
-
- Type: int
Time (in seconds) between each encryption key rotation. - 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
Members
- Encryption
-
- Type: CmafEncryption structure
A Common Media Application Format (CMAF) encryption configuration. - HlsManifests
-
- Type: Array of HlsManifest structures
A list of HLS manifest configurations - SegmentDurationSeconds
-
- Type: int
Duration (in seconds) of each segment. Actual segments will berounded to the nearest multiple of the source segment duration. - SegmentPrefix
-
- Type: string
An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId. - StreamSelection
-
- Type: StreamSelection structure
A StreamSelection configuration.
CmafPackageCreateOrUpdateParameters
Description
Members
- Encryption
-
- Type: CmafEncryption structure
A Common Media Application Format (CMAF) encryption configuration. - HlsManifests
-
- Type: Array of HlsManifestCreateOrUpdateParameters structures
A list of HLS manifest configurations - SegmentDurationSeconds
-
- Type: int
Duration (in seconds) of each segment. Actual segments will berounded to the nearest multiple of the source segment duration. - SegmentPrefix
-
- Type: string
An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId. - StreamSelection
-
- Type: StreamSelection structure
A StreamSelection configuration.
ConfigureLogsParameters
Description
Members
- EgressAccessLogs
-
- Type: EgressAccessLogs structure
Configure egress access logging. - IngressAccessLogs
-
- Type: IngressAccessLogs structure
Configure ingress access logging.
DashEncryption
Description
Members
- KeyRotationIntervalSeconds
-
- Type: int
Time (in seconds) between each encryption key rotation. - 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.
DashPackage
Description
Members
- AdTriggers
-
- Type: Array of strings
A list of SCTE-35 message types that are treated as ad markers in the output. If empty, noad markers are output. Specify multiple items to create ad markers for all of the includedmessage types. - AdsOnDeliveryRestrictions
-
- Type: string
This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors todetermine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages becomeads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers thatcontain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35messages of the types specified in AdTriggers that do not contain delivery restrictions willbe treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified inAdTriggers will be treated as ads. Note that Splice Insert messages do not have these flagsand are always treated as ads if specified in AdTriggers. - Encryption
-
- Type: DashEncryption structure
A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration. - IncludeIframeOnlyStream
-
- Type: boolean
When enabled, an I-Frame only stream will be included in the output. - 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. When set to DRM_TOP_LEVEL_COMPACT, content protection elements are placed the MPD level and referenced at the AdaptationSet level. - ManifestWindowSeconds
-
- Type: int
Time window (in seconds) contained in each manifest. - MinBufferTimeSeconds
-
- Type: int
Minimum duration (in seconds) that a player will buffer media before starting the presentation. - MinUpdatePeriodSeconds
-
- Type: int
Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD). - 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 Channel source contains SCTE-35 ad markers. - 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. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled. - 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. - StreamSelection
-
- Type: StreamSelection structure
A StreamSelection configuration. - SuggestedPresentationDelaySeconds
-
- Type: int
Duration (in seconds) to delay live content before presentation. - UtcTiming
-
- Type: string
Determines the type of UTCTiming included in the Media Presentation Description (MPD) - UtcTimingUri
-
- Type: string
Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE
EgressAccessLogs
Description
Members
- LogGroupName
-
- Type: string
Customize the log group name.
EncryptionContractConfiguration
Description
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
HarvestJob
Description
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) assigned to the HarvestJob. - ChannelId
-
- Type: string
The ID of the Channel that the HarvestJob will harvest from. - CreatedAt
-
- Type: string
The date and time the HarvestJob was submitted. - EndTime
-
- Type: string
The end of the time-window which will be harvested. - Id
-
- Type: string
The ID of the HarvestJob. The ID must be unique within the regionand it cannot be changed after the HarvestJob is submitted. - OriginEndpointId
-
- Type: string
The ID of the OriginEndpoint that the HarvestJob will harvest from.This cannot be changed after the HarvestJob is submitted. - S3Destination
-
- Type: S3Destination structure
Configuration parameters for where in an S3 bucket to place the harvested content - StartTime
-
- Type: string
The start of the time-window which will be harvested. - Status
-
- Type: string
The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen forHarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event willinclude an explanation of why the HarvestJob failed.
HarvestJobCreateParameters
Description
Members
- EndTime
-
- Required: Yes
- Type: string
The end of the time-window which will be harvested - Id
-
- Required: Yes
- Type: string
The ID of the HarvestJob. The ID must be unique within the regionand it cannot be changed after the HarvestJob is submitted - OriginEndpointId
-
- Required: Yes
- Type: string
The ID of the OriginEndpoint that the HarvestJob will harvest from.This cannot be changed after the HarvestJob is submitted. - S3Destination
-
- Required: Yes
- Type: S3Destination structure
Configuration parameters for where in an S3 bucket to place the harvested content - StartTime
-
- Required: Yes
- Type: string
The start of the time-window which will be harvested
HarvestJobList
Description
Members
- HarvestJobs
-
- Type: Array of HarvestJob structures
A list of HarvestJob records. - NextToken
-
- Type: string
A token that can be used to resume pagination from the end of the collection.
HlsEncryption
Description
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. - KeyRotationIntervalSeconds
-
- Type: int
Interval (in seconds) between each encryption key rotation. - RepeatExtXKey
-
- Type: boolean
When enabled, the EXT-X-KEY tag will be repeated in output manifests. - 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.
HlsIngest
Description
Members
- IngestEndpoints
-
- Type: Array of IngestEndpoint structures
A list of endpoints to which the source stream should be sent.
HlsManifest
Description
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."DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition eventsin HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds valuethat is greater than 0. - Id
-
- Required: Yes
- Type: string
The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created. - IncludeIframeOnlyStream
-
- Type: boolean
When enabled, an I-Frame only stream will be included in the output. - ManifestName
-
- Type: string
An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint. - PlaylistType
-
- Type: string
The HTTP Live Streaming (HLS) playlist type.When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPEentry will be included in the media playlist. - PlaylistWindowSeconds
-
- Type: int
Time window (in seconds) contained in each parent 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. - Url
-
- Type: string
The URL of the packaged OriginEndpoint for consumption.
HlsManifestCreateOrUpdateParameters
Description
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."DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition eventsin HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds valuethat is greater than 0. - AdTriggers
-
- Type: Array of strings
A list of SCTE-35 message types that are treated as ad markers in the output. If empty, noad markers are output. Specify multiple items to create ad markers for all of the includedmessage types. - AdsOnDeliveryRestrictions
-
- Type: string
This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors todetermine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages becomeads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers thatcontain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35messages of the types specified in AdTriggers that do not contain delivery restrictions willbe treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified inAdTriggers will be treated as ads. Note that Splice Insert messages do not have these flagsand are always treated as ads if specified in AdTriggers. - Id
-
- Required: Yes
- Type: string
The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created. - IncludeIframeOnlyStream
-
- Type: boolean
When enabled, an I-Frame only stream will be included in the output. - ManifestName
-
- Type: string
An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint. - PlaylistType
-
- Type: string
The HTTP Live Streaming (HLS) playlist type.When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPEentry will be included in the media playlist. - PlaylistWindowSeconds
-
- Type: int
Time window (in seconds) contained in each parent 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.
HlsPackage
Description
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."DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition eventsin HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds valuethat is greater than 0. - AdTriggers
-
- Type: Array of strings
A list of SCTE-35 message types that are treated as ad markers in the output. If empty, noad markers are output. Specify multiple items to create ad markers for all of the includedmessage types. - AdsOnDeliveryRestrictions
-
- Type: string
This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors todetermine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages becomeads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers thatcontain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35messages of the types specified in AdTriggers that do not contain delivery restrictions willbe treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified inAdTriggers will be treated as ads. Note that Splice Insert messages do not have these flagsand are always treated as ads if specified in AdTriggers. - Encryption
-
- Type: HlsEncryption structure
An HTTP Live Streaming (HLS) encryption configuration. - IncludeDvbSubtitles
-
- Type: boolean
When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output. - IncludeIframeOnlyStream
-
- Type: boolean
When enabled, an I-Frame only stream will be included in the output. - PlaylistType
-
- Type: string
The HTTP Live Streaming (HLS) playlist type.When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPEentry will be included in the media playlist. - PlaylistWindowSeconds
-
- Type: int
Time window (in seconds) contained in each parent 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. - SegmentDurationSeconds
-
- Type: int
Duration (in seconds) of each fragment. Actual fragments will berounded to the nearest multiple of the source fragment duration. - StreamSelection
-
- Type: StreamSelection structure
A StreamSelection configuration. - UseAudioRenditionGroup
-
- Type: boolean
When enabled, audio streams will be placed in rendition groups in the output.
IngestEndpoint
Description
Members
- Id
-
- Type: string
The system generated unique identifier for the IngestEndpoint - Password
-
- Type: string
- Url
-
- Type: string
The ingest URL to which the source stream should be sent. - Username
-
- Type: string
IngressAccessLogs
Description
Members
- LogGroupName
-
- Type: string
Customize the log group name.
InternalServerErrorException
Members
- Message
-
- Type: string
MssEncryption
Description
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.
MssPackage
Description
Members
- Encryption
-
- Type: MssEncryption structure
A Microsoft Smooth Streaming (MSS) encryption configuration. - ManifestWindowSeconds
-
- Type: int
The time window (in seconds) contained in each manifest. - SegmentDurationSeconds
-
- Type: int
The duration (in seconds) of each segment. - StreamSelection
-
- Type: StreamSelection structure
A StreamSelection configuration.
NotFoundException
Members
- Message
-
- Type: string
OriginEndpoint
Description
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) assigned to the OriginEndpoint. - Authorization
-
- Type: Authorization structure
CDN Authorization credentials - ChannelId
-
- Type: string
The ID of the Channel the OriginEndpoint is associated with. - CmafPackage
-
- Type: CmafPackage structure
A Common Media Application Format (CMAF) packaging configuration. - CreatedAt
-
- Type: string
The date and time the OriginEndpoint was created. - DashPackage
-
- Type: DashPackage structure
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - Description
-
- Type: string
A short text description of the OriginEndpoint. - HlsPackage
-
- Type: HlsPackage structure
An HTTP Live Streaming (HLS) packaging configuration. - Id
-
- Type: string
The ID of the OriginEndpoint. - ManifestName
-
- Type: string
A short string appended to the end of the OriginEndpoint URL. - MssPackage
-
- Type: MssPackage structure
A Microsoft Smooth Streaming (MSS) packaging configuration. - Origination
-
- Type: string
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpointmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not berequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination - StartoverWindowSeconds
-
- Type: int
Maximum duration (seconds) of content to retain for startover playback.If not specified, startover playback will be disabled for the OriginEndpoint. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of tags associated with a resource - TimeDelaySeconds
-
- Type: int
Amount of delay (seconds) to enforce on the playback of live content.If not specified, there will be no time delay in effect for the OriginEndpoint. - Url
-
- Type: string
The URL of the packaged OriginEndpoint for consumption. - Whitelist
-
- Type: Array of strings
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
OriginEndpointCreateParameters
Description
Members
- Authorization
-
- Type: Authorization structure
CDN Authorization credentials - ChannelId
-
- Required: Yes
- Type: string
The ID of the Channel that the OriginEndpoint will be associated with.This cannot be changed after the OriginEndpoint is created. - CmafPackage
-
- Type: CmafPackageCreateOrUpdateParameters structure
A Common Media Application Format (CMAF) packaging configuration. - DashPackage
-
- Type: DashPackage structure
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - Description
-
- Type: string
A short text description of the OriginEndpoint. - HlsPackage
-
- Type: HlsPackage structure
An HTTP Live Streaming (HLS) packaging configuration. - Id
-
- Required: Yes
- Type: string
The ID of the OriginEndpoint. The ID must be unique within the regionand it cannot be changed after the OriginEndpoint is created. - ManifestName
-
- Type: string
A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index"). - MssPackage
-
- Type: MssPackage structure
A Microsoft Smooth Streaming (MSS) packaging configuration. - Origination
-
- Type: string
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpointmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not berequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination - StartoverWindowSeconds
-
- Type: int
Maximum duration (seconds) of content to retain for startover playback.If not specified, startover playback will be disabled for the OriginEndpoint. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of tags associated with a resource - TimeDelaySeconds
-
- Type: int
Amount of delay (seconds) to enforce on the playback of live content.If not specified, there will be no time delay in effect for the OriginEndpoint. - Whitelist
-
- Type: Array of strings
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
OriginEndpointList
Description
Members
- NextToken
-
- Type: string
A token that can be used to resume pagination from the end of the collection. - OriginEndpoints
-
- Type: Array of OriginEndpoint structures
A list of OriginEndpoint records.
OriginEndpointUpdateParameters
Description
Members
- Authorization
-
- Type: Authorization structure
CDN Authorization credentials - CmafPackage
-
- Type: CmafPackageCreateOrUpdateParameters structure
A Common Media Application Format (CMAF) packaging configuration. - DashPackage
-
- Type: DashPackage structure
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. - Description
-
- Type: string
A short text description of the OriginEndpoint. - HlsPackage
-
- Type: HlsPackage structure
An HTTP Live Streaming (HLS) packaging configuration. - ManifestName
-
- Type: string
A short string that will be appended to the end of the Endpoint URL. - MssPackage
-
- Type: MssPackage structure
A Microsoft Smooth Streaming (MSS) packaging configuration. - Origination
-
- Type: string
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpointmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not berequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination - StartoverWindowSeconds
-
- Type: int
Maximum duration (in seconds) of content to retain for startover playback.If not specified, startover playback will be disabled for the OriginEndpoint. - TimeDelaySeconds
-
- Type: int
Amount of delay (in seconds) to enforce on the playback of live content.If not specified, there will be no time delay in effect for the OriginEndpoint. - Whitelist
-
- Type: Array of strings
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
S3Destination
Description
Members
- BucketName
-
- Required: Yes
- Type: string
The name of an S3 bucket within which harvested content will be exported - ManifestKey
-
- Required: Yes
- Type: string
The key in the specified S3 bucket where the harvested top-level manifest will be placed. - RoleArn
-
- Required: Yes
- Type: string
The IAM role used to write to the specified S3 bucket
ServiceUnavailableException
Members
- Message
-
- Type: string
SpekeKeyProvider
Description
Members
- CertificateArn
-
- Type: string
An Amazon Resource Name (ARN) of a Certificate Manager certificatethat MediaPackage will use for enforcing secure end-to-end datatransfer with the key provider service. - EncryptionContractConfiguration
-
- Type: EncryptionContractConfiguration structure
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 or CMAF 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. - ResourceId
-
- Required: Yes
- Type: string
The resource ID to include in key requests. - 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
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
TooManyRequestsException
Members
- Message
-
- Type: string
UnprocessableEntityException
Members
- Message
-
- Type: string