@aws-sdk/client-sns 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/dist-cjs/protocols/Aws_query.js +65 -224
  2. package/dist-es/protocols/Aws_query.js +65 -224
  3. package/dist-types/SNS.d.ts +43 -0
  4. package/dist-types/SNSClient.d.ts +24 -4
  5. package/dist-types/commands/AddPermissionCommand.d.ts +16 -0
  6. package/dist-types/commands/CheckIfPhoneNumberIsOptedOutCommand.d.ts +16 -0
  7. package/dist-types/commands/ConfirmSubscriptionCommand.d.ts +16 -0
  8. package/dist-types/commands/CreatePlatformApplicationCommand.d.ts +16 -0
  9. package/dist-types/commands/CreatePlatformEndpointCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateSMSSandboxPhoneNumberCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateTopicCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteEndpointCommand.d.ts +16 -0
  13. package/dist-types/commands/DeletePlatformApplicationCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteSMSSandboxPhoneNumberCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteTopicCommand.d.ts +16 -0
  16. package/dist-types/commands/GetDataProtectionPolicyCommand.d.ts +16 -0
  17. package/dist-types/commands/GetEndpointAttributesCommand.d.ts +16 -0
  18. package/dist-types/commands/GetPlatformApplicationAttributesCommand.d.ts +16 -0
  19. package/dist-types/commands/GetSMSAttributesCommand.d.ts +16 -0
  20. package/dist-types/commands/GetSMSSandboxAccountStatusCommand.d.ts +16 -0
  21. package/dist-types/commands/GetSubscriptionAttributesCommand.d.ts +16 -0
  22. package/dist-types/commands/GetTopicAttributesCommand.d.ts +16 -0
  23. package/dist-types/commands/ListEndpointsByPlatformApplicationCommand.d.ts +16 -0
  24. package/dist-types/commands/ListOriginationNumbersCommand.d.ts +16 -0
  25. package/dist-types/commands/ListPhoneNumbersOptedOutCommand.d.ts +16 -0
  26. package/dist-types/commands/ListPlatformApplicationsCommand.d.ts +16 -0
  27. package/dist-types/commands/ListSMSSandboxPhoneNumbersCommand.d.ts +16 -0
  28. package/dist-types/commands/ListSubscriptionsByTopicCommand.d.ts +16 -0
  29. package/dist-types/commands/ListSubscriptionsCommand.d.ts +16 -0
  30. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  31. package/dist-types/commands/ListTopicsCommand.d.ts +16 -0
  32. package/dist-types/commands/OptInPhoneNumberCommand.d.ts +16 -0
  33. package/dist-types/commands/PublishBatchCommand.d.ts +16 -0
  34. package/dist-types/commands/PublishCommand.d.ts +16 -0
  35. package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts +16 -0
  36. package/dist-types/commands/RemovePermissionCommand.d.ts +16 -0
  37. package/dist-types/commands/SetEndpointAttributesCommand.d.ts +16 -0
  38. package/dist-types/commands/SetPlatformApplicationAttributesCommand.d.ts +16 -0
  39. package/dist-types/commands/SetSMSAttributesCommand.d.ts +16 -0
  40. package/dist-types/commands/SetSubscriptionAttributesCommand.d.ts +16 -0
  41. package/dist-types/commands/SetTopicAttributesCommand.d.ts +16 -0
  42. package/dist-types/commands/SubscribeCommand.d.ts +16 -0
  43. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  44. package/dist-types/commands/UnsubscribeCommand.d.ts +16 -0
  45. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  46. package/dist-types/commands/VerifySMSSandboxPhoneNumberCommand.d.ts +16 -0
  47. package/dist-types/models/SNSServiceException.d.ts +2 -0
  48. package/dist-types/models/models_0.d.ts +182 -4
  49. package/dist-types/pagination/Interfaces.d.ts +3 -0
  50. package/dist-types/pagination/ListEndpointsByPlatformApplicationPaginator.d.ts +3 -0
  51. package/dist-types/pagination/ListOriginationNumbersPaginator.d.ts +3 -0
  52. package/dist-types/pagination/ListPhoneNumbersOptedOutPaginator.d.ts +3 -0
  53. package/dist-types/pagination/ListPlatformApplicationsPaginator.d.ts +3 -0
  54. package/dist-types/pagination/ListSMSSandboxPhoneNumbersPaginator.d.ts +3 -0
  55. package/dist-types/pagination/ListSubscriptionsByTopicPaginator.d.ts +3 -0
  56. package/dist-types/pagination/ListSubscriptionsPaginator.d.ts +3 -0
  57. package/dist-types/pagination/ListTopicsPaginator.d.ts +3 -0
  58. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateEndpointResponse, CreatePlatformEndpointInput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreatePlatformEndpointCommand}.
8
10
  */
9
11
  export interface CreatePlatformEndpointCommandInput extends CreatePlatformEndpointInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreatePlatformEndpointCommand}.
13
17
  */
14
18
  export interface CreatePlatformEndpointCommandOutput extends CreateEndpointResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an endpoint for a device and mobile app on one of the supported push
18
23
  * notification services, such as GCM (Firebase Cloud Messaging) and APNS.
19
24
  * <code>CreatePlatformEndpoint</code> requires the <code>PlatformApplicationArn</code>
@@ -38,6 +43,8 @@ export interface CreatePlatformEndpointCommandOutput extends CreateEndpointRespo
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param CreatePlatformEndpointCommandInput - {@link CreatePlatformEndpointCommandInput}
47
+ * @returns {@link CreatePlatformEndpointCommandOutput}
41
48
  * @see {@link CreatePlatformEndpointCommandInput} for command's `input` shape.
42
49
  * @see {@link CreatePlatformEndpointCommandOutput} for command's `response` shape.
43
50
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -60,11 +67,20 @@ export interface CreatePlatformEndpointCommandOutput extends CreateEndpointRespo
60
67
  export declare class CreatePlatformEndpointCommand extends $Command<CreatePlatformEndpointCommandInput, CreatePlatformEndpointCommandOutput, SNSClientResolvedConfig> {
61
68
  readonly input: CreatePlatformEndpointCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: CreatePlatformEndpointCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePlatformEndpointCommandInput, CreatePlatformEndpointCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateSMSSandboxPhoneNumberInput, CreateSMSSandboxPhoneNumberResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateSMSSandboxPhoneNumberCommand}.
8
10
  */
9
11
  export interface CreateSMSSandboxPhoneNumberCommandInput extends CreateSMSSandboxPhoneNumberInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateSMSSandboxPhoneNumberCommand}.
13
17
  */
14
18
  export interface CreateSMSSandboxPhoneNumberCommandOutput extends CreateSMSSandboxPhoneNumberResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a
18
23
  * one-time password (OTP) to that phone number.</p>
19
24
  * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
@@ -34,6 +39,8 @@ export interface CreateSMSSandboxPhoneNumberCommandOutput extends CreateSMSSandb
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param CreateSMSSandboxPhoneNumberCommandInput - {@link CreateSMSSandboxPhoneNumberCommandInput}
43
+ * @returns {@link CreateSMSSandboxPhoneNumberCommandOutput}
37
44
  * @see {@link CreateSMSSandboxPhoneNumberCommandInput} for command's `input` shape.
38
45
  * @see {@link CreateSMSSandboxPhoneNumberCommandOutput} for command's `response` shape.
39
46
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -64,11 +71,20 @@ export interface CreateSMSSandboxPhoneNumberCommandOutput extends CreateSMSSandb
64
71
  export declare class CreateSMSSandboxPhoneNumberCommand extends $Command<CreateSMSSandboxPhoneNumberCommandInput, CreateSMSSandboxPhoneNumberCommandOutput, SNSClientResolvedConfig> {
65
72
  readonly input: CreateSMSSandboxPhoneNumberCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: CreateSMSSandboxPhoneNumberCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSMSSandboxPhoneNumberCommandInput, CreateSMSSandboxPhoneNumberCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateTopicInput, CreateTopicResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateTopicCommand}.
8
10
  */
9
11
  export interface CreateTopicCommandInput extends CreateTopicInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateTopicCommand}.
13
17
  */
14
18
  export interface CreateTopicCommandOutput extends CreateTopicResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a topic to which notifications can be published. Users can create at most
18
23
  * 100,000 standard topics (at most 1,000 FIFO topics). For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html">Creating an Amazon SNS
19
24
  * topic</a> in the <i>Amazon SNS Developer Guide</i>. This action is
@@ -29,6 +34,8 @@ export interface CreateTopicCommandOutput extends CreateTopicResponse, __Metadat
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateTopicCommandInput - {@link CreateTopicCommandInput}
38
+ * @returns {@link CreateTopicCommandOutput}
32
39
  * @see {@link CreateTopicCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateTopicCommandOutput} for command's `response` shape.
