@aws-sdk/client-sns 3.296.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 +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PublishBatchInput, PublishBatchResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PublishBatchCommand}.
8
10
  */
9
11
  export interface PublishBatchCommandInput extends PublishBatchInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PublishBatchCommand}.
13
17
  */
14
18
  export interface PublishBatchCommandOutput extends PublishBatchResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Publishes up to ten messages to the specified topic. This is a batch version of
18
23
  * <code>Publish</code>. For FIFO topics, multiple messages within a single batch are
19
24
  * published in the order they are sent, and messages are deduplicated within the batch and
@@ -45,6 +50,8 @@ export interface PublishBatchCommandOutput extends PublishBatchResponse, __Metad
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param PublishBatchCommandInput - {@link PublishBatchCommandInput}
54
+ * @returns {@link PublishBatchCommandOutput}
48
55
  * @see {@link PublishBatchCommandInput} for command's `input` shape.
49
56
  * @see {@link PublishBatchCommandOutput} for command's `response` shape.
50
57
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -125,11 +132,20 @@ export interface PublishBatchCommandOutput extends PublishBatchResponse, __Metad
125
132
  export declare class PublishBatchCommand extends $Command<PublishBatchCommandInput, PublishBatchCommandOutput, SNSClientResolvedConfig> {
126
133
  readonly input: PublishBatchCommandInput;
127
134
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
135
+ /**
136
+ * @public
137
+ */
128
138
  constructor(input: PublishBatchCommandInput);
129
139
  /**
130
140
  * @internal
131
141
  */
132
142
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PublishBatchCommandInput, PublishBatchCommandOutput>;
143
+ /**
144
+ * @internal
145
+ */
133
146
  private serialize;
147
+ /**
148
+ * @internal
149
+ */
134
150
  private deserialize;
135
151
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PublishInput, PublishResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PublishCommand}.
8
10
  */
9
11
  export interface PublishCommandInput extends PublishInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PublishCommand}.
13
17
  */
14
18
  export interface PublishCommandOutput extends PublishResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone
18
23
  * number, or a message to a mobile platform endpoint (when you specify the
19
24
  * <code>TargetArn</code>).</p>
@@ -42,6 +47,8 @@ export interface PublishCommandOutput extends PublishResponse, __MetadataBearer
42
47
  * const response = await client.send(command);
43
48
  * ```
44
49
  *
50
+ * @param PublishCommandInput - {@link PublishCommandInput}
51
+ * @returns {@link PublishCommandOutput}
45
52
  * @see {@link PublishCommandInput} for command's `input` shape.
46
53
  * @see {@link PublishCommandOutput} for command's `response` shape.
47
54
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -107,11 +114,20 @@ export interface PublishCommandOutput extends PublishResponse, __MetadataBearer
107
114
  export declare class PublishCommand extends $Command<PublishCommandInput, PublishCommandOutput, SNSClientResolvedConfig> {
108
115
  readonly input: PublishCommandInput;
109
116
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
117
+ /**
118
+ * @public
119
+ */
110
120
  constructor(input: PublishCommandInput);
111
121
  /**
112
122
  * @internal
113
123
  */
114
124
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PublishCommandInput, PublishCommandOutput>;
125
+ /**
126
+ * @internal
127
+ */
115
128
  private serialize;
129
+ /**
130
+ * @internal
131
+ */
116
132
  private deserialize;
117
133
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutDataProtectionPolicyInput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutDataProtectionPolicyCommand}.
8
10
  */
9
11
  export interface PutDataProtectionPolicyCommandInput extends PutDataProtectionPolicyInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutDataProtectionPolicyCommand}.
13
17
  */
14
18
  export interface PutDataProtectionPolicyCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds or updates an inline policy document that is stored in the specified Amazon SNS
18
23
  * topic.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface PutDataProtectionPolicyCommandOutput extends __MetadataBearer {
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param PutDataProtectionPolicyCommandInput - {@link PutDataProtectionPolicyCommandInput}
35
+ * @returns {@link PutDataProtectionPolicyCommandOutput}
29
36
  * @see {@link PutDataProtectionPolicyCommandInput} for command's `input` shape.
30
37
  * @see {@link PutDataProtectionPolicyCommandOutput} for command's `response` shape.
31
38
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -52,11 +59,20 @@ export interface PutDataProtectionPolicyCommandOutput extends __MetadataBearer {
52
59
  export declare class PutDataProtectionPolicyCommand extends $Command<PutDataProtectionPolicyCommandInput, PutDataProtectionPolicyCommandOutput, SNSClientResolvedConfig> {
53
60
  readonly input: PutDataProtectionPolicyCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: PutDataProtectionPolicyCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutDataProtectionPolicyCommandInput, PutDataProtectionPolicyCommandOutput>;
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 { RemovePermissionInput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RemovePermissionCommand}.
8
10
  */
9
11
  export interface RemovePermissionCommandInput extends RemovePermissionInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RemovePermissionCommand}.
13
17
  */
14
18
  export interface RemovePermissionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a statement from a topic's access control policy.</p>
18
23
  * <note>
19
24
  * <p>To remove the ability to change topic permissions, you must deny permissions to
@@ -30,6 +35,8 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param RemovePermissionCommandInput - {@link RemovePermissionCommandInput}
39
+ * @returns {@link RemovePermissionCommandOutput}
33
40
  * @see {@link RemovePermissionCommandInput} for command's `input` shape.
34
41
  * @see {@link RemovePermissionCommandOutput} for command's `response` shape.
35
42
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -52,11 +59,20 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
52
59
  export declare class RemovePermissionCommand extends $Command<RemovePermissionCommandInput, RemovePermissionCommandOutput, SNSClientResolvedConfig> {
53
60
  readonly input: RemovePermissionCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: RemovePermissionCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemovePermissionCommandInput, RemovePermissionCommandOutput>;
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 { SetEndpointAttributesInput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SetEndpointAttributesCommand}.
8
10
  */
9
11
  export interface SetEndpointAttributesCommandInput extends SetEndpointAttributesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SetEndpointAttributesCommand}.
13
17
  */
14
18
  export interface SetEndpointAttributesCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets the attributes for an endpoint 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 SetEndpointAttributesCommandOutput extends __MetadataBearer {
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param SetEndpointAttributesCommandInput - {@link SetEndpointAttributesCommandInput}
36
+ * @returns {@link SetEndpointAttributesCommandOutput}
30
37
  * @see {@link SetEndpointAttributesCommandInput} for command's `input` shape.
31
38
  * @see {@link SetEndpointAttributesCommandOutput} for command's `response` shape.
32
39
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -49,11 +56,20 @@ export interface SetEndpointAttributesCommandOutput extends __MetadataBearer {
49
56
  export declare class SetEndpointAttributesCommand extends $Command<SetEndpointAttributesCommandInput, SetEndpointAttributesCommandOutput, SNSClientResolvedConfig> {
50
57
  readonly input: SetEndpointAttributesCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: SetEndpointAttributesCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetEndpointAttributesCommandInput, SetEndpointAttributesCommandOutput>;
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 { SetPlatformApplicationAttributesInput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SetPlatformApplicationAttributesCommand}.
8
10
  */
9
11
  export interface SetPlatformApplicationAttributesCommandInput extends SetPlatformApplicationAttributesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SetPlatformApplicationAttributesCommand}.
13
17
  */
14
18
  export interface SetPlatformApplicationAttributesCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets 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>. For information on configuring
@@ -29,6 +34,8 @@ export interface SetPlatformApplicationAttributesCommandOutput extends __Metadat
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param SetPlatformApplicationAttributesCommandInput - {@link SetPlatformApplicationAttributesCommandInput}
38
+ * @returns {@link SetPlatformApplicationAttributesCommandOutput}
32
39
  * @see {@link SetPlatformApplicationAttributesCommandInput} for command's `input` shape.
33
40
  * @see {@link SetPlatformApplicationAttributesCommandOutput} for command's `response` shape.
34
41
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -51,11 +58,20 @@ export interface SetPlatformApplicationAttributesCommandOutput extends __Metadat
51
58
  export declare class SetPlatformApplicationAttributesCommand extends $Command<SetPlatformApplicationAttributesCommandInput, SetPlatformApplicationAttributesCommandOutput, SNSClientResolvedConfig> {
52
59
  readonly input: SetPlatformApplicationAttributesCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: SetPlatformApplicationAttributesCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetPlatformApplicationAttributesCommandInput, SetPlatformApplicationAttributesCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SetSMSAttributesInput, SetSMSAttributesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SetSMSAttributesCommand}.
8
10
  */
9
11
  export interface SetSMSAttributesCommandInput extends SetSMSAttributesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SetSMSAttributesCommand}.
13
17
  */
14
18
  export interface SetSMSAttributesCommandOutput extends SetSMSAttributesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Use this request to set the default settings for sending SMS messages and receiving
18
23
  * daily SMS usage reports.</p>
19
24
  * <p>You can override some of these settings for a single message when you use the
@@ -35,6 +40,8 @@ export interface SetSMSAttributesCommandOutput extends SetSMSAttributesResponse,
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param SetSMSAttributesCommandInput - {@link SetSMSAttributesCommandInput}
44
+ * @returns {@link SetSMSAttributesCommandOutput}
38
45
  * @see {@link SetSMSAttributesCommandInput} for command's `input` shape.
39
46
  * @see {@link SetSMSAttributesCommandOutput} for command's `response` shape.
40
47
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -57,11 +64,20 @@ export interface SetSMSAttributesCommandOutput extends SetSMSAttributesResponse,
57
64
  export declare class SetSMSAttributesCommand extends $Command<SetSMSAttributesCommandInput, SetSMSAttributesCommandOutput, SNSClientResolvedConfig> {
58
65
  readonly input: SetSMSAttributesCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: SetSMSAttributesCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetSMSAttributesCommandInput, SetSMSAttributesCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SetSubscriptionAttributesInput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SetSubscriptionAttributesCommand}.
8
10
  */
9
11
  export interface SetSubscriptionAttributesCommandInput extends SetSubscriptionAttributesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SetSubscriptionAttributesCommand}.
13
17
  */
14
18
  export interface SetSubscriptionAttributesCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Allows a subscription owner to set an attribute of the subscription to a new
18
23
  * value.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface SetSubscriptionAttributesCommandOutput extends __MetadataBearer
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param SetSubscriptionAttributesCommandInput - {@link SetSubscriptionAttributesCommandInput}
35
+ * @returns {@link SetSubscriptionAttributesCommandOutput}
29
36
  * @see {@link SetSubscriptionAttributesCommandInput} for command's `input` shape.
30
37
  * @see {@link SetSubscriptionAttributesCommandOutput} for command's `response` shape.
31
38
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -53,11 +60,20 @@ export interface SetSubscriptionAttributesCommandOutput extends __MetadataBearer
53
60
  export declare class SetSubscriptionAttributesCommand extends $Command<SetSubscriptionAttributesCommandInput, SetSubscriptionAttributesCommandOutput, SNSClientResolvedConfig> {
54
61
  readonly input: SetSubscriptionAttributesCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: SetSubscriptionAttributesCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetSubscriptionAttributesCommandInput, SetSubscriptionAttributesCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SetTopicAttributesInput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SetTopicAttributesCommand}.
8
10
  */
9
11
  export interface SetTopicAttributesCommandInput extends SetTopicAttributesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SetTopicAttributesCommand}.
13
17
  */
14
18
  export interface SetTopicAttributesCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Allows a topic owner to set an attribute of the topic to a new value.</p>
18
23
  * <note>
19
24
  * <p>To remove the ability to change topic permissions, you must deny permissions to
@@ -30,6 +35,8 @@ export interface SetTopicAttributesCommandOutput extends __MetadataBearer {
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param SetTopicAttributesCommandInput - {@link SetTopicAttributesCommandInput}
39
+ * @returns {@link SetTopicAttributesCommandOutput}
33
40
  * @see {@link SetTopicAttributesCommandInput} for command's `input` shape.
34
41
  * @see {@link SetTopicAttributesCommandOutput} for command's `response` shape.
35
42
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -56,11 +63,20 @@ export interface SetTopicAttributesCommandOutput extends __MetadataBearer {
56
63
  export declare class SetTopicAttributesCommand extends $Command<SetTopicAttributesCommandInput, SetTopicAttributesCommandOutput, SNSClientResolvedConfig> {
57
64
  readonly input: SetTopicAttributesCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: SetTopicAttributesCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetTopicAttributesCommandInput, SetTopicAttributesCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SubscribeInput, SubscribeResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SubscribeCommand}.
8
10
  */
9
11
  export interface SubscribeCommandInput extends SubscribeInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SubscribeCommand}.
13
17
  */
14
18
  export interface SubscribeCommandOutput extends SubscribeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or
18
23
  * if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must
19
24
  * run the <code>ConfirmSubscription</code> action to confirm the subscription.</p>
@@ -30,6 +35,8 @@ export interface SubscribeCommandOutput extends SubscribeResponse, __MetadataBea
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param SubscribeCommandInput - {@link SubscribeCommandInput}
39
+ * @returns {@link SubscribeCommandOutput}
33
40
  * @see {@link SubscribeCommandInput} for command's `input` shape.
34
41
  * @see {@link SubscribeCommandOutput} for command's `response` shape.
35
42
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -65,11 +72,20 @@ export interface SubscribeCommandOutput extends SubscribeResponse, __MetadataBea
65
72
  export declare class SubscribeCommand extends $Command<SubscribeCommandInput, SubscribeCommandOutput, SNSClientResolvedConfig> {
66
73
  readonly input: SubscribeCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: SubscribeCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SubscribeCommandInput, SubscribeCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Add tags to the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the
18
23
  * <i>Amazon SNS Developer Guide</i>.</p>
19
24
  * <p>When you use topic tags, keep the following guidelines in mind:</p>
@@ -47,6 +52,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
47
52
  * const response = await client.send(command);
48
53
  * ```
