@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,151 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { SendNotifyCodeVerificationInput, SendNotifyCodeVerificationOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link SendNotifyCodeVerificationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface SendNotifyCodeVerificationCommandInput extends SendNotifyCodeVerificationInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link SendNotifyCodeVerificationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface SendNotifyCodeVerificationCommandOutput extends SendNotifyCodeVerificationOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const SendNotifyCodeVerificationCommand_base: {
|
|
22
|
+
new (input: SendNotifyCodeVerificationCommandInput): import("@smithy/core/client").CommandImpl<SendNotifyCodeVerificationCommandInput, SendNotifyCodeVerificationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: SendNotifyCodeVerificationCommandInput): import("@smithy/core/client").CommandImpl<SendNotifyCodeVerificationCommandInput, SendNotifyCodeVerificationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Generates a one-time passcode and delivers it to a recipient over the requested channel. The passcode policy is captured from the referenced notify code configuration at the time of the request, so later updates to the configuration do not affect verifications that are already in 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, SendNotifyCodeVerificationCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, SendNotifyCodeVerificationCommand } = 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 = { // SendNotifyCodeVerificationInput
|
|
37
|
+
* channel: "TEXT" || "VOICE" || "WHATSAPP", // required
|
|
38
|
+
* destinationIdentity: "STRING_VALUE", // required
|
|
39
|
+
* originationIdentity: "STRING_VALUE", // required
|
|
40
|
+
* notifyCodeConfiguration: "STRING_VALUE",
|
|
41
|
+
* overrideChannelParameters: { // ChannelParameters
|
|
42
|
+
* text: { // TextParameters
|
|
43
|
+
* inlineTemplateBody: "STRING_VALUE",
|
|
44
|
+
* destinationCountryParameters: { // DestinationCountryParameters
|
|
45
|
+
* "<keys>": "STRING_VALUE",
|
|
46
|
+
* },
|
|
47
|
+
* },
|
|
48
|
+
* voice: { // VoiceParameters
|
|
49
|
+
* inlineTemplateBody: "STRING_VALUE",
|
|
50
|
+
* languageCode: "STRING_VALUE",
|
|
51
|
+
* voiceId: "STRING_VALUE",
|
|
52
|
+
* voiceMessageBodyTextType: "TEXT" || "SSML",
|
|
53
|
+
* },
|
|
54
|
+
* notify: { // NotifyParameters
|
|
55
|
+
* notifyTemplateId: "STRING_VALUE",
|
|
56
|
+
* voiceId: "STRING_VALUE",
|
|
57
|
+
* },
|
|
58
|
+
* whatsApp: { // WhatsAppParameters
|
|
59
|
+
* whatsAppTemplateName: "STRING_VALUE",
|
|
60
|
+
* languageCode: "STRING_VALUE",
|
|
61
|
+
* },
|
|
62
|
+
* },
|
|
63
|
+
* overrideCodeConfigurationParameters: { // CodeConfigurationParameters
|
|
64
|
+
* codeType: "NUMERIC" || "ALPHA" || "ALPHANUMERIC",
|
|
65
|
+
* codeLength: Number("int"),
|
|
66
|
+
* validityPeriodMinutes: Number("int"),
|
|
67
|
+
* maxAttempts: Number("int"),
|
|
68
|
+
* },
|
|
69
|
+
* configurationSetName: "STRING_VALUE",
|
|
70
|
+
* context: { // ContextMap
|
|
71
|
+
* "<keys>": "STRING_VALUE",
|
|
72
|
+
* },
|
|
73
|
+
* referenceId: "STRING_VALUE",
|
|
74
|
+
* };
|
|
75
|
+
* const command = new SendNotifyCodeVerificationCommand(input);
|
|
76
|
+
* const response = await client.send(command);
|
|
77
|
+
* // { // SendNotifyCodeVerificationOutput
|
|
78
|
+
* // verificationId: "STRING_VALUE", // required
|
|
79
|
+
* // messageId: "STRING_VALUE", // required
|
|
80
|
+
* // };
|
|
81
|
+
*
|
|
82
|
+
* ```
|
|
83
|
+
*
|
|
84
|
+
* @param SendNotifyCodeVerificationCommandInput - {@link SendNotifyCodeVerificationCommandInput}
|
|
85
|
+
* @returns {@link SendNotifyCodeVerificationCommandOutput}
|
|
86
|
+
* @see {@link SendNotifyCodeVerificationCommandInput} for command's `input` shape.
|
|
87
|
+
* @see {@link SendNotifyCodeVerificationCommandOutput} for command's `response` shape.
|
|
88
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
91
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ConflictException} (client fault)
|
|
94
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link InternalServerException} (server fault)
|
|
97
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
100
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
103
|
+
* <p>The request would exceed a service quota for your account.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
106
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link ValidationException} (client fault)
|
|
109
|
+
* A standard error for input validation failures.
|
|
110
|
+
* This should be thrown by services when a member of the input structure
|
|
111
|
+
* falls outside of the modeled or documented constraints.
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
114
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
115
|
+
*
|
|
116
|
+
*
|
|
117
|
+
* @example Send a one-time passcode over SMS
|
|
118
|
+
* ```javascript
|
|
119
|
+
* //
|
|
120
|
+
* const input = {
|
|
121
|
+
* channel: "TEXT",
|
|
122
|
+
* destinationIdentity: "+14255550100",
|
|
123
|
+
* notifyCodeConfiguration: "ncc-abc12345678901234",
|
|
124
|
+
* originationIdentity: "arn:aws:sms-voice:us-east-1:123456789012:phone-number/pn-abc123",
|
|
125
|
+
* referenceId: "signup-flow-42"
|
|
126
|
+
* };
|
|
127
|
+
* const command = new SendNotifyCodeVerificationCommand(input);
|
|
128
|
+
* const response = await client.send(command);
|
|
129
|
+
* /* response is
|
|
130
|
+
* {
|
|
131
|
+
* messageId: "msg-abc12345678901234",
|
|
132
|
+
* verificationId: "ver-abc12345678901234"
|
|
133
|
+
* }
|
|
134
|
+
* *\/
|
|
135
|
+
* ```
|
|
136
|
+
*
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
export declare class SendNotifyCodeVerificationCommand extends SendNotifyCodeVerificationCommand_base {
|
|
140
|
+
/** @internal type navigation helper, not in runtime. */
|
|
141
|
+
protected static __types: {
|
|
142
|
+
api: {
|
|
143
|
+
input: SendNotifyCodeVerificationInput;
|
|
144
|
+
output: SendNotifyCodeVerificationOutput;
|
|
145
|
+
};
|
|
146
|
+
sdk: {
|
|
147
|
+
input: SendNotifyCodeVerificationCommandInput;
|
|
148
|
+
output: SendNotifyCodeVerificationCommandOutput;
|
|
149
|
+
};
|
|
150
|
+
};
|
|
151
|
+
}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { TagResourceInput, TagResourceOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link TagResourceCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface TagResourceCommandInput extends TagResourceInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link TagResourceCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const TagResourceCommand_base: {
|
|
22
|
+
new (input: TagResourceCommandInput): import("@smithy/core/client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: TagResourceCommandInput): import("@smithy/core/client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Adds or overwrites the tags on a resource.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, TagResourceCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, TagResourceCommand } = 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 = { // TagResourceInput
|
|
37
|
+
* resourceArn: "STRING_VALUE", // required
|
|
38
|
+
* tags: [ // TagList // required
|
|
39
|
+
* { // Tag
|
|
40
|
+
* key: "STRING_VALUE", // required
|
|
41
|
+
* value: "STRING_VALUE", // required
|
|
42
|
+
* },
|
|
43
|
+
* ],
|
|
44
|
+
* };
|
|
45
|
+
* const command = new TagResourceCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // {};
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param TagResourceCommandInput - {@link TagResourceCommandInput}
|
|
52
|
+
* @returns {@link TagResourceCommandOutput}
|
|
53
|
+
* @see {@link TagResourceCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
+
* <p>You do not have sufficient access to perform this action.</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 ServiceQuotaExceededException} (client fault)
|
|
67
|
+
* <p>The request would exceed a service quota for your account.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ValidationException} (client fault)
|
|
73
|
+
* A standard error for input validation failures.
|
|
74
|
+
* This should be thrown by services when a member of the input structure
|
|
75
|
+
* falls outside of the modeled or documented constraints.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
79
|
+
*
|
|
80
|
+
*
|
|
81
|
+
* @example Tag a resource
|
|
82
|
+
* ```javascript
|
|
83
|
+
* //
|
|
84
|
+
* const input = {
|
|
85
|
+
* resourceArn: "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234",
|
|
86
|
+
* tags: [
|
|
87
|
+
* {
|
|
88
|
+
* key: "Environment",
|
|
89
|
+
* value: "Production"
|
|
90
|
+
* }
|
|
91
|
+
* ]
|
|
92
|
+
* };
|
|
93
|
+
* const command = new TagResourceCommand(input);
|
|
94
|
+
* const response = await client.send(command);
|
|
95
|
+
* /* response is
|
|
96
|
+
* { /* empty *\/ }
|
|
97
|
+
* *\/
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
export declare class TagResourceCommand extends TagResourceCommand_base {
|
|
103
|
+
/** @internal type navigation helper, not in runtime. */
|
|
104
|
+
protected static __types: {
|
|
105
|
+
api: {
|
|
106
|
+
input: TagResourceInput;
|
|
107
|
+
output: {};
|
|
108
|
+
};
|
|
109
|
+
sdk: {
|
|
110
|
+
input: TagResourceCommandInput;
|
|
111
|
+
output: TagResourceCommandOutput;
|
|
112
|
+
};
|
|
113
|
+
};
|
|
114
|
+
}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UntagResourceCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UntagResourceCommandInput extends UntagResourceInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UntagResourceCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UntagResourceCommand_base: {
|
|
22
|
+
new (input: UntagResourceCommandInput): import("@smithy/core/client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: UntagResourceCommandInput): import("@smithy/core/client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Removes the specified tags from a resource.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, UntagResourceCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, UntagResourceCommand } = 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 = { // UntagResourceInput
|
|
37
|
+
* resourceArn: "STRING_VALUE", // required
|
|
38
|
+
* tagKeys: [ // TagKeyList // required
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UntagResourceCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
|
|
49
|
+
* @returns {@link UntagResourceCommandOutput}
|
|
50
|
+
* @see {@link UntagResourceCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link UntagResourceCommandOutput} 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 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 Remove tags from a resource
|
|
76
|
+
* ```javascript
|
|
77
|
+
* //
|
|
78
|
+
* const input = {
|
|
79
|
+
* resourceArn: "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234",
|
|
80
|
+
* tagKeys: [
|
|
81
|
+
* "Environment"
|
|
82
|
+
* ]
|
|
83
|
+
* };
|
|
84
|
+
* const command = new UntagResourceCommand(input);
|
|
85
|
+
* const response = await client.send(command);
|
|
86
|
+
* /* response is
|
|
87
|
+
* { /* empty *\/ }
|
|
88
|
+
* *\/
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export declare class UntagResourceCommand extends UntagResourceCommand_base {
|
|
94
|
+
/** @internal type navigation helper, not in runtime. */
|
|
95
|
+
protected static __types: {
|
|
96
|
+
api: {
|
|
97
|
+
input: UntagResourceInput;
|
|
98
|
+
output: {};
|
|
99
|
+
};
|
|
100
|
+
sdk: {
|
|
101
|
+
input: UntagResourceCommandInput;
|
|
102
|
+
output: UntagResourceCommandOutput;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
}
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UpdateBrandProfileAttributeInput, UpdateBrandProfileAttributeOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UpdateBrandProfileAttributeCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UpdateBrandProfileAttributeCommandInput extends UpdateBrandProfileAttributeInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UpdateBrandProfileAttributeCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateBrandProfileAttributeCommandOutput extends UpdateBrandProfileAttributeOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UpdateBrandProfileAttributeCommand_base: {
|
|
22
|
+
new (input: UpdateBrandProfileAttributeCommandInput): import("@smithy/core/client").CommandImpl<UpdateBrandProfileAttributeCommandInput, UpdateBrandProfileAttributeCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: UpdateBrandProfileAttributeCommandInput): import("@smithy/core/client").CommandImpl<UpdateBrandProfileAttributeCommandInput, UpdateBrandProfileAttributeCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Updates the value, description, or category of an existing brand profile attribute.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, UpdateBrandProfileAttributeCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, UpdateBrandProfileAttributeCommand } = 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 = { // UpdateBrandProfileAttributeInput
|
|
37
|
+
* brandProfileId: "STRING_VALUE", // required
|
|
38
|
+
* attributeName: "STRING_VALUE", // required
|
|
39
|
+
* attributeValue: "STRING_VALUE",
|
|
40
|
+
* attachmentBody: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
41
|
+
* description: "STRING_VALUE",
|
|
42
|
+
* category: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new UpdateBrandProfileAttributeCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // UpdateBrandProfileAttributeOutput
|
|
47
|
+
* // attributeName: "STRING_VALUE", // required
|
|
48
|
+
* // attributeType: "TEXT" || "IMAGE" || "DOCUMENT", // required
|
|
49
|
+
* // attributeValue: "STRING_VALUE",
|
|
50
|
+
* // description: "STRING_VALUE",
|
|
51
|
+
* // category: "STRING_VALUE",
|
|
52
|
+
* // mediaContentType: "STRING_VALUE",
|
|
53
|
+
* // mediaSizeBytes: Number("long"),
|
|
54
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
55
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param UpdateBrandProfileAttributeCommandInput - {@link UpdateBrandProfileAttributeCommandInput}
|
|
61
|
+
* @returns {@link UpdateBrandProfileAttributeCommandOutput}
|
|
62
|
+
* @see {@link UpdateBrandProfileAttributeCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link UpdateBrandProfileAttributeCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
67
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ConflictException} (client fault)
|
|
70
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InternalServerException} (server fault)
|
|
73
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
79
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ValidationException} (client fault)
|
|
82
|
+
* A standard error for input validation failures.
|
|
83
|
+
* This should be thrown by services when a member of the input structure
|
|
84
|
+
* falls outside of the modeled or documented constraints.
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
88
|
+
*
|
|
89
|
+
*
|
|
90
|
+
* @example Update a brand profile attribute value
|
|
91
|
+
* ```javascript
|
|
92
|
+
* //
|
|
93
|
+
* const input = {
|
|
94
|
+
* attributeName: "SupportEmail",
|
|
95
|
+
* attributeValue: "help@example.com",
|
|
96
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
97
|
+
* category: "CONTACT"
|
|
98
|
+
* };
|
|
99
|
+
* const command = new UpdateBrandProfileAttributeCommand(input);
|
|
100
|
+
* const response = await client.send(command);
|
|
101
|
+
* /* response is
|
|
102
|
+
* {
|
|
103
|
+
* attributeName: "SupportEmail",
|
|
104
|
+
* attributeType: "TEXT",
|
|
105
|
+
* attributeValue: "help@example.com",
|
|
106
|
+
* category: "CONTACT",
|
|
107
|
+
* createdAt: 1727130000,
|
|
108
|
+
* updatedAt: 1727216400
|
|
109
|
+
* }
|
|
110
|
+
* *\/
|
|
111
|
+
* ```
|
|
112
|
+
*
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
export declare class UpdateBrandProfileAttributeCommand extends UpdateBrandProfileAttributeCommand_base {
|
|
116
|
+
/** @internal type navigation helper, not in runtime. */
|
|
117
|
+
protected static __types: {
|
|
118
|
+
api: {
|
|
119
|
+
input: UpdateBrandProfileAttributeInput;
|
|
120
|
+
output: UpdateBrandProfileAttributeOutput;
|
|
121
|
+
};
|
|
122
|
+
sdk: {
|
|
123
|
+
input: UpdateBrandProfileAttributeCommandInput;
|
|
124
|
+
output: UpdateBrandProfileAttributeCommandOutput;
|
|
125
|
+
};
|
|
126
|
+
};
|
|
127
|
+
}
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UpdateBrandProfileInput, UpdateBrandProfileOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UpdateBrandProfileCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UpdateBrandProfileCommandInput extends UpdateBrandProfileInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UpdateBrandProfileCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateBrandProfileCommandOutput extends UpdateBrandProfileOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UpdateBrandProfileCommand_base: {
|
|
22
|
+
new (input: UpdateBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<UpdateBrandProfileCommandInput, UpdateBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: UpdateBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<UpdateBrandProfileCommandInput, UpdateBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Updates the name or the deletion protection setting of a brand profile. To change the information that is stored in the profile, use the brand profile attribute operations.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, UpdateBrandProfileCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, UpdateBrandProfileCommand } = 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 = { // UpdateBrandProfileInput
|
|
37
|
+
* brandProfileId: "STRING_VALUE", // required
|
|
38
|
+
* brandProfileName: "STRING_VALUE",
|
|
39
|
+
* deletionProtectionEnabled: true || false,
|
|
40
|
+
* };
|
|
41
|
+
* const command = new UpdateBrandProfileCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // UpdateBrandProfileOutput
|
|
44
|
+
* // brandProfileId: "STRING_VALUE", // required
|
|
45
|
+
* // brandProfileArn: "STRING_VALUE", // required
|
|
46
|
+
* // brandProfileName: "STRING_VALUE", // required
|
|
47
|
+
* // status: "ACTIVE" || "BLOCKED" || "PAUSED" || "CANCELLED" || "FAILED", // required
|
|
48
|
+
* // deletionProtectionEnabled: true || false, // required
|
|
49
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
50
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param UpdateBrandProfileCommandInput - {@link UpdateBrandProfileCommandInput}
|
|
56
|
+
* @returns {@link UpdateBrandProfileCommandOutput}
|
|
57
|
+
* @see {@link UpdateBrandProfileCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link UpdateBrandProfileCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ConflictException} (client fault)
|
|
65
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalServerException} (server fault)
|
|
68
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
71
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
74
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ValidationException} (client fault)
|
|
77
|
+
* A standard error for input validation failures.
|
|
78
|
+
* This should be thrown by services when a member of the input structure
|
|
79
|
+
* falls outside of the modeled or documented constraints.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
83
|
+
*
|
|
84
|
+
*
|
|
85
|
+
* @example Update a brand profile name
|
|
86
|
+
* ```javascript
|
|
87
|
+
* //
|
|
88
|
+
* const input = {
|
|
89
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
90
|
+
* brandProfileName: "AcmeCorpUpdated",
|
|
91
|
+
* deletionProtectionEnabled: false
|
|
92
|
+
* };
|
|
93
|
+
* const command = new UpdateBrandProfileCommand(input);
|
|
94
|
+
* const response = await client.send(command);
|
|
95
|
+
* /* response is
|
|
96
|
+
* {
|
|
97
|
+
* brandProfileArn: "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234",
|
|
98
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
99
|
+
* brandProfileName: "AcmeCorpUpdated",
|
|
100
|
+
* createdAt: 1727130000,
|
|
101
|
+
* deletionProtectionEnabled: false,
|
|
102
|
+
* status: "ACTIVE",
|
|
103
|
+
* updatedAt: 1727216400
|
|
104
|
+
* }
|
|
105
|
+
* *\/
|
|
106
|
+
* ```
|
|
107
|
+
*
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export declare class UpdateBrandProfileCommand extends UpdateBrandProfileCommand_base {
|
|
111
|
+
/** @internal type navigation helper, not in runtime. */
|
|
112
|
+
protected static __types: {
|
|
113
|
+
api: {
|
|
114
|
+
input: UpdateBrandProfileInput;
|
|
115
|
+
output: UpdateBrandProfileOutput;
|
|
116
|
+
};
|
|
117
|
+
sdk: {
|
|
118
|
+
input: UpdateBrandProfileCommandInput;
|
|
119
|
+
output: UpdateBrandProfileCommandOutput;
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
}
|