/AWSSDK_WinRT/Amazon.SimpleNotificationService/IAmazonSimpleNotificationService.cs

https://github.com/cicorias/aws-sdk-net · C# · 451 lines · 86 code · 80 blank · 285 comment · 0 complexity · 5079adad099c63c354bb4b39142046c7 MD5 · raw file

  1. /*
  2. * Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License").
  5. * You may not use this file except in compliance with the License.
  6. * A copy of the License is located at
  7. *
  8. * http://aws.amazon.com/apache2.0
  9. *
  10. * or in the "license" file accompanying this file. This file is distributed
  11. * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  12. * express or implied. See the License for the specific language governing
  13. * permissions and limitations under the License.
  14. */
  15. using System;
  16. using System.Runtime.ExceptionServices;
  17. using System.Threading;
  18. using System.Threading.Tasks;
  19. using Amazon.SimpleNotificationService.Model;
  20. namespace Amazon.SimpleNotificationService
  21. {
  22. /// <summary>
  23. /// Implementation for accessing SimpleNotificationService
  24. ///
  25. /// Amazon Simple Notification Service
  26. /// <para>
  27. /// Amazon Simple Notification Service (Amazon SNS) is a web service that enables you
  28. /// to build distributed web-enabled applications. Applications can use Amazon SNS
  29. /// to easily push real-time notification messages to interested subscribers over
  30. /// multiple delivery protocols. For more information about this product see <a href="http://aws.amazon.com/sns/">http://aws.amazon.com/sns</a>.
  31. /// For detailed information about Amazon SNS features and their associated API calls, see
  32. /// the <a href="http://docs.aws.amazon.com/sns/latest/dg/">Amazon SNS Developer Guide</a>.
  33. /// </para>
  34. ///
  35. /// <para>
  36. /// We also provide SDKs that enable you to access Amazon SNS from your preferred programming
  37. /// language. The SDKs contain functionality that automatically takes care of tasks
  38. /// such as: cryptographically signing your service requests, retrying requests,
  39. /// and handling error responses. For a list of available SDKs, go to <a href="http://aws.amazon.com/tools/">Tools
  40. /// for Amazon Web Services</a>.
  41. /// </para>
  42. /// </summary>
  43. public partial interface IAmazonSimpleNotificationService : IDisposable
  44. {
  45. #region AddPermission
  46. /// <summary>
  47. /// Initiates the asynchronous execution of the AddPermission operation.
  48. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  49. /// </summary>
  50. ///
  51. /// <param name="request">Container for the necessary parameters to execute the AddPermission operation.</param>
  52. /// <param name="cancellationToken">
  53. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  54. /// </param>
  55. /// <returns>The task object representing the asynchronous operation.</returns>
  56. Task<AddPermissionResponse> AddPermissionAsync(AddPermissionRequest request, CancellationToken cancellationToken = default(CancellationToken));
  57. #endregion
  58. #region ConfirmSubscription
  59. /// <summary>
  60. /// Initiates the asynchronous execution of the ConfirmSubscription operation.
  61. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  62. /// </summary>
  63. ///
  64. /// <param name="request">Container for the necessary parameters to execute the ConfirmSubscription operation.</param>
  65. /// <param name="cancellationToken">
  66. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  67. /// </param>
  68. /// <returns>The task object representing the asynchronous operation.</returns>
  69. Task<ConfirmSubscriptionResponse> ConfirmSubscriptionAsync(ConfirmSubscriptionRequest request, CancellationToken cancellationToken = default(CancellationToken));
  70. #endregion
  71. #region CreatePlatformApplication
  72. /// <summary>
  73. /// Initiates the asynchronous execution of the CreatePlatformApplication operation.
  74. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  75. /// </summary>
  76. ///
  77. /// <param name="request">Container for the necessary parameters to execute the CreatePlatformApplication operation.</param>
  78. /// <param name="cancellationToken">
  79. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  80. /// </param>
  81. /// <returns>The task object representing the asynchronous operation.</returns>
  82. Task<CreatePlatformApplicationResponse> CreatePlatformApplicationAsync(CreatePlatformApplicationRequest request, CancellationToken cancellationToken = default(CancellationToken));
  83. #endregion
  84. #region CreatePlatformEndpoint
  85. /// <summary>
  86. /// Initiates the asynchronous execution of the CreatePlatformEndpoint operation.
  87. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  88. /// </summary>
  89. ///
  90. /// <param name="request">Container for the necessary parameters to execute the CreatePlatformEndpoint operation.</param>
  91. /// <param name="cancellationToken">
  92. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  93. /// </param>
  94. /// <returns>The task object representing the asynchronous operation.</returns>
  95. Task<CreatePlatformEndpointResponse> CreatePlatformEndpointAsync(CreatePlatformEndpointRequest request, CancellationToken cancellationToken = default(CancellationToken));
  96. #endregion
  97. #region CreateTopic
  98. /// <summary>
  99. /// Initiates the asynchronous execution of the CreateTopic operation.
  100. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  101. /// </summary>
  102. ///
  103. /// <param name="request">Container for the necessary parameters to execute the CreateTopic operation.</param>
  104. /// <param name="cancellationToken">
  105. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  106. /// </param>
  107. /// <returns>The task object representing the asynchronous operation.</returns>
  108. Task<CreateTopicResponse> CreateTopicAsync(CreateTopicRequest request, CancellationToken cancellationToken = default(CancellationToken));
  109. #endregion
  110. #region DeleteEndpoint
  111. /// <summary>
  112. /// Initiates the asynchronous execution of the DeleteEndpoint operation.
  113. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  114. /// </summary>
  115. ///
  116. /// <param name="request">Container for the necessary parameters to execute the DeleteEndpoint operation.</param>
  117. /// <param name="cancellationToken">
  118. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  119. /// </param>
  120. /// <returns>The task object representing the asynchronous operation.</returns>
  121. Task<DeleteEndpointResponse> DeleteEndpointAsync(DeleteEndpointRequest request, CancellationToken cancellationToken = default(CancellationToken));
  122. #endregion
  123. #region DeletePlatformApplication
  124. /// <summary>
  125. /// Initiates the asynchronous execution of the DeletePlatformApplication operation.
  126. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  127. /// </summary>
  128. ///
  129. /// <param name="request">Container for the necessary parameters to execute the DeletePlatformApplication operation.</param>
  130. /// <param name="cancellationToken">
  131. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  132. /// </param>
  133. /// <returns>The task object representing the asynchronous operation.</returns>
  134. Task<DeletePlatformApplicationResponse> DeletePlatformApplicationAsync(DeletePlatformApplicationRequest request, CancellationToken cancellationToken = default(CancellationToken));
  135. #endregion
  136. #region DeleteTopic
  137. /// <summary>
  138. /// Initiates the asynchronous execution of the DeleteTopic operation.
  139. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  140. /// </summary>
  141. ///
  142. /// <param name="request">Container for the necessary parameters to execute the DeleteTopic operation.</param>
  143. /// <param name="cancellationToken">
  144. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  145. /// </param>
  146. /// <returns>The task object representing the asynchronous operation.</returns>
  147. Task<DeleteTopicResponse> DeleteTopicAsync(DeleteTopicRequest request, CancellationToken cancellationToken = default(CancellationToken));
  148. #endregion
  149. #region GetEndpointAttributes
  150. /// <summary>
  151. /// Initiates the asynchronous execution of the GetEndpointAttributes operation.
  152. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  153. /// </summary>
  154. ///
  155. /// <param name="request">Container for the necessary parameters to execute the GetEndpointAttributes operation.</param>
  156. /// <param name="cancellationToken">
  157. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  158. /// </param>
  159. /// <returns>The task object representing the asynchronous operation.</returns>
  160. Task<GetEndpointAttributesResponse> GetEndpointAttributesAsync(GetEndpointAttributesRequest request, CancellationToken cancellationToken = default(CancellationToken));
  161. #endregion
  162. #region GetPlatformApplicationAttributes
  163. /// <summary>
  164. /// Initiates the asynchronous execution of the GetPlatformApplicationAttributes operation.
  165. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  166. /// </summary>
  167. ///
  168. /// <param name="request">Container for the necessary parameters to execute the GetPlatformApplicationAttributes operation.</param>
  169. /// <param name="cancellationToken">
  170. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  171. /// </param>
  172. /// <returns>The task object representing the asynchronous operation.</returns>
  173. Task<GetPlatformApplicationAttributesResponse> GetPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest request, CancellationToken cancellationToken = default(CancellationToken));
  174. #endregion
  175. #region GetSubscriptionAttributes
  176. /// <summary>
  177. /// Initiates the asynchronous execution of the GetSubscriptionAttributes operation.
  178. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  179. /// </summary>
  180. ///
  181. /// <param name="request">Container for the necessary parameters to execute the GetSubscriptionAttributes operation.</param>
  182. /// <param name="cancellationToken">
  183. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  184. /// </param>
  185. /// <returns>The task object representing the asynchronous operation.</returns>
  186. Task<GetSubscriptionAttributesResponse> GetSubscriptionAttributesAsync(GetSubscriptionAttributesRequest request, CancellationToken cancellationToken = default(CancellationToken));
  187. #endregion
  188. #region GetTopicAttributes
  189. /// <summary>
  190. /// Initiates the asynchronous execution of the GetTopicAttributes operation.
  191. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  192. /// </summary>
  193. ///
  194. /// <param name="request">Container for the necessary parameters to execute the GetTopicAttributes operation.</param>
  195. /// <param name="cancellationToken">
  196. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  197. /// </param>
  198. /// <returns>The task object representing the asynchronous operation.</returns>
  199. Task<GetTopicAttributesResponse> GetTopicAttributesAsync(GetTopicAttributesRequest request, CancellationToken cancellationToken = default(CancellationToken));
  200. #endregion
  201. #region ListEndpointsByPlatformApplication
  202. /// <summary>
  203. /// Initiates the asynchronous execution of the ListEndpointsByPlatformApplication operation.
  204. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  205. /// </summary>
  206. ///
  207. /// <param name="request">Container for the necessary parameters to execute the ListEndpointsByPlatformApplication operation.</param>
  208. /// <param name="cancellationToken">
  209. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  210. /// </param>
  211. /// <returns>The task object representing the asynchronous operation.</returns>
  212. Task<ListEndpointsByPlatformApplicationResponse> ListEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest request, CancellationToken cancellationToken = default(CancellationToken));
  213. #endregion
  214. #region ListPlatformApplications
  215. /// <summary>
  216. /// Initiates the asynchronous execution of the ListPlatformApplications operation.
  217. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  218. /// </summary>
  219. ///
  220. /// <param name="request">Container for the necessary parameters to execute the ListPlatformApplications operation.</param>
  221. /// <param name="cancellationToken">
  222. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  223. /// </param>
  224. /// <returns>The task object representing the asynchronous operation.</returns>
  225. Task<ListPlatformApplicationsResponse> ListPlatformApplicationsAsync(ListPlatformApplicationsRequest request, CancellationToken cancellationToken = default(CancellationToken));
  226. #endregion
  227. #region ListSubscriptions
  228. /// <summary>
  229. /// Initiates the asynchronous execution of the ListSubscriptions operation.
  230. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  231. /// </summary>
  232. ///
  233. /// <param name="request">Container for the necessary parameters to execute the ListSubscriptions operation.</param>
  234. /// <param name="cancellationToken">
  235. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  236. /// </param>
  237. /// <returns>The task object representing the asynchronous operation.</returns>
  238. Task<ListSubscriptionsResponse> ListSubscriptionsAsync(ListSubscriptionsRequest request, CancellationToken cancellationToken = default(CancellationToken));
  239. #endregion
  240. #region ListSubscriptionsByTopic
  241. /// <summary>
  242. /// Initiates the asynchronous execution of the ListSubscriptionsByTopic operation.
  243. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  244. /// </summary>
  245. ///
  246. /// <param name="request">Container for the necessary parameters to execute the ListSubscriptionsByTopic operation.</param>
  247. /// <param name="cancellationToken">
  248. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  249. /// </param>
  250. /// <returns>The task object representing the asynchronous operation.</returns>
  251. Task<ListSubscriptionsByTopicResponse> ListSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest request, CancellationToken cancellationToken = default(CancellationToken));
  252. #endregion
  253. #region ListTopics
  254. /// <summary>
  255. /// Initiates the asynchronous execution of the ListTopics operation.
  256. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  257. /// </summary>
  258. ///
  259. /// <param name="request">Container for the necessary parameters to execute the ListTopics operation.</param>
  260. /// <param name="cancellationToken">
  261. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  262. /// </param>
  263. /// <returns>The task object representing the asynchronous operation.</returns>
  264. Task<ListTopicsResponse> ListTopicsAsync(ListTopicsRequest request, CancellationToken cancellationToken = default(CancellationToken));
  265. #endregion
  266. #region Publish
  267. /// <summary>
  268. /// Initiates the asynchronous execution of the Publish operation.
  269. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  270. /// </summary>
  271. ///
  272. /// <param name="request">Container for the necessary parameters to execute the Publish operation.</param>
  273. /// <param name="cancellationToken">
  274. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  275. /// </param>
  276. /// <returns>The task object representing the asynchronous operation.</returns>
  277. Task<PublishResponse> PublishAsync(PublishRequest request, CancellationToken cancellationToken = default(CancellationToken));
  278. #endregion
  279. #region RemovePermission
  280. /// <summary>
  281. /// Initiates the asynchronous execution of the RemovePermission operation.
  282. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  283. /// </summary>
  284. ///
  285. /// <param name="request">Container for the necessary parameters to execute the RemovePermission operation.</param>
  286. /// <param name="cancellationToken">
  287. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  288. /// </param>
  289. /// <returns>The task object representing the asynchronous operation.</returns>
  290. Task<RemovePermissionResponse> RemovePermissionAsync(RemovePermissionRequest request, CancellationToken cancellationToken = default(CancellationToken));
  291. #endregion
  292. #region SetEndpointAttributes
  293. /// <summary>
  294. /// Initiates the asynchronous execution of the SetEndpointAttributes operation.
  295. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  296. /// </summary>
  297. ///
  298. /// <param name="request">Container for the necessary parameters to execute the SetEndpointAttributes operation.</param>
  299. /// <param name="cancellationToken">
  300. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  301. /// </param>
  302. /// <returns>The task object representing the asynchronous operation.</returns>
  303. Task<SetEndpointAttributesResponse> SetEndpointAttributesAsync(SetEndpointAttributesRequest request, CancellationToken cancellationToken = default(CancellationToken));
  304. #endregion
  305. #region SetPlatformApplicationAttributes
  306. /// <summary>
  307. /// Initiates the asynchronous execution of the SetPlatformApplicationAttributes operation.
  308. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  309. /// </summary>
  310. ///
  311. /// <param name="request">Container for the necessary parameters to execute the SetPlatformApplicationAttributes operation.</param>
  312. /// <param name="cancellationToken">
  313. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  314. /// </param>
  315. /// <returns>The task object representing the asynchronous operation.</returns>
  316. Task<SetPlatformApplicationAttributesResponse> SetPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest request, CancellationToken cancellationToken = default(CancellationToken));
  317. #endregion
  318. #region SetSubscriptionAttributes
  319. /// <summary>
  320. /// Initiates the asynchronous execution of the SetSubscriptionAttributes operation.
  321. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  322. /// </summary>
  323. ///
  324. /// <param name="request">Container for the necessary parameters to execute the SetSubscriptionAttributes operation.</param>
  325. /// <param name="cancellationToken">
  326. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  327. /// </param>
  328. /// <returns>The task object representing the asynchronous operation.</returns>
  329. Task<SetSubscriptionAttributesResponse> SetSubscriptionAttributesAsync(SetSubscriptionAttributesRequest request, CancellationToken cancellationToken = default(CancellationToken));
  330. #endregion
  331. #region SetTopicAttributes
  332. /// <summary>
  333. /// Initiates the asynchronous execution of the SetTopicAttributes operation.
  334. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  335. /// </summary>
  336. ///
  337. /// <param name="request">Container for the necessary parameters to execute the SetTopicAttributes operation.</param>
  338. /// <param name="cancellationToken">
  339. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  340. /// </param>
  341. /// <returns>The task object representing the asynchronous operation.</returns>
  342. Task<SetTopicAttributesResponse> SetTopicAttributesAsync(SetTopicAttributesRequest request, CancellationToken cancellationToken = default(CancellationToken));
  343. #endregion
  344. #region Subscribe
  345. /// <summary>
  346. /// Initiates the asynchronous execution of the Subscribe operation.
  347. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  348. /// </summary>
  349. ///
  350. /// <param name="request">Container for the necessary parameters to execute the Subscribe operation.</param>
  351. /// <param name="cancellationToken">
  352. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  353. /// </param>
  354. /// <returns>The task object representing the asynchronous operation.</returns>
  355. Task<SubscribeResponse> SubscribeAsync(SubscribeRequest request, CancellationToken cancellationToken = default(CancellationToken));
  356. #endregion
  357. #region Unsubscribe
  358. /// <summary>
  359. /// Initiates the asynchronous execution of the Unsubscribe operation.
  360. /// <seealso cref="Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"/>
  361. /// </summary>
  362. ///
  363. /// <param name="request">Container for the necessary parameters to execute the Unsubscribe operation.</param>
  364. /// <param name="cancellationToken">
  365. /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
  366. /// </param>
  367. /// <returns>The task object representing the asynchronous operation.</returns>
  368. Task<UnsubscribeResponse> UnsubscribeAsync(UnsubscribeRequest request, CancellationToken cancellationToken = default(CancellationToken));
  369. #endregion
  370. }
  371. }