@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 { GetSubscriptionAttributesInput, GetSubscriptionAttributesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSubscriptionAttributesCommand}.
8
10
  */
9
11
  export interface GetSubscriptionAttributesCommandInput extends GetSubscriptionAttributesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSubscriptionAttributesCommand}.
13
17
  */
14
18
  export interface GetSubscriptionAttributesCommandOutput extends GetSubscriptionAttributesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns all of the properties of a subscription.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetSubscriptionAttributesCommandOutput extends GetSubscriptionA
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetSubscriptionAttributesCommandInput - {@link GetSubscriptionAttributesCommandInput}
34
+ * @returns {@link GetSubscriptionAttributesCommandOutput}
28
35
  * @see {@link GetSubscriptionAttributesCommandInput} for command's `input` shape.
29
36
  * @see {@link GetSubscriptionAttributesCommandOutput} for command's `response` shape.
30
37
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -47,11 +54,20 @@ export interface GetSubscriptionAttributesCommandOutput extends GetSubscriptionA
47
54
  export declare class GetSubscriptionAttributesCommand extends $Command<GetSubscriptionAttributesCommandInput, GetSubscriptionAttributesCommandOutput, SNSClientResolvedConfig> {
48
55
  readonly input: GetSubscriptionAttributesCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: GetSubscriptionAttributesCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSubscriptionAttributesCommandInput, GetSubscriptionAttributesCommandOutput>;
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 { GetTopicAttributesInput, GetTopicAttributesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetTopicAttributesCommand}.
8
10
  */
9
11
  export interface GetTopicAttributesCommandInput extends GetTopicAttributesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetTopicAttributesCommand}.
13
17
  */
14
18
  export interface GetTopicAttributesCommandOutput extends GetTopicAttributesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns all of the properties of a topic. Topic properties returned might differ based
18
23
  * on the authorization of the user.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetTopicAttributesCommandOutput extends GetTopicAttributesRespo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetTopicAttributesCommandInput - {@link GetTopicAttributesCommandInput}
35
+ * @returns {@link GetTopicAttributesCommandOutput}
29
36
  * @see {@link GetTopicAttributesCommandInput} for command's `input` shape.
30
37
  * @see {@link GetTopicAttributesCommandOutput} for command's `response` shape.
31
38
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -52,11 +59,20 @@ export interface GetTopicAttributesCommandOutput extends GetTopicAttributesRespo
52
59
  export declare class GetTopicAttributesCommand extends $Command<GetTopicAttributesCommandInput, GetTopicAttributesCommandOutput, SNSClientResolvedConfig> {
53
60
  readonly input: GetTopicAttributesCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: GetTopicAttributesCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetTopicAttributesCommandInput, GetTopicAttributesCommandOutput>;
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 { ListEndpointsByPlatformApplicationInput, ListEndpointsByPlatformApplicationResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListEndpointsByPlatformApplicationCommand}.
8
10
  */
9
11
  export interface ListEndpointsByPlatformApplicationCommandInput extends ListEndpointsByPlatformApplicationInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListEndpointsByPlatformApplicationCommand}.
13
17
  */
14
18
  export interface ListEndpointsByPlatformApplicationCommandOutput extends ListEndpointsByPlatformApplicationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the endpoints and endpoint attributes for devices in a supported push
18
23
  * notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for
19
24
  * <code>ListEndpointsByPlatformApplication</code> are paginated and return a limited
@@ -34,6 +39,8 @@ export interface ListEndpointsByPlatformApplicationCommandOutput extends ListEnd
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param ListEndpointsByPlatformApplicationCommandInput - {@link ListEndpointsByPlatformApplicationCommandInput}
43
+ * @returns {@link ListEndpointsByPlatformApplicationCommandOutput}
37
44
  * @see {@link ListEndpointsByPlatformApplicationCommandInput} for command's `input` shape.
38
45
  * @see {@link ListEndpointsByPlatformApplicationCommandOutput} for command's `response` shape.
