amazonka-mediapackage-vod-2.0: Amazon Elemental MediaPackage VOD SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MediaPackageVOD.Lens

Description

 
Synopsis

Operations

ConfigureLogs

configureLogs_id :: Lens' ConfigureLogs Text Source #

The ID of a MediaPackage VOD PackagingGroup resource.

configureLogsResponse_domainName :: Lens' ConfigureLogsResponse (Maybe Text) Source #

The fully qualified domain name for Assets in the PackagingGroup.

CreateAsset

createAsset_resourceId :: Lens' CreateAsset (Maybe Text) Source #

The resource ID to include in SPEKE key requests.

createAsset_sourceArn :: Lens' CreateAsset Text Source #

ARN of the source object in S3.

createAsset_id :: Lens' CreateAsset Text Source #

The unique identifier for the Asset.

createAsset_packagingGroupId :: Lens' CreateAsset Text Source #

The ID of the PackagingGroup for the Asset.

createAsset_sourceRoleArn :: Lens' CreateAsset Text Source #

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

createAssetResponse_createdAt :: Lens' CreateAssetResponse (Maybe Text) Source #

The time the Asset was initially submitted for Ingest.

createAssetResponse_egressEndpoints :: Lens' CreateAssetResponse (Maybe [EgressEndpoint]) Source #

The list of egress endpoints available for the Asset.

createAssetResponse_id :: Lens' CreateAssetResponse (Maybe Text) Source #

The unique identifier for the Asset.

createAssetResponse_packagingGroupId :: Lens' CreateAssetResponse (Maybe Text) Source #

The ID of the PackagingGroup for the Asset.

createAssetResponse_resourceId :: Lens' CreateAssetResponse (Maybe Text) Source #

The resource ID to include in SPEKE key requests.

createAssetResponse_sourceRoleArn :: Lens' CreateAssetResponse (Maybe Text) Source #

The IAM role_arn used to access the source S3 bucket.

CreatePackagingConfiguration

CreatePackagingGroup

createPackagingGroupResponse_domainName :: Lens' CreatePackagingGroupResponse (Maybe Text) Source #

The fully qualified domain name for Assets in the PackagingGroup.

DeleteAsset

deleteAsset_id :: Lens' DeleteAsset Text Source #

The ID of the MediaPackage VOD Asset resource to delete.

DeletePackagingConfiguration

deletePackagingConfiguration_id :: Lens' DeletePackagingConfiguration Text Source #

The ID of the MediaPackage VOD PackagingConfiguration resource to delete.

DeletePackagingGroup

deletePackagingGroup_id :: Lens' DeletePackagingGroup Text Source #

The ID of the MediaPackage VOD PackagingGroup resource to delete.

DescribeAsset

describeAsset_id :: Lens' DescribeAsset Text Source #

The ID of an MediaPackage VOD Asset resource.

describeAssetResponse_createdAt :: Lens' DescribeAssetResponse (Maybe Text) Source #

The time the Asset was initially submitted for Ingest.

describeAssetResponse_egressEndpoints :: Lens' DescribeAssetResponse (Maybe [EgressEndpoint]) Source #

The list of egress endpoints available for the Asset.

describeAssetResponse_id :: Lens' DescribeAssetResponse (Maybe Text) Source #

The unique identifier for the Asset.

describeAssetResponse_packagingGroupId :: Lens' DescribeAssetResponse (Maybe Text) Source #

The ID of the PackagingGroup for the Asset.

describeAssetResponse_resourceId :: Lens' DescribeAssetResponse (Maybe Text) Source #

The resource ID to include in SPEKE key requests.

describeAssetResponse_sourceRoleArn :: Lens' DescribeAssetResponse (Maybe Text) Source #

The IAM role_arn used to access the source S3 bucket.

DescribePackagingConfiguration

describePackagingConfiguration_id :: Lens' DescribePackagingConfiguration Text Source #

The ID of a MediaPackage VOD PackagingConfiguration resource.

DescribePackagingGroup

describePackagingGroup_id :: Lens' DescribePackagingGroup Text Source #

The ID of a MediaPackage VOD PackagingGroup resource.

describePackagingGroupResponse_domainName :: Lens' DescribePackagingGroupResponse (Maybe Text) Source #

The fully qualified domain name for Assets in the PackagingGroup.

ListAssets

