# Data Types


The AWS Elemental MediaPackage v2 API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [CdnAuthConfiguration](API_CdnAuthConfiguration.md) 
+  [ChannelGroupListConfiguration](API_ChannelGroupListConfiguration.md) 
+  [ChannelListConfiguration](API_ChannelListConfiguration.md) 
+  [CreateDashManifestConfiguration](API_CreateDashManifestConfiguration.md) 
+  [CreateHlsManifestConfiguration](API_CreateHlsManifestConfiguration.md) 
+  [CreateLowLatencyHlsManifestConfiguration](API_CreateLowLatencyHlsManifestConfiguration.md) 
+  [CreateMssManifestConfiguration](API_CreateMssManifestConfiguration.md) 
+  [DashBaseUrl](API_DashBaseUrl.md) 
+  [DashDvbFontDownload](API_DashDvbFontDownload.md) 
+  [DashDvbMetricsReporting](API_DashDvbMetricsReporting.md) 
+  [DashDvbSettings](API_DashDvbSettings.md) 
+  [DashProgramInformation](API_DashProgramInformation.md) 
+  [DashSubtitleConfiguration](API_DashSubtitleConfiguration.md) 
+  [DashTtmlConfiguration](API_DashTtmlConfiguration.md) 
+  [DashUtcTiming](API_DashUtcTiming.md) 
+  [Destination](API_Destination.md) 
+  [Encryption](API_Encryption.md) 
+  [EncryptionContractConfiguration](API_EncryptionContractConfiguration.md) 
+  [EncryptionMethod](API_EncryptionMethod.md) 
+  [FilterConfiguration](API_FilterConfiguration.md) 
+  [ForceEndpointErrorConfiguration](API_ForceEndpointErrorConfiguration.md) 
+  [GetDashManifestConfiguration](API_GetDashManifestConfiguration.md) 
+  [GetHlsManifestConfiguration](API_GetHlsManifestConfiguration.md) 
+  [GetLowLatencyHlsManifestConfiguration](API_GetLowLatencyHlsManifestConfiguration.md) 
+  [GetMssManifestConfiguration](API_GetMssManifestConfiguration.md) 
+  [HarvestedDashManifest](API_HarvestedDashManifest.md) 
+  [HarvestedHlsManifest](API_HarvestedHlsManifest.md) 
+  [HarvestedLowLatencyHlsManifest](API_HarvestedLowLatencyHlsManifest.md) 
+  [HarvestedManifests](API_HarvestedManifests.md) 
+  [HarvesterScheduleConfiguration](API_HarvesterScheduleConfiguration.md) 
+  [HarvestJob](API_HarvestJob.md) 
+  [IngestEndpoint](API_IngestEndpoint.md) 
+  [InputSwitchConfiguration](API_InputSwitchConfiguration.md) 
+  [ListDashManifestConfiguration](API_ListDashManifestConfiguration.md) 
+  [ListHlsManifestConfiguration](API_ListHlsManifestConfiguration.md) 
+  [ListLowLatencyHlsManifestConfiguration](API_ListLowLatencyHlsManifestConfiguration.md) 
+  [ListMssManifestConfiguration](API_ListMssManifestConfiguration.md) 
+  [OriginEndpointListConfiguration](API_OriginEndpointListConfiguration.md) 
+  [OutputHeaderConfiguration](API_OutputHeaderConfiguration.md) 
+  [S3DestinationConfig](API_S3DestinationConfig.md) 
+  [Scte](API_Scte.md) 
+  [ScteDash](API_ScteDash.md) 
+  [ScteHls](API_ScteHls.md) 
+  [Segment](API_Segment.md) 
+  [SpekeKeyProvider](API_SpekeKeyProvider.md) 
+  [StartTag](API_StartTag.md) 

# CdnAuthConfiguration


The settings to enable CDN authorization headers in MediaPackage.

## Contents


 ** CdnIdentifierSecretArns **   <a name="mediapackage-Type-CdnAuthConfiguration-CdnIdentifierSecretArns"></a>
The ARN for the secret in Secrets Manager that your CDN uses for authorization to access the endpoint.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: Yes

 ** SecretsRoleArn **   <a name="mediapackage-Type-CdnAuthConfiguration-SecretsRoleArn"></a>
The ARN for the IAM role that gives MediaPackage read access to Secrets Manager and AWS KMS for CDN authorization.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/CdnAuthConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/CdnAuthConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/CdnAuthConfiguration) 

# ChannelGroupListConfiguration


The configuration of the channel group.

## Contents


 ** Arn **   <a name="mediapackage-Type-ChannelGroupListConfiguration-Arn"></a>
The Amazon Resource Name (ARN) associated with the resource.  
Type: String  
Required: Yes

 ** ChannelGroupName **   <a name="mediapackage-Type-ChannelGroupListConfiguration-ChannelGroupName"></a>
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.  
Type: String  
Required: Yes

 ** CreatedAt **   <a name="mediapackage-Type-ChannelGroupListConfiguration-CreatedAt"></a>
The date and time the channel group was created.  
Type: Timestamp  
Required: Yes

 ** ModifiedAt **   <a name="mediapackage-Type-ChannelGroupListConfiguration-ModifiedAt"></a>
The date and time the channel group was modified.  
Type: Timestamp  
Required: Yes

 ** Description **   <a name="mediapackage-Type-ChannelGroupListConfiguration-Description"></a>
Any descriptive information that you want to add to the channel group for future identification purposes.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/ChannelGroupListConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/ChannelGroupListConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/ChannelGroupListConfiguration) 

# ChannelListConfiguration


The configuration of the channel.

## Contents


 ** Arn **   <a name="mediapackage-Type-ChannelListConfiguration-Arn"></a>
The Amazon Resource Name (ARN) associated with the resource.  
Type: String  
Required: Yes

 ** ChannelGroupName **   <a name="mediapackage-Type-ChannelListConfiguration-ChannelGroupName"></a>
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.  
Type: String  
Required: Yes

 ** ChannelName **   <a name="mediapackage-Type-ChannelListConfiguration-ChannelName"></a>
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.   
Type: String  
Required: Yes

 ** CreatedAt **   <a name="mediapackage-Type-ChannelListConfiguration-CreatedAt"></a>
The date and time the channel was created.  
Type: Timestamp  
Required: Yes

 ** ModifiedAt **   <a name="mediapackage-Type-ChannelListConfiguration-ModifiedAt"></a>
The date and time the channel was modified.  
Type: Timestamp  
Required: Yes

 ** Description **   <a name="mediapackage-Type-ChannelListConfiguration-Description"></a>
Any descriptive information that you want to add to the channel for future identification purposes.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** InputType **   <a name="mediapackage-Type-ChannelListConfiguration-InputType"></a>
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.  
The allowed values are:  
+  `HLS` - The HLS streaming specification (which defines M3U8 manifests and TS segments).
+  `CMAF` - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
Type: String  
Valid Values: `HLS | CMAF`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/ChannelListConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/ChannelListConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/ChannelListConfiguration) 

# CreateDashManifestConfiguration


Create a DASH manifest configuration.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-CreateDashManifestConfiguration-ManifestName"></a>
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** BaseUrls **   <a name="mediapackage-Type-CreateDashManifestConfiguration-BaseUrls"></a>
The base URLs to use for retrieving segments.  
Type: Array of [DashBaseUrl](API_DashBaseUrl.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: No

 ** Compactness **   <a name="mediapackage-Type-CreateDashManifestConfiguration-Compactness"></a>
The layout of the DASH manifest that MediaPackage produces. `STANDARD` indicates a default manifest, which is compacted. `NONE` indicates a full manifest.  
For information about compactness, see [DASH manifest compactness](https://docs.aws.amazon.com/mediapackage/latest/userguide/compacted.html) in the * AWS Elemental MediaPackage v2 User Guide*.  
Type: String  
Valid Values: `STANDARD | NONE`   
Required: No

 ** DrmSignaling **   <a name="mediapackage-Type-CreateDashManifestConfiguration-DrmSignaling"></a>
Determines how the DASH manifest signals the DRM content.  
Type: String  
Valid Values: `INDIVIDUAL | REFERENCED`   
Required: No

 ** DvbSettings **   <a name="mediapackage-Type-CreateDashManifestConfiguration-DvbSettings"></a>
For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.  
Type: [DashDvbSettings](API_DashDvbSettings.md) object  
Required: No

 ** FilterConfiguration **   <a name="mediapackage-Type-CreateDashManifestConfiguration-FilterConfiguration"></a>
Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.   
Type: [FilterConfiguration](API_FilterConfiguration.md) object  
Required: No

 ** ManifestWindowSeconds **   <a name="mediapackage-Type-CreateDashManifestConfiguration-ManifestWindowSeconds"></a>
The total duration (in seconds) of the manifest's content.  
Type: Integer  
Valid Range: Minimum value of 30.  
Required: No

 ** MinBufferTimeSeconds **   <a name="mediapackage-Type-CreateDashManifestConfiguration-MinBufferTimeSeconds"></a>
Minimum amount of content (in seconds) that a player must keep available in the buffer.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 3600.  
Required: No

 ** MinUpdatePeriodSeconds **   <a name="mediapackage-Type-CreateDashManifestConfiguration-MinUpdatePeriodSeconds"></a>
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 3600.  
Required: No

 ** PeriodTriggers **   <a name="mediapackage-Type-CreateDashManifestConfiguration-PeriodTriggers"></a>
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type `ADS` to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see [Multi-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/userguide/multi-period.html).  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Valid Values: `AVAILS | DRM_KEY_ROTATION | SOURCE_CHANGES | SOURCE_DISRUPTIONS | NONE`   
Required: No

 ** Profiles **   <a name="mediapackage-Type-CreateDashManifestConfiguration-Profiles"></a>
The profile that the output is compliant with.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Valid Values: `DVB_DASH`   
Required: No

 ** ProgramInformation **   <a name="mediapackage-Type-CreateDashManifestConfiguration-ProgramInformation"></a>
Details about the content that you want MediaPackage to pass through in the manifest to the playback device.  
Type: [DashProgramInformation](API_DashProgramInformation.md) object  
Required: No

 ** ScteDash **   <a name="mediapackage-Type-CreateDashManifestConfiguration-ScteDash"></a>
The SCTE configuration.  
Type: [ScteDash](API_ScteDash.md) object  
Required: No

 ** SegmentTemplateFormat **   <a name="mediapackage-Type-CreateDashManifestConfiguration-SegmentTemplateFormat"></a>
Determines the type of variable used in the `media` URL of the `SegmentTemplate` tag in the manifest. Also specifies if segment timeline information is included in `SegmentTimeline` or `SegmentTemplate`.  
Value description:  
+  `NUMBER_WITH_TIMELINE` - The `$Number$` variable is used in the `media` URL. The value of this variable is the sequential number of the segment. A full `SegmentTimeline` object is presented in each `SegmentTemplate`.
Type: String  
Valid Values: `NUMBER_WITH_TIMELINE`   
Required: No

 ** SubtitleConfiguration **   <a name="mediapackage-Type-CreateDashManifestConfiguration-SubtitleConfiguration"></a>
The configuration for DASH subtitles.  
Type: [DashSubtitleConfiguration](API_DashSubtitleConfiguration.md) object  
Required: No

 ** SuggestedPresentationDelaySeconds **   <a name="mediapackage-Type-CreateDashManifestConfiguration-SuggestedPresentationDelaySeconds"></a>
The amount of time (in seconds) that the player should be from the end of the manifest.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 3600.  
Required: No

 ** UtcTiming **   <a name="mediapackage-Type-CreateDashManifestConfiguration-UtcTiming"></a>
Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).  
Type: [DashUtcTiming](API_DashUtcTiming.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/CreateDashManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/CreateDashManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/CreateDashManifestConfiguration) 

# CreateHlsManifestConfiguration


Create an HTTP live streaming (HLS) manifest configuration.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-CreateHlsManifestConfiguration-ManifestName"></a>
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** ChildManifestName **   <a name="mediapackage-Type-CreateHlsManifestConfiguration-ChildManifestName"></a>
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-]+`   
Required: No

 ** FilterConfiguration **   <a name="mediapackage-Type-CreateHlsManifestConfiguration-FilterConfiguration"></a>
Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.   
Type: [FilterConfiguration](API_FilterConfiguration.md) object  
Required: No

 ** ManifestWindowSeconds **   <a name="mediapackage-Type-CreateHlsManifestConfiguration-ManifestWindowSeconds"></a>
The total duration (in seconds) of the manifest's content.  
Type: Integer  
Valid Range: Minimum value of 30.  
Required: No

 ** ProgramDateTimeIntervalSeconds **   <a name="mediapackage-Type-CreateHlsManifestConfiguration-ProgramDateTimeIntervalSeconds"></a>
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.  
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1209600.  
Required: No

 ** ScteHls **   <a name="mediapackage-Type-CreateHlsManifestConfiguration-ScteHls"></a>
The SCTE configuration.  
Type: [ScteHls](API_ScteHls.md) object  
Required: No

 ** StartTag **   <a name="mediapackage-Type-CreateHlsManifestConfiguration-StartTag"></a>
To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.  
Type: [StartTag](API_StartTag.md) object  
Required: No

 ** UrlEncodeChildManifest **   <a name="mediapackage-Type-CreateHlsManifestConfiguration-UrlEncodeChildManifest"></a>
When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol. For more information, see [AWS Signature Version 4 for API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html) in * AWS Identity and Access Management User Guide*.  
Type: Boolean  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/CreateHlsManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/CreateHlsManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/CreateHlsManifestConfiguration) 

# CreateLowLatencyHlsManifestConfiguration


Create a low-latency HTTP live streaming (HLS) manifest configuration.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-CreateLowLatencyHlsManifestConfiguration-ManifestName"></a>
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** ChildManifestName **   <a name="mediapackage-Type-CreateLowLatencyHlsManifestConfiguration-ChildManifestName"></a>
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-]+`   
Required: No

 ** FilterConfiguration **   <a name="mediapackage-Type-CreateLowLatencyHlsManifestConfiguration-FilterConfiguration"></a>
Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.   
Type: [FilterConfiguration](API_FilterConfiguration.md) object  
Required: No

 ** ManifestWindowSeconds **   <a name="mediapackage-Type-CreateLowLatencyHlsManifestConfiguration-ManifestWindowSeconds"></a>
The total duration (in seconds) of the manifest's content.  
Type: Integer  
Valid Range: Minimum value of 30.  
Required: No

 ** ProgramDateTimeIntervalSeconds **   <a name="mediapackage-Type-CreateLowLatencyHlsManifestConfiguration-ProgramDateTimeIntervalSeconds"></a>
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.  
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1209600.  
Required: No

 ** ScteHls **   <a name="mediapackage-Type-CreateLowLatencyHlsManifestConfiguration-ScteHls"></a>
The SCTE configuration.  
Type: [ScteHls](API_ScteHls.md) object  
Required: No

 ** StartTag **   <a name="mediapackage-Type-CreateLowLatencyHlsManifestConfiguration-StartTag"></a>
To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.  
Type: [StartTag](API_StartTag.md) object  
Required: No

 ** UrlEncodeChildManifest **   <a name="mediapackage-Type-CreateLowLatencyHlsManifestConfiguration-UrlEncodeChildManifest"></a>
When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol. For more information, see [AWS Signature Version 4 for API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html) in * AWS Identity and Access Management User Guide*.  
Type: Boolean  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/CreateLowLatencyHlsManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/CreateLowLatencyHlsManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/CreateLowLatencyHlsManifestConfiguration) 

# CreateMssManifestConfiguration


Configuration parameters for creating a Microsoft Smooth Streaming (MSS) manifest. MSS is a streaming media format developed by Microsoft that delivers adaptive bitrate streaming content to compatible players and devices.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-CreateMssManifestConfiguration-ManifestName"></a>
A short string that's appended to the endpoint URL to create a unique path to this MSS manifest. The manifest name must be unique within the origin endpoint and can contain letters, numbers, hyphens, and underscores.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** FilterConfiguration **   <a name="mediapackage-Type-CreateMssManifestConfiguration-FilterConfiguration"></a>
Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.   
Type: [FilterConfiguration](API_FilterConfiguration.md) object  
Required: No

 ** ManifestLayout **   <a name="mediapackage-Type-CreateMssManifestConfiguration-ManifestLayout"></a>
Determines the layout format of the MSS manifest. This controls how the manifest is structured and presented to client players, affecting compatibility with different MSS-compatible devices and applications.  
Type: String  
Valid Values: `FULL | COMPACT`   
Required: No

 ** ManifestWindowSeconds **   <a name="mediapackage-Type-CreateMssManifestConfiguration-ManifestWindowSeconds"></a>
The total duration (in seconds) of the manifest window. This determines how much content is available in the manifest at any given time. The manifest window slides forward as new segments become available, maintaining a consistent duration of content. The minimum value is 30 seconds.  
Type: Integer  
Valid Range: Minimum value of 30.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/CreateMssManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/CreateMssManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/CreateMssManifestConfiguration) 

# DashBaseUrl


The base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows.

## Contents


 ** Url **   <a name="mediapackage-Type-DashBaseUrl-Url"></a>
A source location for segments.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** DvbPriority **   <a name="mediapackage-Type-DashBaseUrl-DvbPriority"></a>
For use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 15000.  
Required: No

 ** DvbWeight **   <a name="mediapackage-Type-DashBaseUrl-DvbWeight"></a>
For use with DVB-DASH profiles only. The weighting for source locations that have the same priority.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 15000.  
Required: No

 ** ServiceLocation **   <a name="mediapackage-Type-DashBaseUrl-ServiceLocation"></a>
The name of the source location.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/DashBaseUrl) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/DashBaseUrl) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/DashBaseUrl) 

# DashDvbFontDownload


For use with DVB-DASH profiles only. The settings for font downloads that you want AWS Elemental MediaPackage to pass through to the manifest.

## Contents


 ** FontFamily **   <a name="mediapackage-Type-DashDvbFontDownload-FontFamily"></a>
The `fontFamily` name for subtitles, as described in [EBU-TT-D Subtitling Distribution Format](https://tech.ebu.ch/publications/tech3380).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** MimeType **   <a name="mediapackage-Type-DashDvbFontDownload-MimeType"></a>
The `mimeType` of the resource that's at the font download URL.  
For information about font MIME types, see the [MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks](https://dvb.org/wp-content/uploads/2021/06/A168r4_MPEG-DASH-Profile-for-Transport-of-ISO-BMFF-Based-DVB-Services_Draft-ts_103-285-v140_November_2021.pdf) document.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_/-]*[a-zA-Z0-9]`   
Required: No

 ** Url **   <a name="mediapackage-Type-DashDvbFontDownload-Url"></a>
The URL for downloading fonts for subtitles.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/DashDvbFontDownload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/DashDvbFontDownload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/DashDvbFontDownload) 

# DashDvbMetricsReporting


For use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want AWS Elemental MediaPackage to pass through to the manifest.

## Contents


 ** ReportingUrl **   <a name="mediapackage-Type-DashDvbMetricsReporting-ReportingUrl"></a>
The URL where playback devices send error reports.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** Probability **   <a name="mediapackage-Type-DashDvbMetricsReporting-Probability"></a>
The number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/DashDvbMetricsReporting) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/DashDvbMetricsReporting) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/DashDvbMetricsReporting) 

# DashDvbSettings


For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.

## Contents


 ** ErrorMetrics **   <a name="mediapackage-Type-DashDvbSettings-ErrorMetrics"></a>