39
46
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -56,11 +63,20 @@ export interface ListEndpointsByPlatformApplicationCommandOutput extends ListEnd
56
63
  export declare class ListEndpointsByPlatformApplicationCommand extends $Command<ListEndpointsByPlatformApplicationCommandInput, ListEndpointsByPlatformApplicationCommandOutput, SNSClientResolvedConfig> {
57
64
  readonly input: ListEndpointsByPlatformApplicationCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: ListEndpointsByPlatformApplicationCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListEndpointsByPlatformApplicationCommandInput, ListEndpointsByPlatformApplicationCommandOutput>;
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 { ListOriginationNumbersRequest, ListOriginationNumbersResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListOriginationNumbersCommand}.
8
10
  */
9
11
  export interface ListOriginationNumbersCommandInput extends ListOriginationNumbersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListOriginationNumbersCommand}.
13
17
  */
14
18
  export interface ListOriginationNumbersCommandOutput extends ListOriginationNumbersResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.
18
23
  * For more information about origination numbers, see <a href="https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html">Origination numbers</a> in the <i>Amazon SNS Developer
19
24
  * Guide</i>.</p>
@@ -27,6 +32,8 @@ export interface ListOriginationNumbersCommandOutput extends ListOriginationNumb
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListOriginationNumbersCommandInput - {@link ListOriginationNumbersCommandInput}
36
+ * @returns {@link ListOriginationNumbersCommandOutput}
30
37
  * @see {@link ListOriginationNumbersCommandInput} for command's `input` shape.
31
38
  * @see {@link ListOriginationNumbersCommandOutput} for command's `response` shape.
32
39
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListOriginationNumbersCommandOutput extends ListOriginationNumb
52
59
  export declare class ListOriginationNumbersCommand extends $Command<ListOriginationNumbersCommandInput, ListOriginationNumbersCommandOutput, SNSClientResolvedConfig> {
53
60
  readonly input: ListOriginationNumbersCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListOriginationNumbersCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListOriginationNumbersCommandInput, ListOriginationNumbersCommandOutput>;
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 { ListPhoneNumbersOptedOutInput, ListPhoneNumbersOptedOutResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPhoneNumbersOptedOutCommand}.
8
10
  */
9
11
  export interface ListPhoneNumbersOptedOutCommandInput extends ListPhoneNumbersOptedOutInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPhoneNumbersOptedOutCommand}.
13
17
  */
14
18
  export interface ListPhoneNumbersOptedOutCommandOutput extends ListPhoneNumbersOptedOutResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of phone numbers that are opted out, meaning you cannot send SMS
18
23
  * messages to them.</p>
19
24
  * <p>The results for <code>ListPhoneNumbersOptedOut</code> are paginated, and each page
@@ -32,6 +37,8 @@ export interface ListPhoneNumbersOptedOutCommandOutput extends ListPhoneNumbersO
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param ListPhoneNumbersOptedOutCommandInput - {@link ListPhoneNumbersOptedOutCommandInput}
41
+ * @returns {@link ListPhoneNumbersOptedOutCommandOutput}
35
42
  * @see {@link ListPhoneNumbersOptedOutCommandInput} for command's `input` shape.
36
43
  * @see {@link ListPhoneNumbersOptedOutCommandOutput} for command's `response` shape.
37
44
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -54,11 +61,20 @@ export interface ListPhoneNumbersOptedOutCommandOutput extends ListPhoneNumbersO
54
61
  export declare class ListPhoneNumbersOptedOutCommand extends $Command<ListPhoneNumbersOptedOutCommandInput, ListPhoneNumbersOptedOutCommandOutput, SNSClientResolvedConfig> {
55
62
  readonly input: ListPhoneNumbersOptedOutCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: ListPhoneNumbersOptedOutCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPhoneNumbersOptedOutCommandInput, ListPhoneNumbersOptedOutCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListPlatformApplicationsInput, ListPlatformApplicationsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPlatformApplicationsCommand}.
8
10
  */
9
11
  export interface ListPlatformApplicationsCommandInput extends ListPlatformApplicationsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPlatformApplicationsCommand}.
13
17
  */
14
18
  export interface ListPlatformApplicationsCommandOutput extends ListPlatformApplicationsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the platform application objects for the supported push notification services,
18
23
  * such as APNS and GCM (Firebase Cloud Messaging). The results for
19
24
  * <code>ListPlatformApplications</code> are paginated and return a limited list of
@@ -34,6 +39,8 @@ export interface ListPlatformApplicationsCommandOutput extends ListPlatformAppli
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param ListPlatformApplicationsCommandInput - {@link ListPlatformApplicationsCommandInput}
43
+ * @returns {@link ListPlatformApplicationsCommandOutput}
37
44
  * @see {@link ListPlatformApplicationsCommandInput} for command's `input` shape.
38
45
  * @see {@link ListPlatformApplicationsCommandOutput} for command's `response` shape.
39
46
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -53,11 +60,20 @@ export interface ListPlatformApplicationsCommandOutput extends ListPlatformAppli
53
60
  export declare class ListPlatformApplicationsCommand extends $Command<ListPlatformApplicationsCommandInput, ListPlatformApplicationsCommandOutput, SNSClientResolvedConfig> {
54
61
  readonly input: ListPlatformApplicationsCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: ListPlatformApplicationsCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPlatformApplicationsCommandInput, ListPlatformApplicationsCommandOutput>;
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 { ListSMSSandboxPhoneNumbersInput, ListSMSSandboxPhoneNumbersResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListSMSSandboxPhoneNumbersCommand}.
8
10
  */
9
11
  export interface ListSMSSandboxPhoneNumbersCommandInput extends ListSMSSandboxPhoneNumbersInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListSMSSandboxPhoneNumbersCommand}.
13
17
  */
14
18
  export interface ListSMSSandboxPhoneNumbersCommandOutput extends ListSMSSandboxPhoneNumbersResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the calling Amazon Web Services account's current verified and pending destination phone
18
23
  * numbers in the SMS 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 ListSMSSandboxPhoneNumbersCommandOutput extends ListSMSSandboxP
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param ListSMSSandboxPhoneNumbersCommandInput - {@link ListSMSSandboxPhoneNumbersCommandInput}
43
+ * @returns {@link ListSMSSandboxPhoneNumbersCommandOutput}
37
44
  * @see {@link ListSMSSandboxPhoneNumbersCommandInput} for command's `input` shape.
38
45
  * @see {@link ListSMSSandboxPhoneNumbersCommandOutput} for command's `response` shape.
39
46
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -60,11 +67,20 @@ export interface ListSMSSandboxPhoneNumbersCommandOutput extends ListSMSSandboxP
60
67
  export declare class ListSMSSandboxPhoneNumbersCommand extends $Command<ListSMSSandboxPhoneNumbersCommandInput, ListSMSSandboxPhoneNumbersCommandOutput, SNSClientResolvedConfig> {
61
68
  readonly input: ListSMSSandboxPhoneNumbersCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: ListSMSSandboxPhoneNumbersCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSMSSandboxPhoneNumbersCommandInput, ListSMSSandboxPhoneNumbersCommandOutput>;
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 { ListSubscriptionsByTopicInput, ListSubscriptionsByTopicResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListSubscriptionsByTopicCommand}.
8
10
  */
9
11
  export interface ListSubscriptionsByTopicCommandInput extends ListSubscriptionsByTopicInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListSubscriptionsByTopicCommand}.
13
17
  */
14
18
  export interface ListSubscriptionsByTopicCommandOutput extends ListSubscriptionsByTopicResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of the subscriptions to a specific topic. Each call returns a limited
18
23
  * list of subscriptions, up to 100. If there are more subscriptions, a
19
24
  * <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in
@@ -29,6 +34,8 @@ export interface ListSubscriptionsByTopicCommandOutput extends ListSubscriptions
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param ListSubscriptionsByTopicCommandInput - {@link ListSubscriptionsByTopicCommandInput}
38
+ * @returns {@link ListSubscriptionsByTopicCommandOutput}
32
39
  * @see {@link ListSubscriptionsByTopicCommandInput} for command's `input` shape.
33
40
  * @see {@link ListSubscriptionsByTopicCommandOutput} for command's `response` shape.
34
41
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -51,11 +58,20 @@ export interface ListSubscriptionsByTopicCommandOutput extends ListSubscriptions
51
58
  export declare class ListSubscriptionsByTopicCommand extends $Command<ListSubscriptionsByTopicCommandInput, ListSubscriptionsByTopicCommandOutput, SNSClientResolvedConfig> {
52
59
  readonly input: ListSubscriptionsByTopicCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: ListSubscriptionsByTopicCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSubscriptionsByTopicCommandInput, ListSubscriptionsByTopicCommandOutput>;
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 { ListSubscriptionsInput, ListSubscriptionsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListSubscriptionsCommand}.
8
10
  */
9
11
  export interface ListSubscriptionsCommandInput extends ListSubscriptionsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListSubscriptionsCommand}.
