@aws-sdk/client-sns 3.529.1 → 3.535.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.
- package/dist-types/SNS.d.ts +9 -1
- package/dist-types/SNSClient.d.ts +1 -1
- package/dist-types/commands/AddPermissionCommand.d.ts +2 -1
- package/dist-types/commands/CheckIfPhoneNumberIsOptedOutCommand.d.ts +2 -1
- package/dist-types/commands/ConfirmSubscriptionCommand.d.ts +2 -1
- package/dist-types/commands/CreatePlatformApplicationCommand.d.ts +2 -1
- package/dist-types/commands/CreatePlatformEndpointCommand.d.ts +2 -1
- package/dist-types/commands/CreateSMSSandboxPhoneNumberCommand.d.ts +2 -1
- package/dist-types/commands/CreateTopicCommand.d.ts +2 -1
- package/dist-types/commands/DeleteEndpointCommand.d.ts +2 -1
- package/dist-types/commands/DeletePlatformApplicationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSMSSandboxPhoneNumberCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTopicCommand.d.ts +2 -1
- package/dist-types/commands/GetDataProtectionPolicyCommand.d.ts +2 -1
- package/dist-types/commands/GetEndpointAttributesCommand.d.ts +2 -1
- package/dist-types/commands/GetPlatformApplicationAttributesCommand.d.ts +2 -1
- package/dist-types/commands/GetSMSAttributesCommand.d.ts +2 -1
- package/dist-types/commands/GetSMSSandboxAccountStatusCommand.d.ts +2 -1
- package/dist-types/commands/GetSubscriptionAttributesCommand.d.ts +2 -1
- package/dist-types/commands/GetTopicAttributesCommand.d.ts +2 -1
- package/dist-types/commands/ListEndpointsByPlatformApplicationCommand.d.ts +2 -1
- package/dist-types/commands/ListOriginationNumbersCommand.d.ts +2 -1
- package/dist-types/commands/ListPhoneNumbersOptedOutCommand.d.ts +2 -1
- package/dist-types/commands/ListPlatformApplicationsCommand.d.ts +2 -1
- package/dist-types/commands/ListSMSSandboxPhoneNumbersCommand.d.ts +2 -1
- package/dist-types/commands/ListSubscriptionsByTopicCommand.d.ts +2 -1
- package/dist-types/commands/ListSubscriptionsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListTopicsCommand.d.ts +2 -1
- package/dist-types/commands/OptInPhoneNumberCommand.d.ts +2 -1
- package/dist-types/commands/PublishBatchCommand.d.ts +3 -2
- package/dist-types/commands/PublishCommand.d.ts +3 -2
- package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts +2 -1
- package/dist-types/commands/RemovePermissionCommand.d.ts +2 -1
- package/dist-types/commands/SetEndpointAttributesCommand.d.ts +2 -1
- package/dist-types/commands/SetPlatformApplicationAttributesCommand.d.ts +2 -1
- package/dist-types/commands/SetSMSAttributesCommand.d.ts +2 -1
- package/dist-types/commands/SetSubscriptionAttributesCommand.d.ts +2 -1
- package/dist-types/commands/SetTopicAttributesCommand.d.ts +2 -1
- package/dist-types/commands/SubscribeCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UnsubscribeCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/VerifySMSSandboxPhoneNumberCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +248 -248
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/SNS.d.ts +8 -0
- package/dist-types/ts3.4/commands/AddPermissionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CheckIfPhoneNumberIsOptedOutCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ConfirmSubscriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePlatformApplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePlatformEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSMSSandboxPhoneNumberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateTopicCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeletePlatformApplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSMSSandboxPhoneNumberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteTopicCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDataProtectionPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetEndpointAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetPlatformApplicationAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSMSAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSMSSandboxAccountStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSubscriptionAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTopicAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListEndpointsByPlatformApplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListOriginationNumbersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPhoneNumbersOptedOutCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPlatformApplicationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSMSSandboxPhoneNumbersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSubscriptionsByTopicCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSubscriptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTopicsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/OptInPhoneNumberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PublishBatchCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PublishCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/PutDataProtectionPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RemovePermissionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetEndpointAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetPlatformApplicationAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetSMSAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetSubscriptionAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetTopicAttributesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SubscribeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UnsubscribeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/VerifySMSSandboxPhoneNumberCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -5,32 +5,32 @@ import { SNSServiceException as __BaseException } from "./SNSServiceException";
|
|
|
5
5
|
*/
|
|
6
6
|
export interface AddPermissionInput {
|
|
7
7
|
/**
|
|
8
|
-
* @public
|
|
9
8
|
* <p>The ARN of the topic whose access control policy you wish to modify.</p>
|
|
9
|
+
* @public
|
|
10
10
|
*/
|
|
11
11
|
TopicArn: string | undefined;
|
|
12
12
|
/**
|
|
13
|
-
* @public
|
|
14
13
|
* <p>A unique identifier for the new policy statement.</p>
|
|
14
|
+
* @public
|
|
15
15
|
*/
|
|
16
16
|
Label: string | undefined;
|
|
17
17
|
/**
|
|
18
|
-
* @public
|
|
19
18
|
* <p>The Amazon Web Services account IDs of the users (principals) who will be given access to the
|
|
20
19
|
* specified actions. The users must have Amazon Web Services account, but do not need to be signed up
|
|
21
20
|
* for this service.</p>
|
|
21
|
+
* @public
|
|
22
22
|
*/
|
|
23
23
|
AWSAccountId: string[] | undefined;
|
|
24
24
|
/**
|
|
25
|
-
* @public
|
|
26
25
|
* <p>The action you want to allow for the specified principal(s).</p>
|
|
27
26
|
* <p>Valid values: Any Amazon SNS action name, for example <code>Publish</code>.</p>
|
|
27
|
+
* @public
|
|
28
28
|
*/
|
|
29
29
|
ActionName: string[] | undefined;
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
|
-
* @public
|
|
33
32
|
* <p>Indicates that the user has been denied access to the requested resource.</p>
|
|
33
|
+
* @public
|
|
34
34
|
*/
|
|
35
35
|
export declare class AuthorizationErrorException extends __BaseException {
|
|
36
36
|
readonly name: "AuthorizationErrorException";
|
|
@@ -41,8 +41,8 @@ export declare class AuthorizationErrorException extends __BaseException {
|
|
|
41
41
|
constructor(opts: __ExceptionOptionType<AuthorizationErrorException, __BaseException>);
|
|
42
42
|
}
|
|
43
43
|
/**
|
|
44
|
-
* @public
|
|
45
44
|
* <p>Indicates an internal service error.</p>
|
|
45
|
+
* @public
|
|
46
46
|
*/
|
|
47
47
|
export declare class InternalErrorException extends __BaseException {
|
|
48
48
|
readonly name: "InternalErrorException";
|
|
@@ -53,9 +53,9 @@ export declare class InternalErrorException extends __BaseException {
|
|
|
53
53
|
constructor(opts: __ExceptionOptionType<InternalErrorException, __BaseException>);
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
|
-
* @public
|
|
57
56
|
* <p>Indicates that a request parameter does not comply with the associated
|
|
58
57
|
* constraints.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
export declare class InvalidParameterException extends __BaseException {
|
|
61
61
|
readonly name: "InvalidParameterException";
|
|
@@ -66,8 +66,8 @@ export declare class InvalidParameterException extends __BaseException {
|
|
|
66
66
|
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
|
|
67
67
|
}
|
|
68
68
|
/**
|
|
69
|
-
* @public
|
|
70
69
|
* <p>Indicates that the requested resource does not exist.</p>
|
|
70
|
+
* @public
|
|
71
71
|
*/
|
|
72
72
|
export declare class NotFoundException extends __BaseException {
|
|
73
73
|
readonly name: "NotFoundException";
|
|
@@ -78,23 +78,22 @@ export declare class NotFoundException extends __BaseException {
|
|
|
78
78
|
constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
|
|
79
79
|
}
|
|
80
80
|
/**
|
|
81
|
-
* @public
|
|
82
81
|
* <p>The input for the <code>CheckIfPhoneNumberIsOptedOut</code> action.</p>
|
|
82
|
+
* @public
|
|
83
83
|
*/
|
|
84
84
|
export interface CheckIfPhoneNumberIsOptedOutInput {
|
|
85
85
|
/**
|
|
86
|
-
* @public
|
|
87
86
|
* <p>The phone number for which you want to check the opt out status.</p>
|
|
87
|
+
* @public
|
|
88
88
|
*/
|
|
89
89
|
phoneNumber: string | undefined;
|
|
90
90
|
}
|
|
91
91
|
/**
|
|
92
|
-
* @public
|
|
93
92
|
* <p>The response from the <code>CheckIfPhoneNumberIsOptedOut</code> action.</p>
|
|
93
|
+
* @public
|
|
94
94
|
*/
|
|
95
95
|
export interface CheckIfPhoneNumberIsOptedOutResponse {
|
|
96
96
|
/**
|
|
97
|
-
* @public
|
|
98
97
|
* <p>Indicates whether the phone number is opted out:</p>
|
|
99
98
|
* <ul>
|
|
100
99
|
* <li>
|
|
@@ -108,12 +107,13 @@ export interface CheckIfPhoneNumberIsOptedOutResponse {
|
|
|
108
107
|
* messages to it.</p>
|
|
109
108
|
* </li>
|
|
110
109
|
* </ul>
|
|
110
|
+
* @public
|
|
111
111
|
*/
|
|
112
112
|
isOptedOut?: boolean;
|
|
113
113
|
}
|
|
114
114
|
/**
|
|
115
|
-
* @public
|
|
116
115
|
* <p>Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.</p>
|
|
116
|
+
* @public
|
|
117
117
|
*/
|
|
118
118
|
export declare class ThrottledException extends __BaseException {
|
|
119
119
|
readonly name: "ThrottledException";
|
|
@@ -124,45 +124,45 @@ export declare class ThrottledException extends __BaseException {
|
|
|
124
124
|
constructor(opts: __ExceptionOptionType<ThrottledException, __BaseException>);
|
|
125
125
|
}
|
|
126
126
|
/**
|
|
127
|
-
* @public
|
|
128
127
|
* <p>Input for ConfirmSubscription action.</p>
|
|
128
|
+
* @public
|
|
129
129
|
*/
|
|
130
130
|
export interface ConfirmSubscriptionInput {
|
|
131
131
|
/**
|
|
132
|
-
* @public
|
|
133
132
|
* <p>The ARN of the topic for which you wish to confirm a subscription.</p>
|
|
133
|
+
* @public
|
|
134
134
|
*/
|
|
135
135
|
TopicArn: string | undefined;
|
|
136
136
|
/**
|
|
137
|
-
* @public
|
|
138
137
|
* <p>Short-lived token sent to an endpoint during the <code>Subscribe</code> action.</p>
|
|
138
|
+
* @public
|
|
139
139
|
*/
|
|
140
140
|
Token: string | undefined;
|
|
141
141
|
/**
|
|
142
|
-
* @public
|
|
143
142
|
* <p>Disallows unauthenticated unsubscribes of the subscription. If the value of this
|
|
144
143
|
* parameter is <code>true</code> and the request has an Amazon Web Services signature, then only the
|
|
145
144
|
* topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe
|
|
146
145
|
* action requires Amazon Web Services authentication. </p>
|
|
146
|
+
* @public
|
|
147
147
|
*/
|
|
148
148
|
AuthenticateOnUnsubscribe?: string;
|
|
149
149
|
}
|
|
150
150
|
/**
|
|
151
|
-
* @public
|
|
152
151
|
* <p>Response for ConfirmSubscriptions action.</p>
|
|
152
|
+
* @public
|
|
153
153
|
*/
|
|
154
154
|
export interface ConfirmSubscriptionResponse {
|
|
155
155
|
/**
|
|
156
|
-
* @public
|
|
157
156
|
* <p>The ARN of the created subscription.</p>
|
|
157
|
+
* @public
|
|
158
158
|
*/
|
|
159
159
|
SubscriptionArn?: string;
|
|
160
160
|
}
|
|
161
161
|
/**
|
|
162
|
-
* @public
|
|
163
162
|
* <p>Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To
|
|
164
163
|
* add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support
|
|
165
164
|
* Center.</p>
|
|
165
|
+
* @public
|
|
166
166
|
*/
|
|
167
167
|
export declare class FilterPolicyLimitExceededException extends __BaseException {
|
|
168
168
|
readonly name: "FilterPolicyLimitExceededException";
|
|
@@ -173,8 +173,8 @@ export declare class FilterPolicyLimitExceededException extends __BaseException
|
|
|
173
173
|
constructor(opts: __ExceptionOptionType<FilterPolicyLimitExceededException, __BaseException>);
|
|
174
174
|
}
|
|
175
175
|
/**
|
|
176
|
-
* @public
|
|
177
176
|
* <p>Indicates that the request parameter has exceeded the maximum number of concurrent message replays.</p>
|
|
177
|
+
* @public
|
|
178
178
|
*/
|
|
179
179
|
export declare class ReplayLimitExceededException extends __BaseException {
|
|
180
180
|
readonly name: "ReplayLimitExceededException";
|
|
@@ -185,9 +185,9 @@ export declare class ReplayLimitExceededException extends __BaseException {
|
|
|
185
185
|
constructor(opts: __ExceptionOptionType<ReplayLimitExceededException, __BaseException>);
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
188
|
-
* @public
|
|
189
188
|
* <p>Indicates that the customer already owns the maximum allowed number of
|
|
190
189
|
* subscriptions.</p>
|
|
190
|
+
* @public
|
|
191
191
|
*/
|
|
192
192
|
export declare class SubscriptionLimitExceededException extends __BaseException {
|
|
193
193
|
readonly name: "SubscriptionLimitExceededException";
|
|
@@ -198,86 +198,86 @@ export declare class SubscriptionLimitExceededException extends __BaseException
|
|
|
198
198
|
constructor(opts: __ExceptionOptionType<SubscriptionLimitExceededException, __BaseException>);
|
|
199
199
|
}
|
|
200
200
|
/**
|
|
201
|
-
* @public
|
|
202
201
|
* <p>Input for CreatePlatformApplication action.</p>
|
|
202
|
+
* @public
|
|
203
203
|
*/
|
|
204
204
|
export interface CreatePlatformApplicationInput {
|
|
205
205
|
/**
|
|
206
|
-
* @public
|
|
207
206
|
* <p>Application names must be made up of only uppercase and lowercase ASCII letters,
|
|
208
207
|
* numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters
|
|
209
208
|
* long.</p>
|
|
209
|
+
* @public
|
|
210
210
|
*/
|
|
211
211
|
Name: string | undefined;
|
|
212
212
|
/**
|
|
213
|
-
* @public
|
|
214
213
|
* <p>The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push
|
|
215
214
|
* Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).</p>
|
|
215
|
+
* @public
|
|
216
216
|
*/
|
|
217
217
|
Platform: string | undefined;
|
|
218
218
|
/**
|
|
219
|
-
* @public
|
|
220
219
|
* <p>For a list of attributes, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html">
|
|
221
220
|
* <code>SetPlatformApplicationAttributes</code>
|
|
222
221
|
* </a>.</p>
|
|
222
|
+
* @public
|
|
223
223
|
*/
|
|
224
224
|
Attributes: Record<string, string> | undefined;
|
|
225
225
|
}
|
|
226
226
|
/**
|
|
227
|
-
* @public
|
|
228
227
|
* <p>Response from CreatePlatformApplication action.</p>
|
|
228
|
+
* @public
|
|
229
229
|
*/
|
|
230
230
|
export interface CreatePlatformApplicationResponse {
|
|
231
231
|
/**
|
|
232
|
-
* @public
|
|
233
232
|
* <p>
|
|
234
233
|
* <code>PlatformApplicationArn</code> is returned.</p>
|
|
234
|
+
* @public
|
|
235
235
|
*/
|
|
236
236
|
PlatformApplicationArn?: string;
|
|
237
237
|
}
|
|
238
238
|
/**
|
|
239
|
-
* @public
|
|
240
239
|
* <p>Response from CreateEndpoint action.</p>
|
|
240
|
+
* @public
|
|
241
241
|
*/
|
|
242
242
|
export interface CreateEndpointResponse {
|
|
243
243
|
/**
|
|
244
|
-
* @public
|
|
245
244
|
* <p>EndpointArn returned from CreateEndpoint action.</p>
|
|
245
|
+
* @public
|
|
246
246
|
*/
|
|
247
247
|
EndpointArn?: string;
|
|
248
248
|
}
|
|
249
249
|
/**
|
|
250
|
-
* @public
|
|
251
250
|
* <p>Input for CreatePlatformEndpoint action.</p>
|
|
251
|
+
* @public
|
|
252
252
|
*/
|
|
253
253
|
export interface CreatePlatformEndpointInput {
|
|
254
254
|
/**
|
|
255
|
-
* @public
|
|
256
255
|
* <p>
|
|
257
256
|
* <code>PlatformApplicationArn</code> returned from CreatePlatformApplication is used to
|
|
258
257
|
* create a an endpoint.</p>
|
|
258
|
+
* @public
|
|
259
259
|
*/
|
|
260
260
|
PlatformApplicationArn: string | undefined;
|
|
261
261
|
/**
|
|
262
|
-
* @public
|
|
263
262
|
* <p>Unique identifier created by the notification service for an app on a device. The
|
|
264
263
|
* specific name for Token will vary, depending on which notification service is being
|
|
265
264
|
* used. For example, when using APNS as the notification service, you need the device
|
|
266
265
|
* token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token
|
|
267
266
|
* equivalent is called the registration ID.</p>
|
|
267
|
+
* @public
|
|
268
268
|
*/
|
|
269
269
|
Token: string | undefined;
|
|
270
270
|
/**
|
|
271
|
-
* @public
|
|
272
271
|
* <p>Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The
|
|
273
272
|
* data must be in UTF-8 format and less than 2KB.</p>
|
|
273
|
+
* @public
|
|
274
274
|
*/
|
|
275
275
|
CustomUserData?: string;
|
|
276
276
|
/**
|
|
277
|
-
* @public
|
|
278
277
|
* <p>For a list of attributes, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html">
|
|
279
278
|
* <code>SetEndpointAttributes</code>
|
|
280
279
|
* </a>.</p>
|
|
280
|
+
* @public
|
|
281
281
|
*/
|
|
282
282
|
Attributes?: Record<string, string>;
|
|
283
283
|
}
|
|
@@ -309,15 +309,15 @@ export type LanguageCodeString = (typeof LanguageCodeString)[keyof typeof Langua
|
|
|
309
309
|
*/
|
|
310
310
|
export interface CreateSMSSandboxPhoneNumberInput {
|
|
311
311
|
/**
|
|
312
|
-
* @public
|
|
313
312
|
* <p>The destination phone number to verify. On verification, Amazon SNS adds this phone number
|
|
314
313
|
* to the list of verified phone numbers that you can send SMS messages to.</p>
|
|
314
|
+
* @public
|
|
315
315
|
*/
|
|
316
316
|
PhoneNumber: string | undefined;
|
|
317
317
|
/**
|
|
318
|
-
* @public
|
|
319
318
|
* <p>The language to use for sending the OTP. The default value is
|
|
320
319
|
* <code>en-US</code>.</p>
|
|
320
|
+
* @public
|
|
321
321
|
*/
|
|
322
322
|
LanguageCode?: LanguageCodeString;
|
|
323
323
|
}
|
|
@@ -327,9 +327,9 @@ export interface CreateSMSSandboxPhoneNumberInput {
|
|
|
327
327
|
export interface CreateSMSSandboxPhoneNumberResult {
|
|
328
328
|
}
|
|
329
329
|
/**
|
|
330
|
-
* @public
|
|
331
330
|
* <p>Indicates that the specified phone number opted out of receiving SMS messages from
|
|
332
331
|
* your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out.</p>
|
|
332
|
+
* @public
|
|
333
333
|
*/
|
|
334
334
|
export declare class OptedOutException extends __BaseException {
|
|
335
335
|
readonly name: "OptedOutException";
|
|
@@ -340,9 +340,9 @@ export declare class OptedOutException extends __BaseException {
|
|
|
340
340
|
constructor(opts: __ExceptionOptionType<OptedOutException, __BaseException>);
|
|
341
341
|
}
|
|
342
342
|
/**
|
|
343
|
-
* @public
|
|
344
343
|
* <p>Indicates that a request parameter does not comply with the associated
|
|
345
344
|
* constraints.</p>
|
|
345
|
+
* @public
|
|
346
346
|
*/
|
|
347
347
|
export declare class UserErrorException extends __BaseException {
|
|
348
348
|
readonly name: "UserErrorException";
|
|
@@ -353,9 +353,9 @@ export declare class UserErrorException extends __BaseException {
|
|
|
353
353
|
constructor(opts: __ExceptionOptionType<UserErrorException, __BaseException>);
|
|
354
354
|
}
|
|
355
355
|
/**
|
|
356
|
-
* @public
|
|
357
356
|
* <p>Can't perform multiple operations on a tag simultaneously. Perform the operations
|
|
358
357
|
* sequentially.</p>
|
|
358
|
+
* @public
|
|
359
359
|
*/
|
|
360
360
|
export declare class ConcurrentAccessException extends __BaseException {
|
|
361
361
|
readonly name: "ConcurrentAccessException";
|
|
@@ -366,38 +366,37 @@ export declare class ConcurrentAccessException extends __BaseException {
|
|
|
366
366
|
constructor(opts: __ExceptionOptionType<ConcurrentAccessException, __BaseException>);
|
|
367
367
|
}
|
|
368
368
|
/**
|
|
369
|
-
* @public
|
|
370
369
|
* <p>The list of tags to be added to the specified topic.</p>
|
|
370
|
+
* @public
|
|
371
371
|
*/
|
|
372
372
|
export interface Tag {
|
|
373
373
|
/**
|
|
374
|
-
* @public
|
|
375
374
|
* <p>The required key portion of the tag.</p>
|
|
375
|
+
* @public
|
|
376
376
|
*/
|
|
377
377
|
Key: string | undefined;
|
|
378
378
|
/**
|
|
379
|
-
* @public
|
|
380
379
|
* <p>The optional value portion of the tag.</p>
|
|
380
|
+
* @public
|
|
381
381
|
*/
|
|
382
382
|
Value: string | undefined;
|
|
383
383
|
}
|
|
384
384
|
/**
|
|
385
|
-
* @public
|
|
386
385
|
* <p>Input for CreateTopic action.</p>
|
|
386
|
+
* @public
|
|
387
387
|
*/
|
|
388
388
|
export interface CreateTopicInput {
|
|
389
389
|
/**
|
|
390
|
-
* @public
|
|
391
390
|
* <p>The name of the topic you want to create.</p>
|
|
392
391
|
* <p>Constraints: Topic names must be made up of only uppercase and lowercase ASCII
|
|
393
392
|
* letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters
|
|
394
393
|
* long.</p>
|
|
395
394
|
* <p>For a FIFO (first-in-first-out) topic, the name must end with the <code>.fifo</code>
|
|
396
395
|
* suffix. </p>
|
|
396
|
+
* @public
|
|
397
397
|
*/
|
|
398
398
|
Name: string | undefined;
|
|
399
399
|
/**
|
|
400
|
-
* @public
|
|
401
400
|
* <p>A map of attributes with their corresponding values.</p>
|
|
402
401
|
* <p>The following lists the names, descriptions, and values of the special request
|
|
403
402
|
* parameters that the <code>CreateTopic</code> action uses:</p>
|
|
@@ -485,42 +484,43 @@ export interface CreateTopicInput {
|
|
|
485
484
|
* </ul>
|
|
486
485
|
* </li>
|
|
487
486
|
* </ul>
|
|
487
|
+
* @public
|
|
488
488
|
*/
|
|
489
489
|
Attributes?: Record<string, string>;
|
|
490
490
|
/**
|
|
491
|
-
* @public
|
|
492
491
|
* <p>The list of tags to add to a new topic.</p>
|
|
493
492
|
* <note>
|
|
494
493
|
* <p>To be able to tag a topic on creation, you must have the
|
|
495
494
|
* <code>sns:CreateTopic</code> and <code>sns:TagResource</code>
|
|
496
495
|
* permissions.</p>
|
|
497
496
|
* </note>
|
|
497
|
+
* @public
|
|
498
498
|
*/
|
|
499
499
|
Tags?: Tag[];
|
|
500
500
|
/**
|
|
501
|
-
* @public
|
|
502
501
|
* <p>The body of the policy document you want to use for this topic.</p>
|
|
503
502
|
* <p>You can only add one policy per topic.</p>
|
|
504
503
|
* <p>The policy must be in JSON string format.</p>
|
|
505
504
|
* <p>Length Constraints: Maximum length of 30,720.</p>
|
|
505
|
+
* @public
|
|
506
506
|
*/
|
|
507
507
|
DataProtectionPolicy?: string;
|
|
508
508
|
}
|
|
509
509
|
/**
|
|
510
|
-
* @public
|
|
511
510
|
* <p>Response from CreateTopic action.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
export interface CreateTopicResponse {
|
|
514
514
|
/**
|
|
515
|
-
* @public
|
|
516
515
|
* <p>The Amazon Resource Name (ARN) assigned to the created topic.</p>
|
|
516
|
+
* @public
|
|
517
517
|
*/
|
|
518
518
|
TopicArn?: string;
|
|
519
519
|
}
|
|
520
520
|
/**
|
|
521
|
-
* @public
|
|
522
521
|
* <p>The credential signature isn't valid. You must use an HTTPS endpoint and sign your
|
|
523
522
|
* request using Signature Version 4.</p>
|
|
523
|
+
* @public
|
|
524
524
|
*/
|
|
525
525
|
export declare class InvalidSecurityException extends __BaseException {
|
|
526
526
|
readonly name: "InvalidSecurityException";
|
|
@@ -531,9 +531,9 @@ export declare class InvalidSecurityException extends __BaseException {
|
|
|
531
531
|
constructor(opts: __ExceptionOptionType<InvalidSecurityException, __BaseException>);
|
|
532
532
|
}
|
|
533
533
|
/**
|
|
534
|
-
* @public
|
|
535
534
|
* <p>A tag has been added to a resource with the same ARN as a deleted resource. Wait a
|
|
536
535
|
* short while and then retry the operation.</p>
|
|
536
|
+
* @public
|
|
537
537
|
*/
|
|
538
538
|
export declare class StaleTagException extends __BaseException {
|
|
539
539
|
readonly name: "StaleTagException";
|
|
@@ -544,8 +544,8 @@ export declare class StaleTagException extends __BaseException {
|
|
|
544
544
|
constructor(opts: __ExceptionOptionType<StaleTagException, __BaseException>);
|
|
545
545
|
}
|
|
546
546
|
/**
|
|
547
|
-
* @public
|
|
548
547
|
* <p>Can't add more than 50 tags to a topic.</p>
|
|
548
|
+
* @public
|
|
549
549
|
*/
|
|
550
550
|
export declare class TagLimitExceededException extends __BaseException {
|
|
551
551
|
readonly name: "TagLimitExceededException";
|
|
@@ -556,9 +556,9 @@ export declare class TagLimitExceededException extends __BaseException {
|
|
|
556
556
|
constructor(opts: __ExceptionOptionType<TagLimitExceededException, __BaseException>);
|
|
557
557
|
}
|
|
558
558
|
/**
|
|
559
|
-
* @public
|
|
560
559
|
* <p>The request doesn't comply with the IAM tag policy. Correct your request and then
|
|
561
560
|
* retry it.</p>
|
|
561
|
+
* @public
|
|
562
562
|
*/
|
|
563
563
|
export declare class TagPolicyException extends __BaseException {
|
|
564
564
|
readonly name: "TagPolicyException";
|
|
@@ -569,8 +569,8 @@ export declare class TagPolicyException extends __BaseException {
|
|
|
569
569
|
constructor(opts: __ExceptionOptionType<TagPolicyException, __BaseException>);
|
|
570
570
|
}
|
|
571
571
|
/**
|
|
572
|
-
* @public
|
|
573
572
|
* <p>Indicates that the customer already owns the maximum allowed number of topics.</p>
|
|
573
|
+
* @public
|
|
574
574
|
*/
|
|
575
575
|
export declare class TopicLimitExceededException extends __BaseException {
|
|
576
576
|
readonly name: "TopicLimitExceededException";
|
|
@@ -581,26 +581,26 @@ export declare class TopicLimitExceededException extends __BaseException {
|
|
|
581
581
|
constructor(opts: __ExceptionOptionType<TopicLimitExceededException, __BaseException>);
|
|
582
582
|
}
|
|
583
583
|
/**
|
|
584
|
-
* @public
|
|
585
584
|
* <p>Input for <code>DeleteEndpoint</code> action.</p>
|
|
585
|
+
* @public
|
|
586
586
|
*/
|
|
587
587
|
export interface DeleteEndpointInput {
|
|
588
588
|
/**
|
|
589
|
-
* @public
|
|
590
589
|
* <p>
|
|
591
590
|
* <code>EndpointArn</code> of endpoint to delete.</p>
|
|
591
|
+
* @public
|
|
592
592
|
*/
|
|
593
593
|
EndpointArn: string | undefined;
|
|
594
594
|
}
|
|
595
595
|
/**
|
|
596
|
-
* @public
|
|
597
596
|
* <p>Input for <code>DeletePlatformApplication</code> action.</p>
|
|
597
|
+
* @public
|
|
598
598
|
*/
|
|
599
599
|
export interface DeletePlatformApplicationInput {
|
|
600
600
|
/**
|
|
601
|
-
* @public
|
|
602
601
|
* <p>
|
|
603
602
|
* <code>PlatformApplicationArn</code> of platform application object to delete.</p>
|
|
603
|
+
* @public
|
|
604
604
|
*/
|
|
605
605
|
PlatformApplicationArn: string | undefined;
|
|
606
606
|
}
|
|
@@ -609,8 +609,8 @@ export interface DeletePlatformApplicationInput {
|
|
|
609
609
|
*/
|
|
610
610
|
export interface DeleteSMSSandboxPhoneNumberInput {
|
|
611
611
|
/**
|
|
612
|
-
* @public
|
|
613
612
|
* <p>The destination phone number to delete.</p>
|
|
613
|
+
* @public
|
|
614
614
|
*/
|
|
615
615
|
PhoneNumber: string | undefined;
|
|
616
616
|
}
|
|
@@ -620,9 +620,9 @@ export interface DeleteSMSSandboxPhoneNumberInput {
|
|
|
620
620
|
export interface DeleteSMSSandboxPhoneNumberResult {
|
|
621
621
|
}
|
|
622
622
|
/**
|
|
623
|
-
* @public
|
|
624
623
|
* <p>Can’t perform the action on the specified resource. Make sure that the resource
|
|
625
624
|
* exists.</p>
|
|
625
|
+
* @public
|
|
626
626
|
*/
|
|
627
627
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
628
628
|
readonly name: "ResourceNotFoundException";
|
|
@@ -637,14 +637,14 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
637
637
|
*/
|
|
638
638
|
export interface DeleteTopicInput {
|
|
639
639
|
/**
|
|
640
|
-
* @public
|
|
641
640
|
* <p>The ARN of the topic you want to delete.</p>
|
|
641
|
+
* @public
|
|
642
642
|
*/
|
|
643
643
|
TopicArn: string | undefined;
|
|
644
644
|
}
|
|
645
645
|
/**
|
|
646
|
-
* @public
|
|
647
646
|
* <p>Indicates that the specified state is not a valid state for an event source.</p>
|
|
647
|
+
* @public
|
|
648
648
|
*/
|
|
649
649
|
export declare class InvalidStateException extends __BaseException {
|
|
650
650
|
readonly name: "InvalidStateException";
|
|
@@ -659,10 +659,10 @@ export declare class InvalidStateException extends __BaseException {
|
|
|
659
659
|
*/
|
|
660
660
|
export interface GetDataProtectionPolicyInput {
|
|
661
661
|
/**
|
|
662
|
-
* @public
|
|
663
662
|
* <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to get.</p>
|
|
664
663
|
* <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names
|
|
665
664
|
* (ARNs)</a> in the Amazon Web Services General Reference.</p>
|
|
665
|
+
* @public
|
|
666
666
|
*/
|
|
667
667
|
ResourceArn: string | undefined;
|
|
668
668
|
}
|
|
@@ -671,31 +671,30 @@ export interface GetDataProtectionPolicyInput {
|
|
|
671
671
|
*/
|
|
672
672
|
export interface GetDataProtectionPolicyResponse {
|
|
673
673
|
/**
|
|
674
|
-
* @public
|
|
675
674
|
* <p>Retrieves the <code>DataProtectionPolicy</code> in JSON string format.</p>
|
|
675
|
+
* @public
|
|
676
676
|
*/
|
|
677
677
|
DataProtectionPolicy?: string;
|
|
678
678
|
}
|
|
679
679
|
/**
|
|
680
|
-
* @public
|
|
681
680
|
* <p>Input for <code>GetEndpointAttributes</code> action.</p>
|
|
681
|
+
* @public
|
|
682
682
|
*/
|
|
683
683
|
export interface GetEndpointAttributesInput {
|
|
684
684
|
/**
|
|
685
|
-
* @public
|
|
686
685
|
* <p>
|
|
687
686
|
* <code>EndpointArn</code> for <code>GetEndpointAttributes</code> input.</p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
EndpointArn: string | undefined;
|
|
690
690
|
}
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>Response from <code>GetEndpointAttributes</code> of the
|
|
694
693
|
* <code>EndpointArn</code>.</p>
|
|
694
|
+
* @public
|
|
695
695
|
*/
|
|
696
696
|
export interface GetEndpointAttributesResponse {
|
|
697
697
|
/**
|
|
698
|
-
* @public
|
|
699
698
|
* <p>Attributes include the following:</p>
|
|
700
699
|
* <ul>
|
|
701
700
|
* <li>
|
|
@@ -722,28 +721,28 @@ export interface GetEndpointAttributesResponse {
|
|
|
722
721
|
* </note>
|
|
723
722
|
* </li>
|
|
724
723
|
* </ul>
|
|
724
|
+
* @public
|
|
725
725
|
*/
|
|
726
726
|
Attributes?: Record<string, string>;
|
|
727
727
|
}
|
|
728
728
|
/**
|
|
729
|
-
* @public
|
|
730
729
|
* <p>Input for <code>GetPlatformApplicationAttributes</code> action.</p>
|
|
730
|
+
* @public
|
|
731
731
|
*/
|
|
732
732
|
export interface GetPlatformApplicationAttributesInput {
|
|
733
733
|
/**
|
|
734
|
-
* @public
|
|
735
734
|
* <p>
|
|
736
735
|
* <code>PlatformApplicationArn</code> for GetPlatformApplicationAttributesInput.</p>
|
|
736
|
+
* @public
|
|
737
737
|
*/
|
|
738
738
|
PlatformApplicationArn: string | undefined;
|
|
739
739
|
}
|
|
740
740
|
/**
|
|
741
|
-
* @public
|
|
742
741
|
* <p>Response for <code>GetPlatformApplicationAttributes</code> action.</p>
|
|
742
|
+
* @public
|
|
743
743
|
*/
|
|
744
744
|
export interface GetPlatformApplicationAttributesResponse {
|
|
745
745
|
/**
|
|
746
|
-
* @public
|
|
747
746
|
* <p>Attributes include the following:</p>
|
|
748
747
|
* <ul>
|
|
749
748
|
* <li>
|
|
@@ -797,31 +796,32 @@ export interface GetPlatformApplicationAttributesResponse {
|
|
|
797
796
|
* (permanent) to one of the application's endpoints.</p>
|
|
798
797
|
* </li>
|
|
799
798
|
* </ul>
|
|
799
|
+
* @public
|
|
800
800
|
*/
|
|
801
801
|
Attributes?: Record<string, string>;
|
|
802
802
|
}
|
|
803
803
|
/**
|
|
804
|
-
* @public
|
|
805
804
|
* <p>The input for the <code>GetSMSAttributes</code> request.</p>
|
|
805
|
+
* @public
|
|
806
806
|
*/
|
|
807
807
|
export interface GetSMSAttributesInput {
|
|
808
808
|
/**
|
|
809
|
-
* @public
|
|
810
809
|
* <p>A list of the individual attribute names, such as <code>MonthlySpendLimit</code>, for
|
|
811
810
|
* which you want values.</p>
|
|
812
811
|
* <p>For all attribute names, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html">SetSMSAttributes</a>.</p>
|
|
813
812
|
* <p>If you don't use this parameter, Amazon SNS returns all SMS attributes.</p>
|
|
813
|
+
* @public
|
|
814
814
|
*/
|
|
815
815
|
attributes?: string[];
|
|
816
816
|
}
|
|
817
817
|
/**
|
|
818
|
-
* @public
|
|
819
818
|
* <p>The response from the <code>GetSMSAttributes</code> request.</p>
|
|
819
|
+
* @public
|
|
820
820
|
*/
|
|
821
821
|
export interface GetSMSAttributesResponse {
|
|
822
822
|
/**
|
|
823
|
-
* @public
|
|
824
823
|
* <p>The SMS attribute names and their values.</p>
|
|
824
|
+
* @public
|
|
825
825
|
*/
|
|
826
826
|
attributes?: Record<string, string>;
|
|
827
827
|
}
|
|
@@ -835,29 +835,28 @@ export interface GetSMSSandboxAccountStatusInput {
|
|
|
835
835
|
*/
|
|
836
836
|
export interface GetSMSSandboxAccountStatusResult {
|
|
837
837
|
/**
|
|
838
|
-
* @public
|
|
839
838
|
* <p>Indicates whether the calling Amazon Web Services account is in the SMS sandbox.</p>
|
|
839
|
+
* @public
|
|
840
840
|
*/
|
|
841
841
|
IsInSandbox: boolean | undefined;
|
|
842
842
|
}
|
|
843
843
|
/**
|
|
844
|
-
* @public
|
|
845
844
|
* <p>Input for GetSubscriptionAttributes.</p>
|
|
845
|
+
* @public
|
|
846
846
|
*/
|
|
847
847
|
export interface GetSubscriptionAttributesInput {
|
|
848
848
|
/**
|
|
849
|
-
* @public
|
|
850
849
|
* <p>The ARN of the subscription whose properties you want to get.</p>
|
|
850
|
+
* @public
|
|
851
851
|
*/
|
|
852
852
|
SubscriptionArn: string | undefined;
|
|
853
853
|
}
|
|
854
854
|
/**
|
|
855
|
-
* @public
|
|
856
855
|
* <p>Response for GetSubscriptionAttributes action.</p>
|
|
856
|
+
* @public
|
|
857
857
|
*/
|
|
858
858
|
export interface GetSubscriptionAttributesResponse {
|
|
859
859
|
/**
|
|
860
|
-
* @public
|
|
861
860
|
* <p>A map of the subscription's attributes. Attributes in this map include the
|
|
862
861
|
* following:</p>
|
|
863
862
|
* <ul>
|
|
@@ -952,27 +951,27 @@ export interface GetSubscriptionAttributesResponse {
|
|
|
952
951
|
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
|
|
953
952
|
* </li>
|
|
954
953
|
* </ul>
|
|
954
|
+
* @public
|
|
955
955
|
*/
|
|
956
956
|
Attributes?: Record<string, string>;
|
|
957
957
|
}
|
|
958
958
|
/**
|
|
959
|
-
* @public
|
|
960
959
|
* <p>Input for GetTopicAttributes action.</p>
|
|
960
|
+
* @public
|
|
961
961
|
*/
|
|
962
962
|
export interface GetTopicAttributesInput {
|
|
963
963
|
/**
|
|
964
|
-
* @public
|
|
965
964
|
* <p>The ARN of the topic whose properties you want to get.</p>
|
|
965
|
+
* @public
|
|
966
966
|
*/
|
|
967
967
|
TopicArn: string | undefined;
|
|
968
968
|
}
|
|
969
969
|
/**
|
|
970
|
-
* @public
|
|
971
970
|
* <p>Response for GetTopicAttributes action.</p>
|
|
971
|
+
* @public
|
|
972
972
|
*/
|
|
973
973
|
export interface GetTopicAttributesResponse {
|
|
974
974
|
/**
|
|
975
|
-
* @public
|
|
976
975
|
* <p>A map of the topic's attributes. Attributes in this map include the following:</p>
|
|
977
976
|
* <ul>
|
|
978
977
|
* <li>
|
|
@@ -1088,62 +1087,63 @@ export interface GetTopicAttributesResponse {
|
|
|
1088
1087
|
* </ul>
|
|
1089
1088
|
* </li>
|
|
1090
1089
|
* </ul>
|
|
1090
|
+
* @public
|
|
1091
1091
|
*/
|
|
1092
1092
|
Attributes?: Record<string, string>;
|
|
1093
1093
|
}
|
|
1094
1094
|
/**
|
|
1095
|
-
* @public
|
|
1096
1095
|
* <p>Input for <code>ListEndpointsByPlatformApplication</code> action.</p>
|
|
1096
|
+
* @public
|
|
1097
1097
|
*/
|
|
1098
1098
|
export interface ListEndpointsByPlatformApplicationInput {
|
|
1099
1099
|
/**
|
|
1100
|
-
* @public
|
|
1101
1100
|
* <p>
|
|
1102
1101
|
* <code>PlatformApplicationArn</code> for
|
|
1103
1102
|
* <code>ListEndpointsByPlatformApplicationInput</code> action.</p>
|
|
1103
|
+
* @public
|
|
1104
1104
|
*/
|
|
1105
1105
|
PlatformApplicationArn: string | undefined;
|
|
1106
1106
|
/**
|
|
1107
|
-
* @public
|
|
1108
1107
|
* <p>
|
|
1109
1108
|
* <code>NextToken</code> string is used when calling
|
|
1110
1109
|
* <code>ListEndpointsByPlatformApplication</code> action to retrieve additional
|
|
1111
1110
|
* records that are available after the first page results.</p>
|
|
1111
|
+
* @public
|
|
1112
1112
|
*/
|
|
1113
1113
|
NextToken?: string;
|
|
1114
1114
|
}
|
|
1115
1115
|
/**
|
|
1116
|
-
* @public
|
|
1117
1116
|
* <p>The endpoint for mobile app and device.</p>
|
|
1117
|
+
* @public
|
|
1118
1118
|
*/
|
|
1119
1119
|
export interface Endpoint {
|
|
1120
1120
|
/**
|
|
1121
|
-
* @public
|
|
1122
1121
|
* <p>The <code>EndpointArn</code> for mobile app and device.</p>
|
|
1122
|
+
* @public
|
|
1123
1123
|
*/
|
|
1124
1124
|
EndpointArn?: string;
|
|
1125
1125
|
/**
|
|
1126
|
-
* @public
|
|
1127
1126
|
* <p>Attributes for endpoint.</p>
|
|
1127
|
+
* @public
|
|
1128
1128
|
*/
|
|
1129
1129
|
Attributes?: Record<string, string>;
|
|
1130
1130
|
}
|
|
1131
1131
|
/**
|
|
1132
|
-
* @public
|
|
1133
1132
|
* <p>Response for <code>ListEndpointsByPlatformApplication</code> action.</p>
|
|
1133
|
+
* @public
|
|
1134
1134
|
*/
|
|
1135
1135
|
export interface ListEndpointsByPlatformApplicationResponse {
|
|
1136
1136
|
/**
|
|
1137
|
-
* @public
|
|
1138
1137
|
* <p>Endpoints returned for <code>ListEndpointsByPlatformApplication</code> action.</p>
|
|
1138
|
+
* @public
|
|
1139
1139
|
*/
|
|
1140
1140
|
Endpoints?: Endpoint[];
|
|
1141
1141
|
/**
|
|
1142
|
-
* @public
|
|
1143
1142
|
* <p>
|
|
1144
1143
|
* <code>NextToken</code> string is returned when calling
|
|
1145
1144
|
* <code>ListEndpointsByPlatformApplication</code> action if additional records are
|
|
1146
1145
|
* available after the first page results.</p>
|
|
1146
|
+
* @public
|
|
1147
1147
|
*/
|
|
1148
1148
|
NextToken?: string;
|
|
1149
1149
|
}
|
|
@@ -1152,13 +1152,13 @@ export interface ListEndpointsByPlatformApplicationResponse {
|
|
|
1152
1152
|
*/
|
|
1153
1153
|
export interface ListOriginationNumbersRequest {
|
|
1154
1154
|
/**
|
|
1155
|
-
* @public
|
|
1156
1155
|
* <p>Token that the previous <code>ListOriginationNumbers</code> request returns.</p>
|
|
1156
|
+
* @public
|
|
1157
1157
|
*/
|
|
1158
1158
|
NextToken?: string;
|
|
1159
1159
|
/**
|
|
1160
|
-
* @public
|
|
1161
1160
|
* <p>The maximum number of origination numbers to return.</p>
|
|
1161
|
+
* @public
|
|
1162
1162
|
*/
|
|
1163
1163
|
MaxResults?: number;
|
|
1164
1164
|
}
|
|
@@ -1189,38 +1189,38 @@ export declare const RouteType: {
|
|
|
1189
1189
|
*/
|
|
1190
1190
|
export type RouteType = (typeof RouteType)[keyof typeof RouteType];
|
|
1191
1191
|
/**
|
|
1192
|
-
* @public
|
|
1193
1192
|
* <p>A list of phone numbers and their metadata.</p>
|
|
1193
|
+
* @public
|
|
1194
1194
|
*/
|
|
1195
1195
|
export interface PhoneNumberInformation {
|
|
1196
1196
|
/**
|
|
1197
|
-
* @public
|
|
1198
1197
|
* <p>The date and time when the phone number was created.</p>
|
|
1198
|
+
* @public
|
|
1199
1199
|
*/
|
|
1200
1200
|
CreatedAt?: Date;
|
|
1201
1201
|
/**
|
|
1202
|
-
* @public
|
|
1203
1202
|
* <p>The phone number.</p>
|
|
1203
|
+
* @public
|
|
1204
1204
|
*/
|
|
1205
1205
|
PhoneNumber?: string;
|
|
1206
1206
|
/**
|
|
1207
|
-
* @public
|
|
1208
1207
|
* <p>The status of the phone number.</p>
|
|
1208
|
+
* @public
|
|
1209
1209
|
*/
|
|
1210
1210
|
Status?: string;
|
|
1211
1211
|
/**
|
|
1212
|
-
* @public
|
|
1213
1212
|
* <p>The two-character code for the country or region, in ISO 3166-1 alpha-2 format.</p>
|
|
1213
|
+
* @public
|
|
1214
1214
|
*/
|
|
1215
1215
|
Iso2CountryCode?: string;
|
|
1216
1216
|
/**
|
|
1217
|
-
* @public
|
|
1218
1217
|
* <p>The list of supported routes.</p>
|
|
1218
|
+
* @public
|
|
1219
1219
|
*/
|
|
1220
1220
|
RouteType?: RouteType;
|
|
1221
1221
|
/**
|
|
1222
|
-
* @public
|
|
1223
1222
|
* <p>The capabilities of each phone number.</p>
|
|
1223
|
+
* @public
|
|
1224
1224
|
*/
|
|
1225
1225
|
NumberCapabilities?: NumberCapability[];
|
|
1226
1226
|
}
|
|
@@ -1229,21 +1229,21 @@ export interface PhoneNumberInformation {
|
|
|
1229
1229
|
*/
|
|
1230
1230
|
export interface ListOriginationNumbersResult {
|
|
1231
1231
|
/**
|
|
1232
|
-
* @public
|
|
1233
1232
|
* <p>A <code>NextToken</code> string is returned when you call the
|
|
1234
1233
|
* <code>ListOriginationNumbers</code> operation if additional pages of records are
|
|
1235
1234
|
* available.</p>
|
|
1235
|
+
* @public
|
|
1236
1236
|
*/
|
|
1237
1237
|
NextToken?: string;
|
|
1238
1238
|
/**
|
|
1239
|
-
* @public
|
|
1240
1239
|
* <p>A list of the calling account's verified and pending origination numbers.</p>
|
|
1240
|
+
* @public
|
|
1241
1241
|
*/
|
|
1242
1242
|
PhoneNumbers?: PhoneNumberInformation[];
|
|
1243
1243
|
}
|
|
1244
1244
|
/**
|
|
1245
|
-
* @public
|
|
1246
1245
|
* <p>Indicates that a parameter in the request is invalid.</p>
|
|
1246
|
+
* @public
|
|
1247
1247
|
*/
|
|
1248
1248
|
export declare class ValidationException extends __BaseException {
|
|
1249
1249
|
readonly name: "ValidationException";
|
|
@@ -1255,84 +1255,84 @@ export declare class ValidationException extends __BaseException {
|
|
|
1255
1255
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
1256
1256
|
}
|
|
1257
1257
|
/**
|
|
1258
|
-
* @public
|
|
1259
1258
|
* <p>The input for the <code>ListPhoneNumbersOptedOut</code> action.</p>
|
|
1259
|
+
* @public
|
|
1260
1260
|
*/
|
|
1261
1261
|
export interface ListPhoneNumbersOptedOutInput {
|
|
1262
1262
|
/**
|
|
1263
|
-
* @public
|
|
1264
1263
|
* <p>A <code>NextToken</code> string is used when you call the
|
|
1265
1264
|
* <code>ListPhoneNumbersOptedOut</code> action to retrieve additional records that are
|
|
1266
1265
|
* available after the first page of results.</p>
|
|
1266
|
+
* @public
|
|
1267
1267
|
*/
|
|
1268
1268
|
nextToken?: string;
|
|
1269
1269
|
}
|
|
1270
1270
|
/**
|
|
1271
|
-
* @public
|
|
1272
1271
|
* <p>The response from the <code>ListPhoneNumbersOptedOut</code> action.</p>
|
|
1272
|
+
* @public
|
|
1273
1273
|
*/
|
|
1274
1274
|
export interface ListPhoneNumbersOptedOutResponse {
|
|
1275
1275
|
/**
|
|
1276
|
-
* @public
|
|
1277
1276
|
* <p>A list of phone numbers that are opted out of receiving SMS messages. The list is
|
|
1278
1277
|
* paginated, and each page can contain up to 100 phone numbers.</p>
|
|
1278
|
+
* @public
|
|
1279
1279
|
*/
|
|
1280
1280
|
phoneNumbers?: string[];
|
|
1281
1281
|
/**
|
|
1282
|
-
* @public
|
|
1283
1282
|
* <p>A <code>NextToken</code> string is returned when you call the
|
|
1284
1283
|
* <code>ListPhoneNumbersOptedOut</code> action if additional records are available
|
|
1285
1284
|
* after the first page of results.</p>
|
|
1285
|
+
* @public
|
|
1286
1286
|
*/
|
|
1287
1287
|
nextToken?: string;
|
|
1288
1288
|
}
|
|
1289
1289
|
/**
|
|
1290
|
-
* @public
|
|
1291
1290
|
* <p>Input for <code>ListPlatformApplications</code> action.</p>
|
|
1291
|
+
* @public
|
|
1292
1292
|
*/
|
|
1293
1293
|
export interface ListPlatformApplicationsInput {
|
|
1294
1294
|
/**
|
|
1295
|
-
* @public
|
|
1296
1295
|
* <p>
|
|
1297
1296
|
* <code>NextToken</code> string is used when calling
|
|
1298
1297
|
* <code>ListPlatformApplications</code> action to retrieve additional records that are
|
|
1299
1298
|
* available after the first page results.</p>
|
|
1299
|
+
* @public
|
|
1300
1300
|
*/
|
|
1301
1301
|
NextToken?: string;
|
|
1302
1302
|
}
|
|
1303
1303
|
/**
|
|
1304
|
-
* @public
|
|
1305
1304
|
* <p>Platform application object.</p>
|
|
1305
|
+
* @public
|
|
1306
1306
|
*/
|
|
1307
1307
|
export interface PlatformApplication {
|
|
1308
1308
|
/**
|
|
1309
|
-
* @public
|
|
1310
1309
|
* <p>PlatformApplicationArn for platform application object.</p>
|
|
1310
|
+
* @public
|
|
1311
1311
|
*/
|
|
1312
1312
|
PlatformApplicationArn?: string;
|
|
1313
1313
|
/**
|
|
1314
|
-
* @public
|
|
1315
1314
|
* <p>Attributes for platform application object.</p>
|
|
1315
|
+
* @public
|
|
1316
1316
|
*/
|
|
1317
1317
|
Attributes?: Record<string, string>;
|
|
1318
1318
|
}
|
|
1319
1319
|
/**
|
|
1320
|
-
* @public
|
|
1321
1320
|
* <p>Response for <code>ListPlatformApplications</code> action.</p>
|
|
1321
|
+
* @public
|
|
1322
1322
|
*/
|
|
1323
1323
|
export interface ListPlatformApplicationsResponse {
|
|
1324
1324
|
/**
|
|
1325
|
-
* @public
|
|
1326
1325
|
* <p>Platform applications returned when calling <code>ListPlatformApplications</code>
|
|
1327
1326
|
* action.</p>
|
|
1327
|
+
* @public
|
|
1328
1328
|
*/
|
|
1329
1329
|
PlatformApplications?: PlatformApplication[];
|
|
1330
1330
|
/**
|
|
1331
|
-
* @public
|
|
1332
1331
|
* <p>
|
|
1333
1332
|
* <code>NextToken</code> string is returned when calling
|
|
1334
1333
|
* <code>ListPlatformApplications</code> action if additional records are available
|
|
1335
1334
|
* after the first page results.</p>
|
|
1335
|
+
* @public
|
|
1336
1336
|
*/
|
|
1337
1337
|
NextToken?: string;
|
|
1338
1338
|
}
|
|
@@ -1341,14 +1341,14 @@ export interface ListPlatformApplicationsResponse {
|
|
|
1341
1341
|
*/
|
|
1342
1342
|
export interface ListSMSSandboxPhoneNumbersInput {
|
|
1343
1343
|
/**
|
|
1344
|
-
* @public
|
|
1345
1344
|
* <p>Token that the previous <code>ListSMSSandboxPhoneNumbersInput</code> request
|
|
1346
1345
|
* returns.</p>
|
|
1346
|
+
* @public
|
|
1347
1347
|
*/
|
|
1348
1348
|
NextToken?: string;
|
|
1349
1349
|
/**
|
|
1350
|
-
* @public
|
|
1351
1350
|
* <p>The maximum number of phone numbers to return.</p>
|
|
1351
|
+
* @public
|
|
1352
1352
|
*/
|
|
1353
1353
|
MaxResults?: number;
|
|
1354
1354
|
}
|
|
@@ -1365,7 +1365,6 @@ export declare const SMSSandboxPhoneNumberVerificationStatus: {
|
|
|
1365
1365
|
*/
|
|
1366
1366
|
export type SMSSandboxPhoneNumberVerificationStatus = (typeof SMSSandboxPhoneNumberVerificationStatus)[keyof typeof SMSSandboxPhoneNumberVerificationStatus];
|
|
1367
1367
|
/**
|
|
1368
|
-
* @public
|
|
1369
1368
|
* <p>A verified or pending destination phone number in the SMS sandbox.</p>
|
|
1370
1369
|
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
1371
1370
|
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
@@ -1375,16 +1374,17 @@ export type SMSSandboxPhoneNumberVerificationStatus = (typeof SMSSandboxPhoneNum
|
|
|
1375
1374
|
* move out of the sandbox to send messages without restrictions,
|
|
1376
1375
|
* see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in
|
|
1377
1376
|
* the <i>Amazon SNS Developer Guide</i>.</p>
|
|
1377
|
+
* @public
|
|
1378
1378
|
*/
|
|
1379
1379
|
export interface SMSSandboxPhoneNumber {
|
|
1380
1380
|
/**
|
|
1381
|
-
* @public
|
|
1382
1381
|
* <p>The destination phone number.</p>
|
|
1382
|
+
* @public
|
|
1383
1383
|
*/
|
|
1384
1384
|
PhoneNumber?: string;
|
|
1385
1385
|
/**
|
|
1386
|
-
* @public
|
|
1387
1386
|
* <p>The destination phone number's verification status.</p>
|
|
1387
|
+
* @public
|
|
1388
1388
|
*/
|
|
1389
1389
|
Status?: SMSSandboxPhoneNumberVerificationStatus;
|
|
1390
1390
|
}
|
|
@@ -1393,107 +1393,107 @@ export interface SMSSandboxPhoneNumber {
|
|
|
1393
1393
|
*/
|
|
1394
1394
|
export interface ListSMSSandboxPhoneNumbersResult {
|
|
1395
1395
|
/**
|
|
1396
|
-
* @public
|
|
1397
1396
|
* <p>A list of the calling account's pending and verified phone numbers.</p>
|
|
1397
|
+
* @public
|
|
1398
1398
|
*/
|
|
1399
1399
|
PhoneNumbers: SMSSandboxPhoneNumber[] | undefined;
|
|
1400
1400
|
/**
|
|
1401
|
-
* @public
|
|
1402
1401
|
* <p>A <code>NextToken</code> string is returned when you call the
|
|
1403
1402
|
* <code>ListSMSSandboxPhoneNumbersInput</code> operation if additional pages of
|
|
1404
1403
|
* records are available.</p>
|
|
1404
|
+
* @public
|
|
1405
1405
|
*/
|
|
1406
1406
|
NextToken?: string;
|
|
1407
1407
|
}
|
|
1408
1408
|
/**
|
|
1409
|
-
* @public
|
|
1410
1409
|
* <p>Input for ListSubscriptions action.</p>
|
|
1410
|
+
* @public
|
|
1411
1411
|
*/
|
|
1412
1412
|
export interface ListSubscriptionsInput {
|
|
1413
1413
|
/**
|
|
1414
|
-
* @public
|
|
1415
1414
|
* <p>Token returned by the previous <code>ListSubscriptions</code> request.</p>
|
|
1415
|
+
* @public
|
|
1416
1416
|
*/
|
|
1417
1417
|
NextToken?: string;
|
|
1418
1418
|
}
|
|
1419
1419
|
/**
|
|
1420
|
-
* @public
|
|
1421
1420
|
* <p>A wrapper type for the attributes of an Amazon SNS subscription.</p>
|
|
1421
|
+
* @public
|
|
1422
1422
|
*/
|
|
1423
1423
|
export interface Subscription {
|
|
1424
1424
|
/**
|
|
1425
|
-
* @public
|
|
1426
1425
|
* <p>The subscription's ARN.</p>
|
|
1426
|
+
* @public
|
|
1427
1427
|
*/
|
|
1428
1428
|
SubscriptionArn?: string;
|
|
1429
1429
|
/**
|
|
1430
|
-
* @public
|
|
1431
1430
|
* <p>The subscription's owner.</p>
|
|
1431
|
+
* @public
|
|
1432
1432
|
*/
|
|
1433
1433
|
Owner?: string;
|
|
1434
1434
|
/**
|
|
1435
|
-
* @public
|
|
1436
1435
|
* <p>The subscription's protocol.</p>
|
|
1436
|
+
* @public
|
|
1437
1437
|
*/
|
|
1438
1438
|
Protocol?: string;
|
|
1439
1439
|
/**
|
|
1440
|
-
* @public
|
|
1441
1440
|
* <p>The subscription's endpoint (format depends on the protocol).</p>
|
|
1441
|
+
* @public
|
|
1442
1442
|
*/
|
|
1443
1443
|
Endpoint?: string;
|
|
1444
1444
|
/**
|
|
1445
|
-
* @public
|
|
1446
1445
|
* <p>The ARN of the subscription's topic.</p>
|
|
1446
|
+
* @public
|
|
1447
1447
|
*/
|
|
1448
1448
|
TopicArn?: string;
|
|
1449
1449
|
}
|
|
1450
1450
|
/**
|
|
1451
|
-
* @public
|
|
1452
1451
|
* <p>Response for ListSubscriptions action</p>
|
|
1452
|
+
* @public
|
|
1453
1453
|
*/
|
|
1454
1454
|
export interface ListSubscriptionsResponse {
|
|
1455
1455
|
/**
|
|
1456
|
-
* @public
|
|
1457
1456
|
* <p>A list of subscriptions.</p>
|
|
1457
|
+
* @public
|
|
1458
1458
|
*/
|
|
1459
1459
|
Subscriptions?: Subscription[];
|
|
1460
1460
|
/**
|
|
1461
|
-
* @public
|
|
1462
1461
|
* <p>Token to pass along to the next <code>ListSubscriptions</code> request. This element
|
|
1463
1462
|
* is returned if there are more subscriptions to retrieve.</p>
|
|
1463
|
+
* @public
|
|
1464
1464
|
*/
|
|
1465
1465
|
NextToken?: string;
|
|
1466
1466
|
}
|
|
1467
1467
|
/**
|
|
1468
|
-
* @public
|
|
1469
1468
|
* <p>Input for ListSubscriptionsByTopic action.</p>
|
|
1469
|
+
* @public
|
|
1470
1470
|
*/
|
|
1471
1471
|
export interface ListSubscriptionsByTopicInput {
|
|
1472
1472
|
/**
|
|
1473
|
-
* @public
|
|
1474
1473
|
* <p>The ARN of the topic for which you wish to find subscriptions.</p>
|
|
1474
|
+
* @public
|
|
1475
1475
|
*/
|
|
1476
1476
|
TopicArn: string | undefined;
|
|
1477
1477
|
/**
|
|
1478
|
-
* @public
|
|
1479
1478
|
* <p>Token returned by the previous <code>ListSubscriptionsByTopic</code> request.</p>
|
|
1479
|
+
* @public
|
|
1480
1480
|
*/
|
|
1481
1481
|
NextToken?: string;
|
|
1482
1482
|
}
|
|
1483
1483
|
/**
|
|
1484
|
-
* @public
|
|
1485
1484
|
* <p>Response for ListSubscriptionsByTopic action.</p>
|
|
1485
|
+
* @public
|
|
1486
1486
|
*/
|
|
1487
1487
|
export interface ListSubscriptionsByTopicResponse {
|
|
1488
1488
|
/**
|
|
1489
|
-
* @public
|
|
1490
1489
|
* <p>A list of subscriptions.</p>
|
|
1490
|
+
* @public
|
|
1491
1491
|
*/
|
|
1492
1492
|
Subscriptions?: Subscription[];
|
|
1493
1493
|
/**
|
|
1494
|
-
* @public
|
|
1495
1494
|
* <p>Token to pass along to the next <code>ListSubscriptionsByTopic</code> request. This
|
|
1496
1495
|
* element is returned if there are more subscriptions to retrieve.</p>
|
|
1496
|
+
* @public
|
|
1497
1497
|
*/
|
|
1498
1498
|
NextToken?: string;
|
|
1499
1499
|
}
|
|
@@ -1502,8 +1502,8 @@ export interface ListSubscriptionsByTopicResponse {
|
|
|
1502
1502
|
*/
|
|
1503
1503
|
export interface ListTagsForResourceRequest {
|
|
1504
1504
|
/**
|
|
1505
|
-
* @public
|
|
1506
1505
|
* <p>The ARN of the topic for which to list tags.</p>
|
|
1506
|
+
* @public
|
|
1507
1507
|
*/
|
|
1508
1508
|
ResourceArn: string | undefined;
|
|
1509
1509
|
}
|
|
@@ -1512,8 +1512,8 @@ export interface ListTagsForResourceRequest {
|
|
|
1512
1512
|
*/
|
|
1513
1513
|
export interface ListTagsForResourceResponse {
|
|
1514
1514
|
/**
|
|
1515
|
-
* @public
|
|
1516
1515
|
* <p>The tags associated with the specified topic.</p>
|
|
1516
|
+
* @public
|
|
1517
1517
|
*/
|
|
1518
1518
|
Tags?: Tag[];
|
|
1519
1519
|
}
|
|
@@ -1522,60 +1522,60 @@ export interface ListTagsForResourceResponse {
|
|
|
1522
1522
|
*/
|
|
1523
1523
|
export interface ListTopicsInput {
|
|
1524
1524
|
/**
|
|
1525
|
-
* @public
|
|
1526
1525
|
* <p>Token returned by the previous <code>ListTopics</code> request.</p>
|
|
1526
|
+
* @public
|
|
1527
1527
|
*/
|
|
1528
1528
|
NextToken?: string;
|
|
1529
1529
|
}
|
|
1530
1530
|
/**
|
|
1531
|
-
* @public
|
|
1532
1531
|
* <p>A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's
|
|
1533
1532
|
* attributes, use <code>GetTopicAttributes</code>.</p>
|
|
1533
|
+
* @public
|
|
1534
1534
|
*/
|
|
1535
1535
|
export interface Topic {
|
|
1536
1536
|
/**
|
|
1537
|
-
* @public
|
|
1538
1537
|
* <p>The topic's ARN.</p>
|
|
1538
|
+
* @public
|
|
1539
1539
|
*/
|
|
1540
1540
|
TopicArn?: string;
|
|
1541
1541
|
}
|
|
1542
1542
|
/**
|
|
1543
|
-
* @public
|
|
1544
1543
|
* <p>Response for ListTopics action.</p>
|
|
1544
|
+
* @public
|
|
1545
1545
|
*/
|
|
1546
1546
|
export interface ListTopicsResponse {
|
|
1547
1547
|
/**
|
|
1548
|
-
* @public
|
|
1549
1548
|
* <p>A list of topic ARNs.</p>
|
|
1549
|
+
* @public
|
|
1550
1550
|
*/
|
|
1551
1551
|
Topics?: Topic[];
|
|
1552
1552
|
/**
|
|
1553
|
-
* @public
|
|
1554
1553
|
* <p>Token to pass along to the next <code>ListTopics</code> request. This element is
|
|
1555
1554
|
* returned if there are additional topics to retrieve.</p>
|
|
1555
|
+
* @public
|
|
1556
1556
|
*/
|
|
1557
1557
|
NextToken?: string;
|
|
1558
1558
|
}
|
|
1559
1559
|
/**
|
|
1560
|
-
* @public
|
|
1561
1560
|
* <p>Input for the OptInPhoneNumber action.</p>
|
|
1561
|
+
* @public
|
|
1562
1562
|
*/
|
|
1563
1563
|
export interface OptInPhoneNumberInput {
|
|
1564
1564
|
/**
|
|
1565
|
-
* @public
|
|
1566
1565
|
* <p>The phone number to opt in. Use E.164 format.</p>
|
|
1566
|
+
* @public
|
|
1567
1567
|
*/
|
|
1568
1568
|
phoneNumber: string | undefined;
|
|
1569
1569
|
}
|
|
1570
1570
|
/**
|
|
1571
|
-
* @public
|
|
1572
1571
|
* <p>The response for the OptInPhoneNumber action.</p>
|
|
1572
|
+
* @public
|
|
1573
1573
|
*/
|
|
1574
1574
|
export interface OptInPhoneNumberResponse {
|
|
1575
1575
|
}
|
|
1576
1576
|
/**
|
|
1577
|
-
* @public
|
|
1578
1577
|
* <p>Exception error indicating endpoint disabled.</p>
|
|
1578
|
+
* @public
|
|
1579
1579
|
*/
|
|
1580
1580
|
export declare class EndpointDisabledException extends __BaseException {
|
|
1581
1581
|
readonly name: "EndpointDisabledException";
|
|
@@ -1586,8 +1586,8 @@ export declare class EndpointDisabledException extends __BaseException {
|
|
|
1586
1586
|
constructor(opts: __ExceptionOptionType<EndpointDisabledException, __BaseException>);
|
|
1587
1587
|
}
|
|
1588
1588
|
/**
|
|
1589
|
-
* @public
|
|
1590
1589
|
* <p>Indicates that a request parameter does not comply with the associated constraints.</p>
|
|
1590
|
+
* @public
|
|
1591
1591
|
*/
|
|
1592
1592
|
export declare class InvalidParameterValueException extends __BaseException {
|
|
1593
1593
|
readonly name: "InvalidParameterValueException";
|
|
@@ -1598,9 +1598,9 @@ export declare class InvalidParameterValueException extends __BaseException {
|
|
|
1598
1598
|
constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>);
|
|
1599
1599
|
}
|
|
1600
1600
|
/**
|
|
1601
|
-
* @public
|
|
1602
1601
|
* <p>The ciphertext references a key that doesn't exist or that you don't have access
|
|
1603
1602
|
* to.</p>
|
|
1603
|
+
* @public
|
|
1604
1604
|
*/
|
|
1605
1605
|
export declare class KMSAccessDeniedException extends __BaseException {
|
|
1606
1606
|
readonly name: "KMSAccessDeniedException";
|
|
@@ -1611,9 +1611,9 @@ export declare class KMSAccessDeniedException extends __BaseException {
|
|
|
1611
1611
|
constructor(opts: __ExceptionOptionType<KMSAccessDeniedException, __BaseException>);
|
|
1612
1612
|
}
|
|
1613
1613
|
/**
|
|
1614
|
-
* @public
|
|
1615
1614
|
* <p>The request was rejected because the specified Amazon Web Services KMS key isn't
|
|
1616
1615
|
* enabled.</p>
|
|
1616
|
+
* @public
|
|
1617
1617
|
*/
|
|
1618
1618
|
export declare class KMSDisabledException extends __BaseException {
|
|
1619
1619
|
readonly name: "KMSDisabledException";
|
|
@@ -1624,10 +1624,10 @@ export declare class KMSDisabledException extends __BaseException {
|
|
|
1624
1624
|
constructor(opts: __ExceptionOptionType<KMSDisabledException, __BaseException>);
|
|
1625
1625
|
}
|
|
1626
1626
|
/**
|
|
1627
|
-
* @public
|
|
1628
1627
|
* <p>The request was rejected because the state of the specified resource isn't valid for
|
|
1629
1628
|
* this request. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of Amazon Web Services KMS keys</a> in the <i>Key Management Service Developer
|
|
1630
1629
|
* Guide</i>.</p>
|
|
1630
|
+
* @public
|
|
1631
1631
|
*/
|
|
1632
1632
|
export declare class KMSInvalidStateException extends __BaseException {
|
|
1633
1633
|
readonly name: "KMSInvalidStateException";
|
|
@@ -1638,9 +1638,9 @@ export declare class KMSInvalidStateException extends __BaseException {
|
|
|
1638
1638
|
constructor(opts: __ExceptionOptionType<KMSInvalidStateException, __BaseException>);
|
|
1639
1639
|
}
|
|
1640
1640
|
/**
|
|
1641
|
-
* @public
|
|
1642
1641
|
* <p>The request was rejected because the specified entity or resource can't be
|
|
1643
1642
|
* found.</p>
|
|
1643
|
+
* @public
|
|
1644
1644
|
*/
|
|
1645
1645
|
export declare class KMSNotFoundException extends __BaseException {
|
|
1646
1646
|
readonly name: "KMSNotFoundException";
|
|
@@ -1651,8 +1651,8 @@ export declare class KMSNotFoundException extends __BaseException {
|
|
|
1651
1651
|
constructor(opts: __ExceptionOptionType<KMSNotFoundException, __BaseException>);
|
|
1652
1652
|
}
|
|
1653
1653
|
/**
|
|
1654
|
-
* @public
|
|
1655
1654
|
* <p>The Amazon Web Services access key ID needs a subscription for the service.</p>
|
|
1655
|
+
* @public
|
|
1656
1656
|
*/
|
|
1657
1657
|
export declare class KMSOptInRequired extends __BaseException {
|
|
1658
1658
|
readonly name: "KMSOptInRequired";
|
|
@@ -1663,11 +1663,11 @@ export declare class KMSOptInRequired extends __BaseException {
|
|
|
1663
1663
|
constructor(opts: __ExceptionOptionType<KMSOptInRequired, __BaseException>);
|
|
1664
1664
|
}
|
|
1665
1665
|
/**
|
|
1666
|
-
* @public
|
|
1667
1666
|
* <p>The request was denied due to request throttling. For more information about
|
|
1668
1667
|
* throttling, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second">Limits</a> in
|
|
1669
1668
|
* the <i>Key Management Service Developer Guide.</i>
|
|
1670
1669
|
* </p>
|
|
1670
|
+
* @public
|
|
1671
1671
|
*/
|
|
1672
1672
|
export declare class KMSThrottlingException extends __BaseException {
|
|
1673
1673
|
readonly name: "KMSThrottlingException";
|
|
@@ -1678,8 +1678,8 @@ export declare class KMSThrottlingException extends __BaseException {
|
|
|
1678
1678
|
constructor(opts: __ExceptionOptionType<KMSThrottlingException, __BaseException>);
|
|
1679
1679
|
}
|
|
1680
1680
|
/**
|
|
1681
|
-
* @public
|
|
1682
1681
|
* <p>Exception error indicating platform application disabled.</p>
|
|
1682
|
+
* @public
|
|
1683
1683
|
*/
|
|
1684
1684
|
export declare class PlatformApplicationDisabledException extends __BaseException {
|
|
1685
1685
|
readonly name: "PlatformApplicationDisabledException";
|
|
@@ -1690,7 +1690,6 @@ export declare class PlatformApplicationDisabledException extends __BaseExceptio
|
|
|
1690
1690
|
constructor(opts: __ExceptionOptionType<PlatformApplicationDisabledException, __BaseException>);
|
|
1691
1691
|
}
|
|
1692
1692
|
/**
|
|
1693
|
-
* @public
|
|
1694
1693
|
* <p>The user-specified message attribute value. For string data types, the value attribute
|
|
1695
1694
|
* has the same restrictions on the content as the message body. For more information, see
|
|
1696
1695
|
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a>.</p>
|
|
@@ -1701,57 +1700,57 @@ export declare class PlatformApplicationDisabledException extends __BaseExceptio
|
|
|
1701
1700
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Publishing
|
|
1702
1701
|
* to a mobile phone</a> in the <i>Amazon SNS Developer Guide.</i>
|
|
1703
1702
|
* </p>
|
|
1703
|
+
* @public
|
|
1704
1704
|
*/
|
|
1705
1705
|
export interface MessageAttributeValue {
|
|
1706
1706
|
/**
|
|
1707
|
-
* @public
|
|
1708
1707
|
* <p>Amazon SNS supports the following logical data types: String, String.Array, Number, and
|
|
1709
1708
|
* Binary. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes">Message
|
|
1710
1709
|
* Attribute Data Types</a>.</p>
|
|
1710
|
+
* @public
|
|
1711
1711
|
*/
|
|
1712
1712
|
DataType: string | undefined;
|
|
1713
1713
|
/**
|
|
1714
|
-
* @public
|
|
1715
1714
|
* <p>Strings are Unicode with UTF8 binary encoding. For a list of code values, see <a href="https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">ASCII Printable
|
|
1716
1715
|
* Characters</a>.</p>
|
|
1716
|
+
* @public
|
|
1717
1717
|
*/
|
|
1718
1718
|
StringValue?: string;
|
|
1719
1719
|
/**
|
|
1720
|
-
* @public
|
|
1721
1720
|
* <p>Binary type attributes can store any binary data, for example, compressed data,
|
|
1722
1721
|
* encrypted data, or images.</p>
|
|
1722
|
+
* @public
|
|
1723
1723
|
*/
|
|
1724
1724
|
BinaryValue?: Uint8Array;
|
|
1725
1725
|
}
|
|
1726
1726
|
/**
|
|
1727
|
-
* @public
|
|
1728
1727
|
* <p>Input for Publish action.</p>
|
|
1728
|
+
* @public
|
|
1729
1729
|
*/
|
|
1730
1730
|
export interface PublishInput {
|
|
1731
1731
|
/**
|
|
1732
|
-
* @public
|
|
1733
1732
|
* <p>The topic you want to publish to.</p>
|
|
1734
1733
|
* <p>If you don't specify a value for the <code>TopicArn</code> parameter, you must specify
|
|
1735
1734
|
* a value for the <code>PhoneNumber</code> or <code>TargetArn</code> parameters.</p>
|
|
1735
|
+
* @public
|
|
1736
1736
|
*/
|
|
1737
1737
|
TopicArn?: string;
|
|
1738
1738
|
/**
|
|
1739
|
-
* @public
|
|
1740
1739
|
* <p>If you don't specify a value for the <code>TargetArn</code> parameter, you must
|
|
1741
1740
|
* specify a value for the <code>PhoneNumber</code> or <code>TopicArn</code>
|
|
1742
1741
|
* parameters.</p>
|
|
1742
|
+
* @public
|
|
1743
1743
|
*/
|
|
1744
1744
|
TargetArn?: string;
|
|
1745
1745
|
/**
|
|
1746
|
-
* @public
|
|
1747
1746
|
* <p>The phone number to which you want to deliver an SMS message. Use E.164 format.</p>
|
|
1748
1747
|
* <p>If you don't specify a value for the <code>PhoneNumber</code> parameter, you must
|
|
1749
1748
|
* specify a value for the <code>TargetArn</code> or <code>TopicArn</code>
|
|
1750
1749
|
* parameters.</p>
|
|
1750
|
+
* @public
|
|
1751
1751
|
*/
|
|
1752
1752
|
PhoneNumber?: string;
|
|
1753
1753
|
/**
|
|
1754
|
-
* @public
|
|
1755
1754
|
* <p>The message you want to send.</p>
|
|
1756
1755
|
* <p>If you are publishing to a topic and you want to send the same message to all
|
|
1757
1756
|
* transport protocols, include the text of the message as a String value. If you want to
|
|
@@ -1813,20 +1812,20 @@ export interface PublishInput {
|
|
|
1813
1812
|
* <code>Publish</code> call to return an error (no partial delivery).</p>
|
|
1814
1813
|
* </li>
|
|
1815
1814
|
* </ul>
|
|
1815
|
+
* @public
|
|
1816
1816
|
*/
|
|
1817
1817
|
Message: string | undefined;
|
|
1818
1818
|
/**
|
|
1819
|
-
* @public
|
|
1820
1819
|
* <p>Optional parameter to be used as the "Subject" line when the message is delivered to
|
|
1821
1820
|
* email endpoints. This field will also be included, if present, in the standard JSON
|
|
1822
1821
|
* messages delivered to other endpoints.</p>
|
|
1823
1822
|
* <p>Constraints: Subjects must be ASCII text that begins with a letter, number, or
|
|
1824
1823
|
* punctuation mark; must not include line breaks or control characters; and must be less
|
|
1825
1824
|
* than 100 characters long.</p>
|
|
1825
|
+
* @public
|
|
1826
1826
|
*/
|
|
1827
1827
|
Subject?: string;
|
|
1828
1828
|
/**
|
|
1829
|
-
* @public
|
|
1830
1829
|
* <p>Set <code>MessageStructure</code> to <code>json</code> if you want to send a different
|
|
1831
1830
|
* message for each protocol. For example, using one publish action, you can send a short
|
|
1832
1831
|
* message to your SMS subscribers and a longer message to your email subscribers. If you
|
|
@@ -1845,15 +1844,15 @@ export interface PublishInput {
|
|
|
1845
1844
|
* specific transport protocol (e.g., "http").</p>
|
|
1846
1845
|
* <p>Valid value: <code>json</code>
|
|
1847
1846
|
* </p>
|
|
1847
|
+
* @public
|
|
1848
1848
|
*/
|
|
1849
1849
|
MessageStructure?: string;
|
|
1850
1850
|
/**
|
|
1851
|
-
* @public
|
|
1852
1851
|
* <p>Message attributes for Publish action.</p>
|
|
1852
|
+
* @public
|
|
1853
1853
|
*/
|
|
1854
1854
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
1855
1855
|
/**
|
|
1856
|
-
* @public
|
|
1857
1856
|
* <p>This parameter applies only to FIFO (first-in-first-out) topics. The
|
|
1858
1857
|
* <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric characters
|
|
1859
1858
|
* <code>(a-z, A-Z, 0-9)</code> and punctuation
|
|
@@ -1866,10 +1865,10 @@ export interface PublishInput {
|
|
|
1866
1865
|
* <p>If the topic has <code>ContentBasedDeduplication</code> set, the system generates a
|
|
1867
1866
|
* <code>MessageDeduplicationId</code> based on the contents of the message. Your
|
|
1868
1867
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p>
|
|
1868
|
+
* @public
|
|
1869
1869
|
*/
|
|
1870
1870
|
MessageDeduplicationId?: string;
|
|
1871
1871
|
/**
|
|
1872
|
-
* @public
|
|
1873
1872
|
* <p>This parameter applies only to FIFO (first-in-first-out) topics. The
|
|
1874
1873
|
* <code>MessageGroupId</code> can contain up to 128 alphanumeric characters
|
|
1875
1874
|
* <code>(a-z, A-Z, 0-9)</code> and punctuation
|
|
@@ -1878,33 +1877,34 @@ export interface PublishInput {
|
|
|
1878
1877
|
* specific message group. Messages that belong to the same message group are processed in
|
|
1879
1878
|
* a FIFO manner (however, messages in different message groups might be processed out of
|
|
1880
1879
|
* order). Every message must include a <code>MessageGroupId</code>.</p>
|
|
1880
|
+
* @public
|
|
1881
1881
|
*/
|
|
1882
1882
|
MessageGroupId?: string;
|
|
1883
1883
|
}
|
|
1884
1884
|
/**
|
|
1885
|
-
* @public
|
|
1886
1885
|
* <p>Response for Publish action.</p>
|
|
1886
|
+
* @public
|
|
1887
1887
|
*/
|
|
1888
1888
|
export interface PublishResponse {
|
|
1889
1889
|
/**
|
|
1890
|
-
* @public
|
|
1891
1890
|
* <p>Unique identifier assigned to the published message.</p>
|
|
1892
1891
|
* <p>Length Constraint: Maximum 100 characters</p>
|
|
1892
|
+
* @public
|
|
1893
1893
|
*/
|
|
1894
1894
|
MessageId?: string;
|
|
1895
1895
|
/**
|
|
1896
|
-
* @public
|
|
1897
1896
|
* <p>This response element applies only to FIFO (first-in-first-out) topics. </p>
|
|
1898
1897
|
* <p>The sequence number is a large, non-consecutive number that Amazon SNS assigns to each
|
|
1899
1898
|
* message. The length of <code>SequenceNumber</code> is 128 bits.
|
|
1900
1899
|
* <code>SequenceNumber</code> continues to increase for each
|
|
1901
1900
|
* <code>MessageGroupId</code>.</p>
|
|
1901
|
+
* @public
|
|
1902
1902
|
*/
|
|
1903
1903
|
SequenceNumber?: string;
|
|
1904
1904
|
}
|
|
1905
1905
|
/**
|
|
1906
|
-
* @public
|
|
1907
1906
|
* <p>Two or more batch entries in the request have the same <code>Id</code>.</p>
|
|
1907
|
+
* @public
|
|
1908
1908
|
*/
|
|
1909
1909
|
export declare class BatchEntryIdsNotDistinctException extends __BaseException {
|
|
1910
1910
|
readonly name: "BatchEntryIdsNotDistinctException";
|
|
@@ -1915,8 +1915,8 @@ export declare class BatchEntryIdsNotDistinctException extends __BaseException {
|
|
|
1915
1915
|
constructor(opts: __ExceptionOptionType<BatchEntryIdsNotDistinctException, __BaseException>);
|
|
1916
1916
|
}
|
|
1917
1917
|
/**
|
|
1918
|
-
* @public
|
|
1919
1918
|
* <p>The length of all the batch messages put together is more than the limit.</p>
|
|
1919
|
+
* @public
|
|
1920
1920
|
*/
|
|
1921
1921
|
export declare class BatchRequestTooLongException extends __BaseException {
|
|
1922
1922
|
readonly name: "BatchRequestTooLongException";
|
|
@@ -1927,8 +1927,8 @@ export declare class BatchRequestTooLongException extends __BaseException {
|
|
|
1927
1927
|
constructor(opts: __ExceptionOptionType<BatchRequestTooLongException, __BaseException>);
|
|
1928
1928
|
}
|
|
1929
1929
|
/**
|
|
1930
|
-
* @public
|
|
1931
1930
|
* <p>The batch request doesn't contain any entries.</p>
|
|
1931
|
+
* @public
|
|
1932
1932
|
*/
|
|
1933
1933
|
export declare class EmptyBatchRequestException extends __BaseException {
|
|
1934
1934
|
readonly name: "EmptyBatchRequestException";
|
|
@@ -1939,8 +1939,8 @@ export declare class EmptyBatchRequestException extends __BaseException {
|
|
|
1939
1939
|
constructor(opts: __ExceptionOptionType<EmptyBatchRequestException, __BaseException>);
|
|
1940
1940
|
}
|
|
1941
1941
|
/**
|
|
1942
|
-
* @public
|
|
1943
1942
|
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the specification. </p>
|
|
1943
|
+
* @public
|
|
1944
1944
|
*/
|
|
1945
1945
|
export declare class InvalidBatchEntryIdException extends __BaseException {
|
|
1946
1946
|
readonly name: "InvalidBatchEntryIdException";
|
|
@@ -1951,33 +1951,32 @@ export declare class InvalidBatchEntryIdException extends __BaseException {
|
|
|
1951
1951
|
constructor(opts: __ExceptionOptionType<InvalidBatchEntryIdException, __BaseException>);
|
|
1952
1952
|
}
|
|
1953
1953
|
/**
|
|
1954
|
-
* @public
|
|
1955
1954
|
* <p>Contains the details of a single Amazon SNS message along with an <code>Id</code> that
|
|
1956
1955
|
* identifies a message within the batch. </p>
|
|
1956
|
+
* @public
|
|
1957
1957
|
*/
|
|
1958
1958
|
export interface PublishBatchRequestEntry {
|
|
1959
1959
|
/**
|
|
1960
|
-
* @public
|
|
1961
1960
|
* <p>An identifier for the message in this batch.</p>
|
|
1962
1961
|
* <note>
|
|
1963
1962
|
* <p>The <code>Ids</code> of a batch request must be unique within a request. </p>
|
|
1964
1963
|
* <p>This identifier can have up to 80 characters. The following characters are
|
|
1965
1964
|
* accepted: alphanumeric characters, hyphens(-), and underscores (_). </p>
|
|
1966
1965
|
* </note>
|
|
1966
|
+
* @public
|
|
1967
1967
|
*/
|
|
1968
1968
|
Id: string | undefined;
|
|
1969
1969
|
/**
|
|
1970
|
-
* @public
|
|
1971
1970
|
* <p>The body of the message.</p>
|
|
1971
|
+
* @public
|
|
1972
1972
|
*/
|
|
1973
1973
|
Message: string | undefined;
|
|
1974
1974
|
/**
|
|
1975
|
-
* @public
|
|
1976
1975
|
* <p>The subject of the batch message.</p>
|
|
1976
|
+
* @public
|
|
1977
1977
|
*/
|
|
1978
1978
|
Subject?: string;
|
|
1979
1979
|
/**
|
|
1980
|
-
* @public
|
|
1981
1980
|
* <p>Set <code>MessageStructure</code> to <code>json</code> if you want to send a different
|
|
1982
1981
|
* message for each protocol. For example, using one publish action, you can send a short
|
|
1983
1982
|
* message to your SMS subscribers and a longer message to your email subscribers. If you
|
|
@@ -1994,17 +1993,17 @@ export interface PublishBatchRequestEntry {
|
|
|
1994
1993
|
* </ul>
|
|
1995
1994
|
* <p>You can define other top-level keys that define the message you want to send to a
|
|
1996
1995
|
* specific transport protocol (e.g. http). </p>
|
|
1996
|
+
* @public
|
|
1997
1997
|
*/
|
|
1998
1998
|
MessageStructure?: string;
|
|
1999
1999
|
/**
|
|
2000
|
-
* @public
|
|
2001
2000
|
* <p>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and
|
|
2002
2001
|
* <code>Value</code>. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-message-attributes.html">Amazon SNS message attributes</a> in
|
|
2003
2002
|
* the Amazon SNS Developer Guide.</p>
|
|
2003
|
+
* @public
|
|
2004
2004
|
*/
|
|
2005
2005
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
2006
2006
|
/**
|
|
2007
|
-
* @public
|
|
2008
2007
|
* <p>This parameter applies only to FIFO (first-in-first-out) topics.</p>
|
|
2009
2008
|
* <p>The token used for deduplication of messages within a 5-minute minimum deduplication
|
|
2010
2009
|
* interval. If a message with a particular <code>MessageDeduplicationId</code> is sent
|
|
@@ -2064,10 +2063,10 @@ export interface PublishBatchRequestEntry {
|
|
|
2064
2063
|
* <code>MessageDeduplicationId</code> can contain alphanumeric characters <code>(a-z,
|
|
2065
2064
|
* A-Z, 0-9)</code> and punctuation
|
|
2066
2065
|
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
|
|
2066
|
+
* @public
|
|
2067
2067
|
*/
|
|
2068
2068
|
MessageDeduplicationId?: string;
|
|
2069
2069
|
/**
|
|
2070
|
-
* @public
|
|
2071
2070
|
* <p>This parameter applies only to FIFO (first-in-first-out) topics.</p>
|
|
2072
2071
|
* <p>The tag that specifies that a message belongs to a specific message group. Messages
|
|
2073
2072
|
* that belong to the same message group are processed in a FIFO manner (however, messages
|
|
@@ -2087,6 +2086,7 @@ export interface PublishBatchRequestEntry {
|
|
|
2087
2086
|
* <code>MessageGroupId</code> is required for FIFO topics. You can't use it for
|
|
2088
2087
|
* standard topics. </p>
|
|
2089
2088
|
* </important>
|
|
2089
|
+
* @public
|
|
2090
2090
|
*/
|
|
2091
2091
|
MessageGroupId?: string;
|
|
2092
2092
|
}
|
|
@@ -2095,64 +2095,64 @@ export interface PublishBatchRequestEntry {
|
|
|
2095
2095
|
*/
|
|
2096
2096
|
export interface PublishBatchInput {
|
|
2097
2097
|
/**
|
|
2098
|
-
* @public
|
|
2099
2098
|
* <p>The Amazon resource name (ARN) of the topic you want to batch publish to.</p>
|
|
2099
|
+
* @public
|
|
2100
2100
|
*/
|
|
2101
2101
|
TopicArn: string | undefined;
|
|
2102
2102
|
/**
|
|
2103
|
-
* @public
|
|
2104
2103
|
* <p>A list of <code>PublishBatch</code> request entries to be sent to the SNS
|
|
2105
2104
|
* topic.</p>
|
|
2105
|
+
* @public
|
|
2106
2106
|
*/
|
|
2107
2107
|
PublishBatchRequestEntries: PublishBatchRequestEntry[] | undefined;
|
|
2108
2108
|
}
|
|
2109
2109
|
/**
|
|
2110
|
-
* @public
|
|
2111
2110
|
* <p>Gives a detailed description of failed messages in the batch.</p>
|
|
2111
|
+
* @public
|
|
2112
2112
|
*/
|
|
2113
2113
|
export interface BatchResultErrorEntry {
|
|
2114
2114
|
/**
|
|
2115
|
-
* @public
|
|
2116
2115
|
* <p>The <code>Id</code> of an entry in a batch request</p>
|
|
2116
|
+
* @public
|
|
2117
2117
|
*/
|
|
2118
2118
|
Id: string | undefined;
|
|
2119
2119
|
/**
|
|
2120
|
-
* @public
|
|
2121
2120
|
* <p>An error code representing why the action failed on this entry.</p>
|
|
2121
|
+
* @public
|
|
2122
2122
|
*/
|
|
2123
2123
|
Code: string | undefined;
|
|
2124
2124
|
/**
|
|
2125
|
-
* @public
|
|
2126
2125
|
* <p>A message explaining why the action failed on this entry.</p>
|
|
2126
|
+
* @public
|
|
2127
2127
|
*/
|
|
2128
2128
|
Message?: string;
|
|
2129
2129
|
/**
|
|
2130
|
-
* @public
|
|
2131
2130
|
* <p>Specifies whether the error happened due to the caller of the batch API action.</p>
|
|
2131
|
+
* @public
|
|
2132
2132
|
*/
|
|
2133
2133
|
SenderFault: boolean | undefined;
|
|
2134
2134
|
}
|
|
2135
2135
|
/**
|
|
2136
|
-
* @public
|
|
2137
2136
|
* <p>Encloses data related to a successful message in a batch request for topic.</p>
|
|
2137
|
+
* @public
|
|
2138
2138
|
*/
|
|
2139
2139
|
export interface PublishBatchResultEntry {
|
|
2140
2140
|
/**
|
|
2141
|
-
* @public
|
|
2142
2141
|
* <p>The <code>Id</code> of an entry in a batch request.</p>
|
|
2142
|
+
* @public
|
|
2143
2143
|
*/
|
|
2144
2144
|
Id?: string;
|
|
2145
2145
|
/**
|
|
2146
|
-
* @public
|
|
2147
2146
|
* <p>An identifier for the message.</p>
|
|
2147
|
+
* @public
|
|
2148
2148
|
*/
|
|
2149
2149
|
MessageId?: string;
|
|
2150
2150
|
/**
|
|
2151
|
-
* @public
|
|
2152
2151
|
* <p>This parameter applies only to FIFO (first-in-first-out) topics.</p>
|
|
2153
2152
|
* <p>The large, non-consecutive number that Amazon SNS assigns to each message.</p>
|
|
2154
2153
|
* <p>The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code>
|
|
2155
2154
|
* continues to increase for a particular <code>MessageGroupId</code>.</p>
|
|
2155
|
+
* @public
|
|
2156
2156
|
*/
|
|
2157
2157
|
SequenceNumber?: string;
|
|
2158
2158
|
}
|
|
@@ -2161,19 +2161,19 @@ export interface PublishBatchResultEntry {
|
|
|
2161
2161
|
*/
|
|
2162
2162
|
export interface PublishBatchResponse {
|
|
2163
2163
|
/**
|
|
2164
|
-
* @public
|
|
2165
2164
|
* <p>A list of successful <code>PublishBatch</code> responses.</p>
|
|
2165
|
+
* @public
|
|
2166
2166
|
*/
|
|
2167
2167
|
Successful?: PublishBatchResultEntry[];
|
|
2168
2168
|
/**
|
|
2169
|
-
* @public
|
|
2170
2169
|
* <p>A list of failed <code>PublishBatch</code> responses. </p>
|
|
2170
|
+
* @public
|
|
2171
2171
|
*/
|
|
2172
2172
|
Failed?: BatchResultErrorEntry[];
|
|
2173
2173
|
}
|
|
2174
2174
|
/**
|
|
2175
|
-
* @public
|
|
2176
2175
|
* <p>The batch request contains more entries than permissible.</p>
|
|
2176
|
+
* @public
|
|
2177
2177
|
*/
|
|
2178
2178
|
export declare class TooManyEntriesInBatchRequestException extends __BaseException {
|
|
2179
2179
|
readonly name: "TooManyEntriesInBatchRequestException";
|
|
@@ -2188,49 +2188,48 @@ export declare class TooManyEntriesInBatchRequestException extends __BaseExcepti
|
|
|
2188
2188
|
*/
|
|
2189
2189
|
export interface PutDataProtectionPolicyInput {
|
|
2190
2190
|
/**
|
|
2191
|
-
* @public
|
|
2192
2191
|
* <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to add or
|
|
2193
2192
|
* update.</p>
|
|
2194
2193
|
* <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names
|
|
2195
2194
|
* (ARNs)</a> in the Amazon Web Services General Reference.</p>
|
|
2195
|
+
* @public
|
|
2196
2196
|
*/
|
|
2197
2197
|
ResourceArn: string | undefined;
|
|
2198
2198
|
/**
|
|
2199
|
-
* @public
|
|
2200
2199
|
* <p>The JSON serialization of the topic's <code>DataProtectionPolicy</code>.</p>
|
|
2201
2200
|
* <p>The <code>DataProtectionPolicy</code> must be in JSON string format.</p>
|
|
2202
2201
|
* <p>Length Constraints: Maximum length of 30,720.</p>
|
|
2202
|
+
* @public
|
|
2203
2203
|
*/
|
|
2204
2204
|
DataProtectionPolicy: string | undefined;
|
|
2205
2205
|
}
|
|
2206
2206
|
/**
|
|
2207
|
-
* @public
|
|
2208
2207
|
* <p>Input for RemovePermission action.</p>
|
|
2208
|
+
* @public
|
|
2209
2209
|
*/
|
|
2210
2210
|
export interface RemovePermissionInput {
|
|
2211
2211
|
/**
|
|
2212
|
-
* @public
|
|
2213
2212
|
* <p>The ARN of the topic whose access control policy you wish to modify.</p>
|
|
2213
|
+
* @public
|
|
2214
2214
|
*/
|
|
2215
2215
|
TopicArn: string | undefined;
|
|
2216
2216
|
/**
|
|
2217
|
-
* @public
|
|
2218
2217
|
* <p>The unique label of the statement you want to remove.</p>
|
|
2218
|
+
* @public
|
|
2219
2219
|
*/
|
|
2220
2220
|
Label: string | undefined;
|
|
2221
2221
|
}
|
|
2222
2222
|
/**
|
|
2223
|
-
* @public
|
|
2224
2223
|
* <p>Input for <code>SetEndpointAttributes</code> action.</p>
|
|
2224
|
+
* @public
|
|
2225
2225
|
*/
|
|
2226
2226
|
export interface SetEndpointAttributesInput {
|
|
2227
2227
|
/**
|
|
2228
|
-
* @public
|
|
2229
2228
|
* <p>EndpointArn used for <code>SetEndpointAttributes</code> action.</p>
|
|
2229
|
+
* @public
|
|
2230
2230
|
*/
|
|
2231
2231
|
EndpointArn: string | undefined;
|
|
2232
2232
|
/**
|
|
2233
|
-
* @public
|
|
2234
2233
|
* <p>A map of the endpoint attributes. Attributes in this map include the following:</p>
|
|
2235
2234
|
* <ul>
|
|
2236
2235
|
* <li>
|
|
@@ -2254,23 +2253,23 @@ export interface SetEndpointAttributesInput {
|
|
|
2254
2253
|
* service.</p>
|
|
2255
2254
|
* </li>
|
|
2256
2255
|
* </ul>
|
|
2256
|
+
* @public
|
|
2257
2257
|
*/
|
|
2258
2258
|
Attributes: Record<string, string> | undefined;
|
|
2259
2259
|
}
|
|
2260
2260
|
/**
|
|
2261
|
-
* @public
|
|
2262
2261
|
* <p>Input for <code>SetPlatformApplicationAttributes</code> action.</p>
|
|
2262
|
+
* @public
|
|
2263
2263
|
*/
|
|
2264
2264
|
export interface SetPlatformApplicationAttributesInput {
|
|
2265
2265
|
/**
|
|
2266
|
-
* @public
|
|
2267
2266
|
* <p>
|
|
2268
2267
|
* <code>PlatformApplicationArn</code> for <code>SetPlatformApplicationAttributes</code>
|
|
2269
2268
|
* action.</p>
|
|
2269
|
+
* @public
|
|
2270
2270
|
*/
|
|
2271
2271
|
PlatformApplicationArn: string | undefined;
|
|
2272
2272
|
/**
|
|
2273
|
-
* @public
|
|
2274
2273
|
* <p>A map of the platform application attributes. Attributes in this map include the
|
|
2275
2274
|
* following:</p>
|
|
2276
2275
|
* <ul>
|
|
@@ -2384,16 +2383,16 @@ export interface SetPlatformApplicationAttributesInput {
|
|
|
2384
2383
|
* your iOS app.</p>
|
|
2385
2384
|
* </li>
|
|
2386
2385
|
* </ul>
|
|
2386
|
+
* @public
|
|
2387
2387
|
*/
|
|
2388
2388
|
Attributes: Record<string, string> | undefined;
|
|
2389
2389
|
}
|
|
2390
2390
|
/**
|
|
2391
|
-
* @public
|
|
2392
2391
|
* <p>The input for the SetSMSAttributes action.</p>
|
|
2392
|
+
* @public
|
|
2393
2393
|
*/
|
|
2394
2394
|
export interface SetSMSAttributesInput {
|
|
2395
2395
|
/**
|
|
2396
|
-
* @public
|
|
2397
2396
|
* <p>The default settings for sending SMS messages from your Amazon Web Services account. You can set
|
|
2398
2397
|
* values for the following attribute names:</p>
|
|
2399
2398
|
* <p>
|
|
@@ -2480,27 +2479,27 @@ export interface SetSMSAttributesInput {
|
|
|
2480
2479
|
* actions.</p>
|
|
2481
2480
|
* <p>For an example bucket policy and usage report, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_stats.html">Monitoring SMS Activity</a> in the
|
|
2482
2481
|
* <i>Amazon SNS Developer Guide</i>.</p>
|
|
2482
|
+
* @public
|
|
2483
2483
|
*/
|
|
2484
2484
|
attributes: Record<string, string> | undefined;
|
|
2485
2485
|
}
|
|
2486
2486
|
/**
|
|
2487
|
-
* @public
|
|
2488
2487
|
* <p>The response for the SetSMSAttributes action.</p>
|
|
2488
|
+
* @public
|
|
2489
2489
|
*/
|
|
2490
2490
|
export interface SetSMSAttributesResponse {
|
|
2491
2491
|
}
|
|
2492
2492
|
/**
|
|
2493
|
-
* @public
|
|
2494
2493
|
* <p>Input for SetSubscriptionAttributes action.</p>
|
|
2494
|
+
* @public
|
|
2495
2495
|
*/
|
|
2496
2496
|
export interface SetSubscriptionAttributesInput {
|
|
2497
2497
|
/**
|
|
2498
|
-
* @public
|
|
2499
2498
|
* <p>The ARN of the subscription to modify.</p>
|
|
2499
|
+
* @public
|
|
2500
2500
|
*/
|
|
2501
2501
|
SubscriptionArn: string | undefined;
|
|
2502
2502
|
/**
|
|
2503
|
-
* @public
|
|
2504
2503
|
* <p>A map of attributes with their corresponding values.</p>
|
|
2505
2504
|
* <p>The following lists the names, descriptions, and values of the special request
|
|
2506
2505
|
* parameters that this action uses:</p>
|
|
@@ -2566,26 +2565,26 @@ export interface SetSubscriptionAttributesInput {
|
|
|
2566
2565
|
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
|
|
2567
2566
|
* </li>
|
|
2568
2567
|
* </ul>
|
|
2568
|
+
* @public
|
|
2569
2569
|
*/
|
|
2570
2570
|
AttributeName: string | undefined;
|
|
2571
2571
|
/**
|
|
2572
|
-
* @public
|
|
2573
2572
|
* <p>The new value for the attribute in JSON format.</p>
|
|
2573
|
+
* @public
|
|
2574
2574
|
*/
|
|
2575
2575
|
AttributeValue?: string;
|
|
2576
2576
|
}
|
|
2577
2577
|
/**
|
|
2578
|
-
* @public
|
|
2579
2578
|
* <p>Input for SetTopicAttributes action.</p>
|
|
2579
|
+
* @public
|
|
2580
2580
|
*/
|
|
2581
2581
|
export interface SetTopicAttributesInput {
|
|
2582
2582
|
/**
|
|
2583
|
-
* @public
|
|
2584
2583
|
* <p>The ARN of the topic to modify.</p>
|
|
2584
|
+
* @public
|
|
2585
2585
|
*/
|
|
2586
2586
|
TopicArn: string | undefined;
|
|
2587
2587
|
/**
|
|
2588
|
-
* @public
|
|
2589
2588
|
* <p>A map of attributes with their corresponding values.</p>
|
|
2590
2589
|
* <p>The following lists the names, descriptions, and values of the special request
|
|
2591
2590
|
* parameters that the <code>SetTopicAttributes</code> action uses:</p>
|
|
@@ -2794,26 +2793,26 @@ export interface SetTopicAttributesInput {
|
|
|
2794
2793
|
* </ul>
|
|
2795
2794
|
* </li>
|
|
2796
2795
|
* </ul>
|
|
2796
|
+
* @public
|
|
2797
2797
|
*/
|
|
2798
2798
|
AttributeName: string | undefined;
|
|
2799
2799
|
/**
|
|
2800
|
-
* @public
|
|
2801
2800
|
* <p>The new value for the attribute.</p>
|
|
2801
|
+
* @public
|
|
2802
2802
|
*/
|
|
2803
2803
|
AttributeValue?: string;
|
|
2804
2804
|
}
|
|
2805
2805
|
/**
|
|
2806
|
-
* @public
|
|
2807
2806
|
* <p>Input for Subscribe action.</p>
|
|
2807
|
+
* @public
|
|
2808
2808
|
*/
|
|
2809
2809
|
export interface SubscribeInput {
|
|
2810
2810
|
/**
|
|
2811
|
-
* @public
|
|
2812
2811
|
* <p>The ARN of the topic you want to subscribe to.</p>
|
|
2812
|
+
* @public
|
|
2813
2813
|
*/
|
|
2814
2814
|
TopicArn: string | undefined;
|
|
2815
2815
|
/**
|
|
2816
|
-
* @public
|
|
2817
2816
|
* <p>The protocol that you want to use. Supported protocols include:</p>
|
|
2818
2817
|
* <ul>
|
|
2819
2818
|
* <li>
|
|
@@ -2860,10 +2859,10 @@ export interface SubscribeInput {
|
|
|
2860
2859
|
* Kinesis Data Firehose delivery stream.</p>
|
|
2861
2860
|
* </li>
|
|
2862
2861
|
* </ul>
|
|
2862
|
+
* @public
|
|
2863
2863
|
*/
|
|
2864
2864
|
Protocol: string | undefined;
|
|
2865
2865
|
/**
|
|
2866
|
-
* @public
|
|
2867
2866
|
* <p>The endpoint that you want to receive notifications. Endpoints vary by
|
|
2868
2867
|
* protocol:</p>
|
|
2869
2868
|
* <ul>
|
|
@@ -2903,10 +2902,10 @@ export interface SubscribeInput {
|
|
|
2903
2902
|
* Kinesis Data Firehose delivery stream.</p>
|
|
2904
2903
|
* </li>
|
|
2905
2904
|
* </ul>
|
|
2905
|
+
* @public
|
|
2906
2906
|
*/
|
|
2907
2907
|
Endpoint?: string;
|
|
2908
2908
|
/**
|
|
2909
|
-
* @public
|
|
2910
2909
|
* <p>A map of attributes with their corresponding values.</p>
|
|
2911
2910
|
* <p>The following lists the names, descriptions, and values of the special request
|
|
2912
2911
|
* parameters that the <code>Subscribe</code> action uses:</p>
|
|
@@ -3010,10 +3009,10 @@ export interface SubscribeInput {
|
|
|
3010
3009
|
* </ul>
|
|
3011
3010
|
* </li>
|
|
3012
3011
|
* </ul>
|
|
3012
|
+
* @public
|
|
3013
3013
|
*/
|
|
3014
3014
|
Attributes?: Record<string, string>;
|
|
3015
3015
|
/**
|
|
3016
|
-
* @public
|
|
3017
3016
|
* <p>Sets whether the response from the <code>Subscribe</code> request includes the
|
|
3018
3017
|
* subscription ARN, even if the subscription is not yet confirmed.</p>
|
|
3019
3018
|
* <p>If you set this parameter to <code>true</code>, the response includes the ARN in all
|
|
@@ -3024,20 +3023,21 @@ export interface SubscribeInput {
|
|
|
3024
3023
|
* <code>ConfirmSubscription</code> action with a confirmation token.</p>
|
|
3025
3024
|
* <p></p>
|
|
3026
3025
|
* <p>The default value is <code>false</code>.</p>
|
|
3026
|
+
* @public
|
|
3027
3027
|
*/
|
|
3028
3028
|
ReturnSubscriptionArn?: boolean;
|
|
3029
3029
|
}
|
|
3030
3030
|
/**
|
|
3031
|
-
* @public
|
|
3032
3031
|
* <p>Response for Subscribe action.</p>
|
|
3032
|
+
* @public
|
|
3033
3033
|
*/
|
|
3034
3034
|
export interface SubscribeResponse {
|
|
3035
3035
|
/**
|
|
3036
|
-
* @public
|
|
3037
3036
|
* <p>The ARN of the subscription if it is confirmed, or the string "pending confirmation"
|
|
3038
3037
|
* if the subscription requires confirmation. However, if the API request parameter
|
|
3039
3038
|
* <code>ReturnSubscriptionArn</code> is true, then the value is always the
|
|
3040
3039
|
* subscription ARN, even if the subscription requires confirmation.</p>
|
|
3040
|
+
* @public
|
|
3041
3041
|
*/
|
|
3042
3042
|
SubscriptionArn?: string;
|
|
3043
3043
|
}
|
|
@@ -3046,14 +3046,14 @@ export interface SubscribeResponse {
|
|
|
3046
3046
|
*/
|
|
3047
3047
|
export interface TagResourceRequest {
|
|
3048
3048
|
/**
|
|
3049
|
-
* @public
|
|
3050
3049
|
* <p>The ARN of the topic to which to add tags.</p>
|
|
3050
|
+
* @public
|
|
3051
3051
|
*/
|
|
3052
3052
|
ResourceArn: string | undefined;
|
|
3053
3053
|
/**
|
|
3054
|
-
* @public
|
|
3055
3054
|
* <p>The tags to be added to the specified topic. A tag consists of a required key and an
|
|
3056
3055
|
* optional value.</p>
|
|
3056
|
+
* @public
|
|
3057
3057
|
*/
|
|
3058
3058
|
Tags: Tag[] | undefined;
|
|
3059
3059
|
}
|
|
@@ -3063,13 +3063,13 @@ export interface TagResourceRequest {
|
|
|
3063
3063
|
export interface TagResourceResponse {
|
|
3064
3064
|
}
|
|
3065
3065
|
/**
|
|
3066
|
-
* @public
|
|
3067
3066
|
* <p>Input for Unsubscribe action.</p>
|
|
3067
|
+
* @public
|
|
3068
3068
|
*/
|
|
3069
3069
|
export interface UnsubscribeInput {
|
|
3070
3070
|
/**
|
|
3071
|
-
* @public
|
|
3072
3071
|
* <p>The ARN of the subscription to be deleted.</p>
|
|
3072
|
+
* @public
|
|
3073
3073
|
*/
|
|
3074
3074
|
SubscriptionArn: string | undefined;
|
|
3075
3075
|
}
|
|
@@ -3078,13 +3078,13 @@ export interface UnsubscribeInput {
|
|
|
3078
3078
|
*/
|
|
3079
3079
|
export interface UntagResourceRequest {
|
|
3080
3080
|
/**
|
|
3081
|
-
* @public
|
|
3082
3081
|
* <p>The ARN of the topic from which to remove tags.</p>
|
|
3082
|
+
* @public
|
|
3083
3083
|
*/
|
|
3084
3084
|
ResourceArn: string | undefined;
|
|
3085
3085
|
/**
|
|
3086
|
-
* @public
|
|
3087
3086
|
* <p>The list of tag keys to remove from the specified topic.</p>
|
|
3087
|
+
* @public
|
|
3088
3088
|
*/
|
|
3089
3089
|
TagKeys: string[] | undefined;
|
|
3090
3090
|
}
|
|
@@ -3094,16 +3094,16 @@ export interface UntagResourceRequest {
|
|
|
3094
3094
|
export interface UntagResourceResponse {
|
|
3095
3095
|
}
|
|
3096
3096
|
/**
|
|
3097
|
-
* @public
|
|
3098
3097
|
* <p>Indicates that the one-time password (OTP) used for verification is invalid.</p>
|
|
3098
|
+
* @public
|
|
3099
3099
|
*/
|
|
3100
3100
|
export declare class VerificationException extends __BaseException {
|
|
3101
3101
|
readonly name: "VerificationException";
|
|
3102
3102
|
readonly $fault: "client";
|
|
3103
3103
|
Message: string | undefined;
|
|
3104
3104
|
/**
|
|
3105
|
-
* @public
|
|
3106
3105
|
* <p>The status of the verification error.</p>
|
|
3106
|
+
* @public
|
|
3107
3107
|
*/
|
|
3108
3108
|
Status: string | undefined;
|
|
3109
3109
|
/**
|
|
@@ -3116,20 +3116,20 @@ export declare class VerificationException extends __BaseException {
|
|
|
3116
3116
|
*/
|
|
3117
3117
|
export interface VerifySMSSandboxPhoneNumberInput {
|
|
3118
3118
|
/**
|
|
3119
|
-
* @public
|
|
3120
3119
|
* <p>The destination phone number to verify.</p>
|
|
3120
|
+
* @public
|
|
3121
3121
|
*/
|
|
3122
3122
|
PhoneNumber: string | undefined;
|
|
3123
3123
|
/**
|
|
3124
|
-
* @public
|
|
3125
3124
|
* <p>The OTP sent to the destination number from the
|
|
3126
3125
|
* <code>CreateSMSSandBoxPhoneNumber</code> call.</p>
|
|
3126
|
+
* @public
|
|
3127
3127
|
*/
|
|
3128
3128
|
OneTimePassword: string | undefined;
|
|
3129
3129
|
}
|
|
3130
3130
|
/**
|
|
3131
|
-
* @public
|
|
3132
3131
|
* <p>The destination phone number's verification status.</p>
|
|
3132
|
+
* @public
|
|
3133
3133
|
*/
|
|
3134
3134
|
export interface VerifySMSSandboxPhoneNumberResult {
|
|
3135
3135
|
}
|