Playback device error reporting settings.  
Type: Array of [DashDvbMetricsReporting](API_DashDvbMetricsReporting.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: No

 ** FontDownload **   <a name="mediapackage-Type-DashDvbSettings-FontDownload"></a>
Subtitle font settings.  
Type: [DashDvbFontDownload](API_DashDvbFontDownload.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/DashDvbSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/DashDvbSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/DashDvbSettings) 

# DashProgramInformation


Details about the content that you want MediaPackage to pass through in the manifest to the playback device.

## Contents


 ** Copyright **   <a name="mediapackage-Type-DashProgramInformation-Copyright"></a>
A copyright statement about the content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** LanguageCode **   <a name="mediapackage-Type-DashProgramInformation-LanguageCode"></a>
The language code for this manifest.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]`   
Required: No

 ** MoreInformationUrl **   <a name="mediapackage-Type-DashProgramInformation-MoreInformationUrl"></a>
An absolute URL that contains more information about this content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** Source **   <a name="mediapackage-Type-DashProgramInformation-Source"></a>
Information about the content provider.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** Title **   <a name="mediapackage-Type-DashProgramInformation-Title"></a>
The title for the manifest.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/DashProgramInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/DashProgramInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/DashProgramInformation) 

# DashSubtitleConfiguration


The configuration for DASH subtitles.

## Contents


 ** TtmlConfiguration **   <a name="mediapackage-Type-DashSubtitleConfiguration-TtmlConfiguration"></a>
Settings for TTML subtitles.  
Type: [DashTtmlConfiguration](API_DashTtmlConfiguration.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/DashSubtitleConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/DashSubtitleConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/DashSubtitleConfiguration) 

# DashTtmlConfiguration


The settings for TTML subtitles.

## Contents


 ** TtmlProfile **   <a name="mediapackage-Type-DashTtmlConfiguration-TtmlProfile"></a>
The profile that MediaPackage uses when signaling subtitles in the manifest. `IMSC` is the default profile. `EBU-TT-D` produces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see [EBU-TT-D Subtitling Distribution Format](https://tech.ebu.ch/publications/tech3380).  
Type: String  
Valid Values: `IMSC_1 | EBU_TT_D_101`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/DashTtmlConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/DashTtmlConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/DashTtmlConfiguration) 

# DashUtcTiming


Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

## Contents


 ** TimingMode **   <a name="mediapackage-Type-DashUtcTiming-TimingMode"></a>
The UTC timing mode.  
Type: String  
Valid Values: `HTTP_HEAD | HTTP_ISO | HTTP_XSDATE | UTC_DIRECT`   
Required: No

 ** TimingSource **   <a name="mediapackage-Type-DashUtcTiming-TimingSource"></a>
The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/DashUtcTiming) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/DashUtcTiming) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/DashUtcTiming) 

# Destination


The configuration for the destination where the harvested content will be exported.

## Contents


 ** S3Destination **   <a name="mediapackage-Type-Destination-S3Destination"></a>
The configuration for exporting harvested content to an S3 bucket. This includes details such as the bucket name and destination path within the bucket.  
Type: [S3DestinationConfig](API_S3DestinationConfig.md) object  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/Destination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/Destination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/Destination) 

# Encryption


The parameters for encrypting content.

## Contents


 ** EncryptionMethod **   <a name="mediapackage-Type-Encryption-EncryptionMethod"></a>
The encryption method to use.  
Type: [EncryptionMethod](API_EncryptionMethod.md) object  
Required: Yes

 ** SpekeKeyProvider **   <a name="mediapackage-Type-Encryption-SpekeKeyProvider"></a>
The parameters for the SPEKE key provider.  
Type: [SpekeKeyProvider](API_SpekeKeyProvider.md) object  
Required: Yes

 ** CmafExcludeSegmentDrmMetadata **   <a name="mediapackage-Type-Encryption-CmafExcludeSegmentDrmMetadata"></a>
Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.  
When set to `true`, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.  
Important considerations:  
+ This setting only affects CMAF container formats
+ Key rotation can still be handled through media playlist signaling
+ PSSH and TENC boxes remain unaffected
+ Default behavior is preserved when this setting is disabled
Valid values: `true` \$1 `false`   
Default: `false`   
Type: Boolean  
Required: No

 ** ConstantInitializationVector **   <a name="mediapackage-Type-Encryption-ConstantInitializationVector"></a>
A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).  
Type: String  
Length Constraints: Fixed length of 32.  
Pattern: `[0-9a-fA-F]+`   
Required: No

 ** KeyRotationIntervalSeconds **   <a name="mediapackage-Type-Encryption-KeyRotationIntervalSeconds"></a>
The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.  
The following example setting causes the service to rotate keys every thirty minutes: `1800`   
Type: Integer  
Valid Range: Minimum value of 300. Maximum value of 31536000.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/Encryption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/Encryption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/Encryption) 

# EncryptionContractConfiguration


Configure one or more content encryption keys for your endpoints that use SPEKE Version 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.

## Contents


 ** PresetSpeke20Audio **   <a name="mediapackage-Type-EncryptionContractConfiguration-PresetSpeke20Audio"></a>
A collection of audio encryption presets.  
Value description:   
+ PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.
+ PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.
+ PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.
+ SHARED - Use the same content key for all of the audio and video tracks in your stream.
+ UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.
Type: String  
Valid Values: `PRESET_AUDIO_1 | PRESET_AUDIO_2 | PRESET_AUDIO_3 | SHARED | UNENCRYPTED`   
Required: Yes

 ** PresetSpeke20Video **   <a name="mediapackage-Type-EncryptionContractConfiguration-PresetSpeke20Video"></a>
A collection of video encryption presets.  
Value description:   
+ PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.
+ PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.
+ PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.
+ PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
+ PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
+ PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
+ PRESET-VIDEO-7 - Use one content key to encrypt all of the SD\$1HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
+ PRESET-VIDEO-8 - Use one content key to encrypt all of the SD\$1HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
+ SHARED - Use the same content key for all of the video and audio tracks in your stream.
+ UNENCRYPTED - Don't encrypt any of the video tracks in your stream.
Type: String  
Valid Values: `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: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/EncryptionContractConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/EncryptionContractConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/EncryptionContractConfiguration) 

# EncryptionMethod


The encryption type.

## Contents


 ** CmafEncryptionMethod **   <a name="mediapackage-Type-EncryptionMethod-CmafEncryptionMethod"></a>
The encryption method to use.  
Type: String  
Valid Values: `CENC | CBCS`   
Required: No

 ** IsmEncryptionMethod **   <a name="mediapackage-Type-EncryptionMethod-IsmEncryptionMethod"></a>
The encryption method used for Microsoft Smooth Streaming (MSS) content. This specifies how the MSS segments are encrypted to protect the content during delivery to client players.  
Type: String  
Valid Values: `CENC`   
Required: No

 ** TsEncryptionMethod **   <a name="mediapackage-Type-EncryptionMethod-TsEncryptionMethod"></a>
The encryption method to use.  
Type: String  
Valid Values: `AES_128 | SAMPLE_AES`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/EncryptionMethod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/EncryptionMethod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/EncryptionMethod) 

# FilterConfiguration


Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. 

## Contents


 ** ClipStartTime **   <a name="mediapackage-Type-FilterConfiguration-ClipStartTime"></a>
Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL.  
Type: Timestamp  
Required: No

 ** DrmSettings **   <a name="mediapackage-Type-FilterConfiguration-DrmSettings"></a>
Optionally specify one or more DRM settings for all of your manifest egress requests. When you include a DRM setting, note that you cannot use an identical DRM setting query parameter for this manifest's endpoint URL.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** End **   <a name="mediapackage-Type-FilterConfiguration-End"></a>
Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.  
Type: Timestamp  
Required: No

 ** ManifestFilter **   <a name="mediapackage-Type-FilterConfiguration-ManifestFilter"></a>
Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** Start **   <a name="mediapackage-Type-FilterConfiguration-Start"></a>
Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.  
Type: Timestamp  
Required: No

 ** TimeDelaySeconds **   <a name="mediapackage-Type-FilterConfiguration-TimeDelaySeconds"></a>
Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1209600.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/FilterConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/FilterConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/FilterConfiguration) 

# ForceEndpointErrorConfiguration


The failover settings for the endpoint.

## Contents


 ** EndpointErrorConditions **   <a name="mediapackage-Type-ForceEndpointErrorConfiguration-EndpointErrorConditions"></a>
The failover conditions for the endpoint. The options are:  
+  `STALE_MANIFEST` - The manifest stalled and there are no new segments or parts.
+  `INCOMPLETE_MANIFEST` - There is a gap in the manifest.
+  `MISSING_DRM_KEY` - Key rotation is enabled but we're unable to fetch the key for the current key period.
+  `SLATE_INPUT` - The segments which contain slate content are considered to be missing content.
Type: Array of strings  
Valid Values: `STALE_MANIFEST | INCOMPLETE_MANIFEST | MISSING_DRM_KEY | SLATE_INPUT`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/ForceEndpointErrorConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/ForceEndpointErrorConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/ForceEndpointErrorConfiguration) 

# GetDashManifestConfiguration


Retrieve the DASH manifest configuration.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-GetDashManifestConfiguration-ManifestName"></a>
A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** Url **   <a name="mediapackage-Type-GetDashManifestConfiguration-Url"></a>
The egress domain URL for stream delivery from MediaPackage.  
Type: String  
Required: Yes

 ** BaseUrls **   <a name="mediapackage-Type-GetDashManifestConfiguration-BaseUrls"></a>
The base URL to use for retrieving segments.  
Type: Array of [DashBaseUrl](API_DashBaseUrl.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: No

 ** Compactness **   <a name="mediapackage-Type-GetDashManifestConfiguration-Compactness"></a>
The layout of the DASH manifest that MediaPackage produces. `STANDARD` indicates a default manifest, which is compacted. `NONE` indicates a full manifest.  
Type: String  
Valid Values: `STANDARD | NONE`   
Required: No

 ** DrmSignaling **   <a name="mediapackage-Type-GetDashManifestConfiguration-DrmSignaling"></a>
Determines how the DASH manifest signals the DRM content.  
Type: String  
Valid Values: `INDIVIDUAL | REFERENCED`   
Required: No

 ** DvbSettings **   <a name="mediapackage-Type-GetDashManifestConfiguration-DvbSettings"></a>
For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.  
Type: [DashDvbSettings](API_DashDvbSettings.md) object  
Required: No

 ** FilterConfiguration **   <a name="mediapackage-Type-GetDashManifestConfiguration-FilterConfiguration"></a>
Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.   
Type: [FilterConfiguration](API_FilterConfiguration.md) object  
Required: No

 ** ManifestWindowSeconds **   <a name="mediapackage-Type-GetDashManifestConfiguration-ManifestWindowSeconds"></a>
The total duration (in seconds) of the manifest's content.  
Type: Integer  
Required: No

 ** MinBufferTimeSeconds **   <a name="mediapackage-Type-GetDashManifestConfiguration-MinBufferTimeSeconds"></a>
Minimum amount of content (in seconds) that a player must keep available in the buffer.  
Type: Integer  
Required: No

 ** MinUpdatePeriodSeconds **   <a name="mediapackage-Type-GetDashManifestConfiguration-MinUpdatePeriodSeconds"></a>
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.  
Type: Integer  
Required: No

 ** PeriodTriggers **   <a name="mediapackage-Type-GetDashManifestConfiguration-PeriodTriggers"></a>
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see [Multi-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/userguide/multi-period.html).  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Valid Values: `AVAILS | DRM_KEY_ROTATION | SOURCE_CHANGES | SOURCE_DISRUPTIONS | NONE`   
Required: No

 ** Profiles **   <a name="mediapackage-Type-GetDashManifestConfiguration-Profiles"></a>
The profile that the output is compliant with.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Valid Values: `DVB_DASH`   
Required: No

 ** ProgramInformation **   <a name="mediapackage-Type-GetDashManifestConfiguration-ProgramInformation"></a>
Details about the content that you want MediaPackage to pass through in the manifest to the playback device.  
Type: [DashProgramInformation](API_DashProgramInformation.md) object  
Required: No

 ** ScteDash **   <a name="mediapackage-Type-GetDashManifestConfiguration-ScteDash"></a>
The SCTE configuration.  
Type: [ScteDash](API_ScteDash.md) object  
Required: No

 ** SegmentTemplateFormat **   <a name="mediapackage-Type-GetDashManifestConfiguration-SegmentTemplateFormat"></a>
Determines the type of variable used in the `media` URL of the `SegmentTemplate` tag in the manifest. Also specifies if segment timeline information is included in `SegmentTimeline` or `SegmentTemplate`.  
Value description:  
+  `NUMBER_WITH_TIMELINE` - The `$Number$` variable is used in the `media` URL. The value of this variable is the sequential number of the segment. A full `SegmentTimeline` object is presented in each `SegmentTemplate`.
Type: String  
Valid Values: `NUMBER_WITH_TIMELINE`   
Required: No

 ** SubtitleConfiguration **   <a name="mediapackage-Type-GetDashManifestConfiguration-SubtitleConfiguration"></a>
The configuration for DASH subtitles.  
Type: [DashSubtitleConfiguration](API_DashSubtitleConfiguration.md) object  
Required: No

 ** SuggestedPresentationDelaySeconds **   <a name="mediapackage-Type-GetDashManifestConfiguration-SuggestedPresentationDelaySeconds"></a>
The amount of time (in seconds) that the player should be from the end of the manifest.  
Type: Integer  
Required: No

 ** UtcTiming **   <a name="mediapackage-Type-GetDashManifestConfiguration-UtcTiming"></a>
Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).  
Type: [DashUtcTiming](API_DashUtcTiming.md) object  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/GetDashManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/GetDashManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/GetDashManifestConfiguration) 

# GetHlsManifestConfiguration


Retrieve the HTTP live streaming (HLS) manifest configuration.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-GetHlsManifestConfiguration-ManifestName"></a>
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** Url **   <a name="mediapackage-Type-GetHlsManifestConfiguration-Url"></a>
The egress domain URL for stream delivery from MediaPackage.  
Type: String  
Required: Yes

 ** ChildManifestName **   <a name="mediapackage-Type-GetHlsManifestConfiguration-ChildManifestName"></a>
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index\$11. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: No

 ** FilterConfiguration **   <a name="mediapackage-Type-GetHlsManifestConfiguration-FilterConfiguration"></a>
Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.   
Type: [FilterConfiguration](API_FilterConfiguration.md) object  
Required: No

 ** ManifestWindowSeconds **   <a name="mediapackage-Type-GetHlsManifestConfiguration-ManifestWindowSeconds"></a>
The total duration (in seconds) of the manifest's content.  
Type: Integer  
Required: No

 ** ProgramDateTimeIntervalSeconds **   <a name="mediapackage-Type-GetHlsManifestConfiguration-ProgramDateTimeIntervalSeconds"></a>
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.  
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.  
Type: Integer  
Required: No

 ** ScteHls **   <a name="mediapackage-Type-GetHlsManifestConfiguration-ScteHls"></a>
The SCTE configuration.  
Type: [ScteHls](API_ScteHls.md) object  
Required: No

 ** StartTag **   <a name="mediapackage-Type-GetHlsManifestConfiguration-StartTag"></a>
To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.  
Type: [StartTag](API_StartTag.md) object  
Required: No

 ** UrlEncodeChildManifest **   <a name="mediapackage-Type-GetHlsManifestConfiguration-UrlEncodeChildManifest"></a>
When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol. For more information, see [AWS Signature Version 4 for API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html) in * AWS Identity and Access Management User Guide*.  
Type: Boolean  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/GetHlsManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/GetHlsManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/GetHlsManifestConfiguration) 

# GetLowLatencyHlsManifestConfiguration


Retrieve the low-latency HTTP live streaming (HLS) manifest configuration.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-GetLowLatencyHlsManifestConfiguration-ManifestName"></a>
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** Url **   <a name="mediapackage-Type-GetLowLatencyHlsManifestConfiguration-Url"></a>
The egress domain URL for stream delivery from MediaPackage.  
Type: String  
Required: Yes

 ** ChildManifestName **   <a name="mediapackage-Type-GetLowLatencyHlsManifestConfiguration-ChildManifestName"></a>
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index\$11. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: No

 ** FilterConfiguration **   <a name="mediapackage-Type-GetLowLatencyHlsManifestConfiguration-FilterConfiguration"></a>
Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.   
Type: [FilterConfiguration](API_FilterConfiguration.md) object  
Required: No

 ** ManifestWindowSeconds **   <a name="mediapackage-Type-GetLowLatencyHlsManifestConfiguration-ManifestWindowSeconds"></a>
The total duration (in seconds) of the manifest's content.  
Type: Integer  
Required: No

 ** ProgramDateTimeIntervalSeconds **   <a name="mediapackage-Type-GetLowLatencyHlsManifestConfiguration-ProgramDateTimeIntervalSeconds"></a>
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.  
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.  
Type: Integer  
Required: No

 ** ScteHls **   <a name="mediapackage-Type-GetLowLatencyHlsManifestConfiguration-ScteHls"></a>
The SCTE configuration.  
Type: [ScteHls](API_ScteHls.md) object  
Required: No

 ** StartTag **   <a name="mediapackage-Type-GetLowLatencyHlsManifestConfiguration-StartTag"></a>
To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.  
Type: [StartTag](API_StartTag.md) object  
Required: No

 ** UrlEncodeChildManifest **   <a name="mediapackage-Type-GetLowLatencyHlsManifestConfiguration-UrlEncodeChildManifest"></a>
When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol. For more information, see [AWS Signature Version 4 for API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html) in * AWS Identity and Access Management User Guide*.  
Type: Boolean  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/GetLowLatencyHlsManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/GetLowLatencyHlsManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/GetLowLatencyHlsManifestConfiguration) 

# GetMssManifestConfiguration


Configuration details for a Microsoft Smooth Streaming (MSS) manifest associated with an origin endpoint. This includes all the settings and properties that define how the MSS content is packaged and delivered.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-GetMssManifestConfiguration-ManifestName"></a>
The name of the MSS manifest. This name is appended to the origin endpoint URL to create the unique path for accessing this specific MSS manifest.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** Url **   <a name="mediapackage-Type-GetMssManifestConfiguration-Url"></a>
The complete URL for accessing the MSS manifest. Client players use this URL to retrieve the manifest and begin streaming the Microsoft Smooth Streaming content.  
Type: String  
Required: Yes

 ** FilterConfiguration **   <a name="mediapackage-Type-GetMssManifestConfiguration-FilterConfiguration"></a>
Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.   
Type: [FilterConfiguration](API_FilterConfiguration.md) object  
Required: No

 ** ManifestLayout **   <a name="mediapackage-Type-GetMssManifestConfiguration-ManifestLayout"></a>
The layout format of the MSS manifest, which determines how the manifest is structured for client compatibility.  
Type: String  
Valid Values: `FULL | COMPACT`   
Required: No

 ** ManifestWindowSeconds **   <a name="mediapackage-Type-GetMssManifestConfiguration-ManifestWindowSeconds"></a>
The duration (in seconds) of the manifest window. This represents the total amount of content available in the manifest at any given time.  
Type: Integer  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/GetMssManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/GetMssManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/GetMssManifestConfiguration) 

# HarvestedDashManifest


Information about a harvested DASH manifest.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-HarvestedDashManifest-ManifestName"></a>
The name of the harvested DASH manifest.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/HarvestedDashManifest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/HarvestedDashManifest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/HarvestedDashManifest) 

# HarvestedHlsManifest


Information about a harvested HLS manifest.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-HarvestedHlsManifest-ManifestName"></a>
The name of the harvested HLS manifest.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/HarvestedHlsManifest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/HarvestedHlsManifest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/HarvestedHlsManifest) 

# HarvestedLowLatencyHlsManifest


Information about a harvested Low-Latency HLS manifest.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-HarvestedLowLatencyHlsManifest-ManifestName"></a>
The name of the harvested Low-Latency HLS manifest.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/HarvestedLowLatencyHlsManifest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/HarvestedLowLatencyHlsManifest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/HarvestedLowLatencyHlsManifest) 

# HarvestedManifests


A collection of harvested manifests of different types.

## Contents


 ** DashManifests **   <a name="mediapackage-Type-HarvestedManifests-DashManifests"></a>
A list of harvested DASH manifests.  
Type: Array of [HarvestedDashManifest](API_HarvestedDashManifest.md) objects  
Required: No

 ** HlsManifests **   <a name="mediapackage-Type-HarvestedManifests-HlsManifests"></a>
A list of harvested HLS manifests.  
Type: Array of [HarvestedHlsManifest](API_HarvestedHlsManifest.md) objects  
Required: No

 ** LowLatencyHlsManifests **   <a name="mediapackage-Type-HarvestedManifests-LowLatencyHlsManifests"></a>
A list of harvested Low-Latency HLS manifests.  
Type: Array of [HarvestedLowLatencyHlsManifest](API_HarvestedLowLatencyHlsManifest.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/HarvestedManifests) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/HarvestedManifests) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/HarvestedManifests) 

# HarvesterScheduleConfiguration


Defines the schedule configuration for a harvest job.

## Contents


 ** EndTime **   <a name="mediapackage-Type-HarvesterScheduleConfiguration-EndTime"></a>
The end time for the harvest job.  
Type: Timestamp  
Required: Yes

 ** StartTime **   <a name="mediapackage-Type-HarvesterScheduleConfiguration-StartTime"></a>
The start time for the harvest job.  
Type: Timestamp  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/HarvesterScheduleConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/HarvesterScheduleConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/HarvesterScheduleConfiguration) 

# HarvestJob


Represents a harvest job resource in MediaPackage v2, which is used to export content from an origin endpoint to an S3 bucket.

## Contents


 ** Arn **   <a name="mediapackage-Type-HarvestJob-Arn"></a>
The Amazon Resource Name (ARN) of the harvest job.  
Type: String  
Required: Yes

 ** ChannelGroupName **   <a name="mediapackage-Type-HarvestJob-ChannelGroupName"></a>
The name of the channel group containing the channel associated with this harvest job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** ChannelName **   <a name="mediapackage-Type-HarvestJob-ChannelName"></a>
The name of the channel associated with this harvest job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** CreatedAt **   <a name="mediapackage-Type-HarvestJob-CreatedAt"></a>
The date and time when the harvest job was created.  
Type: Timestamp  
Required: Yes

 ** Destination **   <a name="mediapackage-Type-HarvestJob-Destination"></a>
The S3 destination where the harvested content will be placed.  
Type: [Destination](API_Destination.md) object  
Required: Yes

 ** HarvestedManifests **   <a name="mediapackage-Type-HarvestJob-HarvestedManifests"></a>
A list of manifests that are being or have been harvested.  
Type: [HarvestedManifests](API_HarvestedManifests.md) object  
Required: Yes

 ** HarvestJobName **   <a name="mediapackage-Type-HarvestJob-HarvestJobName"></a>
The name of the harvest job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** ModifiedAt **   <a name="mediapackage-Type-HarvestJob-ModifiedAt"></a>
The date and time when the harvest job was last modified.  
Type: Timestamp  
Required: Yes

 ** OriginEndpointName **   <a name="mediapackage-Type-HarvestJob-OriginEndpointName"></a>
The name of the origin endpoint associated with this harvest job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** ScheduleConfiguration **   <a name="mediapackage-Type-HarvestJob-ScheduleConfiguration"></a>
The configuration for when the harvest job is scheduled to run.  
Type: [HarvesterScheduleConfiguration](API_HarvesterScheduleConfiguration.md) object  
Required: Yes

 ** Status **   <a name="mediapackage-Type-HarvestJob-Status"></a>
The current status of the harvest job (e.g., QUEUED, IN\$1PROGRESS, CANCELLED, COMPLETED, FAILED).  
Type: String  
Valid Values: `QUEUED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED`   
Required: Yes

 ** Description **   <a name="mediapackage-Type-HarvestJob-Description"></a>
An optional description of the harvest job.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** ErrorMessage **   <a name="mediapackage-Type-HarvestJob-ErrorMessage"></a>
An error message if the harvest job encountered any issues.  
Type: String  
Required: No

 ** ETag **   <a name="mediapackage-Type-HarvestJob-ETag"></a>
The current version of the harvest job. Used for concurrency control.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\S]+`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/HarvestJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/HarvestJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/HarvestJob) 

# IngestEndpoint


The ingest domain URL where the source stream should be sent.

## Contents


 ** Id **   <a name="mediapackage-Type-IngestEndpoint-Id"></a>
The system-generated unique identifier for the IngestEndpoint.  
Type: String  
Required: No

 ** Url **   <a name="mediapackage-Type-IngestEndpoint-Url"></a>
The ingest domain URL where the source stream should be sent.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/IngestEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/IngestEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/IngestEndpoint) 

# InputSwitchConfiguration


The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.

## Contents


 ** MQCSInputSwitching **   <a name="mediapackage-Type-InputSwitchConfiguration-MQCSInputSwitching"></a>
When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is false. This setting is valid only when `InputType` is `CMAF`.  
Type: Boolean  
Required: No

 ** PreferredInput **   <a name="mediapackage-Type-InputSwitchConfiguration-PreferredInput"></a>
For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select `1` to prefer the first ingest endpoint, or `2` to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 2.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/InputSwitchConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/InputSwitchConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/InputSwitchConfiguration) 

# ListDashManifestConfiguration


List the DASH manifest configuration.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-ListDashManifestConfiguration-ManifestName"></a>
A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** Url **   <a name="mediapackage-Type-ListDashManifestConfiguration-Url"></a>
The egress domain URL for stream delivery from MediaPackage.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/ListDashManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/ListDashManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/ListDashManifestConfiguration) 

# ListHlsManifestConfiguration


List the HTTP live streaming (HLS) manifest configuration.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-ListHlsManifestConfiguration-ManifestName"></a>
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** ChildManifestName **   <a name="mediapackage-Type-ListHlsManifestConfiguration-ChildManifestName"></a>
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index\$11. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: No

 ** Url **   <a name="mediapackage-Type-ListHlsManifestConfiguration-Url"></a>
The egress domain URL for stream delivery from MediaPackage.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/ListHlsManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/ListHlsManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/ListHlsManifestConfiguration) 

# ListLowLatencyHlsManifestConfiguration


List the low-latency HTTP live streaming (HLS) manifest configuration.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-ListLowLatencyHlsManifestConfiguration-ManifestName"></a>
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** ChildManifestName **   <a name="mediapackage-Type-ListLowLatencyHlsManifestConfiguration-ChildManifestName"></a>
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index\$11. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: No

 ** Url **   <a name="mediapackage-Type-ListLowLatencyHlsManifestConfiguration-Url"></a>
The egress domain URL for stream delivery from MediaPackage.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/ListLowLatencyHlsManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/ListLowLatencyHlsManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/ListLowLatencyHlsManifestConfiguration) 

# ListMssManifestConfiguration


Summary information about a Microsoft Smooth Streaming (MSS) manifest configuration. This provides key details about the MSS manifest without including all configuration parameters.

## Contents


 ** ManifestName **   <a name="mediapackage-Type-ListMssManifestConfiguration-ManifestName"></a>
The name of the MSS manifest configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** Url **   <a name="mediapackage-Type-ListMssManifestConfiguration-Url"></a>
The URL for accessing the MSS manifest.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/ListMssManifestConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/ListMssManifestConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/ListMssManifestConfiguration) 

# OriginEndpointListConfiguration


The configuration of the origin endpoint.

## Contents


 ** Arn **   <a name="mediapackage-Type-OriginEndpointListConfiguration-Arn"></a>
The Amazon Resource Name (ARN) associated with the resource.  
Type: String  
Required: Yes

 ** ChannelGroupName **   <a name="mediapackage-Type-OriginEndpointListConfiguration-ChannelGroupName"></a>
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** ChannelName **   <a name="mediapackage-Type-OriginEndpointListConfiguration-ChannelName"></a>
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** ContainerType **   <a name="mediapackage-Type-OriginEndpointListConfiguration-ContainerType"></a>
The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.   
Type: String  
Valid Values: `TS | CMAF | ISM`   
Required: Yes

 ** OriginEndpointName **   <a name="mediapackage-Type-OriginEndpointListConfiguration-OriginEndpointName"></a>
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** CreatedAt **   <a name="mediapackage-Type-OriginEndpointListConfiguration-CreatedAt"></a>
The date and time the origin endpoint was created.  
Type: Timestamp  
Required: No

 ** DashManifests **   <a name="mediapackage-Type-OriginEndpointListConfiguration-DashManifests"></a>
A DASH manifest configuration.  
Type: Array of [ListDashManifestConfiguration](API_ListDashManifestConfiguration.md) objects  
Required: No

 ** Description **   <a name="mediapackage-Type-OriginEndpointListConfiguration-Description"></a>
Any descriptive information that you want to add to the origin endpoint for future identification purposes.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** ForceEndpointErrorConfiguration **   <a name="mediapackage-Type-OriginEndpointListConfiguration-ForceEndpointErrorConfiguration"></a>
The failover settings for the endpoint.  
Type: [ForceEndpointErrorConfiguration](API_ForceEndpointErrorConfiguration.md) object  
Required: No

 ** HlsManifests **   <a name="mediapackage-Type-OriginEndpointListConfiguration-HlsManifests"></a>
An HTTP live streaming (HLS) manifest configuration.  
Type: Array of [ListHlsManifestConfiguration](API_ListHlsManifestConfiguration.md) objects  
Required: No

 ** LowLatencyHlsManifests **   <a name="mediapackage-Type-OriginEndpointListConfiguration-LowLatencyHlsManifests"></a>
A low-latency HLS manifest configuration.  
Type: Array of [ListLowLatencyHlsManifestConfiguration](API_ListLowLatencyHlsManifestConfiguration.md) objects  
Required: No

 ** ModifiedAt **   <a name="mediapackage-Type-OriginEndpointListConfiguration-ModifiedAt"></a>
The date and time the origin endpoint was modified.  
Type: Timestamp  
Required: No

 ** MssManifests **   <a name="mediapackage-Type-OriginEndpointListConfiguration-MssManifests"></a>
A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint. Each configuration represents a different MSS streaming option available from this endpoint.  
Type: Array of [ListMssManifestConfiguration](API_ListMssManifestConfiguration.md) objects  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/OriginEndpointListConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/OriginEndpointListConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/OriginEndpointListConfiguration) 

# OutputHeaderConfiguration


The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.

## Contents


 ** PublishMQCS **   <a name="mediapackage-Type-OutputHeaderConfiguration-PublishMQCS"></a>
When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when `InputType` is `CMAF`.  
Type: Boolean  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/OutputHeaderConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/OutputHeaderConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/OutputHeaderConfiguration) 

# S3DestinationConfig


Configuration parameters for where in an S3 bucket to place the harvested content.

## Contents


 ** BucketName **   <a name="mediapackage-Type-S3DestinationConfig-BucketName"></a>
The name of an S3 bucket within which harvested content will be exported.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Required: Yes

 ** DestinationPath **   <a name="mediapackage-Type-S3DestinationConfig-DestinationPath"></a>
The path within the specified S3 bucket where the harvested content will be placed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[\S]+`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/S3DestinationConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/S3DestinationConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/S3DestinationConfig) 