13
17
  */
14
18
  export interface ListSubscriptionsCommandOutput extends ListSubscriptionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of the requester's subscriptions. Each call returns a limited list of
18
23
  * subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is
19
24
  * also returned. Use the <code>NextToken</code> parameter in a new
@@ -29,6 +34,8 @@ export interface ListSubscriptionsCommandOutput extends ListSubscriptionsRespons
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param ListSubscriptionsCommandInput - {@link ListSubscriptionsCommandInput}
38
+ * @returns {@link ListSubscriptionsCommandOutput}
32
39
  * @see {@link ListSubscriptionsCommandInput} for command's `input` shape.
33
40
  * @see {@link ListSubscriptionsCommandOutput} for command's `response` shape.
34
41
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ListSubscriptionsCommandOutput extends ListSubscriptionsRespons
48
55
  export declare class ListSubscriptionsCommand extends $Command<ListSubscriptionsCommandInput, ListSubscriptionsCommandOutput, SNSClientResolvedConfig> {
49
56
  readonly input: ListSubscriptionsCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: ListSubscriptionsCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSubscriptionsCommandInput, ListSubscriptionsCommandOutput>;
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 { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List all tags added 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 Simple Notification Service Developer Guide</i>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
35
+ * @returns {@link ListTagsForResourceCommandOutput}
29
36
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -54,11 +61,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
54
61
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SNSClientResolvedConfig> {
55
62
  readonly input: ListTagsForResourceCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: ListTagsForResourceCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTopicsInput, ListTopicsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTopicsCommand}.
8
10
  */
9
11
  export interface ListTopicsCommandInput extends ListTopicsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTopicsCommand}.
13
17
  */
14
18
  export interface ListTopicsCommandOutput extends ListTopicsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of the requester's topics. Each call returns a limited list of topics,
18
23
  * up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the
19
24
  * <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get
@@ -29,6 +34,8 @@ export interface ListTopicsCommandOutput extends ListTopicsResponse, __MetadataB
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param ListTopicsCommandInput - {@link ListTopicsCommandInput}
38
+ * @returns {@link ListTopicsCommandOutput}
32
39
  * @see {@link ListTopicsCommandInput} for command's `input` shape.
33
40
  * @see {@link ListTopicsCommandOutput} for command's `response` shape.
34
41
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ListTopicsCommandOutput extends ListTopicsResponse, __MetadataB
48
55
  export declare class ListTopicsCommand extends $Command<ListTopicsCommandInput, ListTopicsCommandOutput, SNSClientResolvedConfig> {
49
56
  readonly input: ListTopicsCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: ListTopicsCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTopicsCommandInput, ListTopicsCommandOutput>;
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 { OptInPhoneNumberInput, OptInPhoneNumberResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SNSClientResolvedConfig } from "../SNSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link OptInPhoneNumberCommand}.
8
10
  */
9
11
  export interface OptInPhoneNumberCommandInput extends OptInPhoneNumberInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link OptInPhoneNumberCommand}.
13
17
  */
14
18
  export interface OptInPhoneNumberCommandOutput extends OptInPhoneNumberResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Use this request to opt in a phone number that is opted out, which enables you to
18
23
  * resume sending SMS messages to the number.</p>
19
24
  * <p>You can opt in a phone number only once every 30 days.</p>
@@ -27,6 +32,8 @@ export interface OptInPhoneNumberCommandOutput extends OptInPhoneNumberResponse,
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param OptInPhoneNumberCommandInput - {@link OptInPhoneNumberCommandInput}
36
+ * @returns {@link OptInPhoneNumberCommandOutput}
30
37
  * @see {@link OptInPhoneNumberCommandInput} for command's `input` shape.
31
38
  * @see {@link OptInPhoneNumberCommandOutput} for command's `response` shape.
32
39
  * @see {@link SNSClientResolvedConfig | config} for SNSClient's `config` shape.
@@ -49,11 +56,20 @@ export interface OptInPhoneNumberCommandOutput extends OptInPhoneNumberResponse,
49
56
  export declare class OptInPhoneNumberCommand extends $Command<OptInPhoneNumberCommandInput, OptInPhoneNumberCommandOutput, SNSClientResolvedConfig> {
50
57
  readonly input: OptInPhoneNumberCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: OptInPhoneNumberCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SNSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<OptInPhoneNumberCommandInput, OptInPhoneNumberCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }