aws-sdk 2.916.0 → 2.920.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/CHANGELOG.md +26 -1
- package/README.md +1 -1
- package/apis/autoscaling-2011-01-01.min.json +63 -60
- package/apis/datasync-2018-11-09.min.json +16 -15
- package/apis/devicefarm-2015-06-23.min.json +144 -92
- package/apis/docdb-2014-10-31.min.json +233 -65
- package/apis/docdb-2014-10-31.paginators.json +6 -0
- package/apis/ec2-2016-11-15.min.json +6 -0
- package/apis/fsx-2018-03-01.min.json +27 -24
- package/apis/iotevents-2018-07-27.min.json +715 -188
- package/apis/iotevents-data-2018-10-23.min.json +380 -1
- package/apis/iotsitewise-2019-12-02.min.json +65 -43
- package/apis/iotwireless-2020-11-22.min.json +210 -6
- package/apis/kendra-2019-02-03.min.json +351 -77
- package/apis/location-2020-11-19.min.json +677 -84
- package/apis/location-2020-11-19.paginators.json +12 -0
- package/apis/sns-2010-03-31.min.json +150 -13
- package/apis/sns-2010-03-31.paginators.json +12 -0
- package/clients/autoscaling.d.ts +55 -50
- package/clients/braket.d.ts +2 -2
- package/clients/datasync.d.ts +39 -34
- package/clients/devicefarm.d.ts +41 -10
- package/clients/docdb.d.ts +217 -4
- package/clients/ec2.d.ts +8 -0
- package/clients/ecs.d.ts +4 -4
- package/clients/fsx.d.ts +15 -2
- package/clients/iam.d.ts +1 -1
- package/clients/iotevents.d.ts +595 -11
- package/clients/ioteventsdata.d.ts +474 -9
- package/clients/iotsitewise.d.ts +34 -0
- package/clients/iotwireless.d.ts +126 -0
- package/clients/kendra.d.ts +410 -6
- package/clients/lightsail.d.ts +3 -3
- package/clients/location.d.ts +651 -77
- package/clients/polly.d.ts +1 -1
- package/clients/resourcegroups.d.ts +4 -4
- package/clients/servicediscovery.d.ts +41 -41
- package/clients/sns.d.ts +181 -4
- package/clients/sqs.d.ts +5 -5
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +17 -17
- package/dist/aws-sdk.js +378 -168
- package/dist/aws-sdk.min.js +68 -68
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/sns.d.ts
CHANGED
|
@@ -51,6 +51,14 @@ declare class SNS extends Service {
|
|
|
51
51
|
* Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications. When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
|
|
52
52
|
*/
|
|
53
53
|
createPlatformEndpoint(callback?: (err: AWSError, data: SNS.Types.CreateEndpointResponse) => void): Request<SNS.Types.CreateEndpointResponse, AWSError>;
|
|
54
|
+
/**
|
|
55
|
+
* Adds a destination phone number to an AWS account in the SMS sandbox and sends a one-time password (OTP) to that phone number. When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
|
|
56
|
+
*/
|
|
57
|
+
createSMSSandboxPhoneNumber(params: SNS.Types.CreateSMSSandboxPhoneNumberInput, callback?: (err: AWSError, data: SNS.Types.CreateSMSSandboxPhoneNumberResult) => void): Request<SNS.Types.CreateSMSSandboxPhoneNumberResult, AWSError>;
|
|
58
|
+
/**
|
|
59
|
+
* Adds a destination phone number to an AWS account in the SMS sandbox and sends a one-time password (OTP) to that phone number. When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
|
|
60
|
+
*/
|
|
61
|
+
createSMSSandboxPhoneNumber(callback?: (err: AWSError, data: SNS.Types.CreateSMSSandboxPhoneNumberResult) => void): Request<SNS.Types.CreateSMSSandboxPhoneNumberResult, AWSError>;
|
|
54
62
|
/**
|
|
55
63
|
* Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
|
|
56
64
|
*/
|
|
@@ -75,6 +83,14 @@ declare class SNS extends Service {
|
|
|
75
83
|
* Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
|
|
76
84
|
*/
|
|
77
85
|
deletePlatformApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
86
|
+
/**
|
|
87
|
+
* Deletes an AWS account's verified or pending phone number from the SMS sandbox. When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
|
|
88
|
+
*/
|
|
89
|
+
deleteSMSSandboxPhoneNumber(params: SNS.Types.DeleteSMSSandboxPhoneNumberInput, callback?: (err: AWSError, data: SNS.Types.DeleteSMSSandboxPhoneNumberResult) => void): Request<SNS.Types.DeleteSMSSandboxPhoneNumberResult, AWSError>;
|
|
90
|
+
/**
|
|
91
|
+
* Deletes an AWS account's verified or pending phone number from the SMS sandbox. When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
|
|
92
|
+
*/
|
|
93
|
+
deleteSMSSandboxPhoneNumber(callback?: (err: AWSError, data: SNS.Types.DeleteSMSSandboxPhoneNumberResult) => void): Request<SNS.Types.DeleteSMSSandboxPhoneNumberResult, AWSError>;
|
|
78
94
|
/**
|
|
79
95
|
* Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
|
|
80
96
|
*/
|
|
@@ -107,6 +123,14 @@ declare class SNS extends Service {
|
|
|
107
123
|
* Returns the settings for sending SMS messages from your account. These settings are set with the SetSMSAttributes action.
|
|
108
124
|
*/
|
|
109
125
|
getSMSAttributes(callback?: (err: AWSError, data: SNS.Types.GetSMSAttributesResponse) => void): Request<SNS.Types.GetSMSAttributesResponse, AWSError>;
|
|
126
|
+
/**
|
|
127
|
+
* Retrieves the SMS sandbox status for the calling AWS account in the target AWS Region. When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
|
|
128
|
+
*/
|
|
129
|
+
getSMSSandboxAccountStatus(params: SNS.Types.GetSMSSandboxAccountStatusInput, callback?: (err: AWSError, data: SNS.Types.GetSMSSandboxAccountStatusResult) => void): Request<SNS.Types.GetSMSSandboxAccountStatusResult, AWSError>;
|
|
130
|
+
/**
|
|
131
|
+
* Retrieves the SMS sandbox status for the calling AWS account in the target AWS Region. When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
|
|
132
|
+
*/
|
|
133
|
+
getSMSSandboxAccountStatus(callback?: (err: AWSError, data: SNS.Types.GetSMSSandboxAccountStatusResult) => void): Request<SNS.Types.GetSMSSandboxAccountStatusResult, AWSError>;
|
|
110
134
|
/**
|
|
111
135
|
* Returns all of the properties of a subscription.
|
|
112
136
|
*/
|
|
@@ -131,6 +155,14 @@ declare class SNS extends Service {
|
|
|
131
155
|
* Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 30 transactions per second (TPS).
|
|
132
156
|
*/
|
|
133
157
|
listEndpointsByPlatformApplication(callback?: (err: AWSError, data: SNS.Types.ListEndpointsByPlatformApplicationResponse) => void): Request<SNS.Types.ListEndpointsByPlatformApplicationResponse, AWSError>;
|
|
158
|
+
/**
|
|
159
|
+
* Lists the calling AWS account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.
|
|
160
|
+
*/
|
|
161
|
+
listOriginationNumbers(params: SNS.Types.ListOriginationNumbersRequest, callback?: (err: AWSError, data: SNS.Types.ListOriginationNumbersResult) => void): Request<SNS.Types.ListOriginationNumbersResult, AWSError>;
|
|
162
|
+
/**
|
|
163
|
+
* Lists the calling AWS account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.
|
|
164
|
+
*/
|
|
165
|
+
listOriginationNumbers(callback?: (err: AWSError, data: SNS.Types.ListOriginationNumbersResult) => void): Request<SNS.Types.ListOriginationNumbersResult, AWSError>;
|
|
134
166
|
/**
|
|
135
167
|
* Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them. The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.
|
|
136
168
|
*/
|
|
@@ -147,6 +179,14 @@ declare class SNS extends Service {
|
|
|
147
179
|
* Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at 15 transactions per second (TPS).
|
|
148
180
|
*/
|
|
149
181
|
listPlatformApplications(callback?: (err: AWSError, data: SNS.Types.ListPlatformApplicationsResponse) => void): Request<SNS.Types.ListPlatformApplicationsResponse, AWSError>;
|
|
182
|
+
/**
|
|
183
|
+
* Lists the calling AWS account's current verified and pending destination phone numbers in the SMS sandbox. When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
|
|
184
|
+
*/
|
|
185
|
+
listSMSSandboxPhoneNumbers(params: SNS.Types.ListSMSSandboxPhoneNumbersInput, callback?: (err: AWSError, data: SNS.Types.ListSMSSandboxPhoneNumbersResult) => void): Request<SNS.Types.ListSMSSandboxPhoneNumbersResult, AWSError>;
|
|
186
|
+
/**
|
|
187
|
+
* Lists the calling AWS account's current verified and pending destination phone numbers in the SMS sandbox. When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
|
|
188
|
+
*/
|
|
189
|
+
listSMSSandboxPhoneNumbers(callback?: (err: AWSError, data: SNS.Types.ListSMSSandboxPhoneNumbersResult) => void): Request<SNS.Types.ListSMSSandboxPhoneNumbersResult, AWSError>;
|
|
150
190
|
/**
|
|
151
191
|
* Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results. This action is throttled at 30 transactions per second (TPS).
|
|
152
192
|
*/
|
|
@@ -275,6 +315,14 @@ declare class SNS extends Service {
|
|
|
275
315
|
* Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
|
|
276
316
|
*/
|
|
277
317
|
untagResource(callback?: (err: AWSError, data: SNS.Types.UntagResourceResponse) => void): Request<SNS.Types.UntagResourceResponse, AWSError>;
|
|
318
|
+
/**
|
|
319
|
+
* Verifies a destination phone number with a one-time password (OTP) for the calling AWS account. When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
|
|
320
|
+
*/
|
|
321
|
+
verifySMSSandboxPhoneNumber(params: SNS.Types.VerifySMSSandboxPhoneNumberInput, callback?: (err: AWSError, data: SNS.Types.VerifySMSSandboxPhoneNumberResult) => void): Request<SNS.Types.VerifySMSSandboxPhoneNumberResult, AWSError>;
|
|
322
|
+
/**
|
|
323
|
+
* Verifies a destination phone number with a one-time password (OTP) for the calling AWS account. When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
|
|
324
|
+
*/
|
|
325
|
+
verifySMSSandboxPhoneNumber(callback?: (err: AWSError, data: SNS.Types.VerifySMSSandboxPhoneNumberResult) => void): Request<SNS.Types.VerifySMSSandboxPhoneNumberResult, AWSError>;
|
|
278
326
|
}
|
|
279
327
|
declare namespace SNS {
|
|
280
328
|
export type ActionsList = action[];
|
|
@@ -346,7 +394,7 @@ declare namespace SNS {
|
|
|
346
394
|
*/
|
|
347
395
|
Platform: String;
|
|
348
396
|
/**
|
|
349
|
-
* For a list of attributes, see SetPlatformApplicationAttributes
|
|
397
|
+
* For a list of attributes, see SetPlatformApplicationAttributes.
|
|
350
398
|
*/
|
|
351
399
|
Attributes: MapStringToString;
|
|
352
400
|
}
|
|
@@ -374,13 +422,25 @@ declare namespace SNS {
|
|
|
374
422
|
*/
|
|
375
423
|
Attributes?: MapStringToString;
|
|
376
424
|
}
|
|
425
|
+
export interface CreateSMSSandboxPhoneNumberInput {
|
|
426
|
+
/**
|
|
427
|
+
* The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.
|
|
428
|
+
*/
|
|
429
|
+
PhoneNumber: PhoneNumberString;
|
|
430
|
+
/**
|
|
431
|
+
* The language to use for sending the OTP. The default value is en-US.
|
|
432
|
+
*/
|
|
433
|
+
LanguageCode?: LanguageCodeString;
|
|
434
|
+
}
|
|
435
|
+
export interface CreateSMSSandboxPhoneNumberResult {
|
|
436
|
+
}
|
|
377
437
|
export interface CreateTopicInput {
|
|
378
438
|
/**
|
|
379
439
|
* The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
|
|
380
440
|
*/
|
|
381
441
|
Name: topicName;
|
|
382
442
|
/**
|
|
383
|
-
* A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. DisplayName – The display name to use for a topic with SMS subscriptions. FifoTopic – Set to true to create a FIFO topic. Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic. The following attribute applies only to server-side
|
|
443
|
+
* A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. DisplayName – The display name to use for a topic with SMS subscriptions. FifoTopic – Set to true to create a FIFO topic. Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic. The following attribute applies only to server-side encryption: KmsMasterKeyId – The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference. The following attributes apply only to FIFO topics: FifoTopic – When this is set to true, a FIFO topic is created. ContentBasedDeduplication – Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action. When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
|
|
384
444
|
*/
|
|
385
445
|
Attributes?: TopicAttributesMap;
|
|
386
446
|
/**
|
|
@@ -407,6 +467,14 @@ declare namespace SNS {
|
|
|
407
467
|
*/
|
|
408
468
|
PlatformApplicationArn: String;
|
|
409
469
|
}
|
|
470
|
+
export interface DeleteSMSSandboxPhoneNumberInput {
|
|
471
|
+
/**
|
|
472
|
+
* The destination phone number to delete.
|
|
473
|
+
*/
|
|
474
|
+
PhoneNumber: PhoneNumberString;
|
|
475
|
+
}
|
|
476
|
+
export interface DeleteSMSSandboxPhoneNumberResult {
|
|
477
|
+
}
|
|
410
478
|
export interface DeleteTopicInput {
|
|
411
479
|
/**
|
|
412
480
|
* The ARN of the topic you want to delete.
|
|
@@ -459,6 +527,14 @@ declare namespace SNS {
|
|
|
459
527
|
*/
|
|
460
528
|
attributes?: MapStringToString;
|
|
461
529
|
}
|
|
530
|
+
export interface GetSMSSandboxAccountStatusInput {
|
|
531
|
+
}
|
|
532
|
+
export interface GetSMSSandboxAccountStatusResult {
|
|
533
|
+
/**
|
|
534
|
+
* Indicates whether the calling account is in the SMS sandbox.
|
|
535
|
+
*/
|
|
536
|
+
IsInSandbox: boolean;
|
|
537
|
+
}
|
|
462
538
|
export interface GetSubscriptionAttributesInput {
|
|
463
539
|
/**
|
|
464
540
|
* The ARN of the subscription whose properties you want to get.
|
|
@@ -479,10 +555,12 @@ declare namespace SNS {
|
|
|
479
555
|
}
|
|
480
556
|
export interface GetTopicAttributesResponse {
|
|
481
557
|
/**
|
|
482
|
-
* A map of the topic's attributes. Attributes in this map include the following: DeliveryPolicy – The JSON serialization of the topic's delivery policy. DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints. Owner – The AWS account ID of the topic's owner. Policy – The JSON serialization of the topic's access control policy. SubscriptionsConfirmed – The number of confirmed subscriptions for the topic. SubscriptionsDeleted – The number of deleted subscriptions for the topic. SubscriptionsPending – The number of subscriptions pending confirmation for the topic. TopicArn – The topic's ARN. EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account. The following attribute applies only to server-side-encryption: KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference. The following attributes apply only to FIFO topics: FifoTopic – When this is set to true, a FIFO topic is created. ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
|
|
558
|
+
* A map of the topic's attributes. Attributes in this map include the following: DeliveryPolicy – The JSON serialization of the topic's delivery policy. DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints. Owner – The AWS account ID of the topic's owner. Policy – The JSON serialization of the topic's access control policy. SubscriptionsConfirmed – The number of confirmed subscriptions for the topic. SubscriptionsDeleted – The number of deleted subscriptions for the topic. SubscriptionsPending – The number of subscriptions pending confirmation for the topic. TopicArn – The topic's ARN. EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account. The following attribute applies only to server-side-encryption: KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference. The following attributes apply only to FIFO topics: FifoTopic – When this is set to true, a FIFO topic is created. ContentBasedDeduplication – Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action. When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
|
|
483
559
|
*/
|
|
484
560
|
Attributes?: TopicAttributesMap;
|
|
485
561
|
}
|
|
562
|
+
export type Iso2CountryCode = string;
|
|
563
|
+
export type LanguageCodeString = "en-US"|"en-GB"|"es-419"|"es-ES"|"de-DE"|"fr-CA"|"fr-FR"|"it-IT"|"ja-JP"|"pt-BR"|"kr-KR"|"zh-CN"|"zh-TW"|string;
|
|
486
564
|
export interface ListEndpointsByPlatformApplicationInput {
|
|
487
565
|
/**
|
|
488
566
|
* PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
|
|
@@ -505,6 +583,26 @@ declare namespace SNS {
|
|
|
505
583
|
}
|
|
506
584
|
export type ListOfEndpoints = Endpoint[];
|
|
507
585
|
export type ListOfPlatformApplications = PlatformApplication[];
|
|
586
|
+
export interface ListOriginationNumbersRequest {
|
|
587
|
+
/**
|
|
588
|
+
* Token that the previous ListOriginationNumbers request returns.
|
|
589
|
+
*/
|
|
590
|
+
NextToken?: nextToken;
|
|
591
|
+
/**
|
|
592
|
+
* The maximum number of origination numbers to return.
|
|
593
|
+
*/
|
|
594
|
+
MaxResults?: MaxItemsListOriginationNumbers;
|
|
595
|
+
}
|
|
596
|
+
export interface ListOriginationNumbersResult {
|
|
597
|
+
/**
|
|
598
|
+
* A NextToken string is returned when you call the ListOriginationNumbers operation if additional pages of records are available.
|
|
599
|
+
*/
|
|
600
|
+
NextToken?: nextToken;
|
|
601
|
+
/**
|
|
602
|
+
* A list of the calling account's verified and pending origination numbers.
|
|
603
|
+
*/
|
|
604
|
+
PhoneNumbers?: PhoneNumberInformationList;
|
|
605
|
+
}
|
|
508
606
|
export interface ListPhoneNumbersOptedOutInput {
|
|
509
607
|
/**
|
|
510
608
|
* A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.
|
|
@@ -537,6 +635,26 @@ declare namespace SNS {
|
|
|
537
635
|
*/
|
|
538
636
|
NextToken?: String;
|
|
539
637
|
}
|
|
638
|
+
export interface ListSMSSandboxPhoneNumbersInput {
|
|
639
|
+
/**
|
|
640
|
+
* Token that the previous ListSMSSandboxPhoneNumbersInput request returns.
|
|
641
|
+
*/
|
|
642
|
+
NextToken?: nextToken;
|
|
643
|
+
/**
|
|
644
|
+
* The maximum number of phone numbers to return.
|
|
645
|
+
*/
|
|
646
|
+
MaxResults?: MaxItems;
|
|
647
|
+
}
|
|
648
|
+
export interface ListSMSSandboxPhoneNumbersResult {
|
|
649
|
+
/**
|
|
650
|
+
* A list of the calling account's pending and verified phone numbers.
|
|
651
|
+
*/
|
|
652
|
+
PhoneNumbers: SMSSandboxPhoneNumberList;
|
|
653
|
+
/**
|
|
654
|
+
* A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput operation if additional pages of records are available.
|
|
655
|
+
*/
|
|
656
|
+
NextToken?: string;
|
|
657
|
+
}
|
|
540
658
|
export type ListString = String[];
|
|
541
659
|
export interface ListSubscriptionsByTopicInput {
|
|
542
660
|
/**
|
|
@@ -603,6 +721,8 @@ declare namespace SNS {
|
|
|
603
721
|
NextToken?: nextToken;
|
|
604
722
|
}
|
|
605
723
|
export type MapStringToString = {[key: string]: String};
|
|
724
|
+
export type MaxItems = number;
|
|
725
|
+
export type MaxItemsListOriginationNumbers = number;
|
|
606
726
|
export type MessageAttributeMap = {[key: string]: MessageAttributeValue};
|
|
607
727
|
export interface MessageAttributeValue {
|
|
608
728
|
/**
|
|
@@ -618,6 +738,9 @@ declare namespace SNS {
|
|
|
618
738
|
*/
|
|
619
739
|
BinaryValue?: Binary;
|
|
620
740
|
}
|
|
741
|
+
export type NumberCapability = "SMS"|"MMS"|"VOICE"|string;
|
|
742
|
+
export type NumberCapabilityList = NumberCapability[];
|
|
743
|
+
export type OTPCode = string;
|
|
621
744
|
export interface OptInPhoneNumberInput {
|
|
622
745
|
/**
|
|
623
746
|
* The phone number to opt in. Use E.164 format.
|
|
@@ -627,7 +750,35 @@ declare namespace SNS {
|
|
|
627
750
|
export interface OptInPhoneNumberResponse {
|
|
628
751
|
}
|
|
629
752
|
export type PhoneNumber = string;
|
|
753
|
+
export interface PhoneNumberInformation {
|
|
754
|
+
/**
|
|
755
|
+
* The date and time when the phone number was created.
|
|
756
|
+
*/
|
|
757
|
+
CreatedAt?: Timestamp;
|
|
758
|
+
/**
|
|
759
|
+
* The phone number.
|
|
760
|
+
*/
|
|
761
|
+
PhoneNumber?: String;
|
|
762
|
+
/**
|
|
763
|
+
* The status of the phone number.
|
|
764
|
+
*/
|
|
765
|
+
Status?: String;
|
|
766
|
+
/**
|
|
767
|
+
* The two-character code for the country or region, in ISO 3166-1 alpha-2 format.
|
|
768
|
+
*/
|
|
769
|
+
Iso2CountryCode?: Iso2CountryCode;
|
|
770
|
+
/**
|
|
771
|
+
* The list of supported routes.
|
|
772
|
+
*/
|
|
773
|
+
RouteType?: RouteType;
|
|
774
|
+
/**
|
|
775
|
+
* The capabilities of each phone number.
|
|
776
|
+
*/
|
|
777
|
+
NumberCapabilities?: NumberCapabilityList;
|
|
778
|
+
}
|
|
779
|
+
export type PhoneNumberInformationList = PhoneNumberInformation[];
|
|
630
780
|
export type PhoneNumberList = PhoneNumber[];
|
|
781
|
+
export type PhoneNumberString = string;
|
|
631
782
|
export interface PlatformApplication {
|
|
632
783
|
/**
|
|
633
784
|
* PlatformApplicationArn for platform application object.
|
|
@@ -696,6 +847,19 @@ declare namespace SNS {
|
|
|
696
847
|
*/
|
|
697
848
|
Label: label;
|
|
698
849
|
}
|
|
850
|
+
export type RouteType = "Transactional"|"Promotional"|"Premium"|string;
|
|
851
|
+
export interface SMSSandboxPhoneNumber {
|
|
852
|
+
/**
|
|
853
|
+
* The destination phone number.
|
|
854
|
+
*/
|
|
855
|
+
PhoneNumber?: PhoneNumberString;
|
|
856
|
+
/**
|
|
857
|
+
* The destination phone number's verification status.
|
|
858
|
+
*/
|
|
859
|
+
Status?: SMSSandboxPhoneNumberVerificationStatus;
|
|
860
|
+
}
|
|
861
|
+
export type SMSSandboxPhoneNumberList = SMSSandboxPhoneNumber[];
|
|
862
|
+
export type SMSSandboxPhoneNumberVerificationStatus = "Pending"|"Verified"|string;
|
|
699
863
|
export interface SetEndpointAttributesInput {
|
|
700
864
|
/**
|
|
701
865
|
* EndpointArn used for SetEndpointAttributes action.
|
|
@@ -744,7 +908,7 @@ declare namespace SNS {
|
|
|
744
908
|
*/
|
|
745
909
|
TopicArn: topicARN;
|
|
746
910
|
/**
|
|
747
|
-
* A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. DisplayName – The display name to use for a topic with SMS subscriptions. Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic. The following attribute applies only to server-side-encryption: KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference. The following attribute applies only to FIFO topics: ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
|
|
911
|
+
* A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. DisplayName – The display name to use for a topic with SMS subscriptions. Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic. The following attribute applies only to server-side-encryption: KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference. The following attribute applies only to FIFO topics: ContentBasedDeduplication – Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action. When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
|
|
748
912
|
*/
|
|
749
913
|
AttributeName: attributeName;
|
|
750
914
|
/**
|
|
@@ -831,6 +995,7 @@ declare namespace SNS {
|
|
|
831
995
|
export interface TagResourceResponse {
|
|
832
996
|
}
|
|
833
997
|
export type TagValue = string;
|
|
998
|
+
export type Timestamp = Date;
|
|
834
999
|
export interface Topic {
|
|
835
1000
|
/**
|
|
836
1001
|
* The topic's ARN.
|
|
@@ -857,6 +1022,18 @@ declare namespace SNS {
|
|
|
857
1022
|
}
|
|
858
1023
|
export interface UntagResourceResponse {
|
|
859
1024
|
}
|
|
1025
|
+
export interface VerifySMSSandboxPhoneNumberInput {
|
|
1026
|
+
/**
|
|
1027
|
+
* The destination phone number to verify.
|
|
1028
|
+
*/
|
|
1029
|
+
PhoneNumber: PhoneNumberString;
|
|
1030
|
+
/**
|
|
1031
|
+
* The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call.
|
|
1032
|
+
*/
|
|
1033
|
+
OneTimePassword: OTPCode;
|
|
1034
|
+
}
|
|
1035
|
+
export interface VerifySMSSandboxPhoneNumberResult {
|
|
1036
|
+
}
|
|
860
1037
|
export type account = string;
|
|
861
1038
|
export type action = string;
|
|
862
1039
|
export type attributeName = string;
|
package/clients/sqs.d.ts
CHANGED
|
@@ -279,7 +279,7 @@ declare namespace SQS {
|
|
|
279
279
|
*/
|
|
280
280
|
QueueName: String;
|
|
281
281
|
/**
|
|
282
|
-
* A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses: DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0. MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). Policy – The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. The following attributes apply only to server-side-encryption: KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference. KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?. The following attributes apply only to FIFO (first-in-first-out) queues: FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly. For more information, see FIFO
|
|
282
|
+
* A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses: DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0. MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). Policy – The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. The following attributes apply only to server-side-encryption: KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference. KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?. The following attributes apply only to FIFO (first-in-first-out) queues: FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly. For more information, see FIFO queue logic in the Amazon Simple Queue Service Developer Guide. ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the Amazon Simple Queue Service Developer Guide. Note the following: Every message must have a unique MessageDeduplicationId. You may provide a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered. The following attributes apply only to high throughput for FIFO queues: DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup. To enable high throughput for FIFO queues, do the following: Set DeduplicationScope to messageGroup. Set FifoThroughputLimit to perMessageGroupId. If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, see Quotas related to messages in the Amazon Simple Queue Service Developer Guide.
|
|
283
283
|
*/
|
|
284
284
|
Attributes?: QueueAttributeMap;
|
|
285
285
|
/**
|
|
@@ -353,7 +353,7 @@ declare namespace SQS {
|
|
|
353
353
|
*/
|
|
354
354
|
QueueUrl: String;
|
|
355
355
|
/**
|
|
356
|
-
* A list of attributes for which to retrieve information. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. The following attributes are supported: The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and ApproximateNumberOfMessagesVisible metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. All – Returns all values. ApproximateNumberOfMessages – Returns the approximate number of messages available for retrieval from the queue. ApproximateNumberOfMessagesDelayed – Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter. ApproximateNumberOfMessagesNotVisible – Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window. CreatedTimestamp – Returns the time when the queue was created in seconds (epoch time). DelaySeconds – Returns the default delay on the queue in seconds. LastModifiedTimestamp – Returns the time when the queue was last changed in seconds (epoch time). MaximumMessageSize – Returns the limit of how many bytes a message can contain before Amazon SQS rejects it. MessageRetentionPeriod – Returns the length of time, in seconds, for which Amazon SQS retains a message. Policy – Returns the policy of the queue. QueueArn – Returns the Amazon resource name (ARN) of the queue. ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive. RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. The following attributes apply only to server-side-encryption: KmsMasterKeyId – Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?. The following attributes apply only to FIFO (first-in-first-out) queues: FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO
|
|
356
|
+
* A list of attributes for which to retrieve information. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. The following attributes are supported: The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and ApproximateNumberOfMessagesVisible metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. All – Returns all values. ApproximateNumberOfMessages – Returns the approximate number of messages available for retrieval from the queue. ApproximateNumberOfMessagesDelayed – Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter. ApproximateNumberOfMessagesNotVisible – Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window. CreatedTimestamp – Returns the time when the queue was created in seconds (epoch time). DelaySeconds – Returns the default delay on the queue in seconds. LastModifiedTimestamp – Returns the time when the queue was last changed in seconds (epoch time). MaximumMessageSize – Returns the limit of how many bytes a message can contain before Amazon SQS rejects it. MessageRetentionPeriod – Returns the length of time, in seconds, for which Amazon SQS retains a message. Policy – Returns the policy of the queue. QueueArn – Returns the Amazon resource name (ARN) of the queue. ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive. RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. The following attributes apply only to server-side-encryption: KmsMasterKeyId – Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?. The following attributes apply only to FIFO (first-in-first-out) queues: FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon Simple Queue Service Developer Guide. To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix. ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon Simple Queue Service Developer Guide. The following attributes apply only to high throughput for FIFO queues: DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup. To enable high throughput for FIFO queues, do the following: Set DeduplicationScope to messageGroup. Set FifoThroughputLimit to perMessageGroupId. If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, see Quotas related to messages in the Amazon Simple Queue Service Developer Guide.
|
|
357
357
|
*/
|
|
358
358
|
AttributeNames?: AttributeNameList;
|
|
359
359
|
}
|
|
@@ -609,7 +609,7 @@ declare namespace SQS {
|
|
|
609
609
|
*/
|
|
610
610
|
MessageSystemAttributes?: MessageBodySystemAttributeMap;
|
|
611
611
|
/**
|
|
612
|
-
* This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-
|
|
612
|
+
* This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon Simple Queue Service Developer Guide. Every message must have a unique MessageDeduplicationId, You may provide a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered. The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues). If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages. Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted. The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.
|
|
613
613
|
*/
|
|
614
614
|
MessageDeduplicationId?: String;
|
|
615
615
|
/**
|
|
@@ -677,7 +677,7 @@ declare namespace SQS {
|
|
|
677
677
|
*/
|
|
678
678
|
MessageSystemAttributes?: MessageBodySystemAttributeMap;
|
|
679
679
|
/**
|
|
680
|
-
* This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-
|
|
680
|
+
* This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon Simple Queue Service Developer Guide. Every message must have a unique MessageDeduplicationId, You may provide a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered. The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues). If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages. Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted. The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.
|
|
681
681
|
*/
|
|
682
682
|
MessageDeduplicationId?: String;
|
|
683
683
|
/**
|
|
@@ -713,7 +713,7 @@ declare namespace SQS {
|
|
|
713
713
|
*/
|
|
714
714
|
QueueUrl: String;
|
|
715
715
|
/**
|
|
716
|
-
* A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses: DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0. MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). Policy – The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. The following attributes apply only to server-side-encryption: KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference. KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?. The following attribute applies only to FIFO (first-in-first-out) queues: ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-
|
|
716
|
+
* A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses: DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0. MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). Policy – The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide. ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide. deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded. maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide. The following attributes apply only to server-side-encryption: KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference. KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?. The following attribute applies only to FIFO (first-in-first-out) queues: ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon Simple Queue Service Developer Guide. Note the following: Every message must have a unique MessageDeduplicationId. You may provide a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error. If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered. The following attributes apply only to high throughput for FIFO queues: DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup. To enable high throughput for FIFO queues, do the following: Set DeduplicationScope to messageGroup. Set FifoThroughputLimit to perMessageGroupId. If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, see Quotas related to messages in the Amazon Simple Queue Service Developer Guide.
|
|
717
717
|
*/
|
|
718
718
|
Attributes: QueueAttributeMap;
|
|
719
719
|
}
|