49
54
  *
55
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
56
+ * @returns {@link TagResourceCommandOutput}
50
57
  * @see {@link TagResourceCommandInput} for command's `input` shape.
51
58
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
52
59
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -82,11 +89,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
82
89
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SNSClientResolvedConfig> {
83
90
  readonly input: TagResourceCommandInput;
84
91
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
92
+ /**
93
+ * @public
94
+ */
85
95
  constructor(input: TagResourceCommandInput);
86
96
  /**
87
97
  * @internal
88
98
  */
89
99
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
100
+ /**
101
+ * @internal
102
+ */
90
103
  private serialize;
104
+ /**
105
+ * @internal
106
+ */
91
107
  private deserialize;
92
108
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UnsubscribeInput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UnsubscribeCommand}.
8
10
  */
9
11
  export interface UnsubscribeCommandInput extends UnsubscribeInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UnsubscribeCommand}.
13
17
  */
14
18
  export interface UnsubscribeCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a subscription. If the subscription requires authentication for deletion, only
18
23
  * the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services
19
24
  * signature is required. If the <code>Unsubscribe</code> call does not require
@@ -36,6 +41,8 @@ export interface UnsubscribeCommandOutput extends __MetadataBearer {
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param UnsubscribeCommandInput - {@link UnsubscribeCommandInput}
45
+ * @returns {@link UnsubscribeCommandOutput}
39
46
  * @see {@link UnsubscribeCommandInput} for command's `input` shape.
40
47
  * @see {@link UnsubscribeCommandOutput} for command's `response` shape.
41
48
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -62,11 +69,20 @@ export interface UnsubscribeCommandOutput extends __MetadataBearer {
62
69
  export declare class UnsubscribeCommand extends $Command<UnsubscribeCommandInput, UnsubscribeCommandOutput, SNSClientResolvedConfig> {
63
70
  readonly input: UnsubscribeCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: UnsubscribeCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UnsubscribeCommandInput, UnsubscribeCommandOutput>;
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 { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Remove tags from the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the
18
23
  * <i>Amazon SNS Developer Guide</i>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
35
+ * @returns {@link UntagResourceCommandOutput}
29
36
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -61,11 +68,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
61
68
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SNSClientResolvedConfig> {
62
69
  readonly input: UntagResourceCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: UntagResourceCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }