Skip to content

Commit 8361611

Browse files
author
AWS
committed
AWS Elemental MediaPackage v2 Update: This release adds the ResetChannelState and ResetOriginEndpointState operation to reset MediaPackage V2 channel and origin endpoint. This release also adds a new field, UrlEncodeChildManifest, for HLS/LL-HLS to allow URL-encoding child manifest query string based on the requirements of AWS SigV4.
1 parent 8ab7787 commit 8361611

File tree

2 files changed

+183
-5
lines changed

2 files changed

+183
-5
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Elemental MediaPackage v2",
4+
"contributor": "",
5+
"description": "This release adds the ResetChannelState and ResetOriginEndpointState operation to reset MediaPackage V2 channel and origin endpoint. This release also adds a new field, UrlEncodeChildManifest, for HLS/LL-HLS to allow URL-encoding child manifest query string based on the requirements of AWS SigV4."
6+
}

services/mediapackagev2/src/main/resources/codegen-resources/service-2.json

Lines changed: 177 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@
335335
{"shape":"AccessDeniedException"},
336336
{"shape":"ValidationException"}
337337
],
338-
"documentation":"<p>Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.</p>"
338+
"documentation":"<p>Retrieves all channel groups that are configured in Elemental MediaPackage.</p>"
339339
},
340340
"ListChannels":{
341341
"name":"ListChannels",
@@ -445,6 +445,46 @@
445445
"documentation":"<p>Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.</p>",
446446
"idempotent":true
447447
},
448+
"ResetChannelState":{
449+
"name":"ResetChannelState",
450+
"http":{
451+
"method":"POST",
452+
"requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/reset",
453+
"responseCode":200
454+
},
455+
"input":{"shape":"ResetChannelStateRequest"},
456+
"output":{"shape":"ResetChannelStateResponse"},
457+
"errors":[
458+
{"shape":"ThrottlingException"},
459+
{"shape":"ConflictException"},
460+
{"shape":"InternalServerException"},
461+
{"shape":"AccessDeniedException"},
462+
{"shape":"ValidationException"},
463+
{"shape":"ResourceNotFoundException"}
464+
],
465+
"documentation":"<p>Resetting the channel can help to clear errors from misconfigurations in the encoder. A reset refreshes the ingest stream and removes previous content. </p> <p> Be sure to stop the encoder before you reset the channel, and wait at least 30 seconds before you restart the encoder. </p>",
466+
"idempotent":true
467+
},
468+
"ResetOriginEndpointState":{
469+
"name":"ResetOriginEndpointState",
470+
"http":{
471+
"method":"POST",
472+
"requestUri":"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}/reset",
473+
"responseCode":200
474+
},
475+
"input":{"shape":"ResetOriginEndpointStateRequest"},
476+
"output":{"shape":"ResetOriginEndpointStateResponse"},
477+
"errors":[
478+
{"shape":"ThrottlingException"},
479+
{"shape":"ConflictException"},
480+
{"shape":"InternalServerException"},
481+
{"shape":"AccessDeniedException"},
482+
{"shape":"ValidationException"},
483+
{"shape":"ResourceNotFoundException"}
484+
],
485+
"documentation":"<p>Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint.</p> <p>MediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoint. </p>",
486+
"idempotent":true
487+
},
448488
"TagResource":{
449489
"name":"TagResource",
450490
"http":{
@@ -1141,7 +1181,11 @@
11411181
"shape":"CreateHlsManifestConfigurationProgramDateTimeIntervalSecondsInteger",
11421182
"documentation":"<p>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.</p> <p>Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.</p>"
11431183
},
1144-
"FilterConfiguration":{"shape":"FilterConfiguration"}
1184+
"FilterConfiguration":{"shape":"FilterConfiguration"},
1185+
"UrlEncodeChildManifest":{
1186+
"shape":"Boolean",
1187+
"documentation":"<p>When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html\">Amazon Web Services Signature Version 4 for API requests</a> in <i>Identity and Access Management User Guide</i>.</p>"
1188+
}
11451189
},
11461190
"documentation":"<p>Create an HTTP live streaming (HLS) manifest configuration.</p>"
11471191
},
@@ -1182,7 +1226,11 @@
11821226
"shape":"CreateLowLatencyHlsManifestConfigurationProgramDateTimeIntervalSecondsInteger",
11831227
"documentation":"<p>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.</p> <p>Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.</p>"
11841228
},
1185-
"FilterConfiguration":{"shape":"FilterConfiguration"}
1229+
"FilterConfiguration":{"shape":"FilterConfiguration"},
1230+
"UrlEncodeChildManifest":{
1231+
"shape":"Boolean",
1232+
"documentation":"<p>When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html\">Amazon Web Services Signature Version 4 for API requests</a> in <i>Identity and Access Management User Guide</i>.</p>"
1233+
}
11861234
},
11871235
"documentation":"<p>Create a low-latency HTTP live streaming (HLS) manifest configuration.</p>"
11881236
},
@@ -1858,6 +1906,10 @@
18581906
"shape":"Timestamp",
18591907
"documentation":"<p>The date and time the channel was modified.</p>"
18601908
},
1909+
"ResetAt":{
1910+
"shape":"Timestamp",
1911+
"documentation":"<p>The time that the channel was last reset.</p>"
1912+
},
18611913
"Description":{
18621914
"shape":"ResourceDescription",
18631915
"documentation":"<p>The description for your channel.</p>"
@@ -2088,7 +2140,11 @@
20882140
},
20892141
"ScteHls":{"shape":"ScteHls"},
20902142
"FilterConfiguration":{"shape":"FilterConfiguration"},
2091-
"StartTag":{"shape":"StartTag"}
2143+
"StartTag":{"shape":"StartTag"},
2144+
"UrlEncodeChildManifest":{
2145+
"shape":"Boolean",
2146+
"documentation":"<p>When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html\">Amazon Web Services Signature Version 4 for API requests</a> in <i>Identity and Access Management User Guide</i>.</p>"
2147+
}
20922148
},
20932149
"documentation":"<p>Retrieve the HTTP live streaming (HLS) manifest configuration.</p>"
20942150
},
@@ -2125,7 +2181,11 @@
21252181
},
21262182
"ScteHls":{"shape":"ScteHls"},
21272183
"FilterConfiguration":{"shape":"FilterConfiguration"},
2128-
"StartTag":{"shape":"StartTag"}
2184+
"StartTag":{"shape":"StartTag"},
2185+
"UrlEncodeChildManifest":{
2186+
"shape":"Boolean",
2187+
"documentation":"<p>When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html\">Amazon Web Services Signature Version 4 for API requests</a> in <i>Identity and Access Management User Guide</i>.</p>"
2188+
}
21292189
},
21302190
"documentation":"<p>Retrieve the low-latency HTTP live streaming (HLS) manifest configuration.</p>"
21312191
},
@@ -2258,6 +2318,10 @@
22582318
"shape":"Timestamp",
22592319
"documentation":"<p>The date and time the origin endpoint was modified.</p>"
22602320
},
2321+
"ResetAt":{
2322+
"shape":"Timestamp",
2323+
"documentation":"<p>The time that the origin endpoint was last reset.</p>"
2324+
},
22612325
"Description":{
22622326
"shape":"ResourceDescription",
22632327
"documentation":"<p>The description for your origin endpoint.</p>"
@@ -2979,6 +3043,114 @@
29793043
"members":{
29803044
}
29813045
},
3046+
"ResetChannelStateRequest":{
3047+
"type":"structure",
3048+
"required":[
3049+
"ChannelGroupName",
3050+
"ChannelName"
3051+
],
3052+
"members":{
3053+
"ChannelGroupName":{
3054+
"shape":"ResourceName",
3055+
"documentation":"<p>The name of the channel group that contains the channel that you are resetting.</p>",
3056+
"location":"uri",
3057+
"locationName":"ChannelGroupName"
3058+
},
3059+
"ChannelName":{
3060+
"shape":"ResourceName",
3061+
"documentation":"<p>The name of the channel that you are resetting.</p>",
3062+
"location":"uri",
3063+
"locationName":"ChannelName"
3064+
}
3065+
}
3066+
},
3067+
"ResetChannelStateResponse":{
3068+
"type":"structure",
3069+
"required":[
3070+
"ChannelGroupName",
3071+
"ChannelName",
3072+
"Arn",
3073+
"ResetAt"
3074+
],
3075+
"members":{
3076+
"ChannelGroupName":{
3077+
"shape":"String",
3078+
"documentation":"<p>The name of the channel group that contains the channel that you just reset.</p>"
3079+
},
3080+
"ChannelName":{
3081+
"shape":"String",
3082+
"documentation":"<p>The name of the channel that you just reset.</p>"
3083+
},
3084+
"Arn":{
3085+
"shape":"String",
3086+
"documentation":"<p>The Amazon Resource Name (ARN) associated with the channel that you just reset.</p>"
3087+
},
3088+
"ResetAt":{
3089+
"shape":"Timestamp",
3090+
"documentation":"<p>The time that the channel was last reset.</p>"
3091+
}
3092+
}
3093+
},
3094+
"ResetOriginEndpointStateRequest":{
3095+
"type":"structure",
3096+
"required":[
3097+
"ChannelGroupName",
3098+
"ChannelName",
3099+
"OriginEndpointName"
3100+
],
3101+
"members":{
3102+
"ChannelGroupName":{
3103+
"shape":"ResourceName",
3104+
"documentation":"<p>The name of the channel group that contains the channel with the origin endpoint that you are resetting.</p>",
3105+
"location":"uri",
3106+
"locationName":"ChannelGroupName"
3107+
},
3108+
"ChannelName":{
3109+
"shape":"ResourceName",
3110+
"documentation":"<p>The name of the channel with the origin endpoint that you are resetting.</p>",
3111+
"location":"uri",
3112+
"locationName":"ChannelName"
3113+
},
3114+
"OriginEndpointName":{
3115+
"shape":"ResourceName",
3116+
"documentation":"<p>The name of the origin endpoint that you are resetting.</p>",
3117+
"location":"uri",
3118+
"locationName":"OriginEndpointName"
3119+
}
3120+
}
3121+
},
3122+
"ResetOriginEndpointStateResponse":{
3123+
"type":"structure",
3124+
"required":[
3125+
"ChannelGroupName",
3126+
"ChannelName",
3127+
"OriginEndpointName",
3128+
"Arn",
3129+
"ResetAt"
3130+
],
3131+
"members":{
3132+
"ChannelGroupName":{
3133+
"shape":"ResourceName",
3134+
"documentation":"<p>The name of the channel group that contains the channel with the origin endpoint that you just reset.</p>"
3135+
},
3136+
"ChannelName":{
3137+
"shape":"ResourceName",
3138+
"documentation":"<p>The name of the channel with the origin endpoint that you just reset.</p>"
3139+
},
3140+
"OriginEndpointName":{
3141+
"shape":"ResourceName",
3142+
"documentation":"<p>The name of the origin endpoint that you just reset.</p>"
3143+
},
3144+
"Arn":{
3145+
"shape":"String",
3146+
"documentation":"<p>The Amazon Resource Name (ARN) associated with the endpoint that you just reset.</p>"
3147+
},
3148+
"ResetAt":{
3149+
"shape":"Timestamp",
3150+
"documentation":"<p>The time that the origin endpoint was last reset.</p>"
3151+
}
3152+
}
3153+
},
29823154
"ResourceDescription":{
29833155
"type":"string",
29843156
"max":1024,

0 commit comments

Comments
 (0)