[ aws . mediapackage-vod ]
list-packaging-configurations¶
Description¶
Returns a collection of MediaPackage VOD PackagingConfiguration resources.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-packaging-configurations is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: PackagingConfigurations
Synopsis¶
list-packaging-configurations
[--packaging-group-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--packaging-group-id (string)
Returns MediaPackage VOD PackagingConfigurations associated with the specified PackagingGroup.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size (integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To list all packaging configurations
The following list-packaging-configurations example lists all of the packaging configurations that are configured on the packaging group named Packaging_group_1.
aws mediapackage-vod list-packaging-configurations \
--packaging-group-id Packaging_group_1
Output:
{
"PackagingConfigurations":[
{
"Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/CMAF",
"Id":"CMAF",
"PackagingGroupId":"Packaging_group_1",
"CmafPackage":[
{
"SegmentDurationSeconds":"2"
},
{
"HlsManifests":{
"AdMarkers":"NONE",
"RepeatExtXKey":"False",
"ManifestName":"index",
"ProgramDateTimeIntervalSeconds":"0",
"IncludeIframeOnlyStream":"False"
}
}
]
},
{
"Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/DASH",
"Id":"DASH",
"PackagingGroupId":"Packaging_group_1",
"DashPackage":[
{
"SegmentDurationSeconds":"2"
},
{
"DashManifests":{
"ManifestName":"index",
"MinBufferTimeSeconds":"30",
"Profile":"NONE"
}
}
]
},
{
"Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/HLS",
"Id":"HLS",
"PackagingGroupId":"Packaging_group_1",
"HlsPackage":[
{
"SegmentDurationSeconds":"6",
"UseAudioRenditionGroup":"False"
},
{
"HlsManifests":{
"AdMarkers":"NONE",
"RepeatExtXKey":"False",
"ManifestName":"index",
"ProgramDateTimeIntervalSeconds":"0",
"IncludeIframeOnlyStream":"False"
}
}
]
},
{
"Arn":"arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-configurations/New_config_0_copy",
"Id":"New_config_0_copy",
"PackagingGroupId":"Packaging_group_1",
"HlsPackage":[
{
"SegmentDurationSeconds":"6",
"UseAudioRenditionGroup":"False"
},
{
"Encryption":{
"EncryptionMethod":"AWS_128",
"SpekeKeyProvider":{
"RoleArn":"arn:aws:iam:111122223333::role/SPEKERole",
"Url":"https://lfgubdvs97.execute-api.us-west-2.amazonaws.com/EkeStage/copyProtection/",
"SystemIds":[
"81376844-f976-481e-a84e-cc25d39b0b33"
]
}
}
},
{
"HlsManifests":{
"AdMarkers":"NONE",
"RepeatExtXKey":"False",
"ManifestName":"index",
"ProgramDateTimeIntervalSeconds":"0",
"IncludeIframeOnlyStream":"False"
}
}
]
}
]
}
For more information, see Viewing Packaging Configuration Details in the AWS Elemental MediaPackage User Guide.
Output¶
NextToken -> (string)
A token that can be used to resume pagination from the end of the collection.
PackagingConfigurations -> (list)
A list of MediaPackage VOD PackagingConfiguration resources.
(structure)
A MediaPackage VOD PackagingConfiguration resource.
Arn -> (string)
The ARN of the PackagingConfiguration.
CmafPackage -> (structure)
A CMAF packaging configuration.
Encryption -> (structure)
A CMAF encryption configuration.
SpekeKeyProvider -> (structure)
A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
RoleArn -> (string)
An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
SystemIds -> (list)
The system IDs to include in key requests.
(string)
Url -> (string)
The URL of the external key provider service.
HlsManifests -> (list)
A list of HLS manifest configurations.
(structure)
An HTTP Live Streaming (HLS) manifest configuration.
AdMarkers -> (string)
This setting controls how ad markers are included in the packaged OriginEndpoint. “NONE” will omit all SCTE-35 ad markers from the output. “PASSTHROUGH” causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. “SCTE35_ENHANCED” generates ad markers and blackout tags based on SCTE-35 messages in the input source.
IncludeIframeOnlyStream -> (boolean)
When enabled, an I-Frame only stream will be included in the output.
ManifestName -> (string)
An optional string to include in the name of the manifest.
ProgramDateTimeIntervalSeconds -> (integer)
The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
RepeatExtXKey -> (boolean)
When enabled, the EXT-X-KEY tag will be repeated in output manifests.
StreamSelection -> (structure)
A StreamSelection configuration.
MaxVideoBitsPerSecond -> (integer)
The maximum video bitrate (bps) to include in output.
MinVideoBitsPerSecond -> (integer)
The minimum video bitrate (bps) to include in output.
StreamOrder -> (string)
A directive that determines the order of streams in the output.
SegmentDurationSeconds -> (integer)
Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
DashPackage -> (structure)
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
DashManifests -> (list)
A list of DASH manifest configurations.
(structure)
A DASH manifest configuration.
ManifestLayout -> (string)
Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.
ManifestName -> (string)
An optional string to include in the name of the manifest.
MinBufferTimeSeconds -> (integer)
Minimum duration (in seconds) that a player will buffer media before starting the presentation.
Profile -> (string)
The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to “HBBTV_1_5”, HbbTV 1.5 compliant output is enabled.
StreamSelection -> (structure)
A StreamSelection configuration.
MaxVideoBitsPerSecond -> (integer)
The maximum video bitrate (bps) to include in output.
MinVideoBitsPerSecond -> (integer)
The minimum video bitrate (bps) to include in output.
StreamOrder -> (string)
A directive that determines the order of streams in the output.
Encryption -> (structure)
A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
SpekeKeyProvider -> (structure)
A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
RoleArn -> (string)
An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
SystemIds -> (list)
The system IDs to include in key requests.
(string)
Url -> (string)
The URL of the external key provider service.
PeriodTriggers -> (list)
A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains “ADS”, new periods will be created where the Asset contains SCTE-35 ad markers.
(string)
SegmentDurationSeconds -> (integer)
Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
SegmentTemplateFormat -> (string)
Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
HlsPackage -> (structure)
An HTTP Live Streaming (HLS) packaging configuration.
Encryption -> (structure)
An HTTP Live Streaming (HLS) encryption configuration.
ConstantInitializationVector -> (string)
A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
EncryptionMethod -> (string)
The encryption method to use.
SpekeKeyProvider -> (structure)
A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
RoleArn -> (string)
An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
SystemIds -> (list)
The system IDs to include in key requests.
(string)
Url -> (string)
The URL of the external key provider service.
HlsManifests -> (list)
A list of HLS manifest configurations.
(structure)
An HTTP Live Streaming (HLS) manifest configuration.
AdMarkers -> (string)
This setting controls how ad markers are included in the packaged OriginEndpoint. “NONE” will omit all SCTE-35 ad markers from the output. “PASSTHROUGH” causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. “SCTE35_ENHANCED” generates ad markers and blackout tags based on SCTE-35 messages in the input source.
IncludeIframeOnlyStream -> (boolean)
When enabled, an I-Frame only stream will be included in the output.
ManifestName -> (string)
An optional string to include in the name of the manifest.
ProgramDateTimeIntervalSeconds -> (integer)
The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
RepeatExtXKey -> (boolean)
When enabled, the EXT-X-KEY tag will be repeated in output manifests.
StreamSelection -> (structure)
A StreamSelection configuration.
MaxVideoBitsPerSecond -> (integer)
The maximum video bitrate (bps) to include in output.
MinVideoBitsPerSecond -> (integer)
The minimum video bitrate (bps) to include in output.
StreamOrder -> (string)
A directive that determines the order of streams in the output.
SegmentDurationSeconds -> (integer)
Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
UseAudioRenditionGroup -> (boolean)
When enabled, audio streams will be placed in rendition groups in the output.
Id -> (string)
The ID of the PackagingConfiguration.
MssPackage -> (structure)
A Microsoft Smooth Streaming (MSS) PackagingConfiguration.
Encryption -> (structure)
A Microsoft Smooth Streaming (MSS) encryption configuration.
SpekeKeyProvider -> (structure)
A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
RoleArn -> (string)
An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
SystemIds -> (list)
The system IDs to include in key requests.
(string)
Url -> (string)
The URL of the external key provider service.
MssManifests -> (list)
A list of MSS manifest configurations.
(structure)
A Microsoft Smooth Streaming (MSS) manifest configuration.
ManifestName -> (string)
An optional string to include in the name of the manifest.
StreamSelection -> (structure)
A StreamSelection configuration.
MaxVideoBitsPerSecond -> (integer)
The maximum video bitrate (bps) to include in output.
MinVideoBitsPerSecond -> (integer)
The minimum video bitrate (bps) to include in output.
StreamOrder -> (string)
A directive that determines the order of streams in the output.
SegmentDurationSeconds -> (integer)
The duration (in seconds) of each segment.
PackagingGroupId -> (string)
The ID of a PackagingGroup.
Tags -> (map)
A collection of tags associated with a resource
key -> (string)
value -> (string)