listAssets_maxResults :: Lens' ListAssets (Maybe Natural) Source #

Upper bound on number of records to return.

listAssets_nextToken :: Lens' ListAssets (Maybe Text) Source #

A token used to resume pagination from the end of a previous request.

listAssets_packagingGroupId :: Lens' ListAssets (Maybe Text) Source #

Returns Assets associated with the specified PackagingGroup.

listAssetsResponse_assets :: Lens' ListAssetsResponse (Maybe [AssetShallow]) Source #

A list of MediaPackage VOD Asset resources.

listAssetsResponse_nextToken :: Lens' ListAssetsResponse (Maybe Text) Source #

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

ListPackagingConfigurations

listPackagingConfigurations_nextToken :: Lens' ListPackagingConfigurations (Maybe Text) Source #

A token used to resume pagination from the end of a previous request.

listPackagingConfigurations_packagingGroupId :: Lens' ListPackagingConfigurations (Maybe Text) Source #

Returns MediaPackage VOD PackagingConfigurations associated with the specified PackagingGroup.

listPackagingConfigurationsResponse_nextToken :: Lens' ListPackagingConfigurationsResponse (Maybe Text) Source #

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

ListPackagingGroups

listPackagingGroups_maxResults :: Lens' ListPackagingGroups (Maybe Natural) Source #

Upper bound on number of records to return.

listPackagingGroups_nextToken :: Lens' ListPackagingGroups (Maybe Text) Source #

A token used to resume pagination from the end of a previous request.

listPackagingGroupsResponse_nextToken :: Lens' ListPackagingGroupsResponse (Maybe Text) Source #

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

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

A collection of tags associated with a resource

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

A collection of tags associated with a resource

UntagResource

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A comma-separated list of the tag keys to remove from the resource.

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.

UpdatePackagingGroup

updatePackagingGroup_id :: Lens' UpdatePackagingGroup Text Source #

The ID of a MediaPackage VOD PackagingGroup resource.

updatePackagingGroupResponse_domainName :: Lens' UpdatePackagingGroupResponse (Maybe Text) Source #

The fully qualified domain name for Assets in the PackagingGroup.

Types

AssetShallow

assetShallow_createdAt :: Lens' AssetShallow (Maybe Text) Source #

The time the Asset was initially submitted for Ingest.

assetShallow_id :: Lens' AssetShallow (Maybe Text) Source #

The unique identifier for the Asset.

assetShallow_packagingGroupId :: Lens' AssetShallow (Maybe Text) Source #

The ID of the PackagingGroup for the Asset.

assetShallow_resourceId :: Lens' AssetShallow (Maybe Text) Source #

The resource ID to include in SPEKE key requests.

assetShallow_sourceArn :: Lens' AssetShallow (Maybe Text) Source #

ARN of the source object in S3.

assetShallow_sourceRoleArn :: Lens' AssetShallow (Maybe Text) Source #

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

Authorization

authorization_secretsRoleArn :: Lens' Authorization Text Source #

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

authorization_cdnIdentifierSecret :: Lens' Authorization Text Source #

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

CmafEncryption

cmafEncryption_constantInitializationVector :: Lens' CmafEncryption (Maybe Text) Source #

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).

CmafPackage

cmafPackage_includeEncoderConfigurationInSegments :: Lens' CmafPackage (Maybe Bool) Source #

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

cmafPackage_segmentDurationSeconds :: Lens' CmafPackage (Maybe Int) Source #

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

cmafPackage_hlsManifests :: Lens' CmafPackage [HlsManifest] Source #

A list of HLS manifest configurations.

DashEncryption

DashManifest

dashManifest_manifestLayout :: Lens' DashManifest (Maybe ManifestLayout) Source #

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.

dashManifest_manifestName :: Lens' DashManifest (Maybe Text) Source #

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

dashManifest_minBufferTimeSeconds :: Lens' DashManifest (Maybe Int) Source #

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

dashManifest_profile :: Lens' DashManifest (Maybe Profile) Source #

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

dashManifest_scteMarkersSource :: Lens' DashManifest (Maybe ScteMarkersSource) Source #