# Scte


The SCTE configuration.

## Contents


 ** ScteFilter **   <a name="mediapackage-Type-Scte-ScteFilter"></a>
The SCTE-35 message types that you want to be treated as ad markers in the output.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Valid Values: `SPLICE_INSERT | BREAK | PROVIDER_ADVERTISEMENT | DISTRIBUTOR_ADVERTISEMENT | PROVIDER_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_PLACEMENT_OPPORTUNITY | PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY | PROGRAM`   
Required: No

 ** ScteInSegments **   <a name="mediapackage-Type-Scte-ScteInSegments"></a>
Controls whether SCTE-35 messages are included in segment files.  
+ None – SCTE-35 messages are not included in segments (default)
+ All – SCTE-35 messages are embedded in segment data
 For DASH manifests, when set to `All`, an `InbandEventStream` tag signals that SCTE messages are present in segments. This setting works independently of manifest ad markers.  
Type: String  
Valid Values: `NONE | ALL`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/Scte) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/Scte) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/Scte) 

# ScteDash


The SCTE configuration.

## Contents


 ** AdMarkerDash **   <a name="mediapackage-Type-ScteDash-AdMarkerDash"></a>
Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.  
Value description:  
+  `Binary` - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.
+  `XML` - The SCTE marker is expressed fully in XML.
Type: String  
Valid Values: `BINARY | XML`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/ScteDash) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/ScteDash) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/ScteDash) 

# ScteHls


The SCTE configuration.

## Contents


 ** AdMarkerHls **   <a name="mediapackage-Type-ScteHls-AdMarkerHls"></a>
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.  
Value description:   
+ SCTE35\$1ENHANCED - Generate industry-standard CUE tag ad markers in HLS manifests based on SCTE-35 input messages from the input stream.
+ DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see [SCTE-35 Ad Marker EXT-X-DATERANGE](http://docs.aws.amazon.com/mediapackage/latest/ug/scte-35-ad-marker-ext-x-daterange.html).
Type: String  
Valid Values: `DATERANGE | SCTE35_ENHANCED`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/ScteHls) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/ScteHls) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/ScteHls) 

# Segment


The segment configuration, including the segment name, duration, and other configuration values.

## Contents


 ** Encryption **   <a name="mediapackage-Type-Segment-Encryption"></a>
The parameters for encrypting content.  
Type: [Encryption](API_Encryption.md) object  
Required: No

 ** IncludeIframeOnlyStreams **   <a name="mediapackage-Type-Segment-IncludeIframeOnlyStreams"></a>
When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.  
Type: Boolean  
Required: No

 ** Scte **   <a name="mediapackage-Type-Segment-Scte"></a>
The SCTE configuration options in the segment settings.  
Type: [Scte](API_Scte.md) object  
Required: No

 ** SegmentDurationSeconds **   <a name="mediapackage-Type-Segment-SegmentDurationSeconds"></a>
The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 30.  
Required: No

 ** SegmentName **   <a name="mediapackage-Type-Segment-SegmentName"></a>
The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: No

 ** TsIncludeDvbSubtitles **   <a name="mediapackage-Type-Segment-TsIncludeDvbSubtitles"></a>
By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.  
Type: Boolean  
Required: No

 ** TsUseAudioRenditionGroup **   <a name="mediapackage-Type-Segment-TsUseAudioRenditionGroup"></a>
When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.  
Type: Boolean  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/Segment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/Segment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/Segment) 

# SpekeKeyProvider


The parameters for the SPEKE key provider.

## Contents


 ** DrmSystems **   <a name="mediapackage-Type-SpekeKeyProvider-DrmSystems"></a>
The DRM solution provider you're using to protect your content during distribution.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 4 items.  
Valid Values: `CLEAR_KEY_AES_128 | FAIRPLAY | PLAYREADY | WIDEVINE | IRDETO`   
Required: Yes

 ** EncryptionContractConfiguration **   <a name="mediapackage-Type-SpekeKeyProvider-EncryptionContractConfiguration"></a>
Configure one or more content encryption keys for your endpoints that use SPEKE Version 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.  
Type: [EncryptionContractConfiguration](API_EncryptionContractConfiguration.md) object  
Required: Yes

 ** ResourceId **   <a name="mediapackage-Type-SpekeKeyProvider-ResourceId"></a>
The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.  
The following example shows a resource ID: `MovieNight20171126093045`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[0-9a-zA-Z_-]+`   
Required: Yes

 ** RoleArn **   <a name="mediapackage-Type-SpekeKeyProvider-RoleArn"></a>
The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.  
Valid format: `arn:aws:iam::{accountID}:role/{name}`. The following example shows a role ARN: `arn:aws:iam::444455556666:role/SpekeAccess`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** Url **   <a name="mediapackage-Type-SpekeKeyProvider-Url"></a>
The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.  
The following example shows a URL: `https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** CertificateArn **   <a name="mediapackage-Type-SpekeKeyProvider-CertificateArn"></a>
The ARN for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint. For this feature to work, your DRM key provider must support content key encryption.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:([^:\n]+):acm:([^:\n]+):([0-9]+):certificate/[a-zA-Z0-9-_]+`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/SpekeKeyProvider) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/SpekeKeyProvider) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/SpekeKeyProvider) 

# StartTag


To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.

## Contents


 ** TimeOffset **   <a name="mediapackage-Type-StartTag-TimeOffset"></a>
Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration.  
Type: Float  
Required: Yes

 ** Precise **   <a name="mediapackage-Type-StartTag-Precise"></a>
Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES.  
Type: Boolean  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediapackagev2-2022-12-25/StartTag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediapackagev2-2022-12-25/StartTag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediapackagev2-2022-12-25/StartTag)