chimesdkmediapipelines.d.ts 86 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092
  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 ChimeSDKMediaPipelines extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: ChimeSDKMediaPipelines.Types.ClientConfiguration)
  13. config: Config & ChimeSDKMediaPipelines.Types.ClientConfiguration;
  14. /**
  15. * Creates a media pipeline.
  16. */
  17. createMediaCapturePipeline(params: ChimeSDKMediaPipelines.Types.CreateMediaCapturePipelineRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaCapturePipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaCapturePipelineResponse, AWSError>;
  18. /**
  19. * Creates a media pipeline.
  20. */
  21. createMediaCapturePipeline(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaCapturePipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaCapturePipelineResponse, AWSError>;
  22. /**
  23. * Creates a media concatenation pipeline.
  24. */
  25. createMediaConcatenationPipeline(params: ChimeSDKMediaPipelines.Types.CreateMediaConcatenationPipelineRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaConcatenationPipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaConcatenationPipelineResponse, AWSError>;
  26. /**
  27. * Creates a media concatenation pipeline.
  28. */
  29. createMediaConcatenationPipeline(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaConcatenationPipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaConcatenationPipelineResponse, AWSError>;
  30. /**
  31. * Creates a media insights pipeline.
  32. */
  33. createMediaInsightsPipeline(params: ChimeSDKMediaPipelines.Types.CreateMediaInsightsPipelineRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaInsightsPipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaInsightsPipelineResponse, AWSError>;
  34. /**
  35. * Creates a media insights pipeline.
  36. */
  37. createMediaInsightsPipeline(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaInsightsPipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaInsightsPipelineResponse, AWSError>;
  38. /**
  39. * A structure that contains the static configurations for a media insights pipeline.
  40. */
  41. createMediaInsightsPipelineConfiguration(params: ChimeSDKMediaPipelines.Types.CreateMediaInsightsPipelineConfigurationRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaInsightsPipelineConfigurationResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaInsightsPipelineConfigurationResponse, AWSError>;
  42. /**
  43. * A structure that contains the static configurations for a media insights pipeline.
  44. */
  45. createMediaInsightsPipelineConfiguration(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaInsightsPipelineConfigurationResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaInsightsPipelineConfigurationResponse, AWSError>;
  46. /**
  47. * Creates a media live connector pipeline in an Amazon Chime SDK meeting.
  48. */
  49. createMediaLiveConnectorPipeline(params: ChimeSDKMediaPipelines.Types.CreateMediaLiveConnectorPipelineRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaLiveConnectorPipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaLiveConnectorPipelineResponse, AWSError>;
  50. /**
  51. * Creates a media live connector pipeline in an Amazon Chime SDK meeting.
  52. */
  53. createMediaLiveConnectorPipeline(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaLiveConnectorPipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaLiveConnectorPipelineResponse, AWSError>;
  54. /**
  55. * Creates an Kinesis video stream pool for the media pipeline.
  56. */
  57. createMediaPipelineKinesisVideoStreamPool(params: ChimeSDKMediaPipelines.Types.CreateMediaPipelineKinesisVideoStreamPoolRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaPipelineKinesisVideoStreamPoolResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaPipelineKinesisVideoStreamPoolResponse, AWSError>;
  58. /**
  59. * Creates an Kinesis video stream pool for the media pipeline.
  60. */
  61. createMediaPipelineKinesisVideoStreamPool(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaPipelineKinesisVideoStreamPoolResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaPipelineKinesisVideoStreamPoolResponse, AWSError>;
  62. /**
  63. * Creates a streaming media pipeline.
  64. */
  65. createMediaStreamPipeline(params: ChimeSDKMediaPipelines.Types.CreateMediaStreamPipelineRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaStreamPipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaStreamPipelineResponse, AWSError>;
  66. /**
  67. * Creates a streaming media pipeline.
  68. */
  69. createMediaStreamPipeline(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.CreateMediaStreamPipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.CreateMediaStreamPipelineResponse, AWSError>;
  70. /**
  71. * Deletes the media pipeline.
  72. */
  73. deleteMediaCapturePipeline(params: ChimeSDKMediaPipelines.Types.DeleteMediaCapturePipelineRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  74. /**
  75. * Deletes the media pipeline.
  76. */
  77. deleteMediaCapturePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  78. /**
  79. * Deletes the specified configuration settings.
  80. */
  81. deleteMediaInsightsPipelineConfiguration(params: ChimeSDKMediaPipelines.Types.DeleteMediaInsightsPipelineConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  82. /**
  83. * Deletes the specified configuration settings.
  84. */
  85. deleteMediaInsightsPipelineConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  86. /**
  87. * Deletes the media pipeline.
  88. */
  89. deleteMediaPipeline(params: ChimeSDKMediaPipelines.Types.DeleteMediaPipelineRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  90. /**
  91. * Deletes the media pipeline.
  92. */
  93. deleteMediaPipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  94. /**
  95. * Deletes an Kinesis video stream pool.
  96. */
  97. deleteMediaPipelineKinesisVideoStreamPool(params: ChimeSDKMediaPipelines.Types.DeleteMediaPipelineKinesisVideoStreamPoolRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  98. /**
  99. * Deletes an Kinesis video stream pool.
  100. */
  101. deleteMediaPipelineKinesisVideoStreamPool(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  102. /**
  103. * Gets an existing media pipeline.
  104. */
  105. getMediaCapturePipeline(params: ChimeSDKMediaPipelines.Types.GetMediaCapturePipelineRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetMediaCapturePipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetMediaCapturePipelineResponse, AWSError>;
  106. /**
  107. * Gets an existing media pipeline.
  108. */
  109. getMediaCapturePipeline(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetMediaCapturePipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetMediaCapturePipelineResponse, AWSError>;
  110. /**
  111. * Gets the configuration settings for a media insights pipeline.
  112. */
  113. getMediaInsightsPipelineConfiguration(params: ChimeSDKMediaPipelines.Types.GetMediaInsightsPipelineConfigurationRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetMediaInsightsPipelineConfigurationResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetMediaInsightsPipelineConfigurationResponse, AWSError>;
  114. /**
  115. * Gets the configuration settings for a media insights pipeline.
  116. */
  117. getMediaInsightsPipelineConfiguration(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetMediaInsightsPipelineConfigurationResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetMediaInsightsPipelineConfigurationResponse, AWSError>;
  118. /**
  119. * Gets an existing media pipeline.
  120. */
  121. getMediaPipeline(params: ChimeSDKMediaPipelines.Types.GetMediaPipelineRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetMediaPipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetMediaPipelineResponse, AWSError>;
  122. /**
  123. * Gets an existing media pipeline.
  124. */
  125. getMediaPipeline(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetMediaPipelineResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetMediaPipelineResponse, AWSError>;
  126. /**
  127. * Gets an Kinesis video stream pool.
  128. */
  129. getMediaPipelineKinesisVideoStreamPool(params: ChimeSDKMediaPipelines.Types.GetMediaPipelineKinesisVideoStreamPoolRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetMediaPipelineKinesisVideoStreamPoolResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetMediaPipelineKinesisVideoStreamPoolResponse, AWSError>;
  130. /**
  131. * Gets an Kinesis video stream pool.
  132. */
  133. getMediaPipelineKinesisVideoStreamPool(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetMediaPipelineKinesisVideoStreamPoolResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetMediaPipelineKinesisVideoStreamPoolResponse, AWSError>;
  134. /**
  135. * Retrieves the details of the specified speaker search task.
  136. */
  137. getSpeakerSearchTask(params: ChimeSDKMediaPipelines.Types.GetSpeakerSearchTaskRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetSpeakerSearchTaskResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetSpeakerSearchTaskResponse, AWSError>;
  138. /**
  139. * Retrieves the details of the specified speaker search task.
  140. */
  141. getSpeakerSearchTask(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetSpeakerSearchTaskResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetSpeakerSearchTaskResponse, AWSError>;
  142. /**
  143. * Retrieves the details of a voice tone analysis task.
  144. */
  145. getVoiceToneAnalysisTask(params: ChimeSDKMediaPipelines.Types.GetVoiceToneAnalysisTaskRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetVoiceToneAnalysisTaskResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetVoiceToneAnalysisTaskResponse, AWSError>;
  146. /**
  147. * Retrieves the details of a voice tone analysis task.
  148. */
  149. getVoiceToneAnalysisTask(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.GetVoiceToneAnalysisTaskResponse) => void): Request<ChimeSDKMediaPipelines.Types.GetVoiceToneAnalysisTaskResponse, AWSError>;
  150. /**
  151. * Returns a list of media pipelines.
  152. */
  153. listMediaCapturePipelines(params: ChimeSDKMediaPipelines.Types.ListMediaCapturePipelinesRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.ListMediaCapturePipelinesResponse) => void): Request<ChimeSDKMediaPipelines.Types.ListMediaCapturePipelinesResponse, AWSError>;
  154. /**
  155. * Returns a list of media pipelines.
  156. */
  157. listMediaCapturePipelines(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.ListMediaCapturePipelinesResponse) => void): Request<ChimeSDKMediaPipelines.Types.ListMediaCapturePipelinesResponse, AWSError>;
  158. /**
  159. * Lists the available media insights pipeline configurations.
  160. */
  161. listMediaInsightsPipelineConfigurations(params: ChimeSDKMediaPipelines.Types.ListMediaInsightsPipelineConfigurationsRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.ListMediaInsightsPipelineConfigurationsResponse) => void): Request<ChimeSDKMediaPipelines.Types.ListMediaInsightsPipelineConfigurationsResponse, AWSError>;
  162. /**
  163. * Lists the available media insights pipeline configurations.
  164. */
  165. listMediaInsightsPipelineConfigurations(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.ListMediaInsightsPipelineConfigurationsResponse) => void): Request<ChimeSDKMediaPipelines.Types.ListMediaInsightsPipelineConfigurationsResponse, AWSError>;
  166. /**
  167. * Lists the video stream pools in the media pipeline.
  168. */
  169. listMediaPipelineKinesisVideoStreamPools(params: ChimeSDKMediaPipelines.Types.ListMediaPipelineKinesisVideoStreamPoolsRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.ListMediaPipelineKinesisVideoStreamPoolsResponse) => void): Request<ChimeSDKMediaPipelines.Types.ListMediaPipelineKinesisVideoStreamPoolsResponse, AWSError>;
  170. /**
  171. * Lists the video stream pools in the media pipeline.
  172. */
  173. listMediaPipelineKinesisVideoStreamPools(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.ListMediaPipelineKinesisVideoStreamPoolsResponse) => void): Request<ChimeSDKMediaPipelines.Types.ListMediaPipelineKinesisVideoStreamPoolsResponse, AWSError>;
  174. /**
  175. * Returns a list of media pipelines.
  176. */
  177. listMediaPipelines(params: ChimeSDKMediaPipelines.Types.ListMediaPipelinesRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.ListMediaPipelinesResponse) => void): Request<ChimeSDKMediaPipelines.Types.ListMediaPipelinesResponse, AWSError>;
  178. /**
  179. * Returns a list of media pipelines.
  180. */
  181. listMediaPipelines(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.ListMediaPipelinesResponse) => void): Request<ChimeSDKMediaPipelines.Types.ListMediaPipelinesResponse, AWSError>;
  182. /**
  183. * Lists the tags available for a media pipeline.
  184. */
  185. listTagsForResource(params: ChimeSDKMediaPipelines.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.ListTagsForResourceResponse) => void): Request<ChimeSDKMediaPipelines.Types.ListTagsForResourceResponse, AWSError>;
  186. /**
  187. * Lists the tags available for a media pipeline.
  188. */
  189. listTagsForResource(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.ListTagsForResourceResponse) => void): Request<ChimeSDKMediaPipelines.Types.ListTagsForResourceResponse, AWSError>;
  190. /**
  191. * Starts a speaker search task. Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
  192. */
  193. startSpeakerSearchTask(params: ChimeSDKMediaPipelines.Types.StartSpeakerSearchTaskRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.StartSpeakerSearchTaskResponse) => void): Request<ChimeSDKMediaPipelines.Types.StartSpeakerSearchTaskResponse, AWSError>;
  194. /**
  195. * Starts a speaker search task. Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
  196. */
  197. startSpeakerSearchTask(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.StartSpeakerSearchTaskResponse) => void): Request<ChimeSDKMediaPipelines.Types.StartSpeakerSearchTaskResponse, AWSError>;
  198. /**
  199. * Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
  200. */
  201. startVoiceToneAnalysisTask(params: ChimeSDKMediaPipelines.Types.StartVoiceToneAnalysisTaskRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.StartVoiceToneAnalysisTaskResponse) => void): Request<ChimeSDKMediaPipelines.Types.StartVoiceToneAnalysisTaskResponse, AWSError>;
  202. /**
  203. * Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
  204. */
  205. startVoiceToneAnalysisTask(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.StartVoiceToneAnalysisTaskResponse) => void): Request<ChimeSDKMediaPipelines.Types.StartVoiceToneAnalysisTaskResponse, AWSError>;
  206. /**
  207. * Stops a speaker search task.
  208. */
  209. stopSpeakerSearchTask(params: ChimeSDKMediaPipelines.Types.StopSpeakerSearchTaskRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  210. /**
  211. * Stops a speaker search task.
  212. */
  213. stopSpeakerSearchTask(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  214. /**
  215. * Stops a voice tone analysis task.
  216. */
  217. stopVoiceToneAnalysisTask(params: ChimeSDKMediaPipelines.Types.StopVoiceToneAnalysisTaskRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  218. /**
  219. * Stops a voice tone analysis task.
  220. */
  221. stopVoiceToneAnalysisTask(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  222. /**
  223. * The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.
  224. */
  225. tagResource(params: ChimeSDKMediaPipelines.Types.TagResourceRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.TagResourceResponse) => void): Request<ChimeSDKMediaPipelines.Types.TagResourceResponse, AWSError>;
  226. /**
  227. * The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.
  228. */
  229. tagResource(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.TagResourceResponse) => void): Request<ChimeSDKMediaPipelines.Types.TagResourceResponse, AWSError>;
  230. /**
  231. * Removes any tags from a media pipeline.
  232. */
  233. untagResource(params: ChimeSDKMediaPipelines.Types.UntagResourceRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.UntagResourceResponse) => void): Request<ChimeSDKMediaPipelines.Types.UntagResourceResponse, AWSError>;
  234. /**
  235. * Removes any tags from a media pipeline.
  236. */
  237. untagResource(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.UntagResourceResponse) => void): Request<ChimeSDKMediaPipelines.Types.UntagResourceResponse, AWSError>;
  238. /**
  239. * Updates the media insights pipeline's configuration settings.
  240. */
  241. updateMediaInsightsPipelineConfiguration(params: ChimeSDKMediaPipelines.Types.UpdateMediaInsightsPipelineConfigurationRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.UpdateMediaInsightsPipelineConfigurationResponse) => void): Request<ChimeSDKMediaPipelines.Types.UpdateMediaInsightsPipelineConfigurationResponse, AWSError>;
  242. /**
  243. * Updates the media insights pipeline's configuration settings.
  244. */
  245. updateMediaInsightsPipelineConfiguration(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.UpdateMediaInsightsPipelineConfigurationResponse) => void): Request<ChimeSDKMediaPipelines.Types.UpdateMediaInsightsPipelineConfigurationResponse, AWSError>;
  246. /**
  247. * Updates the status of a media insights pipeline.
  248. */
  249. updateMediaInsightsPipelineStatus(params: ChimeSDKMediaPipelines.Types.UpdateMediaInsightsPipelineStatusRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  250. /**
  251. * Updates the status of a media insights pipeline.
  252. */
  253. updateMediaInsightsPipelineStatus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  254. /**
  255. * Updates an Kinesis video stream pool in a media pipeline.
  256. */
  257. updateMediaPipelineKinesisVideoStreamPool(params: ChimeSDKMediaPipelines.Types.UpdateMediaPipelineKinesisVideoStreamPoolRequest, callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.UpdateMediaPipelineKinesisVideoStreamPoolResponse) => void): Request<ChimeSDKMediaPipelines.Types.UpdateMediaPipelineKinesisVideoStreamPoolResponse, AWSError>;
  258. /**
  259. * Updates an Kinesis video stream pool in a media pipeline.
  260. */
  261. updateMediaPipelineKinesisVideoStreamPool(callback?: (err: AWSError, data: ChimeSDKMediaPipelines.Types.UpdateMediaPipelineKinesisVideoStreamPoolResponse) => void): Request<ChimeSDKMediaPipelines.Types.UpdateMediaPipelineKinesisVideoStreamPoolResponse, AWSError>;
  262. }
  263. declare namespace ChimeSDKMediaPipelines {
  264. export interface ActiveSpeakerOnlyConfiguration {
  265. /**
  266. * The position of the ActiveSpeakerOnly video tile.
  267. */
  268. ActiveSpeakerPosition?: ActiveSpeakerPosition;
  269. }
  270. export type ActiveSpeakerPosition = "TopLeft"|"TopRight"|"BottomLeft"|"BottomRight"|string;
  271. export type AmazonResourceName = string;
  272. export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
  273. /**
  274. * The language code in the configuration.
  275. */
  276. LanguageCode: CallAnalyticsLanguageCode;
  277. /**
  278. * Specifies the name of the custom vocabulary to use when processing a transcription. Note that vocabulary names are case sensitive. If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription. For more information, see Custom vocabularies in the Amazon Transcribe Developer Guide. Length Constraints: Minimum length of 1. Maximum length of 200.
  279. */
  280. VocabularyName?: VocabularyName;
  281. /**
  282. * Specifies the name of the custom vocabulary filter to use when processing a transcription. Note that vocabulary filter names are case sensitive. If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription. For more information, see Using vocabulary filtering with unwanted words in the Amazon Transcribe Developer Guide. Length Constraints: Minimum length of 1. Maximum length of 200.
  283. */
  284. VocabularyFilterName?: VocabularyFilterName;
  285. /**
  286. * Specifies how to apply a vocabulary filter to a transcript. To replace words with ***, choose mask. To delete words, choose remove. To flag words without changing them, choose tag.
  287. */
  288. VocabularyFilterMethod?: VocabularyFilterMethod;
  289. /**
  290. * Specifies the name of the custom language model to use when processing a transcription. Note that language model names are case sensitive. The language of the specified language model must match the language code specified in the transcription request. If the languages don't match, the custom language model isn't applied. Language mismatches don't generate errors or warnings. For more information, see Custom language models in the Amazon Transcribe Developer Guide.
  291. */
  292. LanguageModelName?: ModelName;
  293. /**
  294. * Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.
  295. */
  296. EnablePartialResultsStabilization?: Boolean;
  297. /**
  298. * Specifies the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization). Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.
  299. */
  300. PartialResultsStability?: PartialResultsStability;
  301. /**
  302. * Labels all personally identifiable information (PII) identified in your transcript. Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment. You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you do, your request returns a BadRequestException. For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.
  303. */
  304. ContentIdentificationType?: ContentType;
  305. /**
  306. * Redacts all personally identifiable information (PII) identified in your transcript. Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment. You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you do, your request returns a BadRequestException. For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.
  307. */
  308. ContentRedactionType?: ContentType;
  309. /**
  310. * Specifies the types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL. To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both. Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL. Length Constraints: Minimum length of 1. Maximum length of 300.
  311. */
  312. PiiEntityTypes?: PiiEntityTypes;
  313. /**
  314. * If true, UtteranceEvents with IsPartial: true are filtered out of the insights target.
  315. */
  316. FilterPartialResults?: Boolean;
  317. /**
  318. * The settings for a post-call analysis task in an analytics configuration.
  319. */
  320. PostCallAnalyticsSettings?: PostCallAnalyticsSettings;
  321. /**
  322. * By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.
  323. */
  324. CallAnalyticsStreamCategories?: CategoryNameList;
  325. }
  326. export interface AmazonTranscribeProcessorConfiguration {
  327. /**
  328. * The language code that represents the language spoken in your audio. If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification. For a list of languages that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.
  329. */
  330. LanguageCode?: CallAnalyticsLanguageCode;
  331. /**
  332. * The name of the custom vocabulary that you specified in your Call Analytics request. Length Constraints: Minimum length of 1. Maximum length of 200.
  333. */
  334. VocabularyName?: VocabularyName;
  335. /**
  336. * The name of the custom vocabulary filter that you specified in your Call Analytics request. Length Constraints: Minimum length of 1. Maximum length of 200.
  337. */
  338. VocabularyFilterName?: VocabularyFilterName;
  339. /**
  340. * The vocabulary filtering method used in your Call Analytics transcription.
  341. */
  342. VocabularyFilterMethod?: VocabularyFilterMethod;
  343. /**
  344. * Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file. For more information, see Partitioning speakers (diarization) in the Amazon Transcribe Developer Guide.
  345. */
  346. ShowSpeakerLabel?: Boolean;
  347. /**
  348. * Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.
  349. */
  350. EnablePartialResultsStabilization?: Boolean;
  351. /**
  352. * The level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization). Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.
  353. */
  354. PartialResultsStability?: PartialResultsStability;
  355. /**
  356. * Labels all personally identifiable information (PII) identified in your transcript. Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment. You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException. For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.
  357. */
  358. ContentIdentificationType?: ContentType;
  359. /**
  360. * Redacts all personally identifiable information (PII) identified in your transcript. Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment. You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException. For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.
  361. */
  362. ContentRedactionType?: ContentType;
  363. /**
  364. * The types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL. To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both. Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL. If you leave this parameter empty, the default behavior is equivalent to ALL.
  365. */
  366. PiiEntityTypes?: PiiEntityTypes;
  367. /**
  368. * The name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive. The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch. For more information, see Custom language models in the Amazon Transcribe Developer Guide.
  369. */
  370. LanguageModelName?: ModelName;
  371. /**
  372. * If true, TranscriptEvents with IsPartial: true are filtered out of the insights target.
  373. */
  374. FilterPartialResults?: Boolean;
  375. /**
  376. * Turns language identification on or off.
  377. */
  378. IdentifyLanguage?: Boolean;
  379. /**
  380. * The language options for the transcription, such as automatic language detection.
  381. */
  382. LanguageOptions?: LanguageOptions;
  383. /**
  384. * The preferred language for the transcription.
  385. */
  386. PreferredLanguage?: CallAnalyticsLanguageCode;
  387. /**
  388. * The names of the custom vocabulary or vocabularies used during transcription.
  389. */
  390. VocabularyNames?: VocabularyNames;
  391. /**
  392. * The names of the custom vocabulary filter or filters using during transcription.
  393. */
  394. VocabularyFilterNames?: VocabularyFilterNames;
  395. }
  396. export type Arn = string;
  397. export interface ArtifactsConcatenationConfiguration {
  398. /**
  399. * The configuration for the audio artifacts concatenation.
  400. */
  401. Audio: AudioConcatenationConfiguration;
  402. /**
  403. * The configuration for the video artifacts concatenation.
  404. */
  405. Video: VideoConcatenationConfiguration;
  406. /**
  407. * The configuration for the content artifacts concatenation.
  408. */
  409. Content: ContentConcatenationConfiguration;
  410. /**
  411. * The configuration for the data channel artifacts concatenation.
  412. */
  413. DataChannel: DataChannelConcatenationConfiguration;
  414. /**
  415. * The configuration for the transcription messages artifacts concatenation.
  416. */
  417. TranscriptionMessages: TranscriptionMessagesConcatenationConfiguration;
  418. /**
  419. * The configuration for the meeting events artifacts concatenation.
  420. */
  421. MeetingEvents: MeetingEventsConcatenationConfiguration;
  422. /**
  423. * The configuration for the composited video artifacts concatenation.
  424. */
  425. CompositedVideo: CompositedVideoConcatenationConfiguration;
  426. }
  427. export type ArtifactsConcatenationState = "Enabled"|"Disabled"|string;
  428. export interface ArtifactsConfiguration {
  429. /**
  430. * The configuration for the audio artifacts.
  431. */
  432. Audio: AudioArtifactsConfiguration;
  433. /**
  434. * The configuration for the video artifacts.
  435. */
  436. Video: VideoArtifactsConfiguration;
  437. /**
  438. * The configuration for the content artifacts.
  439. */
  440. Content: ContentArtifactsConfiguration;
  441. /**
  442. * Enables video compositing.
  443. */
  444. CompositedVideo?: CompositedVideoArtifactsConfiguration;
  445. }
  446. export type ArtifactsState = "Enabled"|"Disabled"|string;
  447. export type AttendeeIdList = GuidString[];
  448. export type AudioArtifactsConcatenationState = "Enabled"|string;
  449. export interface AudioArtifactsConfiguration {
  450. /**
  451. * The MUX type of the audio artifact configuration object.
  452. */
  453. MuxType: AudioMuxType;
  454. }
  455. export type AudioChannelsOption = "Stereo"|"Mono"|string;
  456. export interface AudioConcatenationConfiguration {
  457. /**
  458. * Enables or disables the configuration object.
  459. */
  460. State: AudioArtifactsConcatenationState;
  461. }
  462. export type AudioMuxType = "AudioOnly"|"AudioWithActiveSpeakerVideo"|"AudioWithCompositedVideo"|string;
  463. export type AudioSampleRateOption = string;
  464. export type AwsRegion = string;
  465. export type Boolean = boolean;
  466. export type BorderColor = "Black"|"Blue"|"Red"|"Green"|"White"|"Yellow"|string;
  467. export type BorderThickness = number;
  468. export type CallAnalyticsLanguageCode = "en-US"|"en-GB"|"es-US"|"fr-CA"|"fr-FR"|"en-AU"|"it-IT"|"de-DE"|"pt-BR"|string;
  469. export type CanvasOrientation = "Landscape"|"Portrait"|string;
  470. export type CategoryName = string;
  471. export type CategoryNameList = CategoryName[];
  472. export interface ChannelDefinition {
  473. /**
  474. * The channel ID.
  475. */
  476. ChannelId: ChannelId;
  477. /**
  478. * Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER.
  479. */
  480. ParticipantRole?: ParticipantRole;
  481. }
  482. export type ChannelDefinitions = ChannelDefinition[];
  483. export type ChannelId = number;
  484. export interface ChimeSdkMeetingConcatenationConfiguration {
  485. /**
  486. * The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.
  487. */
  488. ArtifactsConfiguration: ArtifactsConcatenationConfiguration;
  489. }
  490. export interface ChimeSdkMeetingConfiguration {
  491. /**
  492. * The source configuration for a specified media pipeline.
  493. */
  494. SourceConfiguration?: SourceConfiguration;
  495. /**
  496. * The configuration for the artifacts in an Amazon Chime SDK meeting.
  497. */
  498. ArtifactsConfiguration?: ArtifactsConfiguration;
  499. }
  500. export interface ChimeSdkMeetingLiveConnectorConfiguration {
  501. /**
  502. * The configuration object's Chime SDK meeting ARN.
  503. */
  504. Arn: Arn;
  505. /**
  506. * The configuration object's multiplex type.
  507. */
  508. MuxType: LiveConnectorMuxType;
  509. /**
  510. * The media pipeline's composited video.
  511. */
  512. CompositedVideo?: CompositedVideoArtifactsConfiguration;
  513. /**
  514. * The source configuration settings of the media pipeline's configuration object.
  515. */
  516. SourceConfiguration?: SourceConfiguration;
  517. }
  518. export type ClientRequestToken = string;
  519. export interface CompositedVideoArtifactsConfiguration {
  520. /**
  521. * The layout setting, such as GridView in the configuration object.
  522. */
  523. Layout?: LayoutOption;
  524. /**
  525. * The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
  526. */
  527. Resolution?: ResolutionOption;
  528. /**
  529. * The GridView configuration setting.
  530. */
  531. GridViewConfiguration: GridViewConfiguration;
  532. }
  533. export interface CompositedVideoConcatenationConfiguration {
  534. /**
  535. * Enables or disables the configuration object.
  536. */
  537. State: ArtifactsConcatenationState;
  538. }
  539. export interface ConcatenationSink {
  540. /**
  541. * The type of data sink in the configuration object.
  542. */
  543. Type: ConcatenationSinkType;
  544. /**
  545. * The configuration settings for an Amazon S3 bucket sink.
  546. */
  547. S3BucketSinkConfiguration: S3BucketSinkConfiguration;
  548. }
  549. export type ConcatenationSinkList = ConcatenationSink[];
  550. export type ConcatenationSinkType = "S3Bucket"|string;
  551. export interface ConcatenationSource {
  552. /**
  553. * The type of concatenation source in a configuration object.
  554. */
  555. Type: ConcatenationSourceType;
  556. /**
  557. * The concatenation settings for the media pipeline in a configuration object.
  558. */
  559. MediaCapturePipelineSourceConfiguration: MediaCapturePipelineSourceConfiguration;
  560. }
  561. export type ConcatenationSourceList = ConcatenationSource[];
  562. export type ConcatenationSourceType = "MediaCapturePipeline"|string;
  563. export interface ContentArtifactsConfiguration {
  564. /**
  565. * Indicates whether the content artifact is enabled or disabled.
  566. */
  567. State: ArtifactsState;
  568. /**
  569. * The MUX type of the artifact configuration.
  570. */
  571. MuxType?: ContentMuxType;
  572. }
  573. export interface ContentConcatenationConfiguration {
  574. /**
  575. * Enables or disables the configuration object.
  576. */
  577. State: ArtifactsConcatenationState;
  578. }
  579. export type ContentMuxType = "ContentOnly"|string;
  580. export type ContentRedactionOutput = "redacted"|"redacted_and_unredacted"|string;
  581. export type ContentShareLayoutOption = "PresenterOnly"|"Horizontal"|"Vertical"|"ActiveSpeakerOnly"|string;
  582. export type ContentType = "PII"|string;
  583. export type CornerRadius = number;
  584. export interface CreateMediaCapturePipelineRequest {
  585. /**
  586. * Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
  587. */
  588. SourceType: MediaPipelineSourceType;
  589. /**
  590. * ARN of the source from which the media artifacts are captured.
  591. */
  592. SourceArn: Arn;
  593. /**
  594. * Destination type to which the media artifacts are saved. You must use an S3 bucket.
  595. */
  596. SinkType: MediaPipelineSinkType;
  597. /**
  598. * The ARN of the sink type.
  599. */
  600. SinkArn: Arn;
  601. /**
  602. * The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.
  603. */
  604. ClientRequestToken?: ClientRequestToken;
  605. /**
  606. * The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.
  607. */
  608. ChimeSdkMeetingConfiguration?: ChimeSdkMeetingConfiguration;
  609. /**
  610. * The tag key-value pairs.
  611. */
  612. Tags?: TagList;
  613. }
  614. export interface CreateMediaCapturePipelineResponse {
  615. /**
  616. * A media pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media pipeline object.
  617. */
  618. MediaCapturePipeline?: MediaCapturePipeline;
  619. }
  620. export interface CreateMediaConcatenationPipelineRequest {
  621. /**
  622. * An object that specifies the sources for the media concatenation pipeline.
  623. */
  624. Sources: ConcatenationSourceList;
  625. /**
  626. * An object that specifies the data sinks for the media concatenation pipeline.
  627. */
  628. Sinks: ConcatenationSinkList;
  629. /**
  630. * The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media concatenation pipeline request.
  631. */
  632. ClientRequestToken?: ClientRequestToken;
  633. /**
  634. * The tags associated with the media concatenation pipeline.
  635. */
  636. Tags?: TagList;
  637. }
  638. export interface CreateMediaConcatenationPipelineResponse {
  639. /**
  640. * A media concatenation pipeline object, the ID, source type, MediaPipelineARN, and sink of a media concatenation pipeline object.
  641. */
  642. MediaConcatenationPipeline?: MediaConcatenationPipeline;
  643. }
  644. export interface CreateMediaInsightsPipelineConfigurationRequest {
  645. /**
  646. * The name of the media insights pipeline configuration.
  647. */
  648. MediaInsightsPipelineConfigurationName: MediaInsightsPipelineConfigurationNameString;
  649. /**
  650. * The ARN of the role used by the service to access Amazon Web Services resources, including Transcribe and Transcribe Call Analytics, on the caller’s behalf.
  651. */
  652. ResourceAccessRoleArn: Arn;
  653. /**
  654. * The configuration settings for the real-time alerts in a media insights pipeline configuration.
  655. */
  656. RealTimeAlertConfiguration?: RealTimeAlertConfiguration;
  657. /**
  658. * The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream.
  659. */
  660. Elements: MediaInsightsPipelineConfigurationElements;
  661. /**
  662. * The tags assigned to the media insights pipeline configuration.
  663. */
  664. Tags?: TagList;
  665. /**
  666. * The unique identifier for the media insights pipeline configuration request.
  667. */
  668. ClientRequestToken?: ClientRequestToken;
  669. }
  670. export interface CreateMediaInsightsPipelineConfigurationResponse {
  671. /**
  672. * The configuration settings for the media insights pipeline.
  673. */
  674. MediaInsightsPipelineConfiguration?: MediaInsightsPipelineConfiguration;
  675. }
  676. export interface CreateMediaInsightsPipelineRequest {
  677. /**
  678. * The ARN of the pipeline's configuration.
  679. */
  680. MediaInsightsPipelineConfigurationArn: Arn;
  681. /**
  682. * The runtime configuration for the Kinesis video stream source of the media insights pipeline.
  683. */
  684. KinesisVideoStreamSourceRuntimeConfiguration?: KinesisVideoStreamSourceRuntimeConfiguration;
  685. /**
  686. * The runtime metadata for the media insights pipeline. Consists of a key-value map of strings.
  687. */
  688. MediaInsightsRuntimeMetadata?: MediaInsightsRuntimeMetadata;
  689. /**
  690. * The runtime configuration for the Kinesis video recording stream source.
  691. */
  692. KinesisVideoStreamRecordingSourceRuntimeConfiguration?: KinesisVideoStreamRecordingSourceRuntimeConfiguration;
  693. /**
  694. * The runtime configuration for the S3 recording sink. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration.
  695. */
  696. S3RecordingSinkRuntimeConfiguration?: S3RecordingSinkRuntimeConfiguration;
  697. /**
  698. * The tags assigned to the media insights pipeline.
  699. */
  700. Tags?: TagList;
  701. /**
  702. * The unique identifier for the media insights pipeline request.
  703. */
  704. ClientRequestToken?: ClientRequestToken;
  705. }
  706. export interface CreateMediaInsightsPipelineResponse {
  707. /**
  708. * The media insights pipeline object.
  709. */
  710. MediaInsightsPipeline: MediaInsightsPipeline;
  711. }
  712. export interface CreateMediaLiveConnectorPipelineRequest {
  713. /**
  714. * The media live connector pipeline's data sources.
  715. */
  716. Sources: LiveConnectorSourceList;
  717. /**
  718. * The media live connector pipeline's data sinks.
  719. */
  720. Sinks: LiveConnectorSinkList;
  721. /**
  722. * The token assigned to the client making the request.
  723. */
  724. ClientRequestToken?: ClientRequestToken;
  725. /**
  726. * The tags associated with the media live connector pipeline.
  727. */
  728. Tags?: TagList;
  729. }
  730. export interface CreateMediaLiveConnectorPipelineResponse {
  731. /**
  732. * The new media live connector pipeline.
  733. */
  734. MediaLiveConnectorPipeline?: MediaLiveConnectorPipeline;
  735. }
  736. export interface CreateMediaPipelineKinesisVideoStreamPoolRequest {
  737. /**
  738. * The configuration settings for the video stream.
  739. */
  740. StreamConfiguration: KinesisVideoStreamConfiguration;
  741. /**
  742. * The name of the video stream pool.
  743. */
  744. PoolName: KinesisVideoStreamPoolName;
  745. /**
  746. * The token assigned to the client making the request.
  747. */
  748. ClientRequestToken?: ClientRequestToken;
  749. /**
  750. * The tags assigned to the video stream pool.
  751. */
  752. Tags?: TagList;
  753. }
  754. export interface CreateMediaPipelineKinesisVideoStreamPoolResponse {
  755. /**
  756. * The configuration for the Kinesis video stream pool.
  757. */
  758. KinesisVideoStreamPoolConfiguration?: KinesisVideoStreamPoolConfiguration;
  759. }
  760. export interface CreateMediaStreamPipelineRequest {
  761. /**
  762. * The data sources for the media pipeline.
  763. */
  764. Sources: MediaStreamSourceList;
  765. /**
  766. * The data sink for the media pipeline.
  767. */
  768. Sinks: MediaStreamSinkList;
  769. /**
  770. * The token assigned to the client making the request.
  771. */
  772. ClientRequestToken?: ClientRequestToken;
  773. /**
  774. * The tags assigned to the media pipeline.
  775. */
  776. Tags?: TagList;
  777. }
  778. export interface CreateMediaStreamPipelineResponse {
  779. /**
  780. * The requested media pipeline.
  781. */
  782. MediaStreamPipeline?: MediaStreamPipeline;
  783. }
  784. export interface DataChannelConcatenationConfiguration {
  785. /**
  786. * Enables or disables the configuration object.
  787. */
  788. State: ArtifactsConcatenationState;
  789. }
  790. export type DataRetentionChangeInHours = number;
  791. export type DataRetentionInHours = number;
  792. export interface DeleteMediaCapturePipelineRequest {
  793. /**
  794. * The ID of the media pipeline being deleted.
  795. */
  796. MediaPipelineId: GuidString;
  797. }
  798. export interface DeleteMediaInsightsPipelineConfigurationRequest {
  799. /**
  800. * The unique identifier of the resource to be deleted. Valid values include the name and ARN of the media insights pipeline configuration.
  801. */
  802. Identifier: NonEmptyString;
  803. }
  804. export interface DeleteMediaPipelineKinesisVideoStreamPoolRequest {
  805. /**
  806. * The ID of the pool being deleted.
  807. */
  808. Identifier: NonEmptyString;
  809. }
  810. export interface DeleteMediaPipelineRequest {
  811. /**
  812. * The ID of the media pipeline to delete.
  813. */
  814. MediaPipelineId: GuidString;
  815. }
  816. export type ExternalUserIdList = ExternalUserIdType[];
  817. export type ExternalUserIdType = string;
  818. export type FragmentNumberString = string;
  819. export interface FragmentSelector {
  820. /**
  821. * The origin of the timestamps to use, Server or Producer. For more information, see StartSelectorType in the Amazon Kinesis Video Streams Developer Guide.
  822. */
  823. FragmentSelectorType: FragmentSelectorType;
  824. /**
  825. * The range of timestamps to return.
  826. */
  827. TimestampRange: TimestampRange;
  828. }
  829. export type FragmentSelectorType = "ProducerTimestamp"|"ServerTimestamp"|string;
  830. export interface GetMediaCapturePipelineRequest {
  831. /**
  832. * The ID of the pipeline that you want to get.
  833. */
  834. MediaPipelineId: GuidString;
  835. }
  836. export interface GetMediaCapturePipelineResponse {
  837. /**
  838. * The media pipeline object.
  839. */
  840. MediaCapturePipeline?: MediaCapturePipeline;
  841. }
  842. export interface GetMediaInsightsPipelineConfigurationRequest {
  843. /**
  844. * The unique identifier of the requested resource. Valid values include the name and ARN of the media insights pipeline configuration.
  845. */
  846. Identifier: NonEmptyString;
  847. }
  848. export interface GetMediaInsightsPipelineConfigurationResponse {
  849. /**
  850. * The requested media insights pipeline configuration.
  851. */
  852. MediaInsightsPipelineConfiguration?: MediaInsightsPipelineConfiguration;
  853. }
  854. export interface GetMediaPipelineKinesisVideoStreamPoolRequest {
  855. /**
  856. * The ID of the video stream pool.
  857. */
  858. Identifier: NonEmptyString;
  859. }
  860. export interface GetMediaPipelineKinesisVideoStreamPoolResponse {
  861. /**
  862. * The video stream pool configuration object.
  863. */
  864. KinesisVideoStreamPoolConfiguration?: KinesisVideoStreamPoolConfiguration;
  865. }
  866. export interface GetMediaPipelineRequest {
  867. /**
  868. * The ID of the pipeline that you want to get.
  869. */
  870. MediaPipelineId: GuidString;
  871. }
  872. export interface GetMediaPipelineResponse {
  873. /**
  874. * The media pipeline object.
  875. */
  876. MediaPipeline?: MediaPipeline;
  877. }
  878. export interface GetSpeakerSearchTaskRequest {
  879. /**
  880. * The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
  881. */
  882. Identifier: NonEmptyString;
  883. /**
  884. * The ID of the speaker search task.
  885. */
  886. SpeakerSearchTaskId: GuidString;
  887. }
  888. export interface GetSpeakerSearchTaskResponse {
  889. /**
  890. * The details of the speaker search task.
  891. */
  892. SpeakerSearchTask?: SpeakerSearchTask;
  893. }
  894. export interface GetVoiceToneAnalysisTaskRequest {
  895. /**
  896. * The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
  897. */
  898. Identifier: NonEmptyString;
  899. /**
  900. * The ID of the voice tone analysis task.
  901. */
  902. VoiceToneAnalysisTaskId: GuidString;
  903. }
  904. export interface GetVoiceToneAnalysisTaskResponse {
  905. /**
  906. * The details of the voice tone analysis task.
  907. */
  908. VoiceToneAnalysisTask?: VoiceToneAnalysisTask;
  909. }
  910. export interface GridViewConfiguration {
  911. /**
  912. * Defines the layout of the video tiles when content sharing is enabled.
  913. */
  914. ContentShareLayout: ContentShareLayoutOption;
  915. /**
  916. * Defines the configuration options for a presenter only video tile.
  917. */
  918. PresenterOnlyConfiguration?: PresenterOnlyConfiguration;
  919. /**
  920. * The configuration settings for an ActiveSpeakerOnly video tile.
  921. */
  922. ActiveSpeakerOnlyConfiguration?: ActiveSpeakerOnlyConfiguration;
  923. /**
  924. * The configuration settings for a horizontal layout.
  925. */
  926. HorizontalLayoutConfiguration?: HorizontalLayoutConfiguration;
  927. /**
  928. * The configuration settings for a vertical layout.
  929. */
  930. VerticalLayoutConfiguration?: VerticalLayoutConfiguration;
  931. /**
  932. * The attribute settings for the video tiles.
  933. */
  934. VideoAttribute?: VideoAttribute;
  935. /**
  936. * The orientation setting, horizontal or vertical.
  937. */
  938. CanvasOrientation?: CanvasOrientation;
  939. }
  940. export type GuidString = string;
  941. export type HighlightColor = "Black"|"Blue"|"Red"|"Green"|"White"|"Yellow"|string;
  942. export interface HorizontalLayoutConfiguration {
  943. /**
  944. * Sets the automatic ordering of the video tiles.
  945. */
  946. TileOrder?: TileOrder;
  947. /**
  948. * Sets the position of horizontal tiles.
  949. */
  950. TilePosition?: HorizontalTilePosition;
  951. /**
  952. * The maximum number of video tiles to display.
  953. */
  954. TileCount?: TileCount;
  955. /**
  956. * Specifies the aspect ratio of all video tiles.
  957. */
  958. TileAspectRatio?: TileAspectRatio;
  959. }
  960. export type HorizontalTilePosition = "Top"|"Bottom"|string;
  961. export type Iso8601Timestamp = Date;
  962. export interface IssueDetectionConfiguration {
  963. /**
  964. * The name of the issue detection rule.
  965. */
  966. RuleName: RuleName;
  967. }
  968. export type Keyword = string;
  969. export interface KeywordMatchConfiguration {
  970. /**
  971. * The name of the keyword match rule.
  972. */
  973. RuleName: RuleName;
  974. /**
  975. * The keywords or phrases that you want to match.
  976. */
  977. Keywords: KeywordMatchWordList;
  978. /**
  979. * Matches keywords or phrases on their presence or absence. If set to TRUE, the rule matches when all the specified keywords or phrases are absent. Default: FALSE.
  980. */
  981. Negate?: Boolean;
  982. }
  983. export type KeywordMatchWordList = Keyword[];
  984. export interface KinesisDataStreamSinkConfiguration {
  985. /**
  986. * The ARN of the sink.
  987. */
  988. InsightsTarget?: Arn;
  989. }
  990. export type KinesisVideoStreamArn = string;
  991. export interface KinesisVideoStreamConfiguration {
  992. /**
  993. * The Amazon Web Services Region of the video stream.
  994. */
  995. Region: AwsRegion;
  996. /**
  997. * The amount of time that data is retained.
  998. */
  999. DataRetentionInHours?: DataRetentionInHours;
  1000. }
  1001. export interface KinesisVideoStreamConfigurationUpdate {
  1002. /**
  1003. * The updated time that data is retained.
  1004. */
  1005. DataRetentionInHours?: DataRetentionChangeInHours;
  1006. }
  1007. export interface KinesisVideoStreamPoolConfiguration {
  1008. /**
  1009. * The ARN of the video stream pool configuration.
  1010. */
  1011. PoolArn?: Arn;
  1012. /**
  1013. * The name of the video stream pool configuration.
  1014. */
  1015. PoolName?: KinesisVideoStreamPoolName;
  1016. /**
  1017. * The ID of the video stream pool in the configuration.
  1018. */
  1019. PoolId?: KinesisVideoStreamPoolId;
  1020. /**
  1021. * The status of the video stream pool in the configuration.
  1022. */
  1023. PoolStatus?: KinesisVideoStreamPoolStatus;
  1024. /**
  1025. * The size of the video stream pool in the configuration.
  1026. */
  1027. PoolSize?: KinesisVideoStreamPoolSize;
  1028. /**
  1029. * The Kinesis video stream pool configuration object.
  1030. */
  1031. StreamConfiguration?: KinesisVideoStreamConfiguration;
  1032. /**
  1033. * The time at which the configuration was created.
  1034. */
  1035. CreatedTimestamp?: Iso8601Timestamp;
  1036. /**
  1037. * The time at which the configuration was updated.
  1038. */
  1039. UpdatedTimestamp?: Iso8601Timestamp;
  1040. }
  1041. export type KinesisVideoStreamPoolId = string;
  1042. export type KinesisVideoStreamPoolName = string;
  1043. export type KinesisVideoStreamPoolSize = number;
  1044. export type KinesisVideoStreamPoolStatus = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"FAILED"|string;
  1045. export interface KinesisVideoStreamPoolSummary {
  1046. /**
  1047. * The name of the video stream pool.
  1048. */
  1049. PoolName?: KinesisVideoStreamPoolName;
  1050. /**
  1051. * The ID of the video stream pool.
  1052. */
  1053. PoolId?: KinesisVideoStreamPoolId;
  1054. /**
  1055. * The ARN of the video stream pool.
  1056. */
  1057. PoolArn?: Arn;
  1058. }
  1059. export type KinesisVideoStreamPoolSummaryList = KinesisVideoStreamPoolSummary[];
  1060. export interface KinesisVideoStreamRecordingSourceRuntimeConfiguration {
  1061. /**
  1062. * The stream or streams to be recorded.
  1063. */
  1064. Streams: RecordingStreamList;
  1065. /**
  1066. * Describes the timestamp range and timestamp origin of a range of fragments in the Kinesis video stream.
  1067. */
  1068. FragmentSelector: FragmentSelector;
  1069. }
  1070. export interface KinesisVideoStreamSourceRuntimeConfiguration {
  1071. /**
  1072. * The streams in the source runtime configuration of a Kinesis video stream.
  1073. */
  1074. Streams: Streams;
  1075. /**
  1076. * Specifies the encoding of your input audio. Supported format: PCM (only signed 16-bit little-endian audio formats, which does not include WAV) For more information, see Media formats in the Amazon Transcribe Developer Guide.
  1077. */
  1078. MediaEncoding: MediaEncoding;
  1079. /**
  1080. * The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio. Valid Range: Minimum value of 8000. Maximum value of 48000.
  1081. */
  1082. MediaSampleRate: MediaSampleRateHertz;
  1083. }
  1084. export interface KinesisVideoStreamSourceTaskConfiguration {
  1085. /**
  1086. * The ARN of the stream.
  1087. */
  1088. StreamArn: KinesisVideoStreamArn;
  1089. /**
  1090. * The channel ID.
  1091. */
  1092. ChannelId: ChannelId;
  1093. /**
  1094. * The unique identifier of the fragment to begin processing.
  1095. */
  1096. FragmentNumber?: FragmentNumberString;
  1097. }
  1098. export interface LambdaFunctionSinkConfiguration {
  1099. /**
  1100. * The ARN of the sink.
  1101. */
  1102. InsightsTarget?: Arn;
  1103. }
  1104. export type LanguageOptions = string;
  1105. export type LayoutOption = "GridView"|string;
  1106. export interface ListMediaCapturePipelinesRequest {
  1107. /**
  1108. * The token used to retrieve the next page of results.
  1109. */
  1110. NextToken?: String;
  1111. /**
  1112. * The maximum number of results to return in a single call. Valid Range: 1 - 99.
  1113. */
  1114. MaxResults?: ResultMax;
  1115. }
  1116. export interface ListMediaCapturePipelinesResponse {
  1117. /**
  1118. * The media pipeline objects in the list.
  1119. */
  1120. MediaCapturePipelines?: MediaCapturePipelineSummaryList;
  1121. /**
  1122. * The token used to retrieve the next page of results.
  1123. */
  1124. NextToken?: String;
  1125. }
  1126. export interface ListMediaInsightsPipelineConfigurationsRequest {
  1127. /**
  1128. * The token used to return the next page of results.
  1129. */
  1130. NextToken?: String;
  1131. /**
  1132. * The maximum number of results to return in a single call.
  1133. */
  1134. MaxResults?: ResultMax;
  1135. }
  1136. export interface ListMediaInsightsPipelineConfigurationsResponse {
  1137. /**
  1138. * The requested list of media insights pipeline configurations.
  1139. */
  1140. MediaInsightsPipelineConfigurations?: MediaInsightsPipelineConfigurationSummaryList;
  1141. /**
  1142. * The token used to return the next page of results.
  1143. */
  1144. NextToken?: String;
  1145. }
  1146. export interface ListMediaPipelineKinesisVideoStreamPoolsRequest {
  1147. /**
  1148. * The token used to return the next page of results.
  1149. */
  1150. NextToken?: String;
  1151. /**
  1152. * The maximum number of results to return in a single call.
  1153. */
  1154. MaxResults?: ResultMax;
  1155. }
  1156. export interface ListMediaPipelineKinesisVideoStreamPoolsResponse {
  1157. /**
  1158. * The list of video stream pools.
  1159. */
  1160. KinesisVideoStreamPools?: KinesisVideoStreamPoolSummaryList;
  1161. /**
  1162. * The token used to return the next page of results.
  1163. */
  1164. NextToken?: String;
  1165. }
  1166. export interface ListMediaPipelinesRequest {
  1167. /**
  1168. * The token used to retrieve the next page of results.
  1169. */
  1170. NextToken?: String;
  1171. /**
  1172. * The maximum number of results to return in a single call. Valid Range: 1 - 99.
  1173. */
  1174. MaxResults?: ResultMax;
  1175. }
  1176. export interface ListMediaPipelinesResponse {
  1177. /**
  1178. * The media pipeline objects in the list.
  1179. */
  1180. MediaPipelines?: MediaPipelineList;
  1181. /**
  1182. * The token used to retrieve the next page of results.
  1183. */
  1184. NextToken?: String;
  1185. }
  1186. export interface ListTagsForResourceRequest {
  1187. /**
  1188. * The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region, resource ID, and pipeline ID.
  1189. */
  1190. ResourceARN: AmazonResourceName;
  1191. }
  1192. export interface ListTagsForResourceResponse {
  1193. /**
  1194. * The tags associated with the specified media pipeline.
  1195. */
  1196. Tags?: TagList;
  1197. }
  1198. export type LiveConnectorMuxType = "AudioWithCompositedVideo"|"AudioWithActiveSpeakerVideo"|string;
  1199. export interface LiveConnectorRTMPConfiguration {
  1200. /**
  1201. * The URL of the RTMP configuration.
  1202. */
  1203. Url: SensitiveString;
  1204. /**
  1205. * The audio channels set for the RTMP configuration
  1206. */
  1207. AudioChannels?: AudioChannelsOption;
  1208. /**
  1209. * The audio sample rate set for the RTMP configuration. Default: 48000.
  1210. */
  1211. AudioSampleRate?: AudioSampleRateOption;
  1212. }
  1213. export interface LiveConnectorSinkConfiguration {
  1214. /**
  1215. * The sink configuration's sink type.
  1216. */
  1217. SinkType: LiveConnectorSinkType;
  1218. /**
  1219. * The sink configuration's RTMP configuration settings.
  1220. */
  1221. RTMPConfiguration: LiveConnectorRTMPConfiguration;
  1222. }
  1223. export type LiveConnectorSinkList = LiveConnectorSinkConfiguration[];
  1224. export type LiveConnectorSinkType = "RTMP"|string;
  1225. export interface LiveConnectorSourceConfiguration {
  1226. /**
  1227. * The source configuration's media source type.
  1228. */
  1229. SourceType: LiveConnectorSourceType;
  1230. /**
  1231. * The configuration settings of the connector pipeline.
  1232. */
  1233. ChimeSdkMeetingLiveConnectorConfiguration: ChimeSdkMeetingLiveConnectorConfiguration;
  1234. }
  1235. export type LiveConnectorSourceList = LiveConnectorSourceConfiguration[];
  1236. export type LiveConnectorSourceType = "ChimeSdkMeeting"|string;
  1237. export interface MediaCapturePipeline {
  1238. /**
  1239. * The ID of a media pipeline.
  1240. */
  1241. MediaPipelineId?: GuidString;
  1242. /**
  1243. * The ARN of the media capture pipeline
  1244. */
  1245. MediaPipelineArn?: AmazonResourceName;
  1246. /**
  1247. * Source type from which media artifacts are saved. You must use ChimeMeeting.
  1248. */
  1249. SourceType?: MediaPipelineSourceType;
  1250. /**
  1251. * ARN of the source from which the media artifacts are saved.
  1252. */
  1253. SourceArn?: Arn;
  1254. /**
  1255. * The status of the media pipeline.
  1256. */
  1257. Status?: MediaPipelineStatus;
  1258. /**
  1259. * Destination type to which the media artifacts are saved. You must use an S3 Bucket.
  1260. */
  1261. SinkType?: MediaPipelineSinkType;
  1262. /**
  1263. * ARN of the destination to which the media artifacts are saved.
  1264. */
  1265. SinkArn?: Arn;
  1266. /**
  1267. * The time at which the pipeline was created, in ISO 8601 format.
  1268. */
  1269. CreatedTimestamp?: Iso8601Timestamp;
  1270. /**
  1271. * The time at which the pipeline was updated, in ISO 8601 format.
  1272. */
  1273. UpdatedTimestamp?: Iso8601Timestamp;
  1274. /**
  1275. * The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.
  1276. */
  1277. ChimeSdkMeetingConfiguration?: ChimeSdkMeetingConfiguration;
  1278. }
  1279. export interface MediaCapturePipelineSourceConfiguration {
  1280. /**
  1281. * The media pipeline ARN in the configuration object of a media capture pipeline.
  1282. */
  1283. MediaPipelineArn: Arn;
  1284. /**
  1285. * The meeting configuration settings in a media capture pipeline configuration object.
  1286. */
  1287. ChimeSdkMeetingConfiguration: ChimeSdkMeetingConcatenationConfiguration;
  1288. }
  1289. export interface MediaCapturePipelineSummary {
  1290. /**
  1291. * The ID of the media pipeline in the summary.
  1292. */
  1293. MediaPipelineId?: GuidString;
  1294. /**
  1295. * The ARN of the media pipeline in the summary.
  1296. */
  1297. MediaPipelineArn?: AmazonResourceName;
  1298. }
  1299. export type MediaCapturePipelineSummaryList = MediaCapturePipelineSummary[];
  1300. export interface MediaConcatenationPipeline {
  1301. /**
  1302. * The ID of the media pipeline being concatenated.
  1303. */
  1304. MediaPipelineId?: GuidString;
  1305. /**
  1306. * The ARN of the media pipeline that you specify in the SourceConfiguration object.
  1307. */
  1308. MediaPipelineArn?: AmazonResourceName;
  1309. /**
  1310. * The data sources being concatenated.
  1311. */
  1312. Sources?: ConcatenationSourceList;
  1313. /**
  1314. * The data sinks of the concatenation pipeline.
  1315. */
  1316. Sinks?: ConcatenationSinkList;
  1317. /**
  1318. * The status of the concatenation pipeline.
  1319. */
  1320. Status?: MediaPipelineStatus;
  1321. /**
  1322. * The time at which the concatenation pipeline was created.
  1323. */
  1324. CreatedTimestamp?: Iso8601Timestamp;
  1325. /**
  1326. * The time at which the concatenation pipeline was last updated.
  1327. */
  1328. UpdatedTimestamp?: Iso8601Timestamp;
  1329. }
  1330. export type MediaEncoding = "pcm"|string;
  1331. export interface MediaInsightsPipeline {
  1332. /**
  1333. * The ID of a media insights pipeline.
  1334. */
  1335. MediaPipelineId?: GuidString;
  1336. /**
  1337. * The ARN of a media insights pipeline.
  1338. */
  1339. MediaPipelineArn?: Arn;
  1340. /**
  1341. * The ARN of a media insight pipeline's configuration settings.
  1342. */
  1343. MediaInsightsPipelineConfigurationArn?: Arn;
  1344. /**
  1345. * The status of a media insights pipeline.
  1346. */
  1347. Status?: MediaPipelineStatus;
  1348. /**
  1349. * The configuration settings for a Kinesis runtime video stream in a media insights pipeline.
  1350. */
  1351. KinesisVideoStreamSourceRuntimeConfiguration?: KinesisVideoStreamSourceRuntimeConfiguration;
  1352. /**
  1353. * The runtime metadata of a media insights pipeline.
  1354. */
  1355. MediaInsightsRuntimeMetadata?: MediaInsightsRuntimeMetadata;
  1356. /**
  1357. * The runtime configuration settings for a Kinesis recording video stream in a media insights pipeline.
  1358. */
  1359. KinesisVideoStreamRecordingSourceRuntimeConfiguration?: KinesisVideoStreamRecordingSourceRuntimeConfiguration;
  1360. /**
  1361. * The runtime configuration of the Amazon S3 bucket that stores recordings in a media insights pipeline.
  1362. */
  1363. S3RecordingSinkRuntimeConfiguration?: S3RecordingSinkRuntimeConfiguration;
  1364. /**
  1365. * The time at which the media insights pipeline was created.
  1366. */
  1367. CreatedTimestamp?: Iso8601Timestamp;
  1368. /**
  1369. * The statuses that the elements in a media insights pipeline can have during data processing.
  1370. */
  1371. ElementStatuses?: MediaInsightsPipelineElementStatuses;
  1372. }
  1373. export interface MediaInsightsPipelineConfiguration {
  1374. /**
  1375. * The name of the configuration.
  1376. */
  1377. MediaInsightsPipelineConfigurationName?: MediaInsightsPipelineConfigurationNameString;
  1378. /**
  1379. * The ARN of the configuration.
  1380. */
  1381. MediaInsightsPipelineConfigurationArn?: Arn;
  1382. /**
  1383. * The ARN of the role used by the service to access Amazon Web Services resources.
  1384. */
  1385. ResourceAccessRoleArn?: Arn;
  1386. /**
  1387. * Lists the rules that trigger a real-time alert.
  1388. */
  1389. RealTimeAlertConfiguration?: RealTimeAlertConfiguration;
  1390. /**
  1391. * The elements in the configuration.
  1392. */
  1393. Elements?: MediaInsightsPipelineConfigurationElements;
  1394. /**
  1395. * The ID of the configuration.
  1396. */
  1397. MediaInsightsPipelineConfigurationId?: GuidString;
  1398. /**
  1399. * The time at which the configuration was created.
  1400. */
  1401. CreatedTimestamp?: Iso8601Timestamp;
  1402. /**
  1403. * The time at which the configuration was last updated.
  1404. */
  1405. UpdatedTimestamp?: Iso8601Timestamp;
  1406. }
  1407. export interface MediaInsightsPipelineConfigurationElement {
  1408. /**
  1409. * The element type.
  1410. */
  1411. Type: MediaInsightsPipelineConfigurationElementType;
  1412. /**
  1413. * The analytics configuration settings for transcribing audio in a media insights pipeline configuration element.
  1414. */
  1415. AmazonTranscribeCallAnalyticsProcessorConfiguration?: AmazonTranscribeCallAnalyticsProcessorConfiguration;
  1416. /**
  1417. * The transcription processor configuration settings in a media insights pipeline configuration element.
  1418. */
  1419. AmazonTranscribeProcessorConfiguration?: AmazonTranscribeProcessorConfiguration;
  1420. /**
  1421. * The configuration settings for the Kinesis Data Stream Sink in a media insights pipeline configuration element.
  1422. */
  1423. KinesisDataStreamSinkConfiguration?: KinesisDataStreamSinkConfiguration;
  1424. /**
  1425. * The configuration settings for the Amazon S3 recording bucket in a media insights pipeline configuration element.
  1426. */
  1427. S3RecordingSinkConfiguration?: S3RecordingSinkConfiguration;
  1428. /**
  1429. * The voice analytics configuration settings in a media insights pipeline configuration element.
  1430. */
  1431. VoiceAnalyticsProcessorConfiguration?: VoiceAnalyticsProcessorConfiguration;
  1432. /**
  1433. * The configuration settings for the Amazon Web Services Lambda sink in a media insights pipeline configuration element.
  1434. */
  1435. LambdaFunctionSinkConfiguration?: LambdaFunctionSinkConfiguration;
  1436. /**
  1437. * The configuration settings for an SQS queue sink in a media insights pipeline configuration element.
  1438. */
  1439. SqsQueueSinkConfiguration?: SqsQueueSinkConfiguration;
  1440. /**
  1441. * The configuration settings for an SNS topic sink in a media insights pipeline configuration element.
  1442. */
  1443. SnsTopicSinkConfiguration?: SnsTopicSinkConfiguration;
  1444. /**
  1445. * The configuration settings for voice enhancement sink in a media insights pipeline configuration element.
  1446. */
  1447. VoiceEnhancementSinkConfiguration?: VoiceEnhancementSinkConfiguration;
  1448. }
  1449. export type MediaInsightsPipelineConfigurationElementType = "AmazonTranscribeCallAnalyticsProcessor"|"VoiceAnalyticsProcessor"|"AmazonTranscribeProcessor"|"KinesisDataStreamSink"|"LambdaFunctionSink"|"SqsQueueSink"|"SnsTopicSink"|"S3RecordingSink"|"VoiceEnhancementSink"|string;
  1450. export type MediaInsightsPipelineConfigurationElements = MediaInsightsPipelineConfigurationElement[];
  1451. export type MediaInsightsPipelineConfigurationNameString = string;
  1452. export interface MediaInsightsPipelineConfigurationSummary {
  1453. /**
  1454. * The name of the media insights pipeline configuration.
  1455. */
  1456. MediaInsightsPipelineConfigurationName?: MediaInsightsPipelineConfigurationNameString;
  1457. /**
  1458. * The ID of the media insights pipeline configuration.
  1459. */
  1460. MediaInsightsPipelineConfigurationId?: GuidString;
  1461. /**
  1462. * The ARN of the media insights pipeline configuration.
  1463. */
  1464. MediaInsightsPipelineConfigurationArn?: Arn;
  1465. }
  1466. export type MediaInsightsPipelineConfigurationSummaryList = MediaInsightsPipelineConfigurationSummary[];
  1467. export interface MediaInsightsPipelineElementStatus {
  1468. /**
  1469. * The type of status.
  1470. */
  1471. Type?: MediaInsightsPipelineConfigurationElementType;
  1472. /**
  1473. * The element's status.
  1474. */
  1475. Status?: MediaPipelineElementStatus;
  1476. }
  1477. export type MediaInsightsPipelineElementStatuses = MediaInsightsPipelineElementStatus[];
  1478. export type MediaInsightsRuntimeMetadata = {[key: string]: String};
  1479. export interface MediaLiveConnectorPipeline {
  1480. /**
  1481. * The connector pipeline's data sources.
  1482. */
  1483. Sources?: LiveConnectorSourceList;
  1484. /**
  1485. * The connector pipeline's data sinks.
  1486. */
  1487. Sinks?: LiveConnectorSinkList;
  1488. /**
  1489. * The connector pipeline's ID.
  1490. */
  1491. MediaPipelineId?: GuidString;
  1492. /**
  1493. * The connector pipeline's ARN.
  1494. */
  1495. MediaPipelineArn?: AmazonResourceName;
  1496. /**
  1497. * The connector pipeline's status.
  1498. */
  1499. Status?: MediaPipelineStatus;
  1500. /**
  1501. * The time at which the connector pipeline was created.
  1502. */
  1503. CreatedTimestamp?: Iso8601Timestamp;
  1504. /**
  1505. * The time at which the connector pipeline was last updated.
  1506. */
  1507. UpdatedTimestamp?: Iso8601Timestamp;
  1508. }
  1509. export interface MediaPipeline {
  1510. /**
  1511. * A pipeline that enables users to capture audio and video.
  1512. */
  1513. MediaCapturePipeline?: MediaCapturePipeline;
  1514. /**
  1515. * The connector pipeline of the media pipeline.
  1516. */
  1517. MediaLiveConnectorPipeline?: MediaLiveConnectorPipeline;
  1518. /**
  1519. * The media concatenation pipeline in a media pipeline.
  1520. */
  1521. MediaConcatenationPipeline?: MediaConcatenationPipeline;
  1522. /**
  1523. * The media insights pipeline of a media pipeline.
  1524. */
  1525. MediaInsightsPipeline?: MediaInsightsPipeline;
  1526. /**
  1527. * Designates a media pipeline as a media stream pipeline.
  1528. */
  1529. MediaStreamPipeline?: MediaStreamPipeline;
  1530. }
  1531. export type MediaPipelineElementStatus = "NotStarted"|"NotSupported"|"Initializing"|"InProgress"|"Failed"|"Stopping"|"Stopped"|"Paused"|string;
  1532. export type MediaPipelineList = MediaPipelineSummary[];
  1533. export type MediaPipelineSinkType = "S3Bucket"|string;
  1534. export type MediaPipelineSourceType = "ChimeSdkMeeting"|string;
  1535. export type MediaPipelineStatus = "Initializing"|"InProgress"|"Failed"|"Stopping"|"Stopped"|"Paused"|"NotStarted"|string;
  1536. export type MediaPipelineStatusUpdate = "Pause"|"Resume"|string;
  1537. export interface MediaPipelineSummary {
  1538. /**
  1539. * The ID of the media pipeline in the summary.
  1540. */
  1541. MediaPipelineId?: GuidString;
  1542. /**
  1543. * The ARN of the media pipeline in the summary.
  1544. */
  1545. MediaPipelineArn?: AmazonResourceName;
  1546. }
  1547. export type MediaPipelineTaskStatus = "NotStarted"|"Initializing"|"InProgress"|"Failed"|"Stopping"|"Stopped"|string;
  1548. export type MediaSampleRateHertz = number;
  1549. export interface MediaStreamPipeline {
  1550. /**
  1551. * The ID of the media stream pipeline
  1552. */
  1553. MediaPipelineId?: GuidString;
  1554. /**
  1555. * The ARN of the media stream pipeline.
  1556. */
  1557. MediaPipelineArn?: AmazonResourceName;
  1558. /**
  1559. * The time at which the media stream pipeline was created.
  1560. */
  1561. CreatedTimestamp?: Iso8601Timestamp;
  1562. /**
  1563. * The time at which the media stream pipeline was updated.
  1564. */
  1565. UpdatedTimestamp?: Iso8601Timestamp;
  1566. /**
  1567. * The status of the media stream pipeline.
  1568. */
  1569. Status?: MediaPipelineStatus;
  1570. /**
  1571. * The media stream pipeline's data sources.
  1572. */
  1573. Sources?: MediaStreamSourceList;
  1574. /**
  1575. * The media stream pipeline's data sinks.
  1576. */
  1577. Sinks?: MediaStreamSinkList;
  1578. }
  1579. export type MediaStreamPipelineSinkType = "KinesisVideoStreamPool"|string;
  1580. export interface MediaStreamSink {
  1581. /**
  1582. * The ARN of the media stream sink.
  1583. */
  1584. SinkArn: Arn;
  1585. /**
  1586. * The media stream sink's type.
  1587. */
  1588. SinkType: MediaStreamPipelineSinkType;
  1589. /**
  1590. * Specifies the number of streams that the sink can accept.
  1591. */
  1592. ReservedStreamCapacity: ReservedStreamCapacity;
  1593. /**
  1594. * The media stream sink's media stream type.
  1595. */
  1596. MediaStreamType: MediaStreamType;
  1597. }
  1598. export type MediaStreamSinkList = MediaStreamSink[];
  1599. export interface MediaStreamSource {
  1600. /**
  1601. * The type of media stream source.
  1602. */
  1603. SourceType: MediaPipelineSourceType;
  1604. /**
  1605. * The ARN of the media stream source.
  1606. */
  1607. SourceArn: Arn;
  1608. }
  1609. export type MediaStreamSourceList = MediaStreamSource[];
  1610. export type MediaStreamType = "MixedAudio"|"IndividualAudio"|string;
  1611. export interface MeetingEventsConcatenationConfiguration {
  1612. /**
  1613. * Enables or disables the configuration object.
  1614. */
  1615. State: ArtifactsConcatenationState;
  1616. }
  1617. export type ModelName = string;
  1618. export type NonEmptyString = string;
  1619. export type NumberOfChannels = number;
  1620. export type PartialResultsStability = "high"|"medium"|"low"|string;
  1621. export type ParticipantRole = "AGENT"|"CUSTOMER"|string;
  1622. export type PiiEntityTypes = string;
  1623. export interface PostCallAnalyticsSettings {
  1624. /**
  1625. * The URL of the Amazon S3 bucket that contains the post-call data.
  1626. */
  1627. OutputLocation: String;
  1628. /**
  1629. * The ARN of the role used by Amazon Web Services Transcribe to upload your post call analysis. For more information, see Post-call analytics with real-time transcriptions in the Amazon Transcribe Developer Guide.
  1630. */
  1631. DataAccessRoleArn: String;
  1632. /**
  1633. * The content redaction output settings for a post-call analysis task.
  1634. */
  1635. ContentRedactionOutput?: ContentRedactionOutput;
  1636. /**
  1637. * The ID of the KMS (Key Management Service) key used to encrypt the output.
  1638. */
  1639. OutputEncryptionKMSKeyId?: String;
  1640. }
  1641. export interface PresenterOnlyConfiguration {
  1642. /**
  1643. * Defines the position of the presenter video tile. Default: TopRight.
  1644. */
  1645. PresenterPosition?: PresenterPosition;
  1646. }
  1647. export type PresenterPosition = "TopLeft"|"TopRight"|"BottomLeft"|"BottomRight"|string;
  1648. export interface RealTimeAlertConfiguration {
  1649. /**
  1650. * Turns off real-time alerts.
  1651. */
  1652. Disabled?: Boolean;
  1653. /**
  1654. * The rules in the alert. Rules specify the words or phrases that you want to be notified about.
  1655. */
  1656. Rules?: RealTimeAlertRuleList;
  1657. }
  1658. export interface RealTimeAlertRule {
  1659. /**
  1660. * The type of alert rule.
  1661. */
  1662. Type: RealTimeAlertRuleType;
  1663. /**
  1664. * Specifies the settings for matching the keywords in a real-time alert rule.
  1665. */
  1666. KeywordMatchConfiguration?: KeywordMatchConfiguration;
  1667. /**
  1668. * Specifies the settings for predicting sentiment in a real-time alert rule.
  1669. */
  1670. SentimentConfiguration?: SentimentConfiguration;
  1671. /**
  1672. * Specifies the issue detection settings for a real-time alert rule.
  1673. */
  1674. IssueDetectionConfiguration?: IssueDetectionConfiguration;
  1675. }
  1676. export type RealTimeAlertRuleList = RealTimeAlertRule[];
  1677. export type RealTimeAlertRuleType = "KeywordMatch"|"Sentiment"|"IssueDetection"|string;
  1678. export type RecordingFileFormat = "Wav"|"Opus"|string;
  1679. export interface RecordingStreamConfiguration {
  1680. /**
  1681. * The ARN of the recording stream.
  1682. */
  1683. StreamArn?: KinesisVideoStreamArn;
  1684. }
  1685. export type RecordingStreamList = RecordingStreamConfiguration[];
  1686. export type ReservedStreamCapacity = number;
  1687. export type ResolutionOption = "HD"|"FHD"|string;
  1688. export type ResultMax = number;
  1689. export type RuleName = string;
  1690. export interface S3BucketSinkConfiguration {
  1691. /**
  1692. * The destination URL of the S3 bucket.
  1693. */
  1694. Destination: Arn;
  1695. }
  1696. export interface S3RecordingSinkConfiguration {
  1697. /**
  1698. * The default URI of the Amazon S3 bucket used as the recording sink.
  1699. */
  1700. Destination?: Arn;
  1701. /**
  1702. * The default file format for the media files sent to the Amazon S3 bucket.
  1703. */
  1704. RecordingFileFormat?: RecordingFileFormat;
  1705. }
  1706. export interface S3RecordingSinkRuntimeConfiguration {
  1707. /**
  1708. * The URI of the S3 bucket used as the sink.
  1709. */
  1710. Destination: Arn;
  1711. /**
  1712. * The file format for the media files sent to the Amazon S3 bucket.
  1713. */
  1714. RecordingFileFormat: RecordingFileFormat;
  1715. }
  1716. export interface SelectedVideoStreams {
  1717. /**
  1718. * The attendee IDs of the streams selected for a media pipeline.
  1719. */
  1720. AttendeeIds?: AttendeeIdList;
  1721. /**
  1722. * The external user IDs of the streams selected for a media pipeline.
  1723. */
  1724. ExternalUserIds?: ExternalUserIdList;
  1725. }
  1726. export type SensitiveString = string;
  1727. export interface SentimentConfiguration {
  1728. /**
  1729. * The name of the rule in the sentiment configuration.
  1730. */
  1731. RuleName: RuleName;
  1732. /**
  1733. * The type of sentiment, POSITIVE, NEGATIVE, or NEUTRAL.
  1734. */
  1735. SentimentType: SentimentType;
  1736. /**
  1737. * Specifies the analysis interval.
  1738. */
  1739. TimePeriod: SentimentTimePeriodInSeconds;
  1740. }
  1741. export type SentimentTimePeriodInSeconds = number;
  1742. export type SentimentType = "NEGATIVE"|string;
  1743. export interface SnsTopicSinkConfiguration {
  1744. /**
  1745. * The ARN of the SNS sink.
  1746. */
  1747. InsightsTarget?: Arn;
  1748. }
  1749. export interface SourceConfiguration {
  1750. /**
  1751. * The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.
  1752. */
  1753. SelectedVideoStreams?: SelectedVideoStreams;
  1754. }
  1755. export interface SpeakerSearchTask {
  1756. /**
  1757. * The speaker search task ID.
  1758. */
  1759. SpeakerSearchTaskId?: GuidString;
  1760. /**
  1761. * The status of the speaker search task.
  1762. */
  1763. SpeakerSearchTaskStatus?: MediaPipelineTaskStatus;
  1764. /**
  1765. * The time at which a speaker search task was created.
  1766. */
  1767. CreatedTimestamp?: Iso8601Timestamp;
  1768. /**
  1769. * The time at which a speaker search task was updated.
  1770. */
  1771. UpdatedTimestamp?: Iso8601Timestamp;
  1772. }
  1773. export interface SqsQueueSinkConfiguration {
  1774. /**
  1775. * The ARN of the SQS sink.
  1776. */
  1777. InsightsTarget?: Arn;
  1778. }
  1779. export interface StartSpeakerSearchTaskRequest {
  1780. /**
  1781. * The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
  1782. */
  1783. Identifier: NonEmptyString;
  1784. /**
  1785. * The ARN of the voice profile domain that will store the voice profile.
  1786. */
  1787. VoiceProfileDomainArn: Arn;
  1788. /**
  1789. * The task configuration for the Kinesis video stream source of the media insights pipeline.
  1790. */
  1791. KinesisVideoStreamSourceTaskConfiguration?: KinesisVideoStreamSourceTaskConfiguration;
  1792. /**
  1793. * The unique identifier for the client request. Use a different token for different speaker search tasks.
  1794. */
  1795. ClientRequestToken?: ClientRequestToken;
  1796. }
  1797. export interface StartSpeakerSearchTaskResponse {
  1798. /**
  1799. * The details of the speaker search task.
  1800. */
  1801. SpeakerSearchTask?: SpeakerSearchTask;
  1802. }
  1803. export interface StartVoiceToneAnalysisTaskRequest {
  1804. /**
  1805. * The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
  1806. */
  1807. Identifier: NonEmptyString;
  1808. /**
  1809. * The language code.
  1810. */
  1811. LanguageCode: VoiceAnalyticsLanguageCode;
  1812. /**
  1813. * The task configuration for the Kinesis video stream source of the media insights pipeline.
  1814. */
  1815. KinesisVideoStreamSourceTaskConfiguration?: KinesisVideoStreamSourceTaskConfiguration;
  1816. /**
  1817. * The unique identifier for the client request. Use a different token for different voice tone analysis tasks.
  1818. */
  1819. ClientRequestToken?: ClientRequestToken;
  1820. }
  1821. export interface StartVoiceToneAnalysisTaskResponse {
  1822. /**
  1823. * The details of the voice tone analysis task.
  1824. */
  1825. VoiceToneAnalysisTask?: VoiceToneAnalysisTask;
  1826. }
  1827. export interface StopSpeakerSearchTaskRequest {
  1828. /**
  1829. * The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
  1830. */
  1831. Identifier: NonEmptyString;
  1832. /**
  1833. * The speaker search task ID.
  1834. */
  1835. SpeakerSearchTaskId: GuidString;
  1836. }
  1837. export interface StopVoiceToneAnalysisTaskRequest {
  1838. /**
  1839. * The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
  1840. */
  1841. Identifier: NonEmptyString;
  1842. /**
  1843. * The ID of the voice tone analysis task.
  1844. */
  1845. VoiceToneAnalysisTaskId: GuidString;
  1846. }
  1847. export interface StreamChannelDefinition {
  1848. /**
  1849. * The number of channels in a streaming channel.
  1850. */
  1851. NumberOfChannels: NumberOfChannels;
  1852. /**
  1853. * The definitions of the channels in a streaming channel.
  1854. */
  1855. ChannelDefinitions?: ChannelDefinitions;
  1856. }
  1857. export interface StreamConfiguration {
  1858. /**
  1859. * The ARN of the stream.
  1860. */
  1861. StreamArn: KinesisVideoStreamArn;
  1862. /**
  1863. * The unique identifier of the fragment to begin processing.
  1864. */
  1865. FragmentNumber?: FragmentNumberString;
  1866. /**
  1867. * The streaming channel definition in the stream configuration.
  1868. */
  1869. StreamChannelDefinition: StreamChannelDefinition;
  1870. }
  1871. export type Streams = StreamConfiguration[];
  1872. export type String = string;
  1873. export interface Tag {
  1874. /**
  1875. * The key half of a tag.
  1876. */
  1877. Key: TagKey;
  1878. /**
  1879. * The value half of a tag.
  1880. */
  1881. Value: TagValue;
  1882. }
  1883. export type TagKey = string;
  1884. export type TagKeyList = TagKey[];
  1885. export type TagList = Tag[];
  1886. export interface TagResourceRequest {
  1887. /**
  1888. * The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID.
  1889. */
  1890. ResourceARN: AmazonResourceName;
  1891. /**
  1892. * The tags associated with the specified media pipeline.
  1893. */
  1894. Tags: TagList;
  1895. }
  1896. export interface TagResourceResponse {
  1897. }
  1898. export type TagValue = string;
  1899. export type TileAspectRatio = string;
  1900. export type TileCount = number;
  1901. export type TileOrder = "JoinSequence"|"SpeakerSequence"|string;
  1902. export type Timestamp = Date;
  1903. export interface TimestampRange {
  1904. /**
  1905. * The starting timestamp for the specified range.
  1906. */
  1907. StartTimestamp: Timestamp;
  1908. /**
  1909. * The ending timestamp for the specified range.
  1910. */
  1911. EndTimestamp: Timestamp;
  1912. }
  1913. export interface TranscriptionMessagesConcatenationConfiguration {
  1914. /**
  1915. * Enables or disables the configuration object.
  1916. */
  1917. State: ArtifactsConcatenationState;
  1918. }
  1919. export interface UntagResourceRequest {
  1920. /**
  1921. * The ARN of the pipeline that you want to untag.
  1922. */
  1923. ResourceARN: AmazonResourceName;
  1924. /**
  1925. * The key/value pairs in the tag that you want to remove.
  1926. */
  1927. TagKeys: TagKeyList;
  1928. }
  1929. export interface UntagResourceResponse {
  1930. }
  1931. export interface UpdateMediaInsightsPipelineConfigurationRequest {
  1932. /**
  1933. * The unique identifier for the resource to be updated. Valid values include the name and ARN of the media insights pipeline configuration.
  1934. */
  1935. Identifier: NonEmptyString;
  1936. /**
  1937. * The ARN of the role used by the service to access Amazon Web Services resources.
  1938. */
  1939. ResourceAccessRoleArn: Arn;
  1940. /**
  1941. * The configuration settings for real-time alerts for the media insights pipeline.
  1942. */
  1943. RealTimeAlertConfiguration?: RealTimeAlertConfiguration;
  1944. /**
  1945. * The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream..
  1946. */
  1947. Elements: MediaInsightsPipelineConfigurationElements;
  1948. }
  1949. export interface UpdateMediaInsightsPipelineConfigurationResponse {
  1950. /**
  1951. * The updated configuration settings.
  1952. */
  1953. MediaInsightsPipelineConfiguration?: MediaInsightsPipelineConfiguration;
  1954. }
  1955. export interface UpdateMediaInsightsPipelineStatusRequest {
  1956. /**
  1957. * The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.
  1958. */
  1959. Identifier: NonEmptyString;
  1960. /**
  1961. * The requested status of the media insights pipeline.
  1962. */
  1963. UpdateStatus: MediaPipelineStatusUpdate;
  1964. }
  1965. export interface UpdateMediaPipelineKinesisVideoStreamPoolRequest {
  1966. /**
  1967. * The ID of the video stream pool.
  1968. */
  1969. Identifier: NonEmptyString;
  1970. /**
  1971. * The configuration settings for the video stream.
  1972. */
  1973. StreamConfiguration?: KinesisVideoStreamConfigurationUpdate;
  1974. }
  1975. export interface UpdateMediaPipelineKinesisVideoStreamPoolResponse {
  1976. /**
  1977. * The video stream pool configuration object.
  1978. */
  1979. KinesisVideoStreamPoolConfiguration?: KinesisVideoStreamPoolConfiguration;
  1980. }
  1981. export interface VerticalLayoutConfiguration {
  1982. /**
  1983. * Sets the automatic ordering of the video tiles.
  1984. */
  1985. TileOrder?: TileOrder;
  1986. /**
  1987. * Sets the position of vertical tiles.
  1988. */
  1989. TilePosition?: VerticalTilePosition;
  1990. /**
  1991. * The maximum number of tiles to display.
  1992. */
  1993. TileCount?: TileCount;
  1994. /**
  1995. * Sets the aspect ratio of the video tiles, such as 16:9.
  1996. */
  1997. TileAspectRatio?: TileAspectRatio;
  1998. }
  1999. export type VerticalTilePosition = "Left"|"Right"|string;
  2000. export interface VideoArtifactsConfiguration {
  2001. /**
  2002. * Indicates whether the video artifact is enabled or disabled.
  2003. */
  2004. State: ArtifactsState;
  2005. /**
  2006. * The MUX type of the video artifact configuration object.
  2007. */
  2008. MuxType?: VideoMuxType;
  2009. }
  2010. export interface VideoAttribute {
  2011. /**
  2012. * Sets the corner radius of all video tiles.
  2013. */
  2014. CornerRadius?: CornerRadius;
  2015. /**
  2016. * Defines the border color of all video tiles.
  2017. */
  2018. BorderColor?: BorderColor;
  2019. /**
  2020. * Defines the highlight color for the active video tile.
  2021. */
  2022. HighlightColor?: HighlightColor;
  2023. /**
  2024. * Defines the border thickness for all video tiles.
  2025. */
  2026. BorderThickness?: BorderThickness;
  2027. }
  2028. export interface VideoConcatenationConfiguration {
  2029. /**
  2030. * Enables or disables the configuration object.
  2031. */
  2032. State: ArtifactsConcatenationState;
  2033. }
  2034. export type VideoMuxType = "VideoOnly"|string;
  2035. export type VocabularyFilterMethod = "remove"|"mask"|"tag"|string;
  2036. export type VocabularyFilterName = string;
  2037. export type VocabularyFilterNames = string;
  2038. export type VocabularyName = string;
  2039. export type VocabularyNames = string;
  2040. export type VoiceAnalyticsConfigurationStatus = "Enabled"|"Disabled"|string;
  2041. export type VoiceAnalyticsLanguageCode = "en-US"|string;
  2042. export interface VoiceAnalyticsProcessorConfiguration {
  2043. /**
  2044. * The status of the speaker search task.
  2045. */
  2046. SpeakerSearchStatus?: VoiceAnalyticsConfigurationStatus;
  2047. /**
  2048. * The status of the voice tone analysis task.
  2049. */
  2050. VoiceToneAnalysisStatus?: VoiceAnalyticsConfigurationStatus;
  2051. }
  2052. export interface VoiceEnhancementSinkConfiguration {
  2053. /**
  2054. * Disables the VoiceEnhancementSinkConfiguration element.
  2055. */
  2056. Disabled?: Boolean;
  2057. }
  2058. export interface VoiceToneAnalysisTask {
  2059. /**
  2060. * The ID of the voice tone analysis task.
  2061. */
  2062. VoiceToneAnalysisTaskId?: GuidString;
  2063. /**
  2064. * The status of a voice tone analysis task.
  2065. */
  2066. VoiceToneAnalysisTaskStatus?: MediaPipelineTaskStatus;
  2067. /**
  2068. * The time at which a voice tone analysis task was created.
  2069. */
  2070. CreatedTimestamp?: Iso8601Timestamp;
  2071. /**
  2072. * The time at which a voice tone analysis task was updated.
  2073. */
  2074. UpdatedTimestamp?: Iso8601Timestamp;
  2075. }
  2076. /**
  2077. * 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.
  2078. */
  2079. export type apiVersion = "2021-07-15"|"latest"|string;
  2080. export interface ClientApiVersions {
  2081. /**
  2082. * 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.
  2083. */
  2084. apiVersion?: apiVersion;
  2085. }
  2086. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  2087. /**
  2088. * Contains interfaces for use with the ChimeSDKMediaPipelines client.
  2089. */
  2090. export import Types = ChimeSDKMediaPipelines;
  2091. }
  2092. export = ChimeSDKMediaPipelines;