The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content. The MANIFEST value is compatible with source HLS playlists using the SCTE-35 Enhanced syntax (#EXT-OATCLS-SCTE35 tags). SCTE-35 Elemental and SCTE-35 Daterange syntaxes are not supported with this option.

DashPackage

dashPackage_includeEncoderConfigurationInSegments :: Lens' DashPackage (Maybe Bool) Source #

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

dashPackage_includeIframeOnlyStream :: Lens' DashPackage (Maybe Bool) Source #

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

dashPackage_periodTriggers :: Lens' DashPackage (Maybe [PeriodTriggersElement]) Source #

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 not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Asset contains SCTE-35 ad markers.

dashPackage_segmentDurationSeconds :: Lens' DashPackage (Maybe Int) Source #

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

dashPackage_segmentTemplateFormat :: Lens' DashPackage (Maybe SegmentTemplateFormat) Source #

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.

dashPackage_dashManifests :: Lens' DashPackage [DashManifest] Source #

A list of DASH manifest configurations.

EgressAccessLogs

EgressEndpoint

egressEndpoint_packagingConfigurationId :: Lens' EgressEndpoint (Maybe Text) Source #

The ID of the PackagingConfiguration being applied to the Asset.

egressEndpoint_status :: Lens' EgressEndpoint (Maybe Text) Source #

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

egressEndpoint_url :: Lens' EgressEndpoint (Maybe Text) Source #

The URL of the parent manifest for the repackaged Asset.

EncryptionContractConfiguration

HlsEncryption

hlsEncryption_constantInitializationVector :: Lens' HlsEncryption (Maybe Text) Source #

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

HlsManifest

hlsManifest_adMarkers :: Lens' HlsManifest (Maybe AdMarkers) Source #

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 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.

hlsManifest_includeIframeOnlyStream :: Lens' HlsManifest (Maybe Bool) Source #

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

hlsManifest_manifestName :: Lens' HlsManifest (Maybe Text) Source #

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

hlsManifest_programDateTimeIntervalSeconds :: Lens' HlsManifest (Maybe Int) Source #

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

hlsManifest_repeatExtXKey :: Lens' HlsManifest (Maybe Bool) Source #

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

HlsPackage

hlsPackage_includeDvbSubtitles :: Lens' HlsPackage (Maybe Bool) Source #

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

hlsPackage_segmentDurationSeconds :: Lens' HlsPackage (Maybe Int) Source #

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

hlsPackage_useAudioRenditionGroup :: Lens' HlsPackage (Maybe Bool) Source #

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

hlsPackage_hlsManifests :: Lens' HlsPackage [HlsManifest] Source #

A list of HLS manifest configurations.

MssEncryption

MssManifest

mssManifest_manifestName :: Lens' MssManifest (Maybe Text) Source #

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

MssPackage

mssPackage_segmentDurationSeconds :: Lens' MssPackage (Maybe Int) Source #

The duration (in seconds) of each segment.

mssPackage_mssManifests :: Lens' MssPackage [MssManifest] Source #

A list of MSS manifest configurations.

PackagingConfiguration

packagingConfiguration_arn :: Lens' PackagingConfiguration (Maybe Text) Source #

The ARN of the PackagingConfiguration.

packagingConfiguration_id :: Lens' PackagingConfiguration (Maybe Text) Source #

The ID of the PackagingConfiguration.

PackagingGroup

packagingGroup_approximateAssetCount :: Lens' PackagingGroup (Maybe Int) Source #

The approximate asset count of the PackagingGroup.

packagingGroup_arn :: Lens' PackagingGroup (Maybe Text) Source #

The ARN of the PackagingGroup.

packagingGroup_domainName :: Lens' PackagingGroup (Maybe Text) Source #

The fully qualified domain name for Assets in the PackagingGroup.

packagingGroup_id :: Lens' PackagingGroup (Maybe Text) Source #

The ID of the PackagingGroup.

SpekeKeyProvider

spekeKeyProvider_systemIds :: Lens' SpekeKeyProvider [Text] Source #

The system IDs to include in key requests.

spekeKeyProvider_url :: Lens' SpekeKeyProvider Text Source #

The URL of the external key provider service.

spekeKeyProvider_roleArn :: Lens' SpekeKeyProvider Text Source #

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

StreamSelection

streamSelection_maxVideoBitsPerSecond :: Lens' StreamSelection (Maybe Int) Source #

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

streamSelection_minVideoBitsPerSecond :: Lens' StreamSelection (Maybe Int) Source #

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

streamSelection_streamOrder :: Lens' StreamSelection (Maybe StreamOrder) Source #

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