@aws-sdk/client-endusermessaging 3.1145.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/LICENSE +201 -0
- package/README.md +370 -0
- package/dist-cjs/index.js +1645 -0
- package/dist-es/EndUserMessaging.js +79 -0
- package/dist-es/EndUserMessagingClient.js +47 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
- package/dist-es/commandBuilder.js +6 -0
- package/dist-es/commands/CreateBrandProfileAttributesCommand.js +4 -0
- package/dist-es/commands/CreateBrandProfileCommand.js +4 -0
- package/dist-es/commands/CreateBrandProfileFromRegistrationCommand.js +4 -0
- package/dist-es/commands/CreateNotifyCodeConfigurationCommand.js +4 -0
- package/dist-es/commands/CreateRegistrationsFromBrandProfileCommand.js +4 -0
- package/dist-es/commands/DeleteBrandProfileAttributeCommand.js +4 -0
- package/dist-es/commands/DeleteBrandProfileCommand.js +4 -0
- package/dist-es/commands/DeleteNotifyCodeConfigurationCommand.js +4 -0
- package/dist-es/commands/GetBrandProfileAttributeCommand.js +4 -0
- package/dist-es/commands/GetBrandProfileCommand.js +4 -0
- package/dist-es/commands/GetJobCommand.js +4 -0
- package/dist-es/commands/GetNotifyCodeConfigurationCommand.js +4 -0
- package/dist-es/commands/ListBrandProfileAttributesCommand.js +4 -0
- package/dist-es/commands/ListBrandProfilesCommand.js +4 -0
- package/dist-es/commands/ListJobsCommand.js +4 -0
- package/dist-es/commands/ListNotifyCodeConfigurationsCommand.js +4 -0
- package/dist-es/commands/ListRegistrationsFromBrandProfileCommand.js +4 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +4 -0
- package/dist-es/commands/SendNotifyCodeVerificationCommand.js +4 -0
- package/dist-es/commands/TagResourceCommand.js +4 -0
- package/dist-es/commands/UntagResourceCommand.js +4 -0
- package/dist-es/commands/UpdateBrandProfileAttributeCommand.js +4 -0
- package/dist-es/commands/UpdateBrandProfileCommand.js +4 -0
- package/dist-es/commands/UpdateBrandProfileFromRegistrationCommand.js +4 -0
- package/dist-es/commands/UpdateNotifyCodeConfigurationCommand.js +4 -0
- package/dist-es/commands/UpdateRegistrationsFromBrandProfileCommand.js +4 -0
- package/dist-es/commands/ValidateNotifyCodeVerificationCommand.js +4 -0
- package/dist-es/commands/index.js +27 -0
- package/dist-es/endpoint/EndpointParameters.js +13 -0
- package/dist-es/endpoint/bdd.js +46 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +11 -0
- package/dist-es/models/EndUserMessagingServiceException.js +8 -0
- package/dist-es/models/enums.js +43 -0
- package/dist-es/models/errors.js +99 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListBrandProfileAttributesPaginator.js +4 -0
- package/dist-es/pagination/ListBrandProfilesPaginator.js +4 -0
- package/dist-es/pagination/ListJobsPaginator.js +4 -0
- package/dist-es/pagination/ListNotifyCodeConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/ListRegistrationsFromBrandProfilePaginator.js +4 -0
- package/dist-es/pagination/index.js +6 -0
- package/dist-es/runtimeConfig.browser.js +29 -0
- package/dist-es/runtimeConfig.js +43 -0
- package/dist-es/runtimeConfig.native.js +9 -0
- package/dist-es/runtimeConfig.shared.js +40 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +818 -0
- package/dist-es/waiters/index.js +2 -0
- package/dist-es/waiters/waitForBrandProfileActive.js +58 -0
- package/dist-es/waiters/waitForJobSuccess.js +40 -0
- package/dist-types/EndUserMessaging.d.ts +256 -0
- package/dist-types/EndUserMessagingClient.d.ts +213 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commandBuilder.d.ts +18 -0
- package/dist-types/commands/CreateBrandProfileAttributesCommand.d.ts +139 -0
- package/dist-types/commands/CreateBrandProfileCommand.d.ts +129 -0
- package/dist-types/commands/CreateBrandProfileFromRegistrationCommand.d.ts +130 -0
- package/dist-types/commands/CreateNotifyCodeConfigurationCommand.d.ts +206 -0
- package/dist-types/commands/CreateRegistrationsFromBrandProfileCommand.d.ts +125 -0
- package/dist-types/commands/DeleteBrandProfileAttributeCommand.d.ts +110 -0
- package/dist-types/commands/DeleteBrandProfileCommand.d.ts +108 -0
- package/dist-types/commands/DeleteNotifyCodeConfigurationCommand.d.ts +102 -0
- package/dist-types/commands/GetBrandProfileAttributeCommand.d.ts +119 -0
- package/dist-types/commands/GetBrandProfileCommand.d.ts +115 -0
- package/dist-types/commands/GetJobCommand.d.ts +129 -0
- package/dist-types/commands/GetNotifyCodeConfigurationCommand.d.ts +156 -0
- package/dist-types/commands/ListBrandProfileAttributesCommand.d.ts +124 -0
- package/dist-types/commands/ListBrandProfilesCommand.d.ts +122 -0
- package/dist-types/commands/ListJobsCommand.d.ts +133 -0
- package/dist-types/commands/ListNotifyCodeConfigurationsCommand.d.ts +159 -0
- package/dist-types/commands/ListRegistrationsFromBrandProfileCommand.d.ts +121 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +113 -0
- package/dist-types/commands/SendNotifyCodeVerificationCommand.d.ts +151 -0
- package/dist-types/commands/TagResourceCommand.d.ts +114 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +105 -0
- package/dist-types/commands/UpdateBrandProfileAttributeCommand.d.ts +127 -0
- package/dist-types/commands/UpdateBrandProfileCommand.d.ts +122 -0
- package/dist-types/commands/UpdateBrandProfileFromRegistrationCommand.d.ts +123 -0
- package/dist-types/commands/UpdateNotifyCodeConfigurationCommand.d.ts +193 -0
- package/dist-types/commands/UpdateRegistrationsFromBrandProfileCommand.d.ts +127 -0
- package/dist-types/commands/ValidateNotifyCodeVerificationCommand.d.ts +104 -0
- package/dist-types/commands/index.d.ts +27 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +50 -0
- package/dist-types/endpoint/bdd.d.ts +2 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +19 -0
- package/dist-types/models/EndUserMessagingServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +145 -0
- package/dist-types/models/errors.d.ts +119 -0
- package/dist-types/models/models_0.d.ts +1667 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListBrandProfileAttributesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListBrandProfilesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListNotifyCodeConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRegistrationsFromBrandProfilePaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +6 -0
- package/dist-types/runtimeConfig.browser.d.ts +57 -0
- package/dist-types/runtimeConfig.d.ts +57 -0
- package/dist-types/runtimeConfig.native.d.ts +56 -0
- package/dist-types/runtimeConfig.shared.d.ts +28 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +120 -0
- package/dist-types/ts3.4/EndUserMessaging.d.ts +515 -0
- package/dist-types/ts3.4/EndUserMessagingClient.d.ts +256 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +25 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +43 -0
- package/dist-types/ts3.4/commandBuilder.d.ts +40 -0
- package/dist-types/ts3.4/commands/CreateBrandProfileAttributesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateBrandProfileCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateBrandProfileFromRegistrationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateNotifyCodeConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateRegistrationsFromBrandProfileCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteBrandProfileAttributeCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteBrandProfileCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteNotifyCodeConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetBrandProfileAttributeCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetBrandProfileCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetNotifyCodeConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListBrandProfileAttributesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListBrandProfilesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListNotifyCodeConfigurationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListRegistrationsFromBrandProfileCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/SendNotifyCodeVerificationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateBrandProfileAttributeCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateBrandProfileCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateBrandProfileFromRegistrationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateNotifyCodeConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateRegistrationsFromBrandProfileCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ValidateNotifyCodeVerificationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +27 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
- package/dist-types/ts3.4/endpoint/bdd.d.ts +2 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +10 -0
- package/dist-types/ts3.4/index.d.ts +14 -0
- package/dist-types/ts3.4/models/EndUserMessagingServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/enums.d.ts +54 -0
- package/dist-types/ts3.4/models/errors.d.ts +47 -0
- package/dist-types/ts3.4/models/models_0.d.ts +413 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
- package/dist-types/ts3.4/pagination/ListBrandProfileAttributesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListBrandProfilesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListJobsPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/ListNotifyCodeConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRegistrationsFromBrandProfilePaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +6 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +31 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +115 -0
- package/dist-types/ts3.4/waiters/index.d.ts +2 -0
- package/dist-types/ts3.4/waiters/waitForBrandProfileActive.d.ts +15 -0
- package/dist-types/ts3.4/waiters/waitForJobSuccess.d.ts +12 -0
- package/dist-types/waiters/index.d.ts +2 -0
- package/dist-types/waiters/waitForBrandProfileActive.d.ts +15 -0
- package/dist-types/waiters/waitForJobSuccess.d.ts +15 -0
- package/package.json +69 -0
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CreateNotifyCodeConfigurationInput, CreateNotifyCodeConfigurationOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CreateNotifyCodeConfigurationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CreateNotifyCodeConfigurationCommandInput extends CreateNotifyCodeConfigurationInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CreateNotifyCodeConfigurationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateNotifyCodeConfigurationCommandOutput extends CreateNotifyCodeConfigurationOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CreateNotifyCodeConfigurationCommand_base: {
|
|
22
|
+
new (input: CreateNotifyCodeConfigurationCommandInput): import("@smithy/core/client").CommandImpl<CreateNotifyCodeConfigurationCommandInput, CreateNotifyCodeConfigurationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CreateNotifyCodeConfigurationCommandInput): import("@smithy/core/client").CommandImpl<CreateNotifyCodeConfigurationCommandInput, CreateNotifyCodeConfigurationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Creates a notify code configuration. A notify code configuration is a reusable policy that defines how one-time passcodes are generated and rendered, including the code type, length, validity period, maximum number of attempts, and channel templates.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, CreateNotifyCodeConfigurationCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, CreateNotifyCodeConfigurationCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
|
|
33
|
+
* // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
|
|
34
|
+
* const config = {}; // type is EndUserMessagingClientConfig
|
|
35
|
+
* const client = new EndUserMessagingClient(config);
|
|
36
|
+
* const input = { // CreateNotifyCodeConfigurationInput
|
|
37
|
+
* notifyCodeConfigurationName: "STRING_VALUE", // required
|
|
38
|
+
* codeConfigurationParameters: { // CodeConfigurationParameters
|
|
39
|
+
* codeType: "NUMERIC" || "ALPHA" || "ALPHANUMERIC",
|
|
40
|
+
* codeLength: Number("int"),
|
|
41
|
+
* validityPeriodMinutes: Number("int"),
|
|
42
|
+
* maxAttempts: Number("int"),
|
|
43
|
+
* },
|
|
44
|
+
* channelParameters: { // ChannelParameters
|
|
45
|
+
* text: { // TextParameters
|
|
46
|
+
* inlineTemplateBody: "STRING_VALUE",
|
|
47
|
+
* destinationCountryParameters: { // DestinationCountryParameters
|
|
48
|
+
* "<keys>": "STRING_VALUE",
|
|
49
|
+
* },
|
|
50
|
+
* },
|
|
51
|
+
* voice: { // VoiceParameters
|
|
52
|
+
* inlineTemplateBody: "STRING_VALUE",
|
|
53
|
+
* languageCode: "STRING_VALUE",
|
|
54
|
+
* voiceId: "STRING_VALUE",
|
|
55
|
+
* voiceMessageBodyTextType: "TEXT" || "SSML",
|
|
56
|
+
* },
|
|
57
|
+
* notify: { // NotifyParameters
|
|
58
|
+
* notifyTemplateId: "STRING_VALUE",
|
|
59
|
+
* voiceId: "STRING_VALUE",
|
|
60
|
+
* },
|
|
61
|
+
* whatsApp: { // WhatsAppParameters
|
|
62
|
+
* whatsAppTemplateName: "STRING_VALUE",
|
|
63
|
+
* languageCode: "STRING_VALUE",
|
|
64
|
+
* },
|
|
65
|
+
* },
|
|
66
|
+
* deletionProtectionEnabled: true || false,
|
|
67
|
+
* clientToken: "STRING_VALUE",
|
|
68
|
+
* tags: [ // TagList
|
|
69
|
+
* { // Tag
|
|
70
|
+
* key: "STRING_VALUE", // required
|
|
71
|
+
* value: "STRING_VALUE", // required
|
|
72
|
+
* },
|
|
73
|
+
* ],
|
|
74
|
+
* };
|
|
75
|
+
* const command = new CreateNotifyCodeConfigurationCommand(input);
|
|
76
|
+
* const response = await client.send(command);
|
|
77
|
+
* // { // CreateNotifyCodeConfigurationOutput
|
|
78
|
+
* // notifyCodeConfiguration: { // NotifyCodeConfiguration
|
|
79
|
+
* // notifyCodeConfigurationId: "STRING_VALUE", // required
|
|
80
|
+
* // notifyCodeConfigurationArn: "STRING_VALUE", // required
|
|
81
|
+
* // notifyCodeConfigurationName: "STRING_VALUE", // required
|
|
82
|
+
* // codeConfigurationParameters: { // CodeConfigurationParameters
|
|
83
|
+
* // codeType: "NUMERIC" || "ALPHA" || "ALPHANUMERIC",
|
|
84
|
+
* // codeLength: Number("int"),
|
|
85
|
+
* // validityPeriodMinutes: Number("int"),
|
|
86
|
+
* // maxAttempts: Number("int"),
|
|
87
|
+
* // },
|
|
88
|
+
* // channelParameters: { // ChannelParameters
|
|
89
|
+
* // text: { // TextParameters
|
|
90
|
+
* // inlineTemplateBody: "STRING_VALUE",
|
|
91
|
+
* // destinationCountryParameters: { // DestinationCountryParameters
|
|
92
|
+
* // "<keys>": "STRING_VALUE",
|
|
93
|
+
* // },
|
|
94
|
+
* // },
|
|
95
|
+
* // voice: { // VoiceParameters
|
|
96
|
+
* // inlineTemplateBody: "STRING_VALUE",
|
|
97
|
+
* // languageCode: "STRING_VALUE",
|
|
98
|
+
* // voiceId: "STRING_VALUE",
|
|
99
|
+
* // voiceMessageBodyTextType: "TEXT" || "SSML",
|
|
100
|
+
* // },
|
|
101
|
+
* // notify: { // NotifyParameters
|
|
102
|
+
* // notifyTemplateId: "STRING_VALUE",
|
|
103
|
+
* // voiceId: "STRING_VALUE",
|
|
104
|
+
* // },
|
|
105
|
+
* // whatsApp: { // WhatsAppParameters
|
|
106
|
+
* // whatsAppTemplateName: "STRING_VALUE",
|
|
107
|
+
* // languageCode: "STRING_VALUE",
|
|
108
|
+
* // },
|
|
109
|
+
* // },
|
|
110
|
+
* // deletionProtectionEnabled: true || false, // required
|
|
111
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
112
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
113
|
+
* // },
|
|
114
|
+
* // };
|
|
115
|
+
*
|
|
116
|
+
* ```
|
|
117
|
+
*
|
|
118
|
+
* @param CreateNotifyCodeConfigurationCommandInput - {@link CreateNotifyCodeConfigurationCommandInput}
|
|
119
|
+
* @returns {@link CreateNotifyCodeConfigurationCommandOutput}
|
|
120
|
+
* @see {@link CreateNotifyCodeConfigurationCommandInput} for command's `input` shape.
|
|
121
|
+
* @see {@link CreateNotifyCodeConfigurationCommandOutput} for command's `response` shape.
|
|
122
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
125
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link ConflictException} (client fault)
|
|
128
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link InternalServerException} (server fault)
|
|
131
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
134
|
+
* <p>The request would exceed a service quota for your account.</p>
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
137
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
138
|
+
*
|
|
139
|
+
* @throws {@link ValidationException} (client fault)
|
|
140
|
+
* A standard error for input validation failures.
|
|
141
|
+
* This should be thrown by services when a member of the input structure
|
|
142
|
+
* falls outside of the modeled or documented constraints.
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
145
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
146
|
+
*
|
|
147
|
+
*
|
|
148
|
+
* @example Create a notify code configuration
|
|
149
|
+
* ```javascript
|
|
150
|
+
* //
|
|
151
|
+
* const input = {
|
|
152
|
+
* channelParameters: {
|
|
153
|
+
* text: {
|
|
154
|
+
* inlineTemplateBody: "Your verification code is {{code}}."
|
|
155
|
+
* }
|
|
156
|
+
* },
|
|
157
|
+
* codeConfigurationParameters: {
|
|
158
|
+
* codeLength: 6,
|
|
159
|
+
* codeType: "NUMERIC",
|
|
160
|
+
* maxAttempts: 3,
|
|
161
|
+
* validityPeriodMinutes: 10
|
|
162
|
+
* },
|
|
163
|
+
* notifyCodeConfigurationName: "SignupOtp"
|
|
164
|
+
* };
|
|
165
|
+
* const command = new CreateNotifyCodeConfigurationCommand(input);
|
|
166
|
+
* const response = await client.send(command);
|
|
167
|
+
* /* response is
|
|
168
|
+
* {
|
|
169
|
+
* notifyCodeConfiguration: {
|
|
170
|
+
* channelParameters: {
|
|
171
|
+
* text: {
|
|
172
|
+
* inlineTemplateBody: "Your verification code is {{code}}."
|
|
173
|
+
* }
|
|
174
|
+
* },
|
|
175
|
+
* codeConfigurationParameters: {
|
|
176
|
+
* codeLength: 6,
|
|
177
|
+
* codeType: "NUMERIC",
|
|
178
|
+
* maxAttempts: 3,
|
|
179
|
+
* validityPeriodMinutes: 10
|
|
180
|
+
* },
|
|
181
|
+
* createdAt: 1727130000,
|
|
182
|
+
* deletionProtectionEnabled: false,
|
|
183
|
+
* notifyCodeConfigurationArn: "arn:aws:end-user-messaging:us-east-1:123456789012:notify-code-configuration/ncc-abc12345678901234",
|
|
184
|
+
* notifyCodeConfigurationId: "ncc-abc12345678901234",
|
|
185
|
+
* notifyCodeConfigurationName: "SignupOtp",
|
|
186
|
+
* updatedAt: 1727130000
|
|
187
|
+
* }
|
|
188
|
+
* }
|
|
189
|
+
* *\/
|
|
190
|
+
* ```
|
|
191
|
+
*
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
export declare class CreateNotifyCodeConfigurationCommand extends CreateNotifyCodeConfigurationCommand_base {
|
|
195
|
+
/** @internal type navigation helper, not in runtime. */
|
|
196
|
+
protected static __types: {
|
|
197
|
+
api: {
|
|
198
|
+
input: CreateNotifyCodeConfigurationInput;
|
|
199
|
+
output: CreateNotifyCodeConfigurationOutput;
|
|
200
|
+
};
|
|
201
|
+
sdk: {
|
|
202
|
+
input: CreateNotifyCodeConfigurationCommandInput;
|
|
203
|
+
output: CreateNotifyCodeConfigurationCommandOutput;
|
|
204
|
+
};
|
|
205
|
+
};
|
|
206
|
+
}
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CreateRegistrationsFromBrandProfileInput, CreateRegistrationsFromBrandProfileOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CreateRegistrationsFromBrandProfileCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CreateRegistrationsFromBrandProfileCommandInput extends CreateRegistrationsFromBrandProfileInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CreateRegistrationsFromBrandProfileCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateRegistrationsFromBrandProfileCommandOutput extends CreateRegistrationsFromBrandProfileOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CreateRegistrationsFromBrandProfileCommand_base: {
|
|
22
|
+
new (input: CreateRegistrationsFromBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<CreateRegistrationsFromBrandProfileCommandInput, CreateRegistrationsFromBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CreateRegistrationsFromBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<CreateRegistrationsFromBrandProfileCommandInput, CreateRegistrationsFromBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use the GetJob operation to track its progress.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, CreateRegistrationsFromBrandProfileCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, CreateRegistrationsFromBrandProfileCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
|
|
33
|
+
* // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
|
|
34
|
+
* const config = {}; // type is EndUserMessagingClientConfig
|
|
35
|
+
* const client = new EndUserMessagingClient(config);
|
|
36
|
+
* const input = { // CreateRegistrationsFromBrandProfileInput
|
|
37
|
+
* brandProfileId: "STRING_VALUE", // required
|
|
38
|
+
* registrationTypes: [ // RegistrationTypeList // required
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* smartMatch: true || false,
|
|
42
|
+
* clientToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new CreateRegistrationsFromBrandProfileCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // CreateRegistrationsFromBrandProfileOutput
|
|
47
|
+
* // results: [ // JobResults // required
|
|
48
|
+
* // { // JobResult
|
|
49
|
+
* // jobId: "STRING_VALUE", // required
|
|
50
|
+
* // resourceIdentifier: "STRING_VALUE", // required
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param CreateRegistrationsFromBrandProfileCommandInput - {@link CreateRegistrationsFromBrandProfileCommandInput}
|
|
58
|
+
* @returns {@link CreateRegistrationsFromBrandProfileCommandOutput}
|
|
59
|
+
* @see {@link CreateRegistrationsFromBrandProfileCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link CreateRegistrationsFromBrandProfileCommandOutput} for command's `response` shape.
|
|
61
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ConflictException} (client fault)
|
|
67
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalServerException} (server fault)
|
|
70
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
73
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
76
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ValidationException} (client fault)
|
|
79
|
+
* A standard error for input validation failures.
|
|
80
|
+
* This should be thrown by services when a member of the input structure
|
|
81
|
+
* falls outside of the modeled or documented constraints.
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
85
|
+
*
|
|
86
|
+
*
|
|
87
|
+
* @example Create draft registrations from a brand profile
|
|
88
|
+
* ```javascript
|
|
89
|
+
* //
|
|
90
|
+
* const input = {
|
|
91
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
92
|
+
* registrationTypes: [
|
|
93
|
+
* "US_TOLL_FREE_REGISTRATION"
|
|
94
|
+
* ],
|
|
95
|
+
* smartMatch: true
|
|
96
|
+
* };
|
|
97
|
+
* const command = new CreateRegistrationsFromBrandProfileCommand(input);
|
|
98
|
+
* const response = await client.send(command);
|
|
99
|
+
* /* response is
|
|
100
|
+
* {
|
|
101
|
+
* results: [
|
|
102
|
+
* {
|
|
103
|
+
* jobId: "job-abc12345678901234",
|
|
104
|
+
* resourceIdentifier: "US_TOLL_FREE_REGISTRATION"
|
|
105
|
+
* }
|
|
106
|
+
* ]
|
|
107
|
+
* }
|
|
108
|
+
* *\/
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
export declare class CreateRegistrationsFromBrandProfileCommand extends CreateRegistrationsFromBrandProfileCommand_base {
|
|
114
|
+
/** @internal type navigation helper, not in runtime. */
|
|
115
|
+
protected static __types: {
|
|
116
|
+
api: {
|
|
117
|
+
input: CreateRegistrationsFromBrandProfileInput;
|
|
118
|
+
output: CreateRegistrationsFromBrandProfileOutput;
|
|
119
|
+
};
|
|
120
|
+
sdk: {
|
|
121
|
+
input: CreateRegistrationsFromBrandProfileCommandInput;
|
|
122
|
+
output: CreateRegistrationsFromBrandProfileCommandOutput;
|
|
123
|
+
};
|
|
124
|
+
};
|
|
125
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DeleteBrandProfileAttributeInput, DeleteBrandProfileAttributeOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DeleteBrandProfileAttributeCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DeleteBrandProfileAttributeCommandInput extends DeleteBrandProfileAttributeInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DeleteBrandProfileAttributeCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DeleteBrandProfileAttributeCommandOutput extends DeleteBrandProfileAttributeOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DeleteBrandProfileAttributeCommand_base: {
|
|
22
|
+
new (input: DeleteBrandProfileAttributeCommandInput): import("@smithy/core/client").CommandImpl<DeleteBrandProfileAttributeCommandInput, DeleteBrandProfileAttributeCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DeleteBrandProfileAttributeCommandInput): import("@smithy/core/client").CommandImpl<DeleteBrandProfileAttributeCommandInput, DeleteBrandProfileAttributeCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Deletes a brand profile attribute. If the attribute stores media, this operation also deletes the associated media.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, DeleteBrandProfileAttributeCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, DeleteBrandProfileAttributeCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
|
|
33
|
+
* // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
|
|
34
|
+
* const config = {}; // type is EndUserMessagingClientConfig
|
|
35
|
+
* const client = new EndUserMessagingClient(config);
|
|
36
|
+
* const input = { // DeleteBrandProfileAttributeInput
|
|
37
|
+
* brandProfileId: "STRING_VALUE", // required
|
|
38
|
+
* attributeName: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteBrandProfileAttributeCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DeleteBrandProfileAttributeOutput
|
|
43
|
+
* // brandProfileId: "STRING_VALUE", // required
|
|
44
|
+
* // attributeName: "STRING_VALUE", // required
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param DeleteBrandProfileAttributeCommandInput - {@link DeleteBrandProfileAttributeCommandInput}
|
|
50
|
+
* @returns {@link DeleteBrandProfileAttributeCommandOutput}
|
|
51
|
+
* @see {@link DeleteBrandProfileAttributeCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link DeleteBrandProfileAttributeCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ConflictException} (client fault)
|
|
59
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalServerException} (server fault)
|
|
62
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
68
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ValidationException} (client fault)
|
|
71
|
+
* A standard error for input validation failures.
|
|
72
|
+
* This should be thrown by services when a member of the input structure
|
|
73
|
+
* falls outside of the modeled or documented constraints.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
77
|
+
*
|
|
78
|
+
*
|
|
79
|
+
* @example Delete a brand profile attribute
|
|
80
|
+
* ```javascript
|
|
81
|
+
* //
|
|
82
|
+
* const input = {
|
|
83
|
+
* attributeName: "SupportEmail",
|
|
84
|
+
* brandProfileId: "bp-abc12345678901234"
|
|
85
|
+
* };
|
|
86
|
+
* const command = new DeleteBrandProfileAttributeCommand(input);
|
|
87
|
+
* const response = await client.send(command);
|
|
88
|
+
* /* response is
|
|
89
|
+
* {
|
|
90
|
+
* attributeName: "SupportEmail",
|
|
91
|
+
* brandProfileId: "bp-abc12345678901234"
|
|
92
|
+
* }
|
|
93
|
+
* *\/
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export declare class DeleteBrandProfileAttributeCommand extends DeleteBrandProfileAttributeCommand_base {
|
|
99
|
+
/** @internal type navigation helper, not in runtime. */
|
|
100
|
+
protected static __types: {
|
|
101
|
+
api: {
|
|
102
|
+
input: DeleteBrandProfileAttributeInput;
|
|
103
|
+
output: DeleteBrandProfileAttributeOutput;
|
|
104
|
+
};
|
|
105
|
+
sdk: {
|
|
106
|
+
input: DeleteBrandProfileAttributeCommandInput;
|
|
107
|
+
output: DeleteBrandProfileAttributeCommandOutput;
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
}
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DeleteBrandProfileInput, DeleteBrandProfileOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DeleteBrandProfileCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DeleteBrandProfileCommandInput extends DeleteBrandProfileInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DeleteBrandProfileCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DeleteBrandProfileCommandOutput extends DeleteBrandProfileOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DeleteBrandProfileCommand_base: {
|
|
22
|
+
new (input: DeleteBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<DeleteBrandProfileCommandInput, DeleteBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DeleteBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<DeleteBrandProfileCommandInput, DeleteBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Deletes a brand profile. This operation also deletes the attributes of the profile and any associated media. The request fails if deletion protection is enabled for the profile.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, DeleteBrandProfileCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, DeleteBrandProfileCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
|
|
33
|
+
* // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
|
|
34
|
+
* const config = {}; // type is EndUserMessagingClientConfig
|
|
35
|
+
* const client = new EndUserMessagingClient(config);
|
|
36
|
+
* const input = { // DeleteBrandProfileInput
|
|
37
|
+
* brandProfileId: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new DeleteBrandProfileCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // DeleteBrandProfileOutput
|
|
42
|
+
* // brandProfileId: "STRING_VALUE", // required
|
|
43
|
+
* // brandProfileArn: "STRING_VALUE", // required
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param DeleteBrandProfileCommandInput - {@link DeleteBrandProfileCommandInput}
|
|
49
|
+
* @returns {@link DeleteBrandProfileCommandOutput}
|
|
50
|
+
* @see {@link DeleteBrandProfileCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link DeleteBrandProfileCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
55
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ConflictException} (client fault)
|
|
58
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InternalServerException} (server fault)
|
|
61
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
67
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ValidationException} (client fault)
|
|
70
|
+
* A standard error for input validation failures.
|
|
71
|
+
* This should be thrown by services when a member of the input structure
|
|
72
|
+
* falls outside of the modeled or documented constraints.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @example Delete a brand profile
|
|
79
|
+
* ```javascript
|
|
80
|
+
* //
|
|
81
|
+
* const input = {
|
|
82
|
+
* brandProfileId: "bp-abc12345678901234"
|
|
83
|
+
* };
|
|
84
|
+
* const command = new DeleteBrandProfileCommand(input);
|
|
85
|
+
* const response = await client.send(command);
|
|
86
|
+
* /* response is
|
|
87
|
+
* {
|
|
88
|
+
* brandProfileArn: "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234",
|
|
89
|
+
* brandProfileId: "bp-abc12345678901234"
|
|
90
|
+
* }
|
|
91
|
+
* *\/
|
|
92
|
+
* ```
|
|
93
|
+
*
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare class DeleteBrandProfileCommand extends DeleteBrandProfileCommand_base {
|
|
97
|
+
/** @internal type navigation helper, not in runtime. */
|
|
98
|
+
protected static __types: {
|
|
99
|
+
api: {
|
|
100
|
+
input: DeleteBrandProfileInput;
|
|
101
|
+
output: DeleteBrandProfileOutput;
|
|
102
|
+
};
|
|
103
|
+
sdk: {
|
|
104
|
+
input: DeleteBrandProfileCommandInput;
|
|
105
|
+
output: DeleteBrandProfileCommandOutput;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DeleteNotifyCodeConfigurationInput, DeleteNotifyCodeConfigurationOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DeleteNotifyCodeConfigurationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DeleteNotifyCodeConfigurationCommandInput extends DeleteNotifyCodeConfigurationInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DeleteNotifyCodeConfigurationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DeleteNotifyCodeConfigurationCommandOutput extends DeleteNotifyCodeConfigurationOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DeleteNotifyCodeConfigurationCommand_base: {
|
|
22
|
+
new (input: DeleteNotifyCodeConfigurationCommandInput): import("@smithy/core/client").CommandImpl<DeleteNotifyCodeConfigurationCommandInput, DeleteNotifyCodeConfigurationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DeleteNotifyCodeConfigurationCommandInput): import("@smithy/core/client").CommandImpl<DeleteNotifyCodeConfigurationCommandInput, DeleteNotifyCodeConfigurationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Deletes a notify code configuration. Verifications that are already in progress are not affected, because they capture the policy at the time that the passcode was sent.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, DeleteNotifyCodeConfigurationCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, DeleteNotifyCodeConfigurationCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
|
|
33
|
+
* // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
|
|
34
|
+
* const config = {}; // type is EndUserMessagingClientConfig
|
|
35
|
+
* const client = new EndUserMessagingClient(config);
|
|
36
|
+
* const input = { // DeleteNotifyCodeConfigurationInput
|
|
37
|
+
* notifyCodeConfigurationId: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new DeleteNotifyCodeConfigurationCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // {};
|
|
42
|
+
*
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
45
|
+
* @param DeleteNotifyCodeConfigurationCommandInput - {@link DeleteNotifyCodeConfigurationCommandInput}
|
|
46
|
+
* @returns {@link DeleteNotifyCodeConfigurationCommandOutput}
|
|
47
|
+
* @see {@link DeleteNotifyCodeConfigurationCommandInput} for command's `input` shape.
|
|
48
|
+
* @see {@link DeleteNotifyCodeConfigurationCommandOutput} for command's `response` shape.
|
|
49
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
52
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ConflictException} (client fault)
|
|
55
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InternalServerException} (server fault)
|
|
58
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
64
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ValidationException} (client fault)
|
|
67
|
+
* A standard error for input validation failures.
|
|
68
|
+
* This should be thrown by services when a member of the input structure
|
|
69
|
+
* falls outside of the modeled or documented constraints.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
73
|
+
*
|
|
74
|
+
*
|
|
75
|
+
* @example Delete a notify code configuration
|
|
76
|
+
* ```javascript
|
|
77
|
+
* //
|
|
78
|
+
* const input = {
|
|
79
|
+
* notifyCodeConfigurationId: "ncc-abc12345678901234"
|
|
80
|
+
* };
|
|
81
|
+
* const command = new DeleteNotifyCodeConfigurationCommand(input);
|
|
82
|
+
* const response = await client.send(command);
|
|
83
|
+
* /* response is
|
|
84
|
+
* { /* empty *\/ }
|
|
85
|
+
* *\/
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export declare class DeleteNotifyCodeConfigurationCommand extends DeleteNotifyCodeConfigurationCommand_base {
|
|
91
|
+
/** @internal type navigation helper, not in runtime. */
|
|
92
|
+
protected static __types: {
|
|
93
|
+
api: {
|
|
94
|
+
input: DeleteNotifyCodeConfigurationInput;
|
|
95
|
+
output: {};
|
|
96
|
+
};
|
|
97
|
+
sdk: {
|
|
98
|
+
input: DeleteNotifyCodeConfigurationCommandInput;
|
|
99
|
+
output: DeleteNotifyCodeConfigurationCommandOutput;
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
}
|