34
41
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -70,11 +77,20 @@ export interface CreateTopicCommandOutput extends CreateTopicResponse, __Metadat
70
77
  export declare class CreateTopicCommand extends $Command<CreateTopicCommandInput, CreateTopicCommandOutput, SNSClientResolvedConfig> {
71
78
  readonly input: CreateTopicCommandInput;
72
79
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
80
+ /**
81
+ * @public
82
+ */
73
83
  constructor(input: CreateTopicCommandInput);
74
84
  /**
75
85
  * @internal
76
86
  */
77
87
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateTopicCommandInput, CreateTopicCommandOutput>;
88
+ /**
89
+ * @internal
90
+ */
78
91
  private serialize;
92
+ /**
93
+ * @internal
94
+ */
79
95
  private deserialize;
80
96
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteEndpointInput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteEndpointCommand}.
8
10
  */
9
11
  export interface DeleteEndpointCommandInput extends DeleteEndpointInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteEndpointCommand}.
13
17
  */
14
18
  export interface DeleteEndpointCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the endpoint for a device and mobile app from Amazon SNS. This action is
18
23
  * idempotent. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
19
24
  * Notifications</a>. </p>
@@ -29,6 +34,8 @@ export interface DeleteEndpointCommandOutput extends __MetadataBearer {
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteEndpointCommandInput - {@link DeleteEndpointCommandInput}
38
+ * @returns {@link DeleteEndpointCommandOutput}
32
39
  * @see {@link DeleteEndpointCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteEndpointCommandOutput} for command's `response` shape.
34
41
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DeleteEndpointCommandOutput extends __MetadataBearer {
48
55
  export declare class DeleteEndpointCommand extends $Command<DeleteEndpointCommandInput, DeleteEndpointCommandOutput, SNSClientResolvedConfig> {
49
56
  readonly input: DeleteEndpointCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DeleteEndpointCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteEndpointCommandInput, DeleteEndpointCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeletePlatformApplicationInput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeletePlatformApplicationCommand}.
8
10
  */
9
11
  export interface DeletePlatformApplicationCommandInput extends DeletePlatformApplicationInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeletePlatformApplicationCommand}.
13
17
  */
14
18
  export interface DeletePlatformApplicationCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a platform application object for one of the supported push notification
18
23
  * services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see
19
24
  * <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS
@@ -28,6 +33,8 @@ export interface DeletePlatformApplicationCommandOutput extends __MetadataBearer
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeletePlatformApplicationCommandInput - {@link DeletePlatformApplicationCommandInput}
37
+ * @returns {@link DeletePlatformApplicationCommandOutput}
31
38
  * @see {@link DeletePlatformApplicationCommandInput} for command's `input` shape.
32
39
  * @see {@link DeletePlatformApplicationCommandOutput} for command's `response` shape.
33
40
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DeletePlatformApplicationCommandOutput extends __MetadataBearer
47
54
  export declare class DeletePlatformApplicationCommand extends $Command<DeletePlatformApplicationCommandInput, DeletePlatformApplicationCommandOutput, SNSClientResolvedConfig> {
48
55
  readonly input: DeletePlatformApplicationCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DeletePlatformApplicationCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePlatformApplicationCommandInput, DeletePlatformApplicationCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteSMSSandboxPhoneNumberInput, DeleteSMSSandboxPhoneNumberResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSMSSandboxPhoneNumberCommand}.
8
10
  */
9
11
  export interface DeleteSMSSandboxPhoneNumberCommandInput extends DeleteSMSSandboxPhoneNumberInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSMSSandboxPhoneNumberCommand}.
13
17
  */
14
18
  export interface DeleteSMSSandboxPhoneNumberCommandOutput extends DeleteSMSSandboxPhoneNumberResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an Amazon Web Services account's verified or pending phone number from the SMS
18
23
  * sandbox.</p>
19
24
  * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
@@ -34,6 +39,8 @@ export interface DeleteSMSSandboxPhoneNumberCommandOutput extends DeleteSMSSandb
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param DeleteSMSSandboxPhoneNumberCommandInput - {@link DeleteSMSSandboxPhoneNumberCommandInput}
43
+ * @returns {@link DeleteSMSSandboxPhoneNumberCommandOutput}
37
44
  * @see {@link DeleteSMSSandboxPhoneNumberCommandInput} for command's `input` shape.
38
45
  * @see {@link DeleteSMSSandboxPhoneNumberCommandOutput} for command's `response` shape.
39
46
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -64,11 +71,20 @@ export interface DeleteSMSSandboxPhoneNumberCommandOutput extends DeleteSMSSandb
64
71
  export declare class DeleteSMSSandboxPhoneNumberCommand extends $Command<DeleteSMSSandboxPhoneNumberCommandInput, DeleteSMSSandboxPhoneNumberCommandOutput, SNSClientResolvedConfig> {
65
72
  readonly input: DeleteSMSSandboxPhoneNumberCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: DeleteSMSSandboxPhoneNumberCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSMSSandboxPhoneNumberCommandInput, DeleteSMSSandboxPhoneNumberCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteTopicInput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteTopicCommand}.
8
10
  */
9
11
  export interface DeleteTopicCommandInput extends DeleteTopicInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteTopicCommand}.
13
17
  */
14
18
  export interface DeleteTopicCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a topic and all its subscriptions. Deleting a topic might prevent some
18
23
  * messages previously sent to the topic from being delivered to subscribers. This action
19
24
  * is idempotent, so deleting a topic that does not exist does not result in an
@@ -28,6 +33,8 @@ export interface DeleteTopicCommandOutput extends __MetadataBearer {
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteTopicCommandInput - {@link DeleteTopicCommandInput}
37
+ * @returns {@link DeleteTopicCommandOutput}
31
38
  * @see {@link DeleteTopicCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteTopicCommandOutput} for command's `response` shape.
33
40
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -62,11 +69,20 @@ export interface DeleteTopicCommandOutput extends __MetadataBearer {
62
69
  export declare class DeleteTopicCommand extends $Command<DeleteTopicCommandInput, DeleteTopicCommandOutput, SNSClientResolvedConfig> {
63
70
  readonly input: DeleteTopicCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: DeleteTopicCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteTopicCommandInput, DeleteTopicCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDataProtectionPolicyInput, GetDataProtectionPolicyResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDataProtectionPolicyCommand}.
8
10
  */
9
11
  export interface GetDataProtectionPolicyCommandInput extends GetDataProtectionPolicyInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDataProtectionPolicyCommand}.
13
17
  */
14
18
  export interface GetDataProtectionPolicyCommandOutput extends GetDataProtectionPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the specified inline <code>DataProtectionPolicy</code> document that is
18
23
  * stored in the specified Amazon SNS topic. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetDataProtectionPolicyCommandOutput extends GetDataProtectionP
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetDataProtectionPolicyCommandInput - {@link GetDataProtectionPolicyCommandInput}
35
+ * @returns {@link GetDataProtectionPolicyCommandOutput}
29
36
  * @see {@link GetDataProtectionPolicyCommandInput} for command's `input` shape.
30
37
  * @see {@link GetDataProtectionPolicyCommandOutput} for command's `response` shape.
31
38
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -52,11 +59,20 @@ export interface GetDataProtectionPolicyCommandOutput extends GetDataProtectionP
52
59
  export declare class GetDataProtectionPolicyCommand extends $Command<GetDataProtectionPolicyCommandInput, GetDataProtectionPolicyCommandOutput, SNSClientResolvedConfig> {
53
60
  readonly input: GetDataProtectionPolicyCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: GetDataProtectionPolicyCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDataProtectionPolicyCommandInput, GetDataProtectionPolicyCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetEndpointAttributesInput, GetEndpointAttributesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetEndpointAttributesCommand}.
8
10
  */
9
11
  export interface GetEndpointAttributesCommandInput extends GetEndpointAttributesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetEndpointAttributesCommand}.
13
17
  */
14
18
  export interface GetEndpointAttributesCommandOutput extends GetEndpointAttributesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the endpoint attributes for a device on one of the supported push
18
23
  * notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more
19
24
  * information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
@@ -27,6 +32,8 @@ export interface GetEndpointAttributesCommandOutput extends GetEndpointAttribute
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetEndpointAttributesCommandInput - {@link GetEndpointAttributesCommandInput}
36
+ * @returns {@link GetEndpointAttributesCommandOutput}
30
37
  * @see {@link GetEndpointAttributesCommandInput} for command's `input` shape.
31
38
  * @see {@link GetEndpointAttributesCommandOutput} for command's `response` shape.
32
39
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetEndpointAttributesCommandOutput extends GetEndpointAttribute
49
56
  export declare class GetEndpointAttributesCommand extends $Command<GetEndpointAttributesCommandInput, GetEndpointAttributesCommandOutput, SNSClientResolvedConfig> {
50
57
  readonly input: GetEndpointAttributesCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetEndpointAttributesCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEndpointAttributesCommandInput, GetEndpointAttributesCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetPlatformApplicationAttributesInput, GetPlatformApplicationAttributesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPlatformApplicationAttributesCommand}.
8
10
  */
9
11
  export interface GetPlatformApplicationAttributesCommandInput extends GetPlatformApplicationAttributesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPlatformApplicationAttributesCommand}.
13
17
  */
14
18
  export interface GetPlatformApplicationAttributesCommandOutput extends GetPlatformApplicationAttributesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the attributes of the platform application object for the supported push
18
23
  * notification services, such as APNS and GCM (Firebase Cloud Messaging). For more
19
24
  * information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
@@ -27,6 +32,8 @@ export interface GetPlatformApplicationAttributesCommandOutput extends GetPlatfo
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetPlatformApplicationAttributesCommandInput - {@link GetPlatformApplicationAttributesCommandInput}
36
+ * @returns {@link GetPlatformApplicationAttributesCommandOutput}
30
37
  * @see {@link GetPlatformApplicationAttributesCommandInput} for command's `input` shape.
31
38
  * @see {@link GetPlatformApplicationAttributesCommandOutput} for command's `response` shape.
32
39
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetPlatformApplicationAttributesCommandOutput extends GetPlatfo
49
56
  export declare class GetPlatformApplicationAttributesCommand extends $Command<GetPlatformApplicationAttributesCommandInput, GetPlatformApplicationAttributesCommandOutput, SNSClientResolvedConfig> {
50
57
  readonly input: GetPlatformApplicationAttributesCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetPlatformApplicationAttributesCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPlatformApplicationAttributesCommandInput, GetPlatformApplicationAttributesCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetSMSAttributesInput, GetSMSAttributesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSMSAttributesCommand}.
8
10
  */
9
11
  export interface GetSMSAttributesCommandInput extends GetSMSAttributesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSMSAttributesCommand}.
13
17
  */
14
18
  export interface GetSMSAttributesCommandOutput extends GetSMSAttributesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the settings for sending SMS messages from your Amazon Web Services account.</p>
18
23
  * <p>These settings are set with the <code>SetSMSAttributes</code> action.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetSMSAttributesCommandOutput extends GetSMSAttributesResponse,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetSMSAttributesCommandInput - {@link GetSMSAttributesCommandInput}
35
+ * @returns {@link GetSMSAttributesCommandOutput}
29
36
  * @see {@link GetSMSAttributesCommandInput} for command's `input` shape.
30
37
  * @see {@link GetSMSAttributesCommandOutput} for command's `response` shape.
31
38
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -48,11 +55,20 @@ export interface GetSMSAttributesCommandOutput extends GetSMSAttributesResponse,
48
55
  export declare class GetSMSAttributesCommand extends $Command<GetSMSAttributesCommandInput, GetSMSAttributesCommandOutput, SNSClientResolvedConfig> {
49
56
  readonly input: GetSMSAttributesCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: GetSMSAttributesCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSMSAttributesCommandInput, GetSMSAttributesCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetSMSSandboxAccountStatusInput, GetSMSSandboxAccountStatusResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSMSSandboxAccountStatusCommand}.
8
10
  */
9
11
  export interface GetSMSSandboxAccountStatusCommandInput extends GetSMSSandboxAccountStatusInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSMSSandboxAccountStatusCommand}.
13
17
  */
14
18
  export interface GetSMSSandboxAccountStatusCommandOutput extends GetSMSSandboxAccountStatusResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target
18
23
  * Amazon Web Services Region.</p>
19
24
  * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
@@ -34,6 +39,8 @@ export interface GetSMSSandboxAccountStatusCommandOutput extends GetSMSSandboxAc
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param GetSMSSandboxAccountStatusCommandInput - {@link GetSMSSandboxAccountStatusCommandInput}
43
+ * @returns {@link GetSMSSandboxAccountStatusCommandOutput}
37
44
  * @see {@link GetSMSSandboxAccountStatusCommandInput} for command's `input` shape.
38
45
  * @see {@link GetSMSSandboxAccountStatusCommandOutput} for command's `response` shape.
39
46
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -52,11 +59,20 @@ export interface GetSMSSandboxAccountStatusCommandOutput extends GetSMSSandboxAc
52
59
  export declare class GetSMSSandboxAccountStatusCommand extends $Command<GetSMSSandboxAccountStatusCommandInput, GetSMSSandboxAccountStatusCommandOutput, SNSClientResolvedConfig> {
53
60
  readonly input: GetSMSSandboxAccountStatusCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: GetSMSSandboxAccountStatusCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSMSSandboxAccountStatusCommandInput, GetSMSSandboxAccountStatusCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }