mediapackagev2.d.ts 87 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class MediaPackageV2 extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: MediaPackageV2.Types.ClientConfiguration)
  13. config: Config & MediaPackageV2.Types.ClientConfiguration;
  14. /**
  15. * Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.
  16. */
  17. createChannel(params: MediaPackageV2.Types.CreateChannelRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.CreateChannelResponse) => void): Request<MediaPackageV2.Types.CreateChannelResponse, AWSError>;
  18. /**
  19. * Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.
  20. */
  21. createChannel(callback?: (err: AWSError, data: MediaPackageV2.Types.CreateChannelResponse) => void): Request<MediaPackageV2.Types.CreateChannelResponse, AWSError>;
  22. /**
  23. * Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.
  24. */
  25. createChannelGroup(params: MediaPackageV2.Types.CreateChannelGroupRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.CreateChannelGroupResponse) => void): Request<MediaPackageV2.Types.CreateChannelGroupResponse, AWSError>;
  26. /**
  27. * Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.
  28. */
  29. createChannelGroup(callback?: (err: AWSError, data: MediaPackageV2.Types.CreateChannelGroupResponse) => void): Request<MediaPackageV2.Types.CreateChannelGroupResponse, AWSError>;
  30. /**
  31. * The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.
  32. */
  33. createOriginEndpoint(params: MediaPackageV2.Types.CreateOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.CreateOriginEndpointResponse) => void): Request<MediaPackageV2.Types.CreateOriginEndpointResponse, AWSError>;
  34. /**
  35. * The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.
  36. */
  37. createOriginEndpoint(callback?: (err: AWSError, data: MediaPackageV2.Types.CreateOriginEndpointResponse) => void): Request<MediaPackageV2.Types.CreateOriginEndpointResponse, AWSError>;
  38. /**
  39. * Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.
  40. */
  41. deleteChannel(params: MediaPackageV2.Types.DeleteChannelRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.DeleteChannelResponse) => void): Request<MediaPackageV2.Types.DeleteChannelResponse, AWSError>;
  42. /**
  43. * Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.
  44. */
  45. deleteChannel(callback?: (err: AWSError, data: MediaPackageV2.Types.DeleteChannelResponse) => void): Request<MediaPackageV2.Types.DeleteChannelResponse, AWSError>;
  46. /**
  47. * Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.
  48. */
  49. deleteChannelGroup(params: MediaPackageV2.Types.DeleteChannelGroupRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.DeleteChannelGroupResponse) => void): Request<MediaPackageV2.Types.DeleteChannelGroupResponse, AWSError>;
  50. /**
  51. * Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.
  52. */
  53. deleteChannelGroup(callback?: (err: AWSError, data: MediaPackageV2.Types.DeleteChannelGroupResponse) => void): Request<MediaPackageV2.Types.DeleteChannelGroupResponse, AWSError>;
  54. /**
  55. * Delete a channel policy.
  56. */
  57. deleteChannelPolicy(params: MediaPackageV2.Types.DeleteChannelPolicyRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.DeleteChannelPolicyResponse) => void): Request<MediaPackageV2.Types.DeleteChannelPolicyResponse, AWSError>;
  58. /**
  59. * Delete a channel policy.
  60. */
  61. deleteChannelPolicy(callback?: (err: AWSError, data: MediaPackageV2.Types.DeleteChannelPolicyResponse) => void): Request<MediaPackageV2.Types.DeleteChannelPolicyResponse, AWSError>;
  62. /**
  63. * Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.
  64. */
  65. deleteOriginEndpoint(params: MediaPackageV2.Types.DeleteOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.DeleteOriginEndpointResponse) => void): Request<MediaPackageV2.Types.DeleteOriginEndpointResponse, AWSError>;
  66. /**
  67. * Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.
  68. */
  69. deleteOriginEndpoint(callback?: (err: AWSError, data: MediaPackageV2.Types.DeleteOriginEndpointResponse) => void): Request<MediaPackageV2.Types.DeleteOriginEndpointResponse, AWSError>;
  70. /**
  71. * Delete an origin endpoint policy.
  72. */
  73. deleteOriginEndpointPolicy(params: MediaPackageV2.Types.DeleteOriginEndpointPolicyRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.DeleteOriginEndpointPolicyResponse) => void): Request<MediaPackageV2.Types.DeleteOriginEndpointPolicyResponse, AWSError>;
  74. /**
  75. * Delete an origin endpoint policy.
  76. */
  77. deleteOriginEndpointPolicy(callback?: (err: AWSError, data: MediaPackageV2.Types.DeleteOriginEndpointPolicyResponse) => void): Request<MediaPackageV2.Types.DeleteOriginEndpointPolicyResponse, AWSError>;
  78. /**
  79. * Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
  80. */
  81. getChannel(params: MediaPackageV2.Types.GetChannelRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.GetChannelResponse) => void): Request<MediaPackageV2.Types.GetChannelResponse, AWSError>;
  82. /**
  83. * Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
  84. */
  85. getChannel(callback?: (err: AWSError, data: MediaPackageV2.Types.GetChannelResponse) => void): Request<MediaPackageV2.Types.GetChannelResponse, AWSError>;
  86. /**
  87. * Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
  88. */
  89. getChannelGroup(params: MediaPackageV2.Types.GetChannelGroupRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.GetChannelGroupResponse) => void): Request<MediaPackageV2.Types.GetChannelGroupResponse, AWSError>;
  90. /**
  91. * Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
  92. */
  93. getChannelGroup(callback?: (err: AWSError, data: MediaPackageV2.Types.GetChannelGroupResponse) => void): Request<MediaPackageV2.Types.GetChannelGroupResponse, AWSError>;
  94. /**
  95. * Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.
  96. */
  97. getChannelPolicy(params: MediaPackageV2.Types.GetChannelPolicyRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.GetChannelPolicyResponse) => void): Request<MediaPackageV2.Types.GetChannelPolicyResponse, AWSError>;
  98. /**
  99. * Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.
  100. */
  101. getChannelPolicy(callback?: (err: AWSError, data: MediaPackageV2.Types.GetChannelPolicyResponse) => void): Request<MediaPackageV2.Types.GetChannelPolicyResponse, AWSError>;
  102. /**
  103. * Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.
  104. */
  105. getOriginEndpoint(params: MediaPackageV2.Types.GetOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.GetOriginEndpointResponse) => void): Request<MediaPackageV2.Types.GetOriginEndpointResponse, AWSError>;
  106. /**
  107. * Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.
  108. */
  109. getOriginEndpoint(callback?: (err: AWSError, data: MediaPackageV2.Types.GetOriginEndpointResponse) => void): Request<MediaPackageV2.Types.GetOriginEndpointResponse, AWSError>;
  110. /**
  111. * Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
  112. */
  113. getOriginEndpointPolicy(params: MediaPackageV2.Types.GetOriginEndpointPolicyRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.GetOriginEndpointPolicyResponse) => void): Request<MediaPackageV2.Types.GetOriginEndpointPolicyResponse, AWSError>;
  114. /**
  115. * Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
  116. */
  117. getOriginEndpointPolicy(callback?: (err: AWSError, data: MediaPackageV2.Types.GetOriginEndpointPolicyResponse) => void): Request<MediaPackageV2.Types.GetOriginEndpointPolicyResponse, AWSError>;
  118. /**
  119. * Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
  120. */
  121. listChannelGroups(params: MediaPackageV2.Types.ListChannelGroupsRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.ListChannelGroupsResponse) => void): Request<MediaPackageV2.Types.ListChannelGroupsResponse, AWSError>;
  122. /**
  123. * Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
  124. */
  125. listChannelGroups(callback?: (err: AWSError, data: MediaPackageV2.Types.ListChannelGroupsResponse) => void): Request<MediaPackageV2.Types.ListChannelGroupsResponse, AWSError>;
  126. /**
  127. * Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
  128. */
  129. listChannels(params: MediaPackageV2.Types.ListChannelsRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.ListChannelsResponse) => void): Request<MediaPackageV2.Types.ListChannelsResponse, AWSError>;
  130. /**
  131. * Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
  132. */
  133. listChannels(callback?: (err: AWSError, data: MediaPackageV2.Types.ListChannelsResponse) => void): Request<MediaPackageV2.Types.ListChannelsResponse, AWSError>;
  134. /**
  135. * Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
  136. */
  137. listOriginEndpoints(params: MediaPackageV2.Types.ListOriginEndpointsRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.ListOriginEndpointsResponse) => void): Request<MediaPackageV2.Types.ListOriginEndpointsResponse, AWSError>;
  138. /**
  139. * Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
  140. */
  141. listOriginEndpoints(callback?: (err: AWSError, data: MediaPackageV2.Types.ListOriginEndpointsResponse) => void): Request<MediaPackageV2.Types.ListOriginEndpointsResponse, AWSError>;
  142. /**
  143. * Lists the tags assigned to a resource.
  144. */
  145. listTagsForResource(params: MediaPackageV2.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.ListTagsForResourceResponse) => void): Request<MediaPackageV2.Types.ListTagsForResourceResponse, AWSError>;
  146. /**
  147. * Lists the tags assigned to a resource.
  148. */
  149. listTagsForResource(callback?: (err: AWSError, data: MediaPackageV2.Types.ListTagsForResourceResponse) => void): Request<MediaPackageV2.Types.ListTagsForResourceResponse, AWSError>;
  150. /**
  151. * Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.
  152. */
  153. putChannelPolicy(params: MediaPackageV2.Types.PutChannelPolicyRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.PutChannelPolicyResponse) => void): Request<MediaPackageV2.Types.PutChannelPolicyResponse, AWSError>;
  154. /**
  155. * Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.
  156. */
  157. putChannelPolicy(callback?: (err: AWSError, data: MediaPackageV2.Types.PutChannelPolicyResponse) => void): Request<MediaPackageV2.Types.PutChannelPolicyResponse, AWSError>;
  158. /**
  159. * Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
  160. */
  161. putOriginEndpointPolicy(params: MediaPackageV2.Types.PutOriginEndpointPolicyRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.PutOriginEndpointPolicyResponse) => void): Request<MediaPackageV2.Types.PutOriginEndpointPolicyResponse, AWSError>;
  162. /**
  163. * Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
  164. */
  165. putOriginEndpointPolicy(callback?: (err: AWSError, data: MediaPackageV2.Types.PutOriginEndpointPolicyResponse) => void): Request<MediaPackageV2.Types.PutOriginEndpointPolicyResponse, AWSError>;
  166. /**
  167. * Assigns one of more tags (key-value pairs) to the specified MediaPackage resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
  168. */
  169. tagResource(params: MediaPackageV2.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  170. /**
  171. * Assigns one of more tags (key-value pairs) to the specified MediaPackage resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
  172. */
  173. tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  174. /**
  175. * Removes one or more tags from the specified resource.
  176. */
  177. untagResource(params: MediaPackageV2.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  178. /**
  179. * Removes one or more tags from the specified resource.
  180. */
  181. untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  182. /**
  183. * Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details. Any edits you make that impact the video output may not be reflected for a few minutes.
  184. */
  185. updateChannel(params: MediaPackageV2.Types.UpdateChannelRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.UpdateChannelResponse) => void): Request<MediaPackageV2.Types.UpdateChannelResponse, AWSError>;
  186. /**
  187. * Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details. Any edits you make that impact the video output may not be reflected for a few minutes.
  188. */
  189. updateChannel(callback?: (err: AWSError, data: MediaPackageV2.Types.UpdateChannelResponse) => void): Request<MediaPackageV2.Types.UpdateChannelResponse, AWSError>;
  190. /**
  191. * Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group. Any edits you make that impact the video output may not be reflected for a few minutes.
  192. */
  193. updateChannelGroup(params: MediaPackageV2.Types.UpdateChannelGroupRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.UpdateChannelGroupResponse) => void): Request<MediaPackageV2.Types.UpdateChannelGroupResponse, AWSError>;
  194. /**
  195. * Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group. Any edits you make that impact the video output may not be reflected for a few minutes.
  196. */
  197. updateChannelGroup(callback?: (err: AWSError, data: MediaPackageV2.Types.UpdateChannelGroupResponse) => void): Request<MediaPackageV2.Types.UpdateChannelGroupResponse, AWSError>;
  198. /**
  199. * Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint. Any edits you make that impact the video output may not be reflected for a few minutes.
  200. */
  201. updateOriginEndpoint(params: MediaPackageV2.Types.UpdateOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackageV2.Types.UpdateOriginEndpointResponse) => void): Request<MediaPackageV2.Types.UpdateOriginEndpointResponse, AWSError>;
  202. /**
  203. * Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint. Any edits you make that impact the video output may not be reflected for a few minutes.
  204. */
  205. updateOriginEndpoint(callback?: (err: AWSError, data: MediaPackageV2.Types.UpdateOriginEndpointResponse) => void): Request<MediaPackageV2.Types.UpdateOriginEndpointResponse, AWSError>;
  206. }
  207. declare namespace MediaPackageV2 {
  208. export type AdMarkerDash = "BINARY"|"XML"|string;
  209. export type AdMarkerHls = "DATERANGE"|string;
  210. export type Boolean = boolean;
  211. export interface ChannelGroupListConfiguration {
  212. /**
  213. * 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.
  214. */
  215. ChannelGroupName: String;
  216. /**
  217. * The Amazon Resource Name (ARN) associated with the resource.
  218. */
  219. Arn: String;
  220. /**
  221. * The date and time the channel group was created.
  222. */
  223. CreatedAt: Timestamp;
  224. /**
  225. * The date and time the channel group was modified.
  226. */
  227. ModifiedAt: Timestamp;
  228. /**
  229. * Any descriptive information that you want to add to the channel group for future identification purposes.
  230. */
  231. Description?: ResourceDescription;
  232. }
  233. export type ChannelGroupsList = ChannelGroupListConfiguration[];
  234. export type ChannelList = ChannelListConfiguration[];
  235. export interface ChannelListConfiguration {
  236. /**
  237. * The Amazon Resource Name (ARN) associated with the resource.
  238. */
  239. Arn: String;
  240. /**
  241. * 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.
  242. */
  243. ChannelName: String;
  244. /**
  245. * 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.
  246. */
  247. ChannelGroupName: String;
  248. /**
  249. * The date and time the channel was created.
  250. */
  251. CreatedAt: Timestamp;
  252. /**
  253. * The date and time the channel was modified.
  254. */
  255. ModifiedAt: Timestamp;
  256. /**
  257. * Any descriptive information that you want to add to the channel for future identification purposes.
  258. */
  259. Description?: ResourceDescription;
  260. }
  261. export type CmafEncryptionMethod = "CENC"|"CBCS"|string;
  262. export type ContainerType = "TS"|"CMAF"|string;
  263. export interface CreateChannelGroupRequest {
  264. /**
  265. * 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. You can't use spaces in the name. You can't change the name after you create the channel group.
  266. */
  267. ChannelGroupName: ResourceName;
  268. /**
  269. * A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  270. */
  271. ClientToken?: IdempotencyToken;
  272. /**
  273. * Enter any descriptive text that helps you to identify the channel group.
  274. */
  275. Description?: ResourceDescription;
  276. /**
  277. * A comma-separated list of tag key:value pairs that you define. For example: "Key1": "Value1", "Key2": "Value2"
  278. */
  279. Tags?: TagMap;
  280. }
  281. export interface CreateChannelGroupResponse {
  282. /**
  283. * 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.
  284. */
  285. ChannelGroupName: String;
  286. /**
  287. * The Amazon Resource Name (ARN) associated with the resource.
  288. */
  289. Arn: String;
  290. /**
  291. * The output domain where the source stream should be sent. Integrate the egress domain with a downstream CDN (such as Amazon CloudFront) or playback device.
  292. */
  293. EgressDomain: String;
  294. /**
  295. * The date and time the channel group was created.
  296. */
  297. CreatedAt: Timestamp;
  298. /**
  299. * The date and time the channel group was modified.
  300. */
  301. ModifiedAt: Timestamp;
  302. /**
  303. * The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
  304. */
  305. ETag?: EntityTag;
  306. /**
  307. * The description for your channel group.
  308. */
  309. Description?: ResourceDescription;
  310. /**
  311. * The comma-separated list of tag key:value pairs assigned to the channel group.
  312. */
  313. Tags?: TagMap;
  314. }
  315. export interface CreateChannelRequest {
  316. /**
  317. * 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.
  318. */
  319. ChannelGroupName: ResourceName;
  320. /**
  321. * 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. You can't change the name after you create the channel.
  322. */
  323. ChannelName: ResourceName;
  324. /**
  325. * A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  326. */
  327. ClientToken?: IdempotencyToken;
  328. /**
  329. * Enter any descriptive text that helps you to identify the channel.
  330. */
  331. Description?: ResourceDescription;
  332. /**
  333. * A comma-separated list of tag key:value pairs that you define. For example: "Key1": "Value1", "Key2": "Value2"
  334. */
  335. Tags?: TagMap;
  336. }
  337. export interface CreateChannelResponse {
  338. /**
  339. * The Amazon Resource Name (ARN) associated with the resource.
  340. */
  341. Arn: String;
  342. /**
  343. * 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.
  344. */
  345. ChannelName: String;
  346. /**
  347. * 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.
  348. */
  349. ChannelGroupName: String;
  350. /**
  351. * The date and time the channel was created.
  352. */
  353. CreatedAt: Timestamp;
  354. /**
  355. * The date and time the channel was modified.
  356. */
  357. ModifiedAt: Timestamp;
  358. /**
  359. * The description for your channel.
  360. */
  361. Description?: ResourceDescription;
  362. IngestEndpoints?: IngestEndpointList;
  363. /**
  364. * The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
  365. */
  366. ETag?: EntityTag;
  367. /**
  368. * The comma-separated list of tag key:value pairs assigned to the channel.
  369. */
  370. Tags?: TagMap;
  371. }
  372. export interface CreateDashManifestConfiguration {
  373. /**
  374. * A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.
  375. */
  376. ManifestName: ManifestName;
  377. /**
  378. * The total duration (in seconds) of the manifest's content.
  379. */
  380. ManifestWindowSeconds?: CreateDashManifestConfigurationManifestWindowSecondsInteger;
  381. FilterConfiguration?: FilterConfiguration;
  382. /**
  383. * Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
  384. */
  385. MinUpdatePeriodSeconds?: CreateDashManifestConfigurationMinUpdatePeriodSecondsInteger;
  386. /**
  387. * Minimum amount of content (in seconds) that a player must keep available in the buffer.
  388. */
  389. MinBufferTimeSeconds?: CreateDashManifestConfigurationMinBufferTimeSecondsInteger;
  390. /**
  391. * The amount of time (in seconds) that the player should be from the end of the manifest.
  392. */
  393. SuggestedPresentationDelaySeconds?: CreateDashManifestConfigurationSuggestedPresentationDelaySecondsInteger;
  394. /**
  395. * 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.
  396. */
  397. SegmentTemplateFormat?: DashSegmentTemplateFormat;
  398. /**
  399. * 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.
  400. */
  401. PeriodTriggers?: DashPeriodTriggers;
  402. /**
  403. * The SCTE configuration.
  404. */
  405. ScteDash?: ScteDash;
  406. /**
  407. * Determines how the DASH manifest signals the DRM content.
  408. */
  409. DrmSignaling?: DashDrmSignaling;
  410. /**
  411. * Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
  412. */
  413. UtcTiming?: DashUtcTiming;
  414. }
  415. export type CreateDashManifestConfigurationManifestWindowSecondsInteger = number;
  416. export type CreateDashManifestConfigurationMinBufferTimeSecondsInteger = number;
  417. export type CreateDashManifestConfigurationMinUpdatePeriodSecondsInteger = number;
  418. export type CreateDashManifestConfigurationSuggestedPresentationDelaySecondsInteger = number;
  419. export type CreateDashManifests = CreateDashManifestConfiguration[];
  420. export interface CreateHlsManifestConfiguration {
  421. /**
  422. * 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.
  423. */
  424. ManifestName: ManifestName;
  425. /**
  426. * 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.
  427. */
  428. ChildManifestName?: ManifestName;
  429. ScteHls?: ScteHls;
  430. /**
  431. * The total duration (in seconds) of the manifest's content.
  432. */
  433. ManifestWindowSeconds?: CreateHlsManifestConfigurationManifestWindowSecondsInteger;
  434. /**
  435. * 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. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
  436. */
  437. ProgramDateTimeIntervalSeconds?: CreateHlsManifestConfigurationProgramDateTimeIntervalSecondsInteger;
  438. FilterConfiguration?: FilterConfiguration;
  439. }
  440. export type CreateHlsManifestConfigurationManifestWindowSecondsInteger = number;
  441. export type CreateHlsManifestConfigurationProgramDateTimeIntervalSecondsInteger = number;
  442. export type CreateHlsManifests = CreateHlsManifestConfiguration[];
  443. export interface CreateLowLatencyHlsManifestConfiguration {
  444. /**
  445. * 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.
  446. */
  447. ManifestName: ManifestName;
  448. /**
  449. * 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.
  450. */
  451. ChildManifestName?: ManifestName;
  452. ScteHls?: ScteHls;
  453. /**
  454. * The total duration (in seconds) of the manifest's content.
  455. */
  456. ManifestWindowSeconds?: CreateLowLatencyHlsManifestConfigurationManifestWindowSecondsInteger;
  457. /**
  458. * 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. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
  459. */
  460. ProgramDateTimeIntervalSeconds?: CreateLowLatencyHlsManifestConfigurationProgramDateTimeIntervalSecondsInteger;
  461. FilterConfiguration?: FilterConfiguration;
  462. }
  463. export type CreateLowLatencyHlsManifestConfigurationManifestWindowSecondsInteger = number;
  464. export type CreateLowLatencyHlsManifestConfigurationProgramDateTimeIntervalSecondsInteger = number;
  465. export type CreateLowLatencyHlsManifests = CreateLowLatencyHlsManifestConfiguration[];
  466. export interface CreateOriginEndpointRequest {
  467. /**
  468. * 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.
  469. */
  470. ChannelGroupName: ResourceName;
  471. /**
  472. * 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.
  473. */
  474. ChannelName: ResourceName;
  475. /**
  476. * The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and must be unique for your account in the AWS Region and channel. You can't use spaces in the name. You can't change the name after you create the endpoint.
  477. */
  478. OriginEndpointName: ResourceName;
  479. /**
  480. * The type of container to attach 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. You can't change the container type after you create the endpoint.
  481. */
  482. ContainerType: ContainerType;
  483. /**
  484. * The segment configuration, including the segment name, duration, and other configuration values.
  485. */
  486. Segment?: Segment;
  487. /**
  488. * A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  489. */
  490. ClientToken?: IdempotencyToken;
  491. /**
  492. * Enter any descriptive text that helps you to identify the origin endpoint.
  493. */
  494. Description?: ResourceDescription;
  495. /**
  496. * The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).
  497. */
  498. StartoverWindowSeconds?: CreateOriginEndpointRequestStartoverWindowSecondsInteger;
  499. /**
  500. * An HTTP live streaming (HLS) manifest configuration.
  501. */
  502. HlsManifests?: CreateHlsManifests;
  503. /**
  504. * A low-latency HLS manifest configuration.
  505. */
  506. LowLatencyHlsManifests?: CreateLowLatencyHlsManifests;
  507. /**
  508. * A DASH manifest configuration.
  509. */
  510. DashManifests?: CreateDashManifests;
  511. /**
  512. * A comma-separated list of tag key:value pairs that you define. For example: "Key1": "Value1", "Key2": "Value2"
  513. */
  514. Tags?: TagMap;
  515. }
  516. export type CreateOriginEndpointRequestStartoverWindowSecondsInteger = number;
  517. export interface CreateOriginEndpointResponse {
  518. /**
  519. * The Amazon Resource Name (ARN) associated with the resource.
  520. */
  521. Arn: String;
  522. /**
  523. * 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.
  524. */
  525. ChannelGroupName: ResourceName;
  526. /**
  527. * 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.
  528. */
  529. ChannelName: ResourceName;
  530. /**
  531. * 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.
  532. */
  533. OriginEndpointName: ResourceName;
  534. /**
  535. * The type of container attached to this origin endpoint.
  536. */
  537. ContainerType: ContainerType;
  538. /**
  539. * The segment configuration, including the segment name, duration, and other configuration values.
  540. */
  541. Segment: Segment;
  542. /**
  543. * The date and time the origin endpoint was created.
  544. */
  545. CreatedAt: Timestamp;
  546. /**
  547. * The date and time the origin endpoint was modified.
  548. */
  549. ModifiedAt: Timestamp;
  550. /**
  551. * The description for your origin endpoint.
  552. */
  553. Description?: ResourceDescription;
  554. /**
  555. * The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
  556. */
  557. StartoverWindowSeconds?: Integer;
  558. /**
  559. * An HTTP live streaming (HLS) manifest configuration.
  560. */
  561. HlsManifests?: GetHlsManifests;
  562. /**
  563. * A low-latency HLS manifest configuration.
  564. */
  565. LowLatencyHlsManifests?: GetLowLatencyHlsManifests;
  566. /**
  567. * A DASH manifest configuration.
  568. */
  569. DashManifests?: GetDashManifests;
  570. /**
  571. * The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
  572. */
  573. ETag?: EntityTag;
  574. /**
  575. * The comma-separated list of tag key:value pairs assigned to the origin endpoint.
  576. */
  577. Tags?: TagMap;
  578. }
  579. export type DashDrmSignaling = "INDIVIDUAL"|"REFERENCED"|string;
  580. export type DashPeriodTrigger = "AVAILS"|"DRM_KEY_ROTATION"|"SOURCE_CHANGES"|"SOURCE_DISRUPTIONS"|"NONE"|string;
  581. export type DashPeriodTriggers = DashPeriodTrigger[];
  582. export type DashSegmentTemplateFormat = "NUMBER_WITH_TIMELINE"|string;
  583. export interface DashUtcTiming {
  584. /**
  585. * The UTC timing mode.
  586. */
  587. TimingMode?: DashUtcTimingMode;
  588. /**
  589. * The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.
  590. */
  591. TimingSource?: DashUtcTimingTimingSourceString;
  592. }
  593. export type DashUtcTimingMode = "HTTP_HEAD"|"HTTP_ISO"|"HTTP_XSDATE"|"UTC_DIRECT"|string;
  594. export type DashUtcTimingTimingSourceString = string;
  595. export interface DeleteChannelGroupRequest {
  596. /**
  597. * 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.
  598. */
  599. ChannelGroupName: ResourceName;
  600. }
  601. export interface DeleteChannelGroupResponse {
  602. }
  603. export interface DeleteChannelPolicyRequest {
  604. /**
  605. * 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.
  606. */
  607. ChannelGroupName: ResourceName;
  608. /**
  609. * 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.
  610. */
  611. ChannelName: ResourceName;
  612. }
  613. export interface DeleteChannelPolicyResponse {
  614. }
  615. export interface DeleteChannelRequest {
  616. /**
  617. * 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.
  618. */
  619. ChannelGroupName: ResourceName;
  620. /**
  621. * 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.
  622. */
  623. ChannelName: ResourceName;
  624. }
  625. export interface DeleteChannelResponse {
  626. }
  627. export interface DeleteOriginEndpointPolicyRequest {
  628. /**
  629. * 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.
  630. */
  631. ChannelGroupName: ResourceName;
  632. /**
  633. * 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.
  634. */
  635. ChannelName: ResourceName;
  636. /**
  637. * 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.
  638. */
  639. OriginEndpointName: ResourceName;
  640. }
  641. export interface DeleteOriginEndpointPolicyResponse {
  642. }
  643. export interface DeleteOriginEndpointRequest {
  644. /**
  645. * 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.
  646. */
  647. ChannelGroupName: ResourceName;
  648. /**
  649. * 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.
  650. */
  651. ChannelName: ResourceName;
  652. /**
  653. * 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.
  654. */
  655. OriginEndpointName: ResourceName;
  656. }
  657. export interface DeleteOriginEndpointResponse {
  658. }
  659. export type DrmSystem = "CLEAR_KEY_AES_128"|"FAIRPLAY"|"PLAYREADY"|"WIDEVINE"|string;
  660. export interface Encryption {
  661. /**
  662. * 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).
  663. */
  664. ConstantInitializationVector?: EncryptionConstantInitializationVectorString;
  665. /**
  666. * The encryption method to use.
  667. */
  668. EncryptionMethod: EncryptionMethod;
  669. /**
  670. * 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
  671. */
  672. KeyRotationIntervalSeconds?: EncryptionKeyRotationIntervalSecondsInteger;
  673. /**
  674. * The parameters for the SPEKE key provider.
  675. */
  676. SpekeKeyProvider: SpekeKeyProvider;
  677. }
  678. export type EncryptionConstantInitializationVectorString = string;
  679. export interface EncryptionContractConfiguration {
  680. /**
  681. * 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.
  682. */
  683. PresetSpeke20Audio: PresetSpeke20Audio;
  684. /**
  685. * 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+HD1 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+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. 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.
  686. */
  687. PresetSpeke20Video: PresetSpeke20Video;
  688. }
  689. export type EncryptionKeyRotationIntervalSecondsInteger = number;
  690. export interface EncryptionMethod {
  691. /**
  692. * The encryption method to use.
  693. */
  694. TsEncryptionMethod?: TsEncryptionMethod;
  695. /**
  696. * The encryption method to use.
  697. */
  698. CmafEncryptionMethod?: CmafEncryptionMethod;
  699. }
  700. export type EntityTag = string;
  701. export interface FilterConfiguration {
  702. /**
  703. * 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.
  704. */
  705. ManifestFilter?: FilterConfigurationManifestFilterString;
  706. /**
  707. * 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.
  708. */
  709. Start?: Timestamp;
  710. /**
  711. * 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.
  712. */
  713. End?: Timestamp;
  714. /**
  715. * 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.
  716. */
  717. TimeDelaySeconds?: FilterConfigurationTimeDelaySecondsInteger;
  718. }
  719. export type FilterConfigurationManifestFilterString = string;
  720. export type FilterConfigurationTimeDelaySecondsInteger = number;
  721. export interface GetChannelGroupRequest {
  722. /**
  723. * 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.
  724. */
  725. ChannelGroupName: ResourceName;
  726. }
  727. export interface GetChannelGroupResponse {
  728. /**
  729. * 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.
  730. */
  731. ChannelGroupName: String;
  732. /**
  733. * The Amazon Resource Name (ARN) associated with the resource.
  734. */
  735. Arn: String;
  736. /**
  737. * The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.
  738. */
  739. EgressDomain: String;
  740. /**
  741. * The date and time the channel group was created.
  742. */
  743. CreatedAt: Timestamp;
  744. /**
  745. * The date and time the channel group was modified.
  746. */
  747. ModifiedAt: Timestamp;
  748. /**
  749. * The description for your channel group.
  750. */
  751. Description?: ResourceDescription;
  752. /**
  753. * The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
  754. */
  755. ETag?: EntityTag;
  756. /**
  757. * The comma-separated list of tag key:value pairs assigned to the channel group.
  758. */
  759. Tags?: TagMap;
  760. }
  761. export interface GetChannelPolicyRequest {
  762. /**
  763. * 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.
  764. */
  765. ChannelGroupName: ResourceName;
  766. /**
  767. * 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.
  768. */
  769. ChannelName: ResourceName;
  770. }
  771. export interface GetChannelPolicyResponse {
  772. /**
  773. * 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.
  774. */
  775. ChannelGroupName: String;
  776. /**
  777. * 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.
  778. */
  779. ChannelName: String;
  780. /**
  781. * The policy assigned to the channel.
  782. */
  783. Policy: PolicyText;
  784. }
  785. export interface GetChannelRequest {
  786. /**
  787. * 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.
  788. */
  789. ChannelGroupName: ResourceName;
  790. /**
  791. * 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.
  792. */
  793. ChannelName: ResourceName;
  794. }
  795. export interface GetChannelResponse {
  796. /**
  797. * The Amazon Resource Name (ARN) associated with the resource.
  798. */
  799. Arn: String;
  800. /**
  801. * 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.
  802. */
  803. ChannelName: String;
  804. /**
  805. * 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.
  806. */
  807. ChannelGroupName: String;
  808. /**
  809. * The date and time the channel was created.
  810. */
  811. CreatedAt: Timestamp;
  812. /**
  813. * The date and time the channel was modified.
  814. */
  815. ModifiedAt: Timestamp;
  816. /**
  817. * The description for your channel.
  818. */
  819. Description?: ResourceDescription;
  820. IngestEndpoints?: IngestEndpointList;
  821. /**
  822. * The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
  823. */
  824. ETag?: EntityTag;
  825. /**
  826. * The comma-separated list of tag key:value pairs assigned to the channel.
  827. */
  828. Tags?: TagMap;
  829. }
  830. export interface GetDashManifestConfiguration {
  831. /**
  832. * 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.
  833. */
  834. ManifestName: ResourceName;
  835. /**
  836. * The egress domain URL for stream delivery from MediaPackage.
  837. */
  838. Url: String;
  839. /**
  840. * The total duration (in seconds) of the manifest's content.
  841. */
  842. ManifestWindowSeconds?: Integer;
  843. FilterConfiguration?: FilterConfiguration;
  844. /**
  845. * Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
  846. */
  847. MinUpdatePeriodSeconds?: Integer;
  848. /**
  849. * Minimum amount of content (in seconds) that a player must keep available in the buffer.
  850. */
  851. MinBufferTimeSeconds?: Integer;
  852. /**
  853. * The amount of time (in seconds) that the player should be from the end of the manifest.
  854. */
  855. SuggestedPresentationDelaySeconds?: Integer;
  856. /**
  857. * 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.
  858. */
  859. SegmentTemplateFormat?: DashSegmentTemplateFormat;
  860. /**
  861. * 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.
  862. */
  863. PeriodTriggers?: DashPeriodTriggers;
  864. /**
  865. * The SCTE configuration.
  866. */
  867. ScteDash?: ScteDash;
  868. /**
  869. * Determines how the DASH manifest signals the DRM content.
  870. */
  871. DrmSignaling?: DashDrmSignaling;
  872. /**
  873. * Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
  874. */
  875. UtcTiming?: DashUtcTiming;
  876. }
  877. export type GetDashManifests = GetDashManifestConfiguration[];
  878. export interface GetHlsManifestConfiguration {
  879. /**
  880. * 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.
  881. */
  882. ManifestName: ResourceName;
  883. /**
  884. * The egress domain URL for stream delivery from MediaPackage.
  885. */
  886. Url: String;
  887. /**
  888. * 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_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
  889. */
  890. ChildManifestName?: ResourceName;
  891. /**
  892. * The total duration (in seconds) of the manifest's content.
  893. */
  894. ManifestWindowSeconds?: Integer;
  895. /**
  896. * 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. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
  897. */
  898. ProgramDateTimeIntervalSeconds?: Integer;
  899. ScteHls?: ScteHls;
  900. FilterConfiguration?: FilterConfiguration;
  901. }
  902. export type GetHlsManifests = GetHlsManifestConfiguration[];
  903. export interface GetLowLatencyHlsManifestConfiguration {
  904. /**
  905. * 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.
  906. */
  907. ManifestName: ResourceName;
  908. /**
  909. * The egress domain URL for stream delivery from MediaPackage.
  910. */
  911. Url: String;
  912. /**
  913. * 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_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
  914. */
  915. ChildManifestName?: ResourceName;
  916. /**
  917. * The total duration (in seconds) of the manifest's content.
  918. */
  919. ManifestWindowSeconds?: Integer;
  920. /**
  921. * 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. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
  922. */
  923. ProgramDateTimeIntervalSeconds?: Integer;
  924. ScteHls?: ScteHls;
  925. FilterConfiguration?: FilterConfiguration;
  926. }
  927. export type GetLowLatencyHlsManifests = GetLowLatencyHlsManifestConfiguration[];
  928. export interface GetOriginEndpointPolicyRequest {
  929. /**
  930. * 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.
  931. */
  932. ChannelGroupName: ResourceName;
  933. /**
  934. * 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.
  935. */
  936. ChannelName: ResourceName;
  937. /**
  938. * 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.
  939. */
  940. OriginEndpointName: ResourceName;
  941. }
  942. export interface GetOriginEndpointPolicyResponse {
  943. /**
  944. * 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.
  945. */
  946. ChannelGroupName: ResourceName;
  947. /**
  948. * 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.
  949. */
  950. ChannelName: ResourceName;
  951. /**
  952. * 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.
  953. */
  954. OriginEndpointName: ResourceName;
  955. /**
  956. * The policy assigned to the origin endpoint.
  957. */
  958. Policy: PolicyText;
  959. }
  960. export interface GetOriginEndpointRequest {
  961. /**
  962. * 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.
  963. */
  964. ChannelGroupName: ResourceName;
  965. /**
  966. * 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.
  967. */
  968. ChannelName: ResourceName;
  969. /**
  970. * 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.
  971. */
  972. OriginEndpointName: ResourceName;
  973. }
  974. export interface GetOriginEndpointResponse {
  975. /**
  976. * The Amazon Resource Name (ARN) associated with the resource.
  977. */
  978. Arn: String;
  979. /**
  980. * 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.
  981. */
  982. ChannelGroupName: ResourceName;
  983. /**
  984. * 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.
  985. */
  986. ChannelName: ResourceName;
  987. /**
  988. * 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.
  989. */
  990. OriginEndpointName: ResourceName;
  991. /**
  992. * The type of container attached to this origin endpoint.
  993. */
  994. ContainerType: ContainerType;
  995. Segment: Segment;
  996. /**
  997. * The date and time the origin endpoint was created.
  998. */
  999. CreatedAt: Timestamp;
  1000. /**
  1001. * The date and time the origin endpoint was modified.
  1002. */
  1003. ModifiedAt: Timestamp;
  1004. /**
  1005. * The description for your origin endpoint.
  1006. */
  1007. Description?: ResourceDescription;
  1008. /**
  1009. * The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
  1010. */
  1011. StartoverWindowSeconds?: Integer;
  1012. /**
  1013. * An HTTP live streaming (HLS) manifest configuration.
  1014. */
  1015. HlsManifests?: GetHlsManifests;
  1016. /**
  1017. * A low-latency HLS manifest configuration.
  1018. */
  1019. LowLatencyHlsManifests?: GetLowLatencyHlsManifests;
  1020. /**
  1021. * The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
  1022. */
  1023. ETag?: EntityTag;
  1024. /**
  1025. * The comma-separated list of tag key:value pairs assigned to the origin endpoint.
  1026. */
  1027. Tags?: TagMap;
  1028. /**
  1029. * A DASH manifest configuration.
  1030. */
  1031. DashManifests?: GetDashManifests;
  1032. }
  1033. export type IdempotencyToken = string;
  1034. export interface IngestEndpoint {
  1035. /**
  1036. * The system-generated unique identifier for the IngestEndpoint.
  1037. */
  1038. Id?: String;
  1039. /**
  1040. * The ingest domain URL where the source stream should be sent.
  1041. */
  1042. Url?: String;
  1043. }
  1044. export type IngestEndpointList = IngestEndpoint[];
  1045. export type Integer = number;
  1046. export interface ListChannelGroupsRequest {
  1047. /**
  1048. * The maximum number of results to return in the response.
  1049. */
  1050. MaxResults?: ListResourceMaxResults;
  1051. /**
  1052. * The pagination token from the GET list request. Use the token to fetch the next page of results.
  1053. */
  1054. NextToken?: String;
  1055. }
  1056. export interface ListChannelGroupsResponse {
  1057. /**
  1058. * The objects being returned.
  1059. */
  1060. Items?: ChannelGroupsList;
  1061. /**
  1062. * The pagination token from the GET list request. Use the token to fetch the next page of results.
  1063. */
  1064. NextToken?: String;
  1065. }
  1066. export interface ListChannelsRequest {
  1067. /**
  1068. * 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.
  1069. */
  1070. ChannelGroupName: ResourceName;
  1071. /**
  1072. * The maximum number of results to return in the response.
  1073. */
  1074. MaxResults?: ListResourceMaxResults;
  1075. /**
  1076. * The pagination token from the GET list request. Use the token to fetch the next page of results.
  1077. */
  1078. NextToken?: String;
  1079. }
  1080. export interface ListChannelsResponse {
  1081. /**
  1082. * The objects being returned.
  1083. */
  1084. Items?: ChannelList;
  1085. /**
  1086. * The pagination token from the GET list request.
  1087. */
  1088. NextToken?: String;
  1089. }
  1090. export interface ListDashManifestConfiguration {
  1091. /**
  1092. * 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.
  1093. */
  1094. ManifestName: ResourceName;
  1095. /**
  1096. * The egress domain URL for stream delivery from MediaPackage.
  1097. */
  1098. Url?: String;
  1099. }
  1100. export type ListDashManifests = ListDashManifestConfiguration[];
  1101. export interface ListHlsManifestConfiguration {
  1102. /**
  1103. * 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.
  1104. */
  1105. ManifestName: ResourceName;
  1106. /**
  1107. * 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_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
  1108. */
  1109. ChildManifestName?: ResourceName;
  1110. /**
  1111. * The egress domain URL for stream delivery from MediaPackage.
  1112. */
  1113. Url?: String;
  1114. }
  1115. export type ListHlsManifests = ListHlsManifestConfiguration[];
  1116. export interface ListLowLatencyHlsManifestConfiguration {
  1117. /**
  1118. * 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.
  1119. */
  1120. ManifestName: ResourceName;
  1121. /**
  1122. * 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_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
  1123. */
  1124. ChildManifestName?: ResourceName;
  1125. /**
  1126. * The egress domain URL for stream delivery from MediaPackage.
  1127. */
  1128. Url?: String;
  1129. }
  1130. export type ListLowLatencyHlsManifests = ListLowLatencyHlsManifestConfiguration[];
  1131. export interface ListOriginEndpointsRequest {
  1132. /**
  1133. * 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.
  1134. */
  1135. ChannelGroupName: ResourceName;
  1136. /**
  1137. * 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.
  1138. */
  1139. ChannelName: ResourceName;
  1140. /**
  1141. * The maximum number of results to return in the response.
  1142. */
  1143. MaxResults?: ListResourceMaxResults;
  1144. /**
  1145. * The pagination token from the GET list request. Use the token to fetch the next page of results.
  1146. */
  1147. NextToken?: String;
  1148. }
  1149. export interface ListOriginEndpointsResponse {
  1150. /**
  1151. * The objects being returned.
  1152. */
  1153. Items?: OriginEndpointsList;
  1154. /**
  1155. * The pagination token from the GET list request. Use the token to fetch the next page of results.
  1156. */
  1157. NextToken?: String;
  1158. }
  1159. export type ListResourceMaxResults = number;
  1160. export interface ListTagsForResourceRequest {
  1161. /**
  1162. * The ARN of the CloudWatch resource that you want to view tags for.
  1163. */
  1164. ResourceArn: TagArn;
  1165. }
  1166. export interface ListTagsForResourceResponse {
  1167. /**
  1168. * Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
  1169. */
  1170. Tags?: TagMap;
  1171. }
  1172. export type ManifestName = string;
  1173. export interface OriginEndpointListConfiguration {
  1174. /**
  1175. * The Amazon Resource Name (ARN) associated with the resource.
  1176. */
  1177. Arn: String;
  1178. /**
  1179. * 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.
  1180. */
  1181. ChannelGroupName: ResourceName;
  1182. /**
  1183. * 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.
  1184. */
  1185. ChannelName: ResourceName;
  1186. /**
  1187. * 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.
  1188. */
  1189. OriginEndpointName: ResourceName;
  1190. /**
  1191. * 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.
  1192. */
  1193. ContainerType: ContainerType;
  1194. /**
  1195. * Any descriptive information that you want to add to the origin endpoint for future identification purposes.
  1196. */
  1197. Description?: ResourceDescription;
  1198. /**
  1199. * The date and time the origin endpoint was created.
  1200. */
  1201. CreatedAt?: Timestamp;
  1202. /**
  1203. * The date and time the origin endpoint was modified.
  1204. */
  1205. ModifiedAt?: Timestamp;
  1206. /**
  1207. * An HTTP live streaming (HLS) manifest configuration.
  1208. */
  1209. HlsManifests?: ListHlsManifests;
  1210. /**
  1211. * A low-latency HLS manifest configuration.
  1212. */
  1213. LowLatencyHlsManifests?: ListLowLatencyHlsManifests;
  1214. /**
  1215. * A DASH manifest configuration.
  1216. */
  1217. DashManifests?: ListDashManifests;
  1218. }
  1219. export type OriginEndpointsList = OriginEndpointListConfiguration[];
  1220. export type PolicyText = string;
  1221. export type PresetSpeke20Audio = "PRESET_AUDIO_1"|"PRESET_AUDIO_2"|"PRESET_AUDIO_3"|"SHARED"|"UNENCRYPTED"|string;
  1222. export type PresetSpeke20Video = "PRESET_VIDEO_1"|"PRESET_VIDEO_2"|"PRESET_VIDEO_3"|"PRESET_VIDEO_4"|"PRESET_VIDEO_5"|"PRESET_VIDEO_6"|"PRESET_VIDEO_7"|"PRESET_VIDEO_8"|"SHARED"|"UNENCRYPTED"|string;
  1223. export interface PutChannelPolicyRequest {
  1224. /**
  1225. * 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.
  1226. */
  1227. ChannelGroupName: ResourceName;
  1228. /**
  1229. * 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.
  1230. */
  1231. ChannelName: ResourceName;
  1232. /**
  1233. * The policy to attach to the specified channel.
  1234. */
  1235. Policy: PolicyText;
  1236. }
  1237. export interface PutChannelPolicyResponse {
  1238. }
  1239. export interface PutOriginEndpointPolicyRequest {
  1240. /**
  1241. * 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.
  1242. */
  1243. ChannelGroupName: ResourceName;
  1244. /**
  1245. * 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.
  1246. */
  1247. ChannelName: ResourceName;
  1248. /**
  1249. * 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.
  1250. */
  1251. OriginEndpointName: ResourceName;
  1252. /**
  1253. * The policy to attach to the specified origin endpoint.
  1254. */
  1255. Policy: PolicyText;
  1256. }
  1257. export interface PutOriginEndpointPolicyResponse {
  1258. }
  1259. export type ResourceDescription = string;
  1260. export type ResourceName = string;
  1261. export interface Scte {
  1262. /**
  1263. * The SCTE-35 message types that you want to be treated as ad markers in the output.
  1264. */
  1265. ScteFilter?: ScteFilterList;
  1266. }
  1267. export interface ScteDash {
  1268. /**
  1269. * 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.
  1270. */
  1271. AdMarkerDash?: AdMarkerDash;
  1272. }
  1273. export type ScteFilter = "SPLICE_INSERT"|"BREAK"|"PROVIDER_ADVERTISEMENT"|"DISTRIBUTOR_ADVERTISEMENT"|"PROVIDER_PLACEMENT_OPPORTUNITY"|"DISTRIBUTOR_PLACEMENT_OPPORTUNITY"|"PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY"|"DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"|"PROGRAM"|string;
  1274. export type ScteFilterList = ScteFilter[];
  1275. export interface ScteHls {
  1276. /**
  1277. * 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: 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.
  1278. */
  1279. AdMarkerHls?: AdMarkerHls;
  1280. }
  1281. export interface Segment {
  1282. /**
  1283. * 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.
  1284. */
  1285. SegmentDurationSeconds?: SegmentSegmentDurationSecondsInteger;
  1286. /**
  1287. * 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.
  1288. */
  1289. SegmentName?: SegmentSegmentNameString;
  1290. /**
  1291. * 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.
  1292. */
  1293. TsUseAudioRenditionGroup?: Boolean;
  1294. /**
  1295. * 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.
  1296. */
  1297. IncludeIframeOnlyStreams?: Boolean;
  1298. /**
  1299. * By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.
  1300. */
  1301. TsIncludeDvbSubtitles?: Boolean;
  1302. /**
  1303. * The SCTE configuration options in the segment settings.
  1304. */
  1305. Scte?: Scte;
  1306. Encryption?: Encryption;
  1307. }
  1308. export type SegmentSegmentDurationSecondsInteger = number;
  1309. export type SegmentSegmentNameString = string;
  1310. export interface SpekeKeyProvider {
  1311. /**
  1312. * 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.
  1313. */
  1314. EncryptionContractConfiguration: EncryptionContractConfiguration;
  1315. /**
  1316. * 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
  1317. */
  1318. ResourceId: SpekeKeyProviderResourceIdString;
  1319. /**
  1320. * The DRM solution provider you're using to protect your content during distribution.
  1321. */
  1322. DrmSystems: SpekeKeyProviderDrmSystemsList;
  1323. /**
  1324. * 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
  1325. */
  1326. RoleArn: SpekeKeyProviderRoleArnString;
  1327. /**
  1328. * 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
  1329. */
  1330. Url: SpekeKeyProviderUrlString;
  1331. }
  1332. export type SpekeKeyProviderDrmSystemsList = DrmSystem[];
  1333. export type SpekeKeyProviderResourceIdString = string;
  1334. export type SpekeKeyProviderRoleArnString = string;
  1335. export type SpekeKeyProviderUrlString = string;
  1336. export type String = string;
  1337. export type TagArn = string;
  1338. export type TagKey = string;
  1339. export type TagKeyList = TagKey[];
  1340. export type TagMap = {[key: string]: TagValue};
  1341. export interface TagResourceRequest {
  1342. /**
  1343. * The ARN of the MediaPackage resource that you're adding tags to.
  1344. */
  1345. ResourceArn: TagArn;
  1346. /**
  1347. * Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
  1348. */
  1349. Tags: TagMap;
  1350. }
  1351. export type TagValue = string;
  1352. export type Timestamp = Date;
  1353. export type TsEncryptionMethod = "AES_128"|"SAMPLE_AES"|string;
  1354. export interface UntagResourceRequest {
  1355. /**
  1356. * The ARN of the MediaPackage resource that you're removing tags from.
  1357. */
  1358. ResourceArn: TagArn;
  1359. /**
  1360. * The list of tag keys to remove from the resource.
  1361. */
  1362. TagKeys: TagKeyList;
  1363. }
  1364. export interface UpdateChannelGroupRequest {
  1365. /**
  1366. * 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.
  1367. */
  1368. ChannelGroupName: ResourceName;
  1369. /**
  1370. * The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.
  1371. */
  1372. ETag?: EntityTag;
  1373. /**
  1374. * Any descriptive information that you want to add to the channel group for future identification purposes.
  1375. */
  1376. Description?: ResourceDescription;
  1377. }
  1378. export interface UpdateChannelGroupResponse {
  1379. /**
  1380. * 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.
  1381. */
  1382. ChannelGroupName: String;
  1383. /**
  1384. * The Amazon Resource Name (ARN) associated with the resource.
  1385. */
  1386. Arn: String;
  1387. /**
  1388. * The output domain where the source stream is sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.
  1389. */
  1390. EgressDomain: String;
  1391. /**
  1392. * The date and time the channel group was created.
  1393. */
  1394. CreatedAt: Timestamp;
  1395. /**
  1396. * The date and time the channel group was modified.
  1397. */
  1398. ModifiedAt: Timestamp;
  1399. /**
  1400. * The description for your channel group.
  1401. */
  1402. Description?: ResourceDescription;
  1403. /**
  1404. * The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
  1405. */
  1406. ETag?: EntityTag;
  1407. /**
  1408. * The comma-separated list of tag key:value pairs assigned to the channel group.
  1409. */
  1410. Tags?: TagMap;
  1411. }
  1412. export interface UpdateChannelRequest {
  1413. /**
  1414. * 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.
  1415. */
  1416. ChannelGroupName: ResourceName;
  1417. /**
  1418. * 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.
  1419. */
  1420. ChannelName: ResourceName;
  1421. /**
  1422. * The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.
  1423. */
  1424. ETag?: EntityTag;
  1425. /**
  1426. * Any descriptive information that you want to add to the channel for future identification purposes.
  1427. */
  1428. Description?: ResourceDescription;
  1429. }
  1430. export interface UpdateChannelResponse {
  1431. /**
  1432. * The Amazon Resource Name (ARN) associated with the resource.
  1433. */
  1434. Arn: String;
  1435. /**
  1436. * 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.
  1437. */
  1438. ChannelName: String;
  1439. /**
  1440. * 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.
  1441. */
  1442. ChannelGroupName: String;
  1443. /**
  1444. * The date and time the channel was created.
  1445. */
  1446. CreatedAt: Timestamp;
  1447. /**
  1448. * The date and time the channel was modified.
  1449. */
  1450. ModifiedAt: Timestamp;
  1451. /**
  1452. * The description for your channel.
  1453. */
  1454. Description?: ResourceDescription;
  1455. IngestEndpoints?: IngestEndpointList;
  1456. /**
  1457. * The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
  1458. */
  1459. ETag?: EntityTag;
  1460. /**
  1461. * The comma-separated list of tag key:value pairs assigned to the channel.
  1462. */
  1463. Tags?: TagMap;
  1464. }
  1465. export interface UpdateOriginEndpointRequest {
  1466. /**
  1467. * 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.
  1468. */
  1469. ChannelGroupName: ResourceName;
  1470. /**
  1471. * 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.
  1472. */
  1473. ChannelName: ResourceName;
  1474. /**
  1475. * 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.
  1476. */
  1477. OriginEndpointName: ResourceName;
  1478. /**
  1479. * 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.
  1480. */
  1481. ContainerType: ContainerType;
  1482. /**
  1483. * The segment configuration, including the segment name, duration, and other configuration values.
  1484. */
  1485. Segment?: Segment;
  1486. /**
  1487. * Any descriptive information that you want to add to the origin endpoint for future identification purposes.
  1488. */
  1489. Description?: ResourceDescription;
  1490. /**
  1491. * The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).
  1492. */
  1493. StartoverWindowSeconds?: UpdateOriginEndpointRequestStartoverWindowSecondsInteger;
  1494. /**
  1495. * An HTTP live streaming (HLS) manifest configuration.
  1496. */
  1497. HlsManifests?: CreateHlsManifests;
  1498. /**
  1499. * A low-latency HLS manifest configuration.
  1500. */
  1501. LowLatencyHlsManifests?: CreateLowLatencyHlsManifests;
  1502. /**
  1503. * A DASH manifest configuration.
  1504. */
  1505. DashManifests?: CreateDashManifests;
  1506. /**
  1507. * The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.
  1508. */
  1509. ETag?: EntityTag;
  1510. }
  1511. export type UpdateOriginEndpointRequestStartoverWindowSecondsInteger = number;
  1512. export interface UpdateOriginEndpointResponse {
  1513. /**
  1514. * The ARN associated with the resource.
  1515. */
  1516. Arn: String;
  1517. /**
  1518. * 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.
  1519. */
  1520. ChannelGroupName: ResourceName;
  1521. /**
  1522. * 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.
  1523. */
  1524. ChannelName: ResourceName;
  1525. /**
  1526. * 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.
  1527. */
  1528. OriginEndpointName: ResourceName;
  1529. /**
  1530. * The type of container attached to this origin endpoint.
  1531. */
  1532. ContainerType: ContainerType;
  1533. /**
  1534. * The segment configuration, including the segment name, duration, and other configuration values.
  1535. */
  1536. Segment: Segment;
  1537. /**
  1538. * The date and time the origin endpoint was created.
  1539. */
  1540. CreatedAt: Timestamp;
  1541. /**
  1542. * The date and time the origin endpoint was modified.
  1543. */
  1544. ModifiedAt: Timestamp;
  1545. /**
  1546. * The description of the origin endpoint.
  1547. */
  1548. Description?: ResourceDescription;
  1549. /**
  1550. * The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
  1551. */
  1552. StartoverWindowSeconds?: Integer;
  1553. /**
  1554. * An HTTP live streaming (HLS) manifest configuration.
  1555. */
  1556. HlsManifests?: GetHlsManifests;
  1557. /**
  1558. * A low-latency HLS manifest configuration.
  1559. */
  1560. LowLatencyHlsManifests?: GetLowLatencyHlsManifests;
  1561. /**
  1562. * The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
  1563. */
  1564. ETag?: EntityTag;
  1565. /**
  1566. * The comma-separated list of tag key:value pairs assigned to the origin endpoint.
  1567. */
  1568. Tags?: TagMap;
  1569. /**
  1570. * A DASH manifest configuration.
  1571. */
  1572. DashManifests?: GetDashManifests;
  1573. }
  1574. /**
  1575. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  1576. */
  1577. export type apiVersion = "2022-12-25"|"latest"|string;
  1578. export interface ClientApiVersions {
  1579. /**
  1580. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  1581. */
  1582. apiVersion?: apiVersion;
  1583. }
  1584. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  1585. /**
  1586. * Contains interfaces for use with the MediaPackageV2 client.
  1587. */
  1588. export import Types = MediaPackageV2;
  1589. }
  1590. export = MediaPackageV2;