chimesdkidentity.d.ts 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179
  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 ChimeSDKIdentity extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: ChimeSDKIdentity.Types.ClientConfiguration)
  13. config: Config & ChimeSDKIdentity.Types.ClientConfiguration;
  14. /**
  15. * Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard. identity
  16. */
  17. createAppInstance(params: ChimeSDKIdentity.Types.CreateAppInstanceRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.CreateAppInstanceResponse) => void): Request<ChimeSDKIdentity.Types.CreateAppInstanceResponse, AWSError>;
  18. /**
  19. * Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard. identity
  20. */
  21. createAppInstance(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.CreateAppInstanceResponse) => void): Request<ChimeSDKIdentity.Types.CreateAppInstanceResponse, AWSError>;
  22. /**
  23. * Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.
  24. */
  25. createAppInstanceAdmin(params: ChimeSDKIdentity.Types.CreateAppInstanceAdminRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.CreateAppInstanceAdminResponse) => void): Request<ChimeSDKIdentity.Types.CreateAppInstanceAdminResponse, AWSError>;
  26. /**
  27. * Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.
  28. */
  29. createAppInstanceAdmin(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.CreateAppInstanceAdminResponse) => void): Request<ChimeSDKIdentity.Types.CreateAppInstanceAdminResponse, AWSError>;
  30. /**
  31. * Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.
  32. */
  33. createAppInstanceBot(params: ChimeSDKIdentity.Types.CreateAppInstanceBotRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.CreateAppInstanceBotResponse) => void): Request<ChimeSDKIdentity.Types.CreateAppInstanceBotResponse, AWSError>;
  34. /**
  35. * Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.
  36. */
  37. createAppInstanceBot(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.CreateAppInstanceBotResponse) => void): Request<ChimeSDKIdentity.Types.CreateAppInstanceBotResponse, AWSError>;
  38. /**
  39. * Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.
  40. */
  41. createAppInstanceUser(params: ChimeSDKIdentity.Types.CreateAppInstanceUserRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.CreateAppInstanceUserResponse) => void): Request<ChimeSDKIdentity.Types.CreateAppInstanceUserResponse, AWSError>;
  42. /**
  43. * Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.
  44. */
  45. createAppInstanceUser(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.CreateAppInstanceUserResponse) => void): Request<ChimeSDKIdentity.Types.CreateAppInstanceUserResponse, AWSError>;
  46. /**
  47. * Deletes an AppInstance and all associated data asynchronously.
  48. */
  49. deleteAppInstance(params: ChimeSDKIdentity.Types.DeleteAppInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  50. /**
  51. * Deletes an AppInstance and all associated data asynchronously.
  52. */
  53. deleteAppInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  54. /**
  55. * Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action does not delete the user.
  56. */
  57. deleteAppInstanceAdmin(params: ChimeSDKIdentity.Types.DeleteAppInstanceAdminRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  58. /**
  59. * Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action does not delete the user.
  60. */
  61. deleteAppInstanceAdmin(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  62. /**
  63. * Deletes an AppInstanceBot.
  64. */
  65. deleteAppInstanceBot(params: ChimeSDKIdentity.Types.DeleteAppInstanceBotRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  66. /**
  67. * Deletes an AppInstanceBot.
  68. */
  69. deleteAppInstanceBot(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  70. /**
  71. * Deletes an AppInstanceUser.
  72. */
  73. deleteAppInstanceUser(params: ChimeSDKIdentity.Types.DeleteAppInstanceUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  74. /**
  75. * Deletes an AppInstanceUser.
  76. */
  77. deleteAppInstanceUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  78. /**
  79. * Deregisters an AppInstanceUserEndpoint.
  80. */
  81. deregisterAppInstanceUserEndpoint(params: ChimeSDKIdentity.Types.DeregisterAppInstanceUserEndpointRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  82. /**
  83. * Deregisters an AppInstanceUserEndpoint.
  84. */
  85. deregisterAppInstanceUserEndpoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  86. /**
  87. * Returns the full details of an AppInstance.
  88. */
  89. describeAppInstance(params: ChimeSDKIdentity.Types.DescribeAppInstanceRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.DescribeAppInstanceResponse) => void): Request<ChimeSDKIdentity.Types.DescribeAppInstanceResponse, AWSError>;
  90. /**
  91. * Returns the full details of an AppInstance.
  92. */
  93. describeAppInstance(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.DescribeAppInstanceResponse) => void): Request<ChimeSDKIdentity.Types.DescribeAppInstanceResponse, AWSError>;
  94. /**
  95. * Returns the full details of an AppInstanceAdmin.
  96. */
  97. describeAppInstanceAdmin(params: ChimeSDKIdentity.Types.DescribeAppInstanceAdminRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.DescribeAppInstanceAdminResponse) => void): Request<ChimeSDKIdentity.Types.DescribeAppInstanceAdminResponse, AWSError>;
  98. /**
  99. * Returns the full details of an AppInstanceAdmin.
  100. */
  101. describeAppInstanceAdmin(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.DescribeAppInstanceAdminResponse) => void): Request<ChimeSDKIdentity.Types.DescribeAppInstanceAdminResponse, AWSError>;
  102. /**
  103. * The AppInstanceBot's information.
  104. */
  105. describeAppInstanceBot(params: ChimeSDKIdentity.Types.DescribeAppInstanceBotRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.DescribeAppInstanceBotResponse) => void): Request<ChimeSDKIdentity.Types.DescribeAppInstanceBotResponse, AWSError>;
  106. /**
  107. * The AppInstanceBot's information.
  108. */
  109. describeAppInstanceBot(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.DescribeAppInstanceBotResponse) => void): Request<ChimeSDKIdentity.Types.DescribeAppInstanceBotResponse, AWSError>;
  110. /**
  111. * Returns the full details of an AppInstanceUser.
  112. */
  113. describeAppInstanceUser(params: ChimeSDKIdentity.Types.DescribeAppInstanceUserRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.DescribeAppInstanceUserResponse) => void): Request<ChimeSDKIdentity.Types.DescribeAppInstanceUserResponse, AWSError>;
  114. /**
  115. * Returns the full details of an AppInstanceUser.
  116. */
  117. describeAppInstanceUser(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.DescribeAppInstanceUserResponse) => void): Request<ChimeSDKIdentity.Types.DescribeAppInstanceUserResponse, AWSError>;
  118. /**
  119. * Returns the full details of an AppInstanceUserEndpoint.
  120. */
  121. describeAppInstanceUserEndpoint(params: ChimeSDKIdentity.Types.DescribeAppInstanceUserEndpointRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.DescribeAppInstanceUserEndpointResponse) => void): Request<ChimeSDKIdentity.Types.DescribeAppInstanceUserEndpointResponse, AWSError>;
  122. /**
  123. * Returns the full details of an AppInstanceUserEndpoint.
  124. */
  125. describeAppInstanceUserEndpoint(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.DescribeAppInstanceUserEndpointResponse) => void): Request<ChimeSDKIdentity.Types.DescribeAppInstanceUserEndpointResponse, AWSError>;
  126. /**
  127. * Gets the retention settings for an AppInstance.
  128. */
  129. getAppInstanceRetentionSettings(params: ChimeSDKIdentity.Types.GetAppInstanceRetentionSettingsRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.GetAppInstanceRetentionSettingsResponse) => void): Request<ChimeSDKIdentity.Types.GetAppInstanceRetentionSettingsResponse, AWSError>;
  130. /**
  131. * Gets the retention settings for an AppInstance.
  132. */
  133. getAppInstanceRetentionSettings(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.GetAppInstanceRetentionSettingsResponse) => void): Request<ChimeSDKIdentity.Types.GetAppInstanceRetentionSettingsResponse, AWSError>;
  134. /**
  135. * Returns a list of the administrators in the AppInstance.
  136. */
  137. listAppInstanceAdmins(params: ChimeSDKIdentity.Types.ListAppInstanceAdminsRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListAppInstanceAdminsResponse) => void): Request<ChimeSDKIdentity.Types.ListAppInstanceAdminsResponse, AWSError>;
  138. /**
  139. * Returns a list of the administrators in the AppInstance.
  140. */
  141. listAppInstanceAdmins(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListAppInstanceAdminsResponse) => void): Request<ChimeSDKIdentity.Types.ListAppInstanceAdminsResponse, AWSError>;
  142. /**
  143. * Lists all AppInstanceBots created under a single AppInstance.
  144. */
  145. listAppInstanceBots(params: ChimeSDKIdentity.Types.ListAppInstanceBotsRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListAppInstanceBotsResponse) => void): Request<ChimeSDKIdentity.Types.ListAppInstanceBotsResponse, AWSError>;
  146. /**
  147. * Lists all AppInstanceBots created under a single AppInstance.
  148. */
  149. listAppInstanceBots(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListAppInstanceBotsResponse) => void): Request<ChimeSDKIdentity.Types.ListAppInstanceBotsResponse, AWSError>;
  150. /**
  151. * Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
  152. */
  153. listAppInstanceUserEndpoints(params: ChimeSDKIdentity.Types.ListAppInstanceUserEndpointsRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListAppInstanceUserEndpointsResponse) => void): Request<ChimeSDKIdentity.Types.ListAppInstanceUserEndpointsResponse, AWSError>;
  154. /**
  155. * Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
  156. */
  157. listAppInstanceUserEndpoints(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListAppInstanceUserEndpointsResponse) => void): Request<ChimeSDKIdentity.Types.ListAppInstanceUserEndpointsResponse, AWSError>;
  158. /**
  159. * List all AppInstanceUsers created under a single AppInstance.
  160. */
  161. listAppInstanceUsers(params: ChimeSDKIdentity.Types.ListAppInstanceUsersRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListAppInstanceUsersResponse) => void): Request<ChimeSDKIdentity.Types.ListAppInstanceUsersResponse, AWSError>;
  162. /**
  163. * List all AppInstanceUsers created under a single AppInstance.
  164. */
  165. listAppInstanceUsers(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListAppInstanceUsersResponse) => void): Request<ChimeSDKIdentity.Types.ListAppInstanceUsersResponse, AWSError>;
  166. /**
  167. * Lists all Amazon Chime AppInstances created under a single AWS account.
  168. */
  169. listAppInstances(params: ChimeSDKIdentity.Types.ListAppInstancesRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListAppInstancesResponse) => void): Request<ChimeSDKIdentity.Types.ListAppInstancesResponse, AWSError>;
  170. /**
  171. * Lists all Amazon Chime AppInstances created under a single AWS account.
  172. */
  173. listAppInstances(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListAppInstancesResponse) => void): Request<ChimeSDKIdentity.Types.ListAppInstancesResponse, AWSError>;
  174. /**
  175. * Lists the tags applied to an Amazon Chime SDK identity resource.
  176. */
  177. listTagsForResource(params: ChimeSDKIdentity.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListTagsForResourceResponse) => void): Request<ChimeSDKIdentity.Types.ListTagsForResourceResponse, AWSError>;
  178. /**
  179. * Lists the tags applied to an Amazon Chime SDK identity resource.
  180. */
  181. listTagsForResource(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.ListTagsForResourceResponse) => void): Request<ChimeSDKIdentity.Types.ListTagsForResourceResponse, AWSError>;
  182. /**
  183. * Sets the amount of time in days that a given AppInstance retains data.
  184. */
  185. putAppInstanceRetentionSettings(params: ChimeSDKIdentity.Types.PutAppInstanceRetentionSettingsRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.PutAppInstanceRetentionSettingsResponse) => void): Request<ChimeSDKIdentity.Types.PutAppInstanceRetentionSettingsResponse, AWSError>;
  186. /**
  187. * Sets the amount of time in days that a given AppInstance retains data.
  188. */
  189. putAppInstanceRetentionSettings(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.PutAppInstanceRetentionSettingsResponse) => void): Request<ChimeSDKIdentity.Types.PutAppInstanceRetentionSettingsResponse, AWSError>;
  190. /**
  191. * Sets the number of days before the AppInstanceUser is automatically deleted. A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary. Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.
  192. */
  193. putAppInstanceUserExpirationSettings(params: ChimeSDKIdentity.Types.PutAppInstanceUserExpirationSettingsRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.PutAppInstanceUserExpirationSettingsResponse) => void): Request<ChimeSDKIdentity.Types.PutAppInstanceUserExpirationSettingsResponse, AWSError>;
  194. /**
  195. * Sets the number of days before the AppInstanceUser is automatically deleted. A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary. Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.
  196. */
  197. putAppInstanceUserExpirationSettings(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.PutAppInstanceUserExpirationSettingsResponse) => void): Request<ChimeSDKIdentity.Types.PutAppInstanceUserExpirationSettingsResponse, AWSError>;
  198. /**
  199. * Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.
  200. */
  201. registerAppInstanceUserEndpoint(params: ChimeSDKIdentity.Types.RegisterAppInstanceUserEndpointRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.RegisterAppInstanceUserEndpointResponse) => void): Request<ChimeSDKIdentity.Types.RegisterAppInstanceUserEndpointResponse, AWSError>;
  202. /**
  203. * Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.
  204. */
  205. registerAppInstanceUserEndpoint(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.RegisterAppInstanceUserEndpointResponse) => void): Request<ChimeSDKIdentity.Types.RegisterAppInstanceUserEndpointResponse, AWSError>;
  206. /**
  207. * Applies the specified tags to the specified Amazon Chime SDK identity resource.
  208. */
  209. tagResource(params: ChimeSDKIdentity.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  210. /**
  211. * Applies the specified tags to the specified Amazon Chime SDK identity resource.
  212. */
  213. tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  214. /**
  215. * Removes the specified tags from the specified Amazon Chime SDK identity resource.
  216. */
  217. untagResource(params: ChimeSDKIdentity.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  218. /**
  219. * Removes the specified tags from the specified Amazon Chime SDK identity resource.
  220. */
  221. untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  222. /**
  223. * Updates AppInstance metadata.
  224. */
  225. updateAppInstance(params: ChimeSDKIdentity.Types.UpdateAppInstanceRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.UpdateAppInstanceResponse) => void): Request<ChimeSDKIdentity.Types.UpdateAppInstanceResponse, AWSError>;
  226. /**
  227. * Updates AppInstance metadata.
  228. */
  229. updateAppInstance(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.UpdateAppInstanceResponse) => void): Request<ChimeSDKIdentity.Types.UpdateAppInstanceResponse, AWSError>;
  230. /**
  231. * Updates the name and metadata of an AppInstanceBot.
  232. */
  233. updateAppInstanceBot(params: ChimeSDKIdentity.Types.UpdateAppInstanceBotRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.UpdateAppInstanceBotResponse) => void): Request<ChimeSDKIdentity.Types.UpdateAppInstanceBotResponse, AWSError>;
  234. /**
  235. * Updates the name and metadata of an AppInstanceBot.
  236. */
  237. updateAppInstanceBot(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.UpdateAppInstanceBotResponse) => void): Request<ChimeSDKIdentity.Types.UpdateAppInstanceBotResponse, AWSError>;
  238. /**
  239. * Updates the details of an AppInstanceUser. You can update names and metadata.
  240. */
  241. updateAppInstanceUser(params: ChimeSDKIdentity.Types.UpdateAppInstanceUserRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.UpdateAppInstanceUserResponse) => void): Request<ChimeSDKIdentity.Types.UpdateAppInstanceUserResponse, AWSError>;
  242. /**
  243. * Updates the details of an AppInstanceUser. You can update names and metadata.
  244. */
  245. updateAppInstanceUser(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.UpdateAppInstanceUserResponse) => void): Request<ChimeSDKIdentity.Types.UpdateAppInstanceUserResponse, AWSError>;
  246. /**
  247. * Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.
  248. */
  249. updateAppInstanceUserEndpoint(params: ChimeSDKIdentity.Types.UpdateAppInstanceUserEndpointRequest, callback?: (err: AWSError, data: ChimeSDKIdentity.Types.UpdateAppInstanceUserEndpointResponse) => void): Request<ChimeSDKIdentity.Types.UpdateAppInstanceUserEndpointResponse, AWSError>;
  250. /**
  251. * Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.
  252. */
  253. updateAppInstanceUserEndpoint(callback?: (err: AWSError, data: ChimeSDKIdentity.Types.UpdateAppInstanceUserEndpointResponse) => void): Request<ChimeSDKIdentity.Types.UpdateAppInstanceUserEndpointResponse, AWSError>;
  254. }
  255. declare namespace ChimeSDKIdentity {
  256. export type AllowMessages = "ALL"|"NONE"|string;
  257. export interface AppInstance {
  258. /**
  259. * The ARN of the messaging instance.
  260. */
  261. AppInstanceArn?: ChimeArn;
  262. /**
  263. * The name of an AppInstance.
  264. */
  265. Name?: NonEmptyResourceName;
  266. /**
  267. * The time at which an AppInstance was created. In epoch milliseconds.
  268. */
  269. CreatedTimestamp?: Timestamp;
  270. /**
  271. * The time an AppInstance was last updated. In epoch milliseconds.
  272. */
  273. LastUpdatedTimestamp?: Timestamp;
  274. /**
  275. * The metadata of an AppInstance.
  276. */
  277. Metadata?: Metadata;
  278. }
  279. export interface AppInstanceAdmin {
  280. /**
  281. * The AppInstanceAdmin data.
  282. */
  283. Admin?: Identity;
  284. /**
  285. * The ARN of the AppInstance for which the user is an administrator.
  286. */
  287. AppInstanceArn?: ChimeArn;
  288. /**
  289. * The time at which an administrator was created.
  290. */
  291. CreatedTimestamp?: Timestamp;
  292. }
  293. export type AppInstanceAdminList = AppInstanceAdminSummary[];
  294. export interface AppInstanceAdminSummary {
  295. /**
  296. * The details of the AppInstanceAdmin.
  297. */
  298. Admin?: Identity;
  299. }
  300. export interface AppInstanceBot {
  301. /**
  302. * The ARN of the AppInstanceBot.
  303. */
  304. AppInstanceBotArn?: ChimeArn;
  305. /**
  306. * The name of the AppInstanceBot.
  307. */
  308. Name?: ResourceName;
  309. /**
  310. * The data processing instructions for an AppInstanceBot.
  311. */
  312. Configuration?: Configuration;
  313. /**
  314. * The time at which the AppInstanceBot was created.
  315. */
  316. CreatedTimestamp?: Timestamp;
  317. /**
  318. * The time at which the AppInstanceBot was last updated.
  319. */
  320. LastUpdatedTimestamp?: Timestamp;
  321. /**
  322. * The metadata for an AppInstanceBot.
  323. */
  324. Metadata?: Metadata;
  325. }
  326. export type AppInstanceBotList = AppInstanceBotSummary[];
  327. export interface AppInstanceBotSummary {
  328. /**
  329. * The ARN of the AppInstanceBot.
  330. */
  331. AppInstanceBotArn?: ChimeArn;
  332. /**
  333. * The name of the AppInstanceBox.
  334. */
  335. Name?: ResourceName;
  336. /**
  337. * The metadata of the AppInstanceBot.
  338. */
  339. Metadata?: Metadata;
  340. }
  341. export type AppInstanceList = AppInstanceSummary[];
  342. export interface AppInstanceRetentionSettings {
  343. /**
  344. * The length of time in days to retain the messages in a channel.
  345. */
  346. ChannelRetentionSettings?: ChannelRetentionSettings;
  347. }
  348. export interface AppInstanceSummary {
  349. /**
  350. * The AppInstance ARN.
  351. */
  352. AppInstanceArn?: ChimeArn;
  353. /**
  354. * The name of the AppInstance.
  355. */
  356. Name?: NonEmptyResourceName;
  357. /**
  358. * The metadata of the AppInstance.
  359. */
  360. Metadata?: Metadata;
  361. }
  362. export interface AppInstanceUser {
  363. /**
  364. * The ARN of the AppInstanceUser.
  365. */
  366. AppInstanceUserArn?: ChimeArn;
  367. /**
  368. * The name of the AppInstanceUser.
  369. */
  370. Name?: UserName;
  371. /**
  372. * The metadata of the AppInstanceUser.
  373. */
  374. Metadata?: Metadata;
  375. /**
  376. * The time at which the AppInstanceUser was created.
  377. */
  378. CreatedTimestamp?: Timestamp;
  379. /**
  380. * The time at which the AppInstanceUser was last updated.
  381. */
  382. LastUpdatedTimestamp?: Timestamp;
  383. /**
  384. * The interval after which an AppInstanceUser is automatically deleted.
  385. */
  386. ExpirationSettings?: ExpirationSettings;
  387. }
  388. export interface AppInstanceUserEndpoint {
  389. /**
  390. * The ARN of the AppInstanceUser.
  391. */
  392. AppInstanceUserArn?: ChimeArn;
  393. /**
  394. * The unique identifier of the AppInstanceUserEndpoint.
  395. */
  396. EndpointId?: String64;
  397. /**
  398. * The name of the AppInstanceUserEndpoint.
  399. */
  400. Name?: SensitiveString1600;
  401. /**
  402. * The type of the AppInstanceUserEndpoint.
  403. */
  404. Type?: AppInstanceUserEndpointType;
  405. /**
  406. * The ARN of the resource to which the endpoint belongs.
  407. */
  408. ResourceArn?: ChimeArn;
  409. /**
  410. * The attributes of an Endpoint.
  411. */
  412. EndpointAttributes?: EndpointAttributes;
  413. /**
  414. * The time at which an AppInstanceUserEndpoint was created.
  415. */
  416. CreatedTimestamp?: Timestamp;
  417. /**
  418. * The time at which an AppInstanceUserEndpoint was last updated.
  419. */
  420. LastUpdatedTimestamp?: Timestamp;
  421. /**
  422. * Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.
  423. */
  424. AllowMessages?: AllowMessages;
  425. /**
  426. * A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values: ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty. INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason. INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.
  427. */
  428. EndpointState?: EndpointState;
  429. }
  430. export interface AppInstanceUserEndpointSummary {
  431. /**
  432. * The ARN of the AppInstanceUser.
  433. */
  434. AppInstanceUserArn?: ChimeArn;
  435. /**
  436. * The unique identifier of the AppInstanceUserEndpoint.
  437. */
  438. EndpointId?: String64;
  439. /**
  440. * The name of the AppInstanceUserEndpoint.
  441. */
  442. Name?: SensitiveString1600;
  443. /**
  444. * The type of the AppInstanceUserEndpoint.
  445. */
  446. Type?: AppInstanceUserEndpointType;
  447. /**
  448. * BBoolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.
  449. */
  450. AllowMessages?: AllowMessages;
  451. /**
  452. * A read-only field that represent the state of an AppInstanceUserEndpoint.
  453. */
  454. EndpointState?: EndpointState;
  455. }
  456. export type AppInstanceUserEndpointSummaryList = AppInstanceUserEndpointSummary[];
  457. export type AppInstanceUserEndpointType = "APNS"|"APNS_SANDBOX"|"GCM"|string;
  458. export type AppInstanceUserList = AppInstanceUserSummary[];
  459. export interface AppInstanceUserSummary {
  460. /**
  461. * The ARN of the AppInstanceUser.
  462. */
  463. AppInstanceUserArn?: ChimeArn;
  464. /**
  465. * The name of an AppInstanceUser.
  466. */
  467. Name?: UserName;
  468. /**
  469. * The metadata of the AppInstanceUser.
  470. */
  471. Metadata?: Metadata;
  472. }
  473. export interface ChannelRetentionSettings {
  474. /**
  475. * The time in days to retain the messages in a channel.
  476. */
  477. RetentionDays?: RetentionDays;
  478. }
  479. export type ChimeArn = string;
  480. export type ClientRequestToken = string;
  481. export interface Configuration {
  482. /**
  483. * The configuration for an Amazon Lex V2 bot.
  484. */
  485. Lex: LexConfiguration;
  486. }
  487. export interface CreateAppInstanceAdminRequest {
  488. /**
  489. * The ARN of the administrator of the current AppInstance.
  490. */
  491. AppInstanceAdminArn: ChimeArn;
  492. /**
  493. * The ARN of the AppInstance.
  494. */
  495. AppInstanceArn: ChimeArn;
  496. }
  497. export interface CreateAppInstanceAdminResponse {
  498. /**
  499. * The ARN and name of the administrator, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.
  500. */
  501. AppInstanceAdmin?: Identity;
  502. /**
  503. * The ARN of the of the admin for the AppInstance.
  504. */
  505. AppInstanceArn?: ChimeArn;
  506. }
  507. export interface CreateAppInstanceBotRequest {
  508. /**
  509. * The ARN of the AppInstance request.
  510. */
  511. AppInstanceArn: ChimeArn;
  512. /**
  513. * The user's name.
  514. */
  515. Name?: ResourceName;
  516. /**
  517. * The request metadata. Limited to a 1KB string in UTF-8.
  518. */
  519. Metadata?: Metadata;
  520. /**
  521. * The unique ID for the client making the request. Use different tokens for different AppInstanceBots.
  522. */
  523. ClientRequestToken: ClientRequestToken;
  524. /**
  525. * The tags assigned to the AppInstanceBot.
  526. */
  527. Tags?: TagList;
  528. /**
  529. * Configuration information about the Amazon Lex V2 V2 bot.
  530. */
  531. Configuration: Configuration;
  532. }
  533. export interface CreateAppInstanceBotResponse {
  534. /**
  535. * The ARN of the AppinstanceBot.
  536. */
  537. AppInstanceBotArn?: ChimeArn;
  538. }
  539. export interface CreateAppInstanceRequest {
  540. /**
  541. * The name of the AppInstance.
  542. */
  543. Name: NonEmptyResourceName;
  544. /**
  545. * The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
  546. */
  547. Metadata?: Metadata;
  548. /**
  549. * The unique ID of the request. Use different tokens to create different AppInstances.
  550. */
  551. ClientRequestToken: ClientRequestToken;
  552. /**
  553. * Tags assigned to the AppInstance.
  554. */
  555. Tags?: TagList;
  556. }
  557. export interface CreateAppInstanceResponse {
  558. /**
  559. * The Amazon Resource Number (ARN) of the AppInstance.
  560. */
  561. AppInstanceArn?: ChimeArn;
  562. }
  563. export interface CreateAppInstanceUserRequest {
  564. /**
  565. * The ARN of the AppInstance request.
  566. */
  567. AppInstanceArn: ChimeArn;
  568. /**
  569. * The user ID of the AppInstance.
  570. */
  571. AppInstanceUserId: UserId;
  572. /**
  573. * The user's name.
  574. */
  575. Name: UserName;
  576. /**
  577. * The request's metadata. Limited to a 1KB string in UTF-8.
  578. */
  579. Metadata?: Metadata;
  580. /**
  581. * The unique ID of the request. Use different tokens to request additional AppInstances.
  582. */
  583. ClientRequestToken: ClientRequestToken;
  584. /**
  585. * Tags assigned to the AppInstanceUser.
  586. */
  587. Tags?: TagList;
  588. /**
  589. * Settings that control the interval after which the AppInstanceUser is automatically deleted.
  590. */
  591. ExpirationSettings?: ExpirationSettings;
  592. }
  593. export interface CreateAppInstanceUserResponse {
  594. /**
  595. * The user's ARN.
  596. */
  597. AppInstanceUserArn?: ChimeArn;
  598. }
  599. export interface DeleteAppInstanceAdminRequest {
  600. /**
  601. * The ARN of the AppInstance's administrator.
  602. */
  603. AppInstanceAdminArn: ChimeArn;
  604. /**
  605. * The ARN of the AppInstance.
  606. */
  607. AppInstanceArn: ChimeArn;
  608. }
  609. export interface DeleteAppInstanceBotRequest {
  610. /**
  611. * The ARN of the AppInstanceBot being deleted.
  612. */
  613. AppInstanceBotArn: ChimeArn;
  614. }
  615. export interface DeleteAppInstanceRequest {
  616. /**
  617. * The ARN of the AppInstance.
  618. */
  619. AppInstanceArn: ChimeArn;
  620. }
  621. export interface DeleteAppInstanceUserRequest {
  622. /**
  623. * The ARN of the user request being deleted.
  624. */
  625. AppInstanceUserArn: ChimeArn;
  626. }
  627. export interface DeregisterAppInstanceUserEndpointRequest {
  628. /**
  629. * The ARN of the AppInstanceUser.
  630. */
  631. AppInstanceUserArn: ChimeArn;
  632. /**
  633. * The unique identifier of the AppInstanceUserEndpoint.
  634. */
  635. EndpointId: String64;
  636. }
  637. export interface DescribeAppInstanceAdminRequest {
  638. /**
  639. * The ARN of the AppInstanceAdmin.
  640. */
  641. AppInstanceAdminArn: ChimeArn;
  642. /**
  643. * The ARN of the AppInstance.
  644. */
  645. AppInstanceArn: ChimeArn;
  646. }
  647. export interface DescribeAppInstanceAdminResponse {
  648. /**
  649. * The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.
  650. */
  651. AppInstanceAdmin?: AppInstanceAdmin;
  652. }
  653. export interface DescribeAppInstanceBotRequest {
  654. /**
  655. * The ARN of the AppInstanceBot.
  656. */
  657. AppInstanceBotArn: ChimeArn;
  658. }
  659. export interface DescribeAppInstanceBotResponse {
  660. /**
  661. * The detials of the AppInstanceBot.
  662. */
  663. AppInstanceBot?: AppInstanceBot;
  664. }
  665. export interface DescribeAppInstanceRequest {
  666. /**
  667. * The ARN of the AppInstance.
  668. */
  669. AppInstanceArn: ChimeArn;
  670. }
  671. export interface DescribeAppInstanceResponse {
  672. /**
  673. * The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds.
  674. */
  675. AppInstance?: AppInstance;
  676. }
  677. export interface DescribeAppInstanceUserEndpointRequest {
  678. /**
  679. * The ARN of the AppInstanceUser.
  680. */
  681. AppInstanceUserArn: String1600;
  682. /**
  683. * The unique identifier of the AppInstanceUserEndpoint.
  684. */
  685. EndpointId: String64;
  686. }
  687. export interface DescribeAppInstanceUserEndpointResponse {
  688. /**
  689. * The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.
  690. */
  691. AppInstanceUserEndpoint?: AppInstanceUserEndpoint;
  692. }
  693. export interface DescribeAppInstanceUserRequest {
  694. /**
  695. * The ARN of the AppInstanceUser.
  696. */
  697. AppInstanceUserArn: ChimeArn;
  698. }
  699. export interface DescribeAppInstanceUserResponse {
  700. /**
  701. * The name of the AppInstanceUser.
  702. */
  703. AppInstanceUser?: AppInstanceUser;
  704. }
  705. export interface EndpointAttributes {
  706. /**
  707. * The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
  708. */
  709. DeviceToken: NonEmptySensitiveString1600;
  710. /**
  711. * The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
  712. */
  713. VoipDeviceToken?: NonEmptySensitiveString1600;
  714. }
  715. export interface EndpointState {
  716. /**
  717. * Enum that indicates the Status of an AppInstanceUserEndpoint.
  718. */
  719. Status: EndpointStatus;
  720. /**
  721. * The reason for the EndpointStatus.
  722. */
  723. StatusReason?: EndpointStatusReason;
  724. }
  725. export type EndpointStatus = "ACTIVE"|"INACTIVE"|string;
  726. export type EndpointStatusReason = "INVALID_DEVICE_TOKEN"|"INVALID_PINPOINT_ARN"|string;
  727. export type ExpirationCriterion = "CREATED_TIMESTAMP"|string;
  728. export type ExpirationDays = number;
  729. export interface ExpirationSettings {
  730. /**
  731. * The period in days after which an AppInstanceUser will be automatically deleted.
  732. */
  733. ExpirationDays: ExpirationDays;
  734. /**
  735. * Specifies the conditions under which an AppInstanceUser will expire.
  736. */
  737. ExpirationCriterion: ExpirationCriterion;
  738. }
  739. export interface GetAppInstanceRetentionSettingsRequest {
  740. /**
  741. * The ARN of the AppInstance.
  742. */
  743. AppInstanceArn: ChimeArn;
  744. }
  745. export interface GetAppInstanceRetentionSettingsResponse {
  746. /**
  747. * The retention settings for the AppInstance.
  748. */
  749. AppInstanceRetentionSettings?: AppInstanceRetentionSettings;
  750. /**
  751. * The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
  752. */
  753. InitiateDeletionTimestamp?: Timestamp;
  754. }
  755. export interface Identity {
  756. /**
  757. * The ARN in an Identity.
  758. */
  759. Arn?: ChimeArn;
  760. /**
  761. * The name in an Identity.
  762. */
  763. Name?: ResourceName;
  764. }
  765. export interface InvokedBy {
  766. /**
  767. * Sets standard messages as the bot trigger. For standard messages: ALL: The bot processes all standard messages. AUTO: The bot responds to ALL messages when the channel has one other non-hidden member, and responds to MENTIONS when the channel has more than one other non-hidden member. MENTIONS: The bot processes all standard messages that have a message attribute with CHIME.mentions and a value of the bot ARN. NONE: The bot processes no standard messages.
  768. */
  769. StandardMessages: StandardMessages;
  770. /**
  771. * Sets targeted messages as the bot trigger. For targeted messages: ALL: The bot processes all TargetedMessages sent to it. The bot then responds with a targeted message back to the sender. NONE: The bot processes no targeted messages.
  772. */
  773. TargetedMessages: TargetedMessages;
  774. }
  775. export type LexBotAliasArn = string;
  776. export interface LexConfiguration {
  777. /**
  778. * Deprecated. Use InvokedBy instead. Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.
  779. */
  780. RespondsTo?: RespondsTo;
  781. /**
  782. * Specifies the type of message that triggers a bot.
  783. */
  784. InvokedBy?: InvokedBy;
  785. /**
  786. * The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS
  787. */
  788. LexBotAliasArn: LexBotAliasArn;
  789. /**
  790. * Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide.
  791. */
  792. LocaleId: String;
  793. /**
  794. * The name of the welcome intent configured in the Amazon Lex V2 bot.
  795. */
  796. WelcomeIntent?: LexIntentName;
  797. }
  798. export type LexIntentName = string;
  799. export interface ListAppInstanceAdminsRequest {
  800. /**
  801. * The ARN of the AppInstance.
  802. */
  803. AppInstanceArn: ChimeArn;
  804. /**
  805. * The maximum number of administrators that you want to return.
  806. */
  807. MaxResults?: MaxResults;
  808. /**
  809. * The token returned from previous API requests until the number of administrators is reached.
  810. */
  811. NextToken?: NextToken;
  812. }
  813. export interface ListAppInstanceAdminsResponse {
  814. /**
  815. * The ARN of the AppInstance.
  816. */
  817. AppInstanceArn?: ChimeArn;
  818. /**
  819. * The information for each administrator.
  820. */
  821. AppInstanceAdmins?: AppInstanceAdminList;
  822. /**
  823. * The token returned from previous API requests until the number of administrators is reached.
  824. */
  825. NextToken?: NextToken;
  826. }
  827. export interface ListAppInstanceBotsRequest {
  828. /**
  829. * The ARN of the AppInstance.
  830. */
  831. AppInstanceArn: ChimeArn;
  832. /**
  833. * The maximum number of requests to return.
  834. */
  835. MaxResults?: MaxResults;
  836. /**
  837. * The token passed by previous API calls until all requested bots are returned.
  838. */
  839. NextToken?: NextToken;
  840. }
  841. export interface ListAppInstanceBotsResponse {
  842. /**
  843. * The ARN of the AppInstance.
  844. */
  845. AppInstanceArn?: ChimeArn;
  846. /**
  847. * The information for each requested AppInstanceBot.
  848. */
  849. AppInstanceBots?: AppInstanceBotList;
  850. /**
  851. * The token passed by previous API calls until all requested bots are returned.
  852. */
  853. NextToken?: NextToken;
  854. }
  855. export interface ListAppInstanceUserEndpointsRequest {
  856. /**
  857. * The ARN of the AppInstanceUser.
  858. */
  859. AppInstanceUserArn: SensitiveChimeArn;
  860. /**
  861. * The maximum number of endpoints that you want to return.
  862. */
  863. MaxResults?: MaxResults;
  864. /**
  865. * The token passed by previous API calls until all requested endpoints are returned.
  866. */
  867. NextToken?: NextToken;
  868. }
  869. export interface ListAppInstanceUserEndpointsResponse {
  870. /**
  871. * The information for each requested AppInstanceUserEndpoint.
  872. */
  873. AppInstanceUserEndpoints?: AppInstanceUserEndpointSummaryList;
  874. /**
  875. * The token passed by previous API calls until all requested endpoints are returned.
  876. */
  877. NextToken?: NextToken;
  878. }
  879. export interface ListAppInstanceUsersRequest {
  880. /**
  881. * The ARN of the AppInstance.
  882. */
  883. AppInstanceArn: ChimeArn;
  884. /**
  885. * The maximum number of requests that you want returned.
  886. */
  887. MaxResults?: MaxResults;
  888. /**
  889. * The token passed by previous API calls until all requested users are returned.
  890. */
  891. NextToken?: NextToken;
  892. }
  893. export interface ListAppInstanceUsersResponse {
  894. /**
  895. * The ARN of the AppInstance.
  896. */
  897. AppInstanceArn?: ChimeArn;
  898. /**
  899. * The information for each requested AppInstanceUser.
  900. */
  901. AppInstanceUsers?: AppInstanceUserList;
  902. /**
  903. * The token passed by previous API calls until all requested users are returned.
  904. */
  905. NextToken?: NextToken;
  906. }
  907. export interface ListAppInstancesRequest {
  908. /**
  909. * The maximum number of AppInstances that you want to return.
  910. */
  911. MaxResults?: MaxResults;
  912. /**
  913. * The token passed by previous API requests until you reach the maximum number of AppInstances.
  914. */
  915. NextToken?: NextToken;
  916. }
  917. export interface ListAppInstancesResponse {
  918. /**
  919. * The information for each AppInstance.
  920. */
  921. AppInstances?: AppInstanceList;
  922. /**
  923. * The token passed by previous API requests until the maximum number of AppInstances is reached.
  924. */
  925. NextToken?: NextToken;
  926. }
  927. export interface ListTagsForResourceRequest {
  928. /**
  929. * The ARN of the resource.
  930. */
  931. ResourceARN: ChimeArn;
  932. }
  933. export interface ListTagsForResourceResponse {
  934. /**
  935. * The tag key-value pairs.
  936. */
  937. Tags?: TagList;
  938. }
  939. export type MaxResults = number;
  940. export type Metadata = string;
  941. export type NextToken = string;
  942. export type NonEmptyResourceName = string;
  943. export type NonEmptySensitiveString1600 = string;
  944. export interface PutAppInstanceRetentionSettingsRequest {
  945. /**
  946. * The ARN of the AppInstance.
  947. */
  948. AppInstanceArn: ChimeArn;
  949. /**
  950. * The time in days to retain data. Data type: number.
  951. */
  952. AppInstanceRetentionSettings: AppInstanceRetentionSettings;
  953. }
  954. export interface PutAppInstanceRetentionSettingsResponse {
  955. /**
  956. * The time in days to retain data. Data type: number.
  957. */
  958. AppInstanceRetentionSettings?: AppInstanceRetentionSettings;
  959. /**
  960. * The time at which the API deletes data.
  961. */
  962. InitiateDeletionTimestamp?: Timestamp;
  963. }
  964. export interface PutAppInstanceUserExpirationSettingsRequest {
  965. /**
  966. * The ARN of the AppInstanceUser.
  967. */
  968. AppInstanceUserArn: ChimeArn;
  969. /**
  970. * Settings that control the interval after which an AppInstanceUser is automatically deleted.
  971. */
  972. ExpirationSettings?: ExpirationSettings;
  973. }
  974. export interface PutAppInstanceUserExpirationSettingsResponse {
  975. /**
  976. * The ARN of the AppInstanceUser.
  977. */
  978. AppInstanceUserArn?: ChimeArn;
  979. /**
  980. * Settings that control the interval after which an AppInstanceUser is automatically deleted.
  981. */
  982. ExpirationSettings?: ExpirationSettings;
  983. }
  984. export interface RegisterAppInstanceUserEndpointRequest {
  985. /**
  986. * The ARN of the AppInstanceUser.
  987. */
  988. AppInstanceUserArn: SensitiveChimeArn;
  989. /**
  990. * The name of the AppInstanceUserEndpoint.
  991. */
  992. Name?: SensitiveString1600;
  993. /**
  994. * The type of the AppInstanceUserEndpoint. Supported types: APNS: The mobile notification service for an Apple device. APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device. GCM: The mobile notification service for an Android device. Populate the ResourceArn value of each type as PinpointAppArn.
  995. */
  996. Type: AppInstanceUserEndpointType;
  997. /**
  998. * The ARN of the resource to which the endpoint belongs.
  999. */
  1000. ResourceArn: ChimeArn;
  1001. /**
  1002. * The attributes of an Endpoint.
  1003. */
  1004. EndpointAttributes: EndpointAttributes;
  1005. /**
  1006. * The unique ID assigned to the request. Use different tokens to register other endpoints.
  1007. */
  1008. ClientRequestToken: ClientRequestToken;
  1009. /**
  1010. * Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.
  1011. */
  1012. AllowMessages?: AllowMessages;
  1013. }
  1014. export interface RegisterAppInstanceUserEndpointResponse {
  1015. /**
  1016. * The ARN of the AppInstanceUser.
  1017. */
  1018. AppInstanceUserArn?: ChimeArn;
  1019. /**
  1020. * The unique identifier of the AppInstanceUserEndpoint.
  1021. */
  1022. EndpointId?: String64;
  1023. }
  1024. export type ResourceName = string;
  1025. export type RespondsTo = "STANDARD_MESSAGES"|string;
  1026. export type RetentionDays = number;
  1027. export type SensitiveChimeArn = string;
  1028. export type SensitiveString1600 = string;
  1029. export type StandardMessages = "AUTO"|"ALL"|"MENTIONS"|"NONE"|string;
  1030. export type String = string;
  1031. export type String1600 = string;
  1032. export type String64 = string;
  1033. export interface Tag {
  1034. /**
  1035. * The key in a tag.
  1036. */
  1037. Key: TagKey;
  1038. /**
  1039. * The value in a tag.
  1040. */
  1041. Value: TagValue;
  1042. }
  1043. export type TagKey = string;
  1044. export type TagKeyList = TagKey[];
  1045. export type TagList = Tag[];
  1046. export interface TagResourceRequest {
  1047. /**
  1048. * The resource ARN.
  1049. */
  1050. ResourceARN: ChimeArn;
  1051. /**
  1052. * The tag key-value pairs.
  1053. */
  1054. Tags: TagList;
  1055. }
  1056. export type TagValue = string;
  1057. export type TargetedMessages = "ALL"|"NONE"|string;
  1058. export type Timestamp = Date;
  1059. export interface UntagResourceRequest {
  1060. /**
  1061. * The resource ARN.
  1062. */
  1063. ResourceARN: ChimeArn;
  1064. /**
  1065. * The tag keys.
  1066. */
  1067. TagKeys: TagKeyList;
  1068. }
  1069. export interface UpdateAppInstanceBotRequest {
  1070. /**
  1071. * The ARN of the AppInstanceBot.
  1072. */
  1073. AppInstanceBotArn: ChimeArn;
  1074. /**
  1075. * The name of the AppInstanceBot.
  1076. */
  1077. Name: ResourceName;
  1078. /**
  1079. * The metadata of the AppInstanceBot.
  1080. */
  1081. Metadata: Metadata;
  1082. /**
  1083. * The configuration for the bot update.
  1084. */
  1085. Configuration?: Configuration;
  1086. }
  1087. export interface UpdateAppInstanceBotResponse {
  1088. /**
  1089. * The ARN of the AppInstanceBot.
  1090. */
  1091. AppInstanceBotArn?: ChimeArn;
  1092. }
  1093. export interface UpdateAppInstanceRequest {
  1094. /**
  1095. * The ARN of the AppInstance.
  1096. */
  1097. AppInstanceArn: ChimeArn;
  1098. /**
  1099. * The name that you want to change.
  1100. */
  1101. Name: NonEmptyResourceName;
  1102. /**
  1103. * The metadata that you want to change.
  1104. */
  1105. Metadata: Metadata;
  1106. }
  1107. export interface UpdateAppInstanceResponse {
  1108. /**
  1109. * The ARN of the AppInstance.
  1110. */
  1111. AppInstanceArn?: ChimeArn;
  1112. }
  1113. export interface UpdateAppInstanceUserEndpointRequest {
  1114. /**
  1115. * The ARN of the AppInstanceUser.
  1116. */
  1117. AppInstanceUserArn: ChimeArn;
  1118. /**
  1119. * The unique identifier of the AppInstanceUserEndpoint.
  1120. */
  1121. EndpointId: String64;
  1122. /**
  1123. * The name of the AppInstanceUserEndpoint.
  1124. */
  1125. Name?: SensitiveString1600;
  1126. /**
  1127. * Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.
  1128. */
  1129. AllowMessages?: AllowMessages;
  1130. }
  1131. export interface UpdateAppInstanceUserEndpointResponse {
  1132. /**
  1133. * The ARN of the AppInstanceUser.
  1134. */
  1135. AppInstanceUserArn?: ChimeArn;
  1136. /**
  1137. * The unique identifier of the AppInstanceUserEndpoint.
  1138. */
  1139. EndpointId?: String64;
  1140. }
  1141. export interface UpdateAppInstanceUserRequest {
  1142. /**
  1143. * The ARN of the AppInstanceUser.
  1144. */
  1145. AppInstanceUserArn: ChimeArn;
  1146. /**
  1147. * The name of the AppInstanceUser.
  1148. */
  1149. Name: UserName;
  1150. /**
  1151. * The metadata of the AppInstanceUser.
  1152. */
  1153. Metadata: Metadata;
  1154. }
  1155. export interface UpdateAppInstanceUserResponse {
  1156. /**
  1157. * The ARN of the AppInstanceUser.
  1158. */
  1159. AppInstanceUserArn?: ChimeArn;
  1160. }
  1161. export type UserId = string;
  1162. export type UserName = string;
  1163. /**
  1164. * 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.
  1165. */
  1166. export type apiVersion = "2021-04-20"|"latest"|string;
  1167. export interface ClientApiVersions {
  1168. /**
  1169. * 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.
  1170. */
  1171. apiVersion?: apiVersion;
  1172. }
  1173. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  1174. /**
  1175. * Contains interfaces for use with the ChimeSDKIdentity client.
  1176. */
  1177. export import Types = ChimeSDKIdentity;
  1178. }
  1179. export = ChimeSDKIdentity;