@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,119 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { GetBrandProfileAttributeInput, GetBrandProfileAttributeOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link GetBrandProfileAttributeCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetBrandProfileAttributeCommandInput extends GetBrandProfileAttributeInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link GetBrandProfileAttributeCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface GetBrandProfileAttributeCommandOutput extends GetBrandProfileAttributeOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const GetBrandProfileAttributeCommand_base: {
|
|
22
|
+
new (input: GetBrandProfileAttributeCommandInput): import("@smithy/core/client").CommandImpl<GetBrandProfileAttributeCommandInput, GetBrandProfileAttributeCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: GetBrandProfileAttributeCommandInput): import("@smithy/core/client").CommandImpl<GetBrandProfileAttributeCommandInput, GetBrandProfileAttributeCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves a single 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, GetBrandProfileAttributeCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, GetBrandProfileAttributeCommand } = 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 = { // GetBrandProfileAttributeInput
|
|
37
|
+
* brandProfileId: "STRING_VALUE", // required
|
|
38
|
+
* attributeName: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetBrandProfileAttributeCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetBrandProfileAttributeOutput
|
|
43
|
+
* // attributeName: "STRING_VALUE", // required
|
|
44
|
+
* // attributeType: "TEXT" || "IMAGE" || "DOCUMENT", // required
|
|
45
|
+
* // attributeValue: "STRING_VALUE",
|
|
46
|
+
* // description: "STRING_VALUE",
|
|
47
|
+
* // category: "STRING_VALUE",
|
|
48
|
+
* // mediaContentType: "STRING_VALUE",
|
|
49
|
+
* // mediaSizeBytes: Number("long"),
|
|
50
|
+
* // mediaDownloadUrl: "STRING_VALUE",
|
|
51
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
52
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param GetBrandProfileAttributeCommandInput - {@link GetBrandProfileAttributeCommandInput}
|
|
58
|
+
* @returns {@link GetBrandProfileAttributeCommandOutput}
|
|
59
|
+
* @see {@link GetBrandProfileAttributeCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link GetBrandProfileAttributeCommandOutput} 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 InternalServerException} (server fault)
|
|
67
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
73
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ValidationException} (client fault)
|
|
76
|
+
* A standard error for input validation failures.
|
|
77
|
+
* This should be thrown by services when a member of the input structure
|
|
78
|
+
* falls outside of the modeled or documented constraints.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
82
|
+
*
|
|
83
|
+
*
|
|
84
|
+
* @example Get a brand profile attribute
|
|
85
|
+
* ```javascript
|
|
86
|
+
* //
|
|
87
|
+
* const input = {
|
|
88
|
+
* attributeName: "SupportEmail",
|
|
89
|
+
* brandProfileId: "bp-abc12345678901234"
|
|
90
|
+
* };
|
|
91
|
+
* const command = new GetBrandProfileAttributeCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* /* response is
|
|
94
|
+
* {
|
|
95
|
+
* attributeName: "SupportEmail",
|
|
96
|
+
* attributeType: "TEXT",
|
|
97
|
+
* attributeValue: "support@example.com",
|
|
98
|
+
* category: "CONTACT",
|
|
99
|
+
* createdAt: 1727130000,
|
|
100
|
+
* updatedAt: 1727130000
|
|
101
|
+
* }
|
|
102
|
+
* *\/
|
|
103
|
+
* ```
|
|
104
|
+
*
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export declare class GetBrandProfileAttributeCommand extends GetBrandProfileAttributeCommand_base {
|
|
108
|
+
/** @internal type navigation helper, not in runtime. */
|
|
109
|
+
protected static __types: {
|
|
110
|
+
api: {
|
|
111
|
+
input: GetBrandProfileAttributeInput;
|
|
112
|
+
output: GetBrandProfileAttributeOutput;
|
|
113
|
+
};
|
|
114
|
+
sdk: {
|
|
115
|
+
input: GetBrandProfileAttributeCommandInput;
|
|
116
|
+
output: GetBrandProfileAttributeCommandOutput;
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { GetBrandProfileInput, GetBrandProfileOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link GetBrandProfileCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetBrandProfileCommandInput extends GetBrandProfileInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link GetBrandProfileCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface GetBrandProfileCommandOutput extends GetBrandProfileOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const GetBrandProfileCommand_base: {
|
|
22
|
+
new (input: GetBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<GetBrandProfileCommandInput, GetBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: GetBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<GetBrandProfileCommandInput, GetBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps. To retrieve the attributes of the profile, use the ListBrandProfileAttributes operation.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, GetBrandProfileCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, GetBrandProfileCommand } = 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 = { // GetBrandProfileInput
|
|
37
|
+
* brandProfileId: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new GetBrandProfileCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // GetBrandProfileOutput
|
|
42
|
+
* // brandProfileId: "STRING_VALUE", // required
|
|
43
|
+
* // brandProfileArn: "STRING_VALUE", // required
|
|
44
|
+
* // brandProfileName: "STRING_VALUE", // required
|
|
45
|
+
* // status: "ACTIVE" || "BLOCKED" || "PAUSED" || "CANCELLED" || "FAILED", // required
|
|
46
|
+
* // deletionProtectionEnabled: true || false, // required
|
|
47
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
48
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param GetBrandProfileCommandInput - {@link GetBrandProfileCommandInput}
|
|
54
|
+
* @returns {@link GetBrandProfileCommandOutput}
|
|
55
|
+
* @see {@link GetBrandProfileCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link GetBrandProfileCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerException} (server fault)
|
|
63
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
69
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ValidationException} (client fault)
|
|
72
|
+
* A standard error for input validation failures.
|
|
73
|
+
* This should be thrown by services when a member of the input structure
|
|
74
|
+
* falls outside of the modeled or documented constraints.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
78
|
+
*
|
|
79
|
+
*
|
|
80
|
+
* @example Get a brand profile
|
|
81
|
+
* ```javascript
|
|
82
|
+
* //
|
|
83
|
+
* const input = {
|
|
84
|
+
* brandProfileId: "bp-abc12345678901234"
|
|
85
|
+
* };
|
|
86
|
+
* const command = new GetBrandProfileCommand(input);
|
|
87
|
+
* const response = await client.send(command);
|
|
88
|
+
* /* response is
|
|
89
|
+
* {
|
|
90
|
+
* brandProfileArn: "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234",
|
|
91
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
92
|
+
* brandProfileName: "AcmeCorp",
|
|
93
|
+
* createdAt: 1727130000,
|
|
94
|
+
* deletionProtectionEnabled: true,
|
|
95
|
+
* status: "ACTIVE",
|
|
96
|
+
* updatedAt: 1727130000
|
|
97
|
+
* }
|
|
98
|
+
* *\/
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
export declare class GetBrandProfileCommand extends GetBrandProfileCommand_base {
|
|
104
|
+
/** @internal type navigation helper, not in runtime. */
|
|
105
|
+
protected static __types: {
|
|
106
|
+
api: {
|
|
107
|
+
input: GetBrandProfileInput;
|
|
108
|
+
output: GetBrandProfileOutput;
|
|
109
|
+
};
|
|
110
|
+
sdk: {
|
|
111
|
+
input: GetBrandProfileCommandInput;
|
|
112
|
+
output: GetBrandProfileCommandOutput;
|
|
113
|
+
};
|
|
114
|
+
};
|
|
115
|
+
}
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { GetJobInput, Job } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link GetJobCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetJobCommandInput extends GetJobInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link GetJobCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface GetJobCommandOutput extends Job, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const GetJobCommand_base: {
|
|
22
|
+
new (input: GetJobCommandInput): import("@smithy/core/client").CommandImpl<GetJobCommandInput, GetJobCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: GetJobCommandInput): import("@smithy/core/client").CommandImpl<GetJobCommandInput, GetJobCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, GetJobCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, GetJobCommand } = 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 = { // GetJobInput
|
|
37
|
+
* jobId: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new GetJobCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // Job
|
|
42
|
+
* // jobId: "STRING_VALUE", // required
|
|
43
|
+
* // status: "SUCCESS" || "PROCESSING" || "FAILED", // required
|
|
44
|
+
* // operationType: "STRING_VALUE", // required
|
|
45
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
46
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
47
|
+
* // brandProfileId: "STRING_VALUE",
|
|
48
|
+
* // errorCode: "STRING_VALUE",
|
|
49
|
+
* // errorMessage: "STRING_VALUE",
|
|
50
|
+
* // resources: [ // JobResourceList
|
|
51
|
+
* // { // JobResource
|
|
52
|
+
* // resourceType: "REGISTRATION" || "BRAND_PROFILE", // required
|
|
53
|
+
* // resourceId: "STRING_VALUE", // required
|
|
54
|
+
* // resourceArn: "STRING_VALUE", // required
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
61
|
+
* @param GetJobCommandInput - {@link GetJobCommandInput}
|
|
62
|
+
* @returns {@link GetJobCommandOutput}
|
|
63
|
+
* @see {@link GetJobCommandInput} for command's `input` shape.
|
|
64
|
+
* @see {@link GetJobCommandOutput} for command's `response` shape.
|
|
65
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
68
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServerException} (server fault)
|
|
71
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ValidationException} (client fault)
|
|
80
|
+
* A standard error for input validation failures.
|
|
81
|
+
* This should be thrown by services when a member of the input structure
|
|
82
|
+
* falls outside of the modeled or documented constraints.
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* @example Get an async job
|
|
89
|
+
* ```javascript
|
|
90
|
+
* //
|
|
91
|
+
* const input = {
|
|
92
|
+
* jobId: "job-abc12345678901234"
|
|
93
|
+
* };
|
|
94
|
+
* const command = new GetJobCommand(input);
|
|
95
|
+
* const response = await client.send(command);
|
|
96
|
+
* /* response is
|
|
97
|
+
* {
|
|
98
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
99
|
+
* createdAt: 1727130000,
|
|
100
|
+
* jobId: "job-abc12345678901234",
|
|
101
|
+
* operationType: "CreateRegistrationsFromBrandProfile",
|
|
102
|
+
* resources: [
|
|
103
|
+
* {
|
|
104
|
+
* resourceArn: "arn:aws:end-user-messaging:us-east-1:123456789012:registration/reg-abc12345678901234",
|
|
105
|
+
* resourceId: "reg-abc12345678901234",
|
|
106
|
+
* resourceType: "REGISTRATION"
|
|
107
|
+
* }
|
|
108
|
+
* ],
|
|
109
|
+
* status: "SUCCESS",
|
|
110
|
+
* updatedAt: 1727130060
|
|
111
|
+
* }
|
|
112
|
+
* *\/
|
|
113
|
+
* ```
|
|
114
|
+
*
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
export declare class GetJobCommand extends GetJobCommand_base {
|
|
118
|
+
/** @internal type navigation helper, not in runtime. */
|
|
119
|
+
protected static __types: {
|
|
120
|
+
api: {
|
|
121
|
+
input: GetJobInput;
|
|
122
|
+
output: Job;
|
|
123
|
+
};
|
|
124
|
+
sdk: {
|
|
125
|
+
input: GetJobCommandInput;
|
|
126
|
+
output: GetJobCommandOutput;
|
|
127
|
+
};
|
|
128
|
+
};
|
|
129
|
+
}
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { GetNotifyCodeConfigurationInput, GetNotifyCodeConfigurationOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link GetNotifyCodeConfigurationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetNotifyCodeConfigurationCommandInput extends GetNotifyCodeConfigurationInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link GetNotifyCodeConfigurationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface GetNotifyCodeConfigurationCommandOutput extends GetNotifyCodeConfigurationOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const GetNotifyCodeConfigurationCommand_base: {
|
|
22
|
+
new (input: GetNotifyCodeConfigurationCommandInput): import("@smithy/core/client").CommandImpl<GetNotifyCodeConfigurationCommandInput, GetNotifyCodeConfigurationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: GetNotifyCodeConfigurationCommandInput): import("@smithy/core/client").CommandImpl<GetNotifyCodeConfigurationCommandInput, GetNotifyCodeConfigurationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves a notify code configuration.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, GetNotifyCodeConfigurationCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, GetNotifyCodeConfigurationCommand } = 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 = { // GetNotifyCodeConfigurationInput
|
|
37
|
+
* notifyCodeConfigurationId: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new GetNotifyCodeConfigurationCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // GetNotifyCodeConfigurationOutput
|
|
42
|
+
* // notifyCodeConfiguration: { // NotifyCodeConfiguration
|
|
43
|
+
* // notifyCodeConfigurationId: "STRING_VALUE", // required
|
|
44
|
+
* // notifyCodeConfigurationArn: "STRING_VALUE", // required
|
|
45
|
+
* // notifyCodeConfigurationName: "STRING_VALUE", // required
|
|
46
|
+
* // codeConfigurationParameters: { // CodeConfigurationParameters
|
|
47
|
+
* // codeType: "NUMERIC" || "ALPHA" || "ALPHANUMERIC",
|
|
48
|
+
* // codeLength: Number("int"),
|
|
49
|
+
* // validityPeriodMinutes: Number("int"),
|
|
50
|
+
* // maxAttempts: Number("int"),
|
|
51
|
+
* // },
|
|
52
|
+
* // channelParameters: { // ChannelParameters
|
|
53
|
+
* // text: { // TextParameters
|
|
54
|
+
* // inlineTemplateBody: "STRING_VALUE",
|
|
55
|
+
* // destinationCountryParameters: { // DestinationCountryParameters
|
|
56
|
+
* // "<keys>": "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // },
|
|
59
|
+
* // voice: { // VoiceParameters
|
|
60
|
+
* // inlineTemplateBody: "STRING_VALUE",
|
|
61
|
+
* // languageCode: "STRING_VALUE",
|
|
62
|
+
* // voiceId: "STRING_VALUE",
|
|
63
|
+
* // voiceMessageBodyTextType: "TEXT" || "SSML",
|
|
64
|
+
* // },
|
|
65
|
+
* // notify: { // NotifyParameters
|
|
66
|
+
* // notifyTemplateId: "STRING_VALUE",
|
|
67
|
+
* // voiceId: "STRING_VALUE",
|
|
68
|
+
* // },
|
|
69
|
+
* // whatsApp: { // WhatsAppParameters
|
|
70
|
+
* // whatsAppTemplateName: "STRING_VALUE",
|
|
71
|
+
* // languageCode: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // },
|
|
74
|
+
* // deletionProtectionEnabled: true || false, // required
|
|
75
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
76
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
77
|
+
* // },
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
80
|
+
* ```
|
|
81
|
+
*
|
|
82
|
+
* @param GetNotifyCodeConfigurationCommandInput - {@link GetNotifyCodeConfigurationCommandInput}
|
|
83
|
+
* @returns {@link GetNotifyCodeConfigurationCommandOutput}
|
|
84
|
+
* @see {@link GetNotifyCodeConfigurationCommandInput} for command's `input` shape.
|
|
85
|
+
* @see {@link GetNotifyCodeConfigurationCommandOutput} for command's `response` shape.
|
|
86
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
89
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link InternalServerException} (server fault)
|
|
92
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
95
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
98
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link ValidationException} (client fault)
|
|
101
|
+
* A standard error for input validation failures.
|
|
102
|
+
* This should be thrown by services when a member of the input structure
|
|
103
|
+
* falls outside of the modeled or documented constraints.
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
106
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
107
|
+
*
|
|
108
|
+
*
|
|
109
|
+
* @example Get a notify code configuration
|
|
110
|
+
* ```javascript
|
|
111
|
+
* //
|
|
112
|
+
* const input = {
|
|
113
|
+
* notifyCodeConfigurationId: "ncc-abc12345678901234"
|
|
114
|
+
* };
|
|
115
|
+
* const command = new GetNotifyCodeConfigurationCommand(input);
|
|
116
|
+
* const response = await client.send(command);
|
|
117
|
+
* /* response is
|
|
118
|
+
* {
|
|
119
|
+
* notifyCodeConfiguration: {
|
|
120
|
+
* channelParameters: {
|
|
121
|
+
* text: {
|
|
122
|
+
* inlineTemplateBody: "Your verification code is {{code}}."
|
|
123
|
+
* }
|
|
124
|
+
* },
|
|
125
|
+
* codeConfigurationParameters: {
|
|
126
|
+
* codeLength: 6,
|
|
127
|
+
* codeType: "NUMERIC",
|
|
128
|
+
* maxAttempts: 3,
|
|
129
|
+
* validityPeriodMinutes: 10
|
|
130
|
+
* },
|
|
131
|
+
* createdAt: 1727130000,
|
|
132
|
+
* deletionProtectionEnabled: false,
|
|
133
|
+
* notifyCodeConfigurationArn: "arn:aws:end-user-messaging:us-east-1:123456789012:notify-code-configuration/ncc-abc12345678901234",
|
|
134
|
+
* notifyCodeConfigurationId: "ncc-abc12345678901234",
|
|
135
|
+
* notifyCodeConfigurationName: "SignupOtp",
|
|
136
|
+
* updatedAt: 1727130000
|
|
137
|
+
* }
|
|
138
|
+
* }
|
|
139
|
+
* *\/
|
|
140
|
+
* ```
|
|
141
|
+
*
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
export declare class GetNotifyCodeConfigurationCommand extends GetNotifyCodeConfigurationCommand_base {
|
|
145
|
+
/** @internal type navigation helper, not in runtime. */
|
|
146
|
+
protected static __types: {
|
|
147
|
+
api: {
|
|
148
|
+
input: GetNotifyCodeConfigurationInput;
|
|
149
|
+
output: GetNotifyCodeConfigurationOutput;
|
|
150
|
+
};
|
|
151
|
+
sdk: {
|
|
152
|
+
input: GetNotifyCodeConfigurationCommandInput;
|
|
153
|
+
output: GetNotifyCodeConfigurationCommandOutput;
|
|
154
|
+
};
|
|
155
|
+
};
|
|
156
|
+
}
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListBrandProfileAttributesInput, ListBrandProfileAttributesOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListBrandProfileAttributesCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListBrandProfileAttributesCommandInput extends ListBrandProfileAttributesInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListBrandProfileAttributesCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListBrandProfileAttributesCommandOutput extends ListBrandProfileAttributesOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListBrandProfileAttributesCommand_base: {
|
|
22
|
+
new (input: ListBrandProfileAttributesCommandInput): import("@smithy/core/client").CommandImpl<ListBrandProfileAttributesCommandInput, ListBrandProfileAttributesCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: ListBrandProfileAttributesCommandInput): import("@smithy/core/client").CommandImpl<ListBrandProfileAttributesCommandInput, ListBrandProfileAttributesCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves a paginated list of the attributes for a brand 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, ListBrandProfileAttributesCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, ListBrandProfileAttributesCommand } = 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 = { // ListBrandProfileAttributesInput
|
|
37
|
+
* brandProfileId: "STRING_VALUE", // required
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListBrandProfileAttributesCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListBrandProfileAttributesOutput
|
|
44
|
+
* // brandProfileAttributes: [ // BrandProfileAttributeSummaryList // required
|
|
45
|
+
* // { // BrandProfileAttributeSummary
|
|
46
|
+
* // attributeName: "STRING_VALUE", // required
|
|
47
|
+
* // attributeType: "TEXT" || "IMAGE" || "DOCUMENT", // required
|
|
48
|
+
* // description: "STRING_VALUE",
|
|
49
|
+
* // category: "STRING_VALUE",
|
|
50
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
51
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // nextToken: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param ListBrandProfileAttributesCommandInput - {@link ListBrandProfileAttributesCommandInput}
|
|
60
|
+
* @returns {@link ListBrandProfileAttributesCommandOutput}
|
|
61
|
+
* @see {@link ListBrandProfileAttributesCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link ListBrandProfileAttributesCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerException} (server fault)
|
|
69
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ValidationException} (client fault)
|
|
78
|
+
* A standard error for input validation failures.
|
|
79
|
+
* This should be thrown by services when a member of the input structure
|
|
80
|
+
* falls outside of the modeled or documented constraints.
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @example List brand profile attributes
|
|
87
|
+
* ```javascript
|
|
88
|
+
* //
|
|
89
|
+
* const input = {
|
|
90
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
91
|
+
* maxResults: 10
|
|
92
|
+
* };
|
|
93
|
+
* const command = new ListBrandProfileAttributesCommand(input);
|
|
94
|
+
* const response = await client.send(command);
|
|
95
|
+
* /* response is
|
|
96
|
+
* {
|
|
97
|
+
* brandProfileAttributes: [
|
|
98
|
+
* {
|
|
99
|
+
* attributeName: "SupportEmail",
|
|
100
|
+
* attributeType: "TEXT",
|
|
101
|
+
* category: "CONTACT",
|
|
102
|
+
* createdAt: 1727130000,
|
|
103
|
+
* updatedAt: 1727130000
|
|
104
|
+
* }
|
|
105
|
+
* ]
|
|
106
|
+
* }
|
|
107
|
+
* *\/
|
|
108
|
+
* ```
|
|
109
|
+
*
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
export declare class ListBrandProfileAttributesCommand extends ListBrandProfileAttributesCommand_base {
|
|
113
|
+
/** @internal type navigation helper, not in runtime. */
|
|
114
|
+
protected static __types: {
|
|
115
|
+
api: {
|
|
116
|
+
input: ListBrandProfileAttributesInput;
|
|
117
|
+
output: ListBrandProfileAttributesOutput;
|
|
118
|
+
};
|
|
119
|
+
sdk: {
|
|
120
|
+
input: ListBrandProfileAttributesCommandInput;
|
|
121
|
+
output: ListBrandProfileAttributesCommandOutput;
|
|
122
|
+
};
|
|
123
|
+
};
|
|
124
|
+
}
|