@aws-sdk/client-sns 3.261.0 → 3.263.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-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/protocols/Aws_query.js +1 -1
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/protocols/Aws_query.js +2 -2
- package/dist-types/SNS.d.ts +63 -63
- package/dist-types/SNSClient.d.ts +3 -3
- package/dist-types/commands/AddPermissionCommand.d.ts +2 -2
- package/dist-types/commands/CheckIfPhoneNumberIsOptedOutCommand.d.ts +1 -1
- package/dist-types/commands/CreatePlatformApplicationCommand.d.ts +10 -10
- package/dist-types/commands/CreatePlatformEndpointCommand.d.ts +1 -1
- package/dist-types/commands/CreateSMSSandboxPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEndpointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSMSSandboxPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/GetSMSAttributesCommand.d.ts +1 -1
- package/dist-types/commands/GetSMSSandboxAccountStatusCommand.d.ts +1 -1
- package/dist-types/commands/ListEndpointsByPlatformApplicationCommand.d.ts +1 -1
- package/dist-types/commands/ListPhoneNumbersOptedOutCommand.d.ts +1 -1
- package/dist-types/commands/ListPlatformApplicationsCommand.d.ts +1 -1
- package/dist-types/commands/ListSMSSandboxPhoneNumbersCommand.d.ts +1 -1
- package/dist-types/commands/ListSubscriptionsByTopicCommand.d.ts +1 -1
- package/dist-types/commands/ListSubscriptionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTopicsCommand.d.ts +1 -1
- package/dist-types/commands/OptInPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/PublishBatchCommand.d.ts +7 -7
- package/dist-types/commands/PublishCommand.d.ts +6 -6
- package/dist-types/commands/RemovePermissionCommand.d.ts +2 -2
- package/dist-types/commands/SetSMSAttributesCommand.d.ts +3 -3
- package/dist-types/commands/SetTopicAttributesCommand.d.ts +2 -2
- package/dist-types/commands/SubscribeCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +7 -7
- package/dist-types/commands/UnsubscribeCommand.d.ts +3 -3
- package/dist-types/commands/VerifySMSSandboxPhoneNumberCommand.d.ts +1 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +480 -379
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +2 -2
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a =
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const s = "fn", t = "argv", u = "ref";
|
|
5
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = "stringEquals", i = { "required": true, "default": false, "type": "Boolean" }, j = { [u]: "Region" }, k = { [u]: "Endpoint" }, l = { [s]: "booleanEquals", [t]: [{ [u]: "UseFIPS" }, true] }, m = { [s]: "booleanEquals", [t]: [{ [u]: "UseDualStack" }, true] }, n = {}, o = { [s]: "booleanEquals", [t]: [true, { [s]: "getAttr", [t]: [{ [u]: d }, "supportsFIPS"] }] }, p = { [s]: "booleanEquals", [t]: [true, { [s]: "getAttr", [t]: [{ [u]: d }, "supportsDualStack"] }] }, q = [l], r = [m];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: i, UseFIPS: i, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [s]: "aws.partition", [t]: [j], assign: d }], type: e, rules: [{ conditions: [{ [s]: "isSet", [t]: [k] }], type: e, rules: [{ conditions: q, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: r, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: k, properties: n, headers: n }, type: g }] }] }, { conditions: [l, m], type: e, rules: [{ conditions: [o, p], type: e, rules: [{ endpoint: { url: "https://sns-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: n, headers: n }, type: g }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: q, type: e, rules: [{ conditions: [o], type: e, rules: [{ type: e, rules: [{ conditions: [{ [s]: h, [t]: [j, "us-gov-east-1"] }], endpoint: { url: "https://sns.us-gov-east-1.amazonaws.com", properties: n, headers: n }, type: g }, { conditions: [{ [s]: h, [t]: [j, "us-gov-west-1"] }], endpoint: { url: "https://sns.us-gov-west-1.amazonaws.com", properties: n, headers: n }, type: g }, { endpoint: { url: "https://sns-fips.{Region}.{PartitionResult#dnsSuffix}", properties: n, headers: n }, type: g }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: r, type: e, rules: [{ conditions: [p], type: e, rules: [{ endpoint: { url: "https://sns.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: n, headers: n }, type: g }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { endpoint: { url: "https://sns.{Region}.{PartitionResult#dnsSuffix}", properties: n, headers: n }, type: g }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -3994,7 +3994,7 @@ const deserializeAws_queryPhoneNumberInformation = (output, context) => {
|
|
|
3994
3994
|
NumberCapabilities: undefined,
|
|
3995
3995
|
};
|
|
3996
3996
|
if (output["CreatedAt"] !== undefined) {
|
|
3997
|
-
contents.CreatedAt = (0, smithy_client_1.expectNonNull)((0, smithy_client_1.
|
|
3997
|
+
contents.CreatedAt = (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseRfc3339DateTimeWithOffset)(output["CreatedAt"]));
|
|
3998
3998
|
}
|
|
3999
3999
|
if (output["PhoneNumber"] !== undefined) {
|
|
4000
4000
|
contents.PhoneNumber = (0, smithy_client_1.expectString)(output["PhoneNumber"]);
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a =
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const s = "fn", t = "argv", u = "ref";
|
|
2
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = "stringEquals", i = { "required": true, "default": false, "type": "Boolean" }, j = { [u]: "Region" }, k = { [u]: "Endpoint" }, l = { [s]: "booleanEquals", [t]: [{ [u]: "UseFIPS" }, true] }, m = { [s]: "booleanEquals", [t]: [{ [u]: "UseDualStack" }, true] }, n = {}, o = { [s]: "booleanEquals", [t]: [true, { [s]: "getAttr", [t]: [{ [u]: d }, "supportsFIPS"] }] }, p = { [s]: "booleanEquals", [t]: [true, { [s]: "getAttr", [t]: [{ [u]: d }, "supportsDualStack"] }] }, q = [l], r = [m];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: i, UseFIPS: i, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [s]: "aws.partition", [t]: [j], assign: d }], type: e, rules: [{ conditions: [{ [s]: "isSet", [t]: [k] }], type: e, rules: [{ conditions: q, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: r, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: k, properties: n, headers: n }, type: g }] }] }, { conditions: [l, m], type: e, rules: [{ conditions: [o, p], type: e, rules: [{ endpoint: { url: "https://sns-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: n, headers: n }, type: g }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: q, type: e, rules: [{ conditions: [o], type: e, rules: [{ type: e, rules: [{ conditions: [{ [s]: h, [t]: [j, "us-gov-east-1"] }], endpoint: { url: "https://sns.us-gov-east-1.amazonaws.com", properties: n, headers: n }, type: g }, { conditions: [{ [s]: h, [t]: [j, "us-gov-west-1"] }], endpoint: { url: "https://sns.us-gov-west-1.amazonaws.com", properties: n, headers: n }, type: g }, { endpoint: { url: "https://sns-fips.{Region}.{PartitionResult#dnsSuffix}", properties: n, headers: n }, type: g }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: r, type: e, rules: [{ conditions: [p], type: e, rules: [{ endpoint: { url: "https://sns.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: n, headers: n }, type: g }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { endpoint: { url: "https://sns.{Region}.{PartitionResult#dnsSuffix}", properties: n, headers: n }, type: g }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { HttpRequest as __HttpRequest } from "@aws-sdk/protocol-http";
|
|
2
|
-
import { decorateServiceException as __decorateServiceException, expectNonNull as __expectNonNull, expectString as __expectString, extendedEncodeURIComponent as __extendedEncodeURIComponent, getArrayIfSingleItem as __getArrayIfSingleItem, getValueFromTextNode as __getValueFromTextNode, parseBoolean as __parseBoolean,
|
|
2
|
+
import { decorateServiceException as __decorateServiceException, expectNonNull as __expectNonNull, expectString as __expectString, extendedEncodeURIComponent as __extendedEncodeURIComponent, getArrayIfSingleItem as __getArrayIfSingleItem, getValueFromTextNode as __getValueFromTextNode, parseBoolean as __parseBoolean, parseRfc3339DateTimeWithOffset as __parseRfc3339DateTimeWithOffset, throwDefaultError, } from "@aws-sdk/smithy-client";
|
|
3
3
|
import { XMLParser } from "fast-xml-parser";
|
|
4
4
|
import { AuthorizationErrorException, BatchEntryIdsNotDistinctException, BatchRequestTooLongException, ConcurrentAccessException, EmptyBatchRequestException, EndpointDisabledException, FilterPolicyLimitExceededException, InternalErrorException, InvalidBatchEntryIdException, InvalidParameterException, InvalidParameterValueException, InvalidSecurityException, KMSAccessDeniedException, KMSDisabledException, KMSInvalidStateException, KMSNotFoundException, KMSOptInRequired, KMSThrottlingException, NotFoundException, OptedOutException, PlatformApplicationDisabledException, ResourceNotFoundException, StaleTagException, SubscriptionLimitExceededException, TagLimitExceededException, TagPolicyException, ThrottledException, TooManyEntriesInBatchRequestException, TopicLimitExceededException, UserErrorException, ValidationException, VerificationException, } from "../models/models_0";
|
|
5
5
|
import { SNSServiceException as __BaseException } from "../models/SNSServiceException";
|
|
@@ -3906,7 +3906,7 @@ const deserializeAws_queryPhoneNumberInformation = (output, context) => {
|
|
|
3906
3906
|
NumberCapabilities: undefined,
|
|
3907
3907
|
};
|
|
3908
3908
|
if (output["CreatedAt"] !== undefined) {
|
|
3909
|
-
contents.CreatedAt = __expectNonNull(
|
|
3909
|
+
contents.CreatedAt = __expectNonNull(__parseRfc3339DateTimeWithOffset(output["CreatedAt"]));
|
|
3910
3910
|
}
|
|
3911
3911
|
if (output["PhoneNumber"] !== undefined) {
|
|
3912
3912
|
contents.PhoneNumber = __expectString(output["PhoneNumber"]);
|
package/dist-types/SNS.d.ts
CHANGED
|
@@ -44,15 +44,15 @@ import { VerifySMSSandboxPhoneNumberCommandInput, VerifySMSSandboxPhoneNumberCom
|
|
|
44
44
|
import { SNSClient } from "./SNSClient";
|
|
45
45
|
/**
|
|
46
46
|
* <fullname>Amazon Simple Notification Service</fullname>
|
|
47
|
-
*
|
|
47
|
+
* <p>Amazon Simple Notification Service (Amazon SNS) is a web service that enables you
|
|
48
48
|
* to build distributed web-enabled applications. Applications can use Amazon SNS to easily push
|
|
49
49
|
* real-time notification messages to interested subscribers over multiple delivery
|
|
50
50
|
* protocols. For more information about this product see the <a href="http://aws.amazon.com/sns/">Amazon SNS product page</a>. For detailed information about Amazon SNS features
|
|
51
51
|
* and their associated API calls, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/">Amazon SNS Developer Guide</a>. </p>
|
|
52
|
-
*
|
|
52
|
+
* <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-authentication-and-access-control.html">Identity and access management in Amazon SNS</a> in the <i>Amazon SNS Developer
|
|
53
53
|
* Guide.</i>
|
|
54
54
|
* </p>
|
|
55
|
-
*
|
|
55
|
+
* <p>We also provide SDKs that enable you to access Amazon SNS from your preferred programming
|
|
56
56
|
* language. The SDKs contain functionality that automatically takes care of tasks such as:
|
|
57
57
|
* cryptographically signing your service requests, retrying requests, and handling error
|
|
58
58
|
* responses. For a list of available SDKs, go to <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </p>
|
|
@@ -61,11 +61,11 @@ export declare class SNS extends SNSClient {
|
|
|
61
61
|
/**
|
|
62
62
|
* <p>Adds a statement to a topic's access control policy, granting access for the specified
|
|
63
63
|
* Amazon Web Services accounts to the specified actions.</p>
|
|
64
|
-
*
|
|
64
|
+
* <note>
|
|
65
65
|
* <p>To remove the ability to change topic permissions, you must deny permissions to
|
|
66
66
|
* the <code>AddPermission</code>, <code>RemovePermission</code>, and
|
|
67
67
|
* <code>SetTopicAttributes</code> actions in your IAM policy.</p>
|
|
68
|
-
*
|
|
68
|
+
* </note>
|
|
69
69
|
*/
|
|
70
70
|
addPermission(args: AddPermissionCommandInput, options?: __HttpHandlerOptions): Promise<AddPermissionCommandOutput>;
|
|
71
71
|
addPermission(args: AddPermissionCommandInput, cb: (err: any, data?: AddPermissionCommandOutput) => void): void;
|
|
@@ -74,7 +74,7 @@ export declare class SNS extends SNSClient {
|
|
|
74
74
|
* <p>Accepts a phone number and indicates whether the phone holder has opted out of
|
|
75
75
|
* receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number
|
|
76
76
|
* that is opted out.</p>
|
|
77
|
-
*
|
|
77
|
+
* <p>To resume sending messages, you can opt in the number by using the
|
|
78
78
|
* <code>OptInPhoneNumber</code> action.</p>
|
|
79
79
|
*/
|
|
80
80
|
checkIfPhoneNumberIsOptedOut(args: CheckIfPhoneNumberIsOptedOutCommandInput, options?: __HttpHandlerOptions): Promise<CheckIfPhoneNumberIsOptedOutCommandOutput>;
|
|
@@ -96,45 +96,45 @@ export declare class SNS extends SNSClient {
|
|
|
96
96
|
* apps may register. You must specify <code>PlatformPrincipal</code> and
|
|
97
97
|
* <code>PlatformCredential</code> attributes when using the
|
|
98
98
|
* <code>CreatePlatformApplication</code> action.</p>
|
|
99
|
-
*
|
|
99
|
+
* <p>
|
|
100
100
|
* <code>PlatformPrincipal</code> and <code>PlatformCredential</code> are received from
|
|
101
101
|
* the notification service.</p>
|
|
102
|
-
*
|
|
102
|
+
* <ul>
|
|
103
103
|
* <li>
|
|
104
|
-
*
|
|
104
|
+
* <p>For <code>ADM</code>, <code>PlatformPrincipal</code> is <code>client id</code>
|
|
105
105
|
* and <code>PlatformCredential</code> is <code>client secret</code>.</p>
|
|
106
106
|
* </li>
|
|
107
107
|
* <li>
|
|
108
|
-
*
|
|
108
|
+
* <p>For <code>Baidu</code>, <code>PlatformPrincipal</code> is <code>API key</code>
|
|
109
109
|
* and <code>PlatformCredential</code> is <code>secret key</code>.</p>
|
|
110
110
|
* </li>
|
|
111
111
|
* <li>
|
|
112
|
-
*
|
|
112
|
+
* <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using certificate
|
|
113
113
|
* credentials, <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
|
|
114
114
|
* <code>PlatformCredential</code> is <code>private key</code>.</p>
|
|
115
115
|
* </li>
|
|
116
116
|
* <li>
|
|
117
|
-
*
|
|
117
|
+
* <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using token credentials,
|
|
118
118
|
* <code>PlatformPrincipal</code> is <code>signing key ID</code> and
|
|
119
119
|
* <code>PlatformCredential</code> is <code>signing key</code>.</p>
|
|
120
120
|
* </li>
|
|
121
121
|
* <li>
|
|
122
|
-
*
|
|
122
|
+
* <p>For <code>GCM</code> (Firebase Cloud Messaging), there is no
|
|
123
123
|
* <code>PlatformPrincipal</code> and the <code>PlatformCredential</code> is
|
|
124
124
|
* <code>API key</code>.</p>
|
|
125
125
|
* </li>
|
|
126
126
|
* <li>
|
|
127
|
-
*
|
|
127
|
+
* <p>For <code>MPNS</code>, <code>PlatformPrincipal</code> is <code>TLS
|
|
128
128
|
* certificate</code> and <code>PlatformCredential</code> is <code>private
|
|
129
129
|
* key</code>.</p>
|
|
130
130
|
* </li>
|
|
131
131
|
* <li>
|
|
132
|
-
*
|
|
132
|
+
* <p>For <code>WNS</code>, <code>PlatformPrincipal</code> is <code>Package Security
|
|
133
133
|
* Identifier</code> and <code>PlatformCredential</code> is <code>secret
|
|
134
134
|
* key</code>.</p>
|
|
135
135
|
* </li>
|
|
136
136
|
* </ul>
|
|
137
|
-
*
|
|
137
|
+
* <p>You can use the returned <code>PlatformApplicationArn</code> as an attribute for the
|
|
138
138
|
* <code>CreatePlatformEndpoint</code> action.</p>
|
|
139
139
|
*/
|
|
140
140
|
createPlatformApplication(args: CreatePlatformApplicationCommandInput, options?: __HttpHandlerOptions): Promise<CreatePlatformApplicationCommandOutput>;
|
|
@@ -151,7 +151,7 @@ export declare class SNS extends SNSClient {
|
|
|
151
151
|
* already owns an endpoint with the same device token and attributes, that endpoint's ARN
|
|
152
152
|
* is returned without creating a new endpoint. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
|
|
153
153
|
* Notifications</a>. </p>
|
|
154
|
-
*
|
|
154
|
+
* <p>When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be
|
|
155
155
|
* provided: ChannelId and UserId. The token field must also contain the ChannelId. For
|
|
156
156
|
* more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for
|
|
157
157
|
* Baidu</a>. </p>
|
|
@@ -162,7 +162,7 @@ export declare class SNS extends SNSClient {
|
|
|
162
162
|
/**
|
|
163
163
|
* <p>Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a
|
|
164
164
|
* one-time password (OTP) to that phone number.</p>
|
|
165
|
-
*
|
|
165
|
+
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
166
166
|
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
167
167
|
* you to try Amazon SNS features without risking your reputation as an SMS sender. While your
|
|
168
168
|
* Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
|
|
@@ -188,7 +188,7 @@ export declare class SNS extends SNSClient {
|
|
|
188
188
|
* <p>Deletes the endpoint for a device and mobile app from Amazon SNS. This action is
|
|
189
189
|
* idempotent. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
|
|
190
190
|
* Notifications</a>. </p>
|
|
191
|
-
*
|
|
191
|
+
* <p>When you delete an endpoint that is also subscribed to a topic, then you must also
|
|
192
192
|
* unsubscribe the endpoint from the topic.</p>
|
|
193
193
|
*/
|
|
194
194
|
deleteEndpoint(args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEndpointCommandOutput>;
|
|
@@ -206,7 +206,7 @@ export declare class SNS extends SNSClient {
|
|
|
206
206
|
/**
|
|
207
207
|
* <p>Deletes an Amazon Web Services account's verified or pending phone number from the SMS
|
|
208
208
|
* sandbox.</p>
|
|
209
|
-
*
|
|
209
|
+
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
210
210
|
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
211
211
|
* you to try Amazon SNS features without risking your reputation as an SMS sender. While your
|
|
212
212
|
* Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
|
|
@@ -252,7 +252,7 @@ export declare class SNS extends SNSClient {
|
|
|
252
252
|
getPlatformApplicationAttributes(args: GetPlatformApplicationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlatformApplicationAttributesCommandOutput) => void): void;
|
|
253
253
|
/**
|
|
254
254
|
* <p>Returns the settings for sending SMS messages from your Amazon Web Services account.</p>
|
|
255
|
-
*
|
|
255
|
+
* <p>These settings are set with the <code>SetSMSAttributes</code> action.</p>
|
|
256
256
|
*/
|
|
257
257
|
getSMSAttributes(args: GetSMSAttributesCommandInput, options?: __HttpHandlerOptions): Promise<GetSMSAttributesCommandOutput>;
|
|
258
258
|
getSMSAttributes(args: GetSMSAttributesCommandInput, cb: (err: any, data?: GetSMSAttributesCommandOutput) => void): void;
|
|
@@ -260,7 +260,7 @@ export declare class SNS extends SNSClient {
|
|
|
260
260
|
/**
|
|
261
261
|
* <p>Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target
|
|
262
262
|
* Amazon Web Services Region.</p>
|
|
263
|
-
*
|
|
263
|
+
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
264
264
|
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
265
265
|
* you to try Amazon SNS features without risking your reputation as an SMS sender. While your
|
|
266
266
|
* Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
|
|
@@ -295,7 +295,7 @@ export declare class SNS extends SNSClient {
|
|
|
295
295
|
* received from the previous call. When there are no more records to return, NextToken
|
|
296
296
|
* will be null. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
|
|
297
297
|
* Notifications</a>. </p>
|
|
298
|
-
*
|
|
298
|
+
* <p>This action is throttled at 30 transactions per second (TPS).</p>
|
|
299
299
|
*/
|
|
300
300
|
listEndpointsByPlatformApplication(args: ListEndpointsByPlatformApplicationCommandInput, options?: __HttpHandlerOptions): Promise<ListEndpointsByPlatformApplicationCommandOutput>;
|
|
301
301
|
listEndpointsByPlatformApplication(args: ListEndpointsByPlatformApplicationCommandInput, cb: (err: any, data?: ListEndpointsByPlatformApplicationCommandOutput) => void): void;
|
|
@@ -311,7 +311,7 @@ export declare class SNS extends SNSClient {
|
|
|
311
311
|
/**
|
|
312
312
|
* <p>Returns a list of phone numbers that are opted out, meaning you cannot send SMS
|
|
313
313
|
* messages to them.</p>
|
|
314
|
-
*
|
|
314
|
+
* <p>The results for <code>ListPhoneNumbersOptedOut</code> are paginated, and each page
|
|
315
315
|
* returns up to 100 phone numbers. If additional phone numbers are available after the
|
|
316
316
|
* first page of results, then a <code>NextToken</code> string will be returned. To receive
|
|
317
317
|
* the next page, you call <code>ListPhoneNumbersOptedOut</code> again using the
|
|
@@ -331,7 +331,7 @@ export declare class SNS extends SNSClient {
|
|
|
331
331
|
* previous call. When there are no more records to return, <code>NextToken</code> will be
|
|
332
332
|
* null. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
|
|
333
333
|
* Notifications</a>. </p>
|
|
334
|
-
*
|
|
334
|
+
* <p>This action is throttled at 15 transactions per second (TPS).</p>
|
|
335
335
|
*/
|
|
336
336
|
listPlatformApplications(args: ListPlatformApplicationsCommandInput, options?: __HttpHandlerOptions): Promise<ListPlatformApplicationsCommandOutput>;
|
|
337
337
|
listPlatformApplications(args: ListPlatformApplicationsCommandInput, cb: (err: any, data?: ListPlatformApplicationsCommandOutput) => void): void;
|
|
@@ -339,7 +339,7 @@ export declare class SNS extends SNSClient {
|
|
|
339
339
|
/**
|
|
340
340
|
* <p>Lists the calling Amazon Web Services account's current verified and pending destination phone
|
|
341
341
|
* numbers in the SMS sandbox.</p>
|
|
342
|
-
*
|
|
342
|
+
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
343
343
|
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
344
344
|
* you to try Amazon SNS features without risking your reputation as an SMS sender. While your
|
|
345
345
|
* Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
|
|
@@ -356,7 +356,7 @@ export declare class SNS extends SNSClient {
|
|
|
356
356
|
* subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is
|
|
357
357
|
* also returned. Use the <code>NextToken</code> parameter in a new
|
|
358
358
|
* <code>ListSubscriptions</code> call to get further results.</p>
|
|
359
|
-
*
|
|
359
|
+
* <p>This action is throttled at 30 transactions per second (TPS).</p>
|
|
360
360
|
*/
|
|
361
361
|
listSubscriptions(args: ListSubscriptionsCommandInput, options?: __HttpHandlerOptions): Promise<ListSubscriptionsCommandOutput>;
|
|
362
362
|
listSubscriptions(args: ListSubscriptionsCommandInput, cb: (err: any, data?: ListSubscriptionsCommandOutput) => void): void;
|
|
@@ -366,7 +366,7 @@ export declare class SNS extends SNSClient {
|
|
|
366
366
|
* list of subscriptions, up to 100. If there are more subscriptions, a
|
|
367
367
|
* <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in
|
|
368
368
|
* a new <code>ListSubscriptionsByTopic</code> call to get further results.</p>
|
|
369
|
-
*
|
|
369
|
+
* <p>This action is throttled at 30 transactions per second (TPS).</p>
|
|
370
370
|
*/
|
|
371
371
|
listSubscriptionsByTopic(args: ListSubscriptionsByTopicCommandInput, options?: __HttpHandlerOptions): Promise<ListSubscriptionsByTopicCommandOutput>;
|
|
372
372
|
listSubscriptionsByTopic(args: ListSubscriptionsByTopicCommandInput, cb: (err: any, data?: ListSubscriptionsByTopicCommandOutput) => void): void;
|
|
@@ -383,7 +383,7 @@ export declare class SNS extends SNSClient {
|
|
|
383
383
|
* up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the
|
|
384
384
|
* <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get
|
|
385
385
|
* further results.</p>
|
|
386
|
-
*
|
|
386
|
+
* <p>This action is throttled at 30 transactions per second (TPS).</p>
|
|
387
387
|
*/
|
|
388
388
|
listTopics(args: ListTopicsCommandInput, options?: __HttpHandlerOptions): Promise<ListTopicsCommandOutput>;
|
|
389
389
|
listTopics(args: ListTopicsCommandInput, cb: (err: any, data?: ListTopicsCommandOutput) => void): void;
|
|
@@ -391,7 +391,7 @@ export declare class SNS extends SNSClient {
|
|
|
391
391
|
/**
|
|
392
392
|
* <p>Use this request to opt in a phone number that is opted out, which enables you to
|
|
393
393
|
* resume sending SMS messages to the number.</p>
|
|
394
|
-
*
|
|
394
|
+
* <p>You can opt in a phone number only once every 30 days.</p>
|
|
395
395
|
*/
|
|
396
396
|
optInPhoneNumber(args: OptInPhoneNumberCommandInput, options?: __HttpHandlerOptions): Promise<OptInPhoneNumberCommandOutput>;
|
|
397
397
|
optInPhoneNumber(args: OptInPhoneNumberCommandInput, cb: (err: any, data?: OptInPhoneNumberCommandOutput) => void): void;
|
|
@@ -400,21 +400,21 @@ export declare class SNS extends SNSClient {
|
|
|
400
400
|
* <p>Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone
|
|
401
401
|
* number, or a message to a mobile platform endpoint (when you specify the
|
|
402
402
|
* <code>TargetArn</code>).</p>
|
|
403
|
-
*
|
|
403
|
+
* <p>If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is
|
|
404
404
|
* subscribed to the topic. The format of the message depends on the notification protocol
|
|
405
405
|
* for each subscribed endpoint.</p>
|
|
406
|
-
*
|
|
406
|
+
* <p>When a <code>messageId</code> is returned, the message is saved and Amazon SNS immediately
|
|
407
407
|
* delivers it to subscribers.</p>
|
|
408
|
-
*
|
|
408
|
+
* <p>To use the <code>Publish</code> action for publishing a message to a mobile endpoint,
|
|
409
409
|
* such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for
|
|
410
410
|
* the TargetArn parameter. The EndpointArn is returned when making a call with the
|
|
411
411
|
* <code>CreatePlatformEndpoint</code> action. </p>
|
|
412
|
-
*
|
|
412
|
+
* <p>For more information about formatting messages, see <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html">Send Custom
|
|
413
413
|
* Platform-Specific Payloads in Messages to Mobile Devices</a>. </p>
|
|
414
|
-
*
|
|
414
|
+
* <important>
|
|
415
415
|
* <p>You can publish messages only to topics and endpoints in the same
|
|
416
416
|
* Amazon Web Services Region.</p>
|
|
417
|
-
*
|
|
417
|
+
* </important>
|
|
418
418
|
*/
|
|
419
419
|
publish(args: PublishCommandInput, options?: __HttpHandlerOptions): Promise<PublishCommandOutput>;
|
|
420
420
|
publish(args: PublishCommandInput, cb: (err: any, data?: PublishCommandOutput) => void): void;
|
|
@@ -424,22 +424,22 @@ export declare class SNS extends SNSClient {
|
|
|
424
424
|
* <code>Publish</code>. For FIFO topics, multiple messages within a single batch are
|
|
425
425
|
* published in the order they are sent, and messages are deduplicated within the batch and
|
|
426
426
|
* across batches for 5 minutes.</p>
|
|
427
|
-
*
|
|
427
|
+
* <p>The result of publishing each message is reported individually in the response.
|
|
428
428
|
* Because the batch request can result in a combination of successful and unsuccessful
|
|
429
429
|
* actions, you should check for batch errors even when the call returns an HTTP status
|
|
430
430
|
* code of <code>200</code>.</p>
|
|
431
|
-
*
|
|
431
|
+
* <p>The maximum allowed individual message size and the maximum total payload size (the
|
|
432
432
|
* sum of the individual lengths of all of the batched messages) are both 256 KB (262,144
|
|
433
433
|
* bytes). </p>
|
|
434
|
-
*
|
|
434
|
+
* <p>Some actions take lists of parameters. These lists are specified using the
|
|
435
435
|
* <code>param.n</code> notation. Values of <code>n</code> are integers starting from
|
|
436
436
|
* 1. For example, a parameter list with two elements looks like this: </p>
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
437
|
+
* <p>&AttributeName.1=first</p>
|
|
438
|
+
* <p>&AttributeName.2=second</p>
|
|
439
|
+
* <p>If you send a batch message to a topic, Amazon SNS publishes the batch message to each
|
|
440
440
|
* endpoint that is subscribed to the topic. The format of the batch message depends on the
|
|
441
441
|
* notification protocol for each subscribed endpoint.</p>
|
|
442
|
-
*
|
|
442
|
+
* <p>When a <code>messageId</code> is returned, the batch message is saved and Amazon SNS
|
|
443
443
|
* immediately delivers the message to subscribers.</p>
|
|
444
444
|
*/
|
|
445
445
|
publishBatch(args: PublishBatchCommandInput, options?: __HttpHandlerOptions): Promise<PublishBatchCommandOutput>;
|
|
@@ -454,11 +454,11 @@ export declare class SNS extends SNSClient {
|
|
|
454
454
|
putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void): void;
|
|
455
455
|
/**
|
|
456
456
|
* <p>Removes a statement from a topic's access control policy.</p>
|
|
457
|
-
*
|
|
457
|
+
* <note>
|
|
458
458
|
* <p>To remove the ability to change topic permissions, you must deny permissions to
|
|
459
459
|
* the <code>AddPermission</code>, <code>RemovePermission</code>, and
|
|
460
460
|
* <code>SetTopicAttributes</code> actions in your IAM policy.</p>
|
|
461
|
-
*
|
|
461
|
+
* </note>
|
|
462
462
|
*/
|
|
463
463
|
removePermission(args: RemovePermissionCommandInput, options?: __HttpHandlerOptions): Promise<RemovePermissionCommandOutput>;
|
|
464
464
|
removePermission(args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
|
|
@@ -484,15 +484,15 @@ export declare class SNS extends SNSClient {
|
|
|
484
484
|
/**
|
|
485
485
|
* <p>Use this request to set the default settings for sending SMS messages and receiving
|
|
486
486
|
* daily SMS usage reports.</p>
|
|
487
|
-
*
|
|
487
|
+
* <p>You can override some of these settings for a single message when you use the
|
|
488
488
|
* <code>Publish</code> action with the <code>MessageAttributes.entry.N</code>
|
|
489
489
|
* parameter. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Publishing to a mobile phone</a>
|
|
490
490
|
* in the <i>Amazon SNS Developer Guide</i>.</p>
|
|
491
|
-
*
|
|
491
|
+
* <note>
|
|
492
492
|
* <p>To use this operation, you must grant the Amazon SNS service principal
|
|
493
493
|
* (<code>sns.amazonaws.com</code>) permission to perform the
|
|
494
494
|
* <code>s3:ListBucket</code> action. </p>
|
|
495
|
-
*
|
|
495
|
+
* </note>
|
|
496
496
|
*/
|
|
497
497
|
setSMSAttributes(args: SetSMSAttributesCommandInput, options?: __HttpHandlerOptions): Promise<SetSMSAttributesCommandOutput>;
|
|
498
498
|
setSMSAttributes(args: SetSMSAttributesCommandInput, cb: (err: any, data?: SetSMSAttributesCommandOutput) => void): void;
|
|
@@ -506,11 +506,11 @@ export declare class SNS extends SNSClient {
|
|
|
506
506
|
setSubscriptionAttributes(args: SetSubscriptionAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSubscriptionAttributesCommandOutput) => void): void;
|
|
507
507
|
/**
|
|
508
508
|
* <p>Allows a topic owner to set an attribute of the topic to a new value.</p>
|
|
509
|
-
*
|
|
509
|
+
* <note>
|
|
510
510
|
* <p>To remove the ability to change topic permissions, you must deny permissions to
|
|
511
511
|
* the <code>AddPermission</code>, <code>RemovePermission</code>, and
|
|
512
512
|
* <code>SetTopicAttributes</code> actions in your IAM policy.</p>
|
|
513
|
-
*
|
|
513
|
+
* </note>
|
|
514
514
|
*/
|
|
515
515
|
setTopicAttributes(args: SetTopicAttributesCommandInput, options?: __HttpHandlerOptions): Promise<SetTopicAttributesCommandOutput>;
|
|
516
516
|
setTopicAttributes(args: SetTopicAttributesCommandInput, cb: (err: any, data?: SetTopicAttributesCommandOutput) => void): void;
|
|
@@ -519,9 +519,9 @@ export declare class SNS extends SNSClient {
|
|
|
519
519
|
* <p>Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or
|
|
520
520
|
* if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must
|
|
521
521
|
* run the <code>ConfirmSubscription</code> action to confirm the subscription.</p>
|
|
522
|
-
*
|
|
522
|
+
* <p>You call the <code>ConfirmSubscription</code> action with the token from the
|
|
523
523
|
* subscription response. Confirmation tokens are valid for three days.</p>
|
|
524
|
-
*
|
|
524
|
+
* <p>This action is throttled at 100 transactions per second (TPS).</p>
|
|
525
525
|
*/
|
|
526
526
|
subscribe(args: SubscribeCommandInput, options?: __HttpHandlerOptions): Promise<SubscribeCommandOutput>;
|
|
527
527
|
subscribe(args: SubscribeCommandInput, cb: (err: any, data?: SubscribeCommandOutput) => void): void;
|
|
@@ -529,24 +529,24 @@ export declare class SNS extends SNSClient {
|
|
|
529
529
|
/**
|
|
530
530
|
* <p>Add tags to the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the
|
|
531
531
|
* <i>Amazon SNS Developer Guide</i>.</p>
|
|
532
|
-
*
|
|
533
|
-
*
|
|
532
|
+
* <p>When you use topic tags, keep the following guidelines in mind:</p>
|
|
533
|
+
* <ul>
|
|
534
534
|
* <li>
|
|
535
|
-
*
|
|
535
|
+
* <p>Adding more than 50 tags to a topic isn't recommended.</p>
|
|
536
536
|
* </li>
|
|
537
537
|
* <li>
|
|
538
|
-
*
|
|
538
|
+
* <p>Tags don't have any semantic meaning. Amazon SNS interprets tags as character
|
|
539
539
|
* strings.</p>
|
|
540
540
|
* </li>
|
|
541
541
|
* <li>
|
|
542
|
-
*
|
|
542
|
+
* <p>Tags are case-sensitive.</p>
|
|
543
543
|
* </li>
|
|
544
544
|
* <li>
|
|
545
|
-
*
|
|
545
|
+
* <p>A new tag with a key identical to that of an existing tag overwrites the
|
|
546
546
|
* existing tag.</p>
|
|
547
547
|
* </li>
|
|
548
548
|
* <li>
|
|
549
|
-
*
|
|
549
|
+
* <p>Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If
|
|
550
550
|
* your application requires a higher throughput, file a <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=technical">technical support request</a>.</p>
|
|
551
551
|
* </li>
|
|
552
552
|
* </ul>
|
|
@@ -561,12 +561,12 @@ export declare class SNS extends SNSClient {
|
|
|
561
561
|
* authentication and the requester is not the subscription owner, a final cancellation
|
|
562
562
|
* message is delivered to the endpoint, so that the endpoint owner can easily resubscribe
|
|
563
563
|
* to the topic if the <code>Unsubscribe</code> request was unintended.</p>
|
|
564
|
-
*
|
|
564
|
+
* <note>
|
|
565
565
|
* <p>Amazon SQS queue subscriptions require authentication for deletion. Only the owner of
|
|
566
566
|
* the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services
|
|
567
567
|
* signature.</p>
|
|
568
|
-
*
|
|
569
|
-
*
|
|
568
|
+
* </note>
|
|
569
|
+
* <p>This action is throttled at 100 transactions per second (TPS).</p>
|
|
570
570
|
*/
|
|
571
571
|
unsubscribe(args: UnsubscribeCommandInput, options?: __HttpHandlerOptions): Promise<UnsubscribeCommandOutput>;
|
|
572
572
|
unsubscribe(args: UnsubscribeCommandInput, cb: (err: any, data?: UnsubscribeCommandOutput) => void): void;
|
|
@@ -581,7 +581,7 @@ export declare class SNS extends SNSClient {
|
|
|
581
581
|
/**
|
|
582
582
|
* <p>Verifies a destination phone number with a one-time password (OTP) for the calling
|
|
583
583
|
* Amazon Web Services account.</p>
|
|
584
|
-
*
|
|
584
|
+
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
585
585
|
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
586
586
|
* you to try Amazon SNS features without risking your reputation as an SMS sender. While your
|
|
587
587
|
* Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
|
|
@@ -166,15 +166,15 @@ export interface SNSClientResolvedConfig extends SNSClientResolvedConfigType {
|
|
|
166
166
|
}
|
|
167
167
|
/**
|
|
168
168
|
* <fullname>Amazon Simple Notification Service</fullname>
|
|
169
|
-
*
|
|
169
|
+
* <p>Amazon Simple Notification Service (Amazon SNS) is a web service that enables you
|
|
170
170
|
* to build distributed web-enabled applications. Applications can use Amazon SNS to easily push
|
|
171
171
|
* real-time notification messages to interested subscribers over multiple delivery
|
|
172
172
|
* protocols. For more information about this product see the <a href="http://aws.amazon.com/sns/">Amazon SNS product page</a>. For detailed information about Amazon SNS features
|
|
173
173
|
* and their associated API calls, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/">Amazon SNS Developer Guide</a>. </p>
|
|
174
|
-
*
|
|
174
|
+
* <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-authentication-and-access-control.html">Identity and access management in Amazon SNS</a> in the <i>Amazon SNS Developer
|
|
175
175
|
* Guide.</i>
|
|
176
176
|
* </p>
|
|
177
|
-
*
|
|
177
|
+
* <p>We also provide SDKs that enable you to access Amazon SNS from your preferred programming
|
|
178
178
|
* language. The SDKs contain functionality that automatically takes care of tasks such as:
|
|
179
179
|
* cryptographically signing your service requests, retrying requests, and handling error
|
|
180
180
|
* responses. For a list of available SDKs, go to <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </p>
|
|
@@ -10,11 +10,11 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Adds a statement to a topic's access control policy, granting access for the specified
|
|
12
12
|
* Amazon Web Services accounts to the specified actions.</p>
|
|
13
|
-
*
|
|
13
|
+
* <note>
|
|
14
14
|
* <p>To remove the ability to change topic permissions, you must deny permissions to
|
|
15
15
|
* the <code>AddPermission</code>, <code>RemovePermission</code>, and
|
|
16
16
|
* <code>SetTopicAttributes</code> actions in your IAM policy.</p>
|
|
17
|
-
*
|
|
17
|
+
* </note>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
20
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface CheckIfPhoneNumberIsOptedOutCommandOutput extends CheckIfPhoneN
|
|
|
11
11
|
* <p>Accepts a phone number and indicates whether the phone holder has opted out of
|
|
12
12
|
* receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number
|
|
13
13
|
* that is opted out.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>To resume sending messages, you can opt in the number by using the
|
|
15
15
|
* <code>OptInPhoneNumber</code> action.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -13,45 +13,45 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
|
|
|
13
13
|
* apps may register. You must specify <code>PlatformPrincipal</code> and
|
|
14
14
|
* <code>PlatformCredential</code> attributes when using the
|
|
15
15
|
* <code>CreatePlatformApplication</code> action.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>
|
|
17
17
|
* <code>PlatformPrincipal</code> and <code>PlatformCredential</code> are received from
|
|
18
18
|
* the notification service.</p>
|
|
19
|
-
*
|
|
19
|
+
* <ul>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
21
|
+
* <p>For <code>ADM</code>, <code>PlatformPrincipal</code> is <code>client id</code>
|
|
22
22
|
* and <code>PlatformCredential</code> is <code>client secret</code>.</p>
|
|
23
23
|
* </li>
|
|
24
24
|
* <li>
|
|
25
|
-
*
|
|
25
|
+
* <p>For <code>Baidu</code>, <code>PlatformPrincipal</code> is <code>API key</code>
|
|
26
26
|
* and <code>PlatformCredential</code> is <code>secret key</code>.</p>
|
|
27
27
|
* </li>
|
|
28
28
|
* <li>
|
|
29
|
-
*
|
|
29
|
+
* <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using certificate
|
|
30
30
|
* credentials, <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
|
|
31
31
|
* <code>PlatformCredential</code> is <code>private key</code>.</p>
|
|
32
32
|
* </li>
|
|
33
33
|
* <li>
|
|
34
|
-
*
|
|
34
|
+
* <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using token credentials,
|
|
35
35
|
* <code>PlatformPrincipal</code> is <code>signing key ID</code> and
|
|
36
36
|
* <code>PlatformCredential</code> is <code>signing key</code>.</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* <li>
|
|
39
|
-
*
|
|
39
|
+
* <p>For <code>GCM</code> (Firebase Cloud Messaging), there is no
|
|
40
40
|
* <code>PlatformPrincipal</code> and the <code>PlatformCredential</code> is
|
|
41
41
|
* <code>API key</code>.</p>
|
|
42
42
|
* </li>
|
|
43
43
|
* <li>
|
|
44
|
-
*
|
|
44
|
+
* <p>For <code>MPNS</code>, <code>PlatformPrincipal</code> is <code>TLS
|
|
45
45
|
* certificate</code> and <code>PlatformCredential</code> is <code>private
|
|
46
46
|
* key</code>.</p>
|
|
47
47
|
* </li>
|
|
48
48
|
* <li>
|
|
49
|
-
*
|
|
49
|
+
* <p>For <code>WNS</code>, <code>PlatformPrincipal</code> is <code>Package Security
|
|
50
50
|
* Identifier</code> and <code>PlatformCredential</code> is <code>secret
|
|
51
51
|
* key</code>.</p>
|
|
52
52
|
* </li>
|
|
53
53
|
* </ul>
|
|
54
|
-
*
|
|
54
|
+
* <p>You can use the returned <code>PlatformApplicationArn</code> as an attribute for the
|
|
55
55
|
* <code>CreatePlatformEndpoint</code> action.</p>
|
|
56
56
|
* @example
|
|
57
57
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -18,7 +18,7 @@ export interface CreatePlatformEndpointCommandOutput extends CreateEndpointRespo
|
|
|
18
18
|
* already owns an endpoint with the same device token and attributes, that endpoint's ARN
|
|
19
19
|
* is returned without creating a new endpoint. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
|
|
20
20
|
* Notifications</a>. </p>
|
|
21
|
-
*
|
|
21
|
+
* <p>When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be
|
|
22
22
|
* provided: ChannelId and UserId. The token field must also contain the ChannelId. For
|
|
23
23
|
* more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for
|
|
24
24
|
* Baidu</a>. </p>
|