@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,122 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListBrandProfilesInput, ListBrandProfilesOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListBrandProfilesCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListBrandProfilesCommandInput extends ListBrandProfilesInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListBrandProfilesCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListBrandProfilesCommandOutput extends ListBrandProfilesOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListBrandProfilesCommand_base: {
|
|
22
|
+
new (input: ListBrandProfilesCommandInput): import("@smithy/core/client").CommandImpl<ListBrandProfilesCommandInput, ListBrandProfilesCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (...[input]: [] | [ListBrandProfilesCommandInput]): import("@smithy/core/client").CommandImpl<ListBrandProfilesCommandInput, ListBrandProfilesCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, ListBrandProfilesCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, ListBrandProfilesCommand } = 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 = { // ListBrandProfilesInput
|
|
37
|
+
* nextToken: "STRING_VALUE",
|
|
38
|
+
* maxResults: Number("int"),
|
|
39
|
+
* };
|
|
40
|
+
* const command = new ListBrandProfilesCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ListBrandProfilesOutput
|
|
43
|
+
* // brandProfiles: [ // BrandProfileInfoList // required
|
|
44
|
+
* // { // BrandProfileInfo
|
|
45
|
+
* // brandProfileId: "STRING_VALUE", // required
|
|
46
|
+
* // brandProfileArn: "STRING_VALUE", // required
|
|
47
|
+
* // brandProfileName: "STRING_VALUE", // required
|
|
48
|
+
* // status: "ACTIVE" || "BLOCKED" || "PAUSED" || "CANCELLED" || "FAILED", // required
|
|
49
|
+
* // deletionProtectionEnabled: true || false, // required
|
|
50
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
51
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // nextToken: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param ListBrandProfilesCommandInput - {@link ListBrandProfilesCommandInput}
|
|
60
|
+
* @returns {@link ListBrandProfilesCommandOutput}
|
|
61
|
+
* @see {@link ListBrandProfilesCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link ListBrandProfilesCommandOutput} 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 ThrottlingException} (client fault)
|
|
72
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ValidationException} (client fault)
|
|
75
|
+
* A standard error for input validation failures.
|
|
76
|
+
* This should be thrown by services when a member of the input structure
|
|
77
|
+
* falls outside of the modeled or documented constraints.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
81
|
+
*
|
|
82
|
+
*
|
|
83
|
+
* @example List brand profiles
|
|
84
|
+
* ```javascript
|
|
85
|
+
* //
|
|
86
|
+
* const input = {
|
|
87
|
+
* maxResults: 10
|
|
88
|
+
* };
|
|
89
|
+
* const command = new ListBrandProfilesCommand(input);
|
|
90
|
+
* const response = await client.send(command);
|
|
91
|
+
* /* response is
|
|
92
|
+
* {
|
|
93
|
+
* brandProfiles: [
|
|
94
|
+
* {
|
|
95
|
+
* brandProfileArn: "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234",
|
|
96
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
97
|
+
* brandProfileName: "AcmeCorp",
|
|
98
|
+
* createdAt: 1727130000,
|
|
99
|
+
* deletionProtectionEnabled: true,
|
|
100
|
+
* status: "ACTIVE",
|
|
101
|
+
* updatedAt: 1727130000
|
|
102
|
+
* }
|
|
103
|
+
* ]
|
|
104
|
+
* }
|
|
105
|
+
* *\/
|
|
106
|
+
* ```
|
|
107
|
+
*
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export declare class ListBrandProfilesCommand extends ListBrandProfilesCommand_base {
|
|
111
|
+
/** @internal type navigation helper, not in runtime. */
|
|
112
|
+
protected static __types: {
|
|
113
|
+
api: {
|
|
114
|
+
input: ListBrandProfilesInput;
|
|
115
|
+
output: ListBrandProfilesOutput;
|
|
116
|
+
};
|
|
117
|
+
sdk: {
|
|
118
|
+
input: ListBrandProfilesCommandInput;
|
|
119
|
+
output: ListBrandProfilesCommandOutput;
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
}
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListJobsInput, ListJobsOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListJobsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListJobsCommandInput extends ListJobsInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListJobsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListJobsCommandOutput extends ListJobsOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListJobsCommand_base: {
|
|
22
|
+
new (input: ListJobsCommandInput): import("@smithy/core/client").CommandImpl<ListJobsCommandInput, ListJobsCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (...[input]: [] | [ListJobsCommandInput]): import("@smithy/core/client").CommandImpl<ListJobsCommandInput, ListJobsCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, ListJobsCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, ListJobsCommand } = 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 = { // ListJobsInput
|
|
37
|
+
* maxResults: Number("int"),
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* status: "SUCCESS" || "PROCESSING" || "FAILED",
|
|
40
|
+
* brandProfileId: "STRING_VALUE",
|
|
41
|
+
* operationType: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListJobsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListJobsOutput
|
|
46
|
+
* // jobs: [ // JobSummaryList // required
|
|
47
|
+
* // { // JobSummary
|
|
48
|
+
* // jobId: "STRING_VALUE", // required
|
|
49
|
+
* // status: "SUCCESS" || "PROCESSING" || "FAILED", // required
|
|
50
|
+
* // operationType: "STRING_VALUE", // required
|
|
51
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
52
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // brandProfileId: "STRING_VALUE",
|
|
54
|
+
* // errorCode: "STRING_VALUE",
|
|
55
|
+
* // errorMessage: "STRING_VALUE",
|
|
56
|
+
* // resources: [ // JobResourceList
|
|
57
|
+
* // { // JobResource
|
|
58
|
+
* // resourceType: "REGISTRATION" || "BRAND_PROFILE", // required
|
|
59
|
+
* // resourceId: "STRING_VALUE", // required
|
|
60
|
+
* // resourceArn: "STRING_VALUE", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // nextToken: "STRING_VALUE",
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @param ListJobsCommandInput - {@link ListJobsCommandInput}
|
|
71
|
+
* @returns {@link ListJobsCommandOutput}
|
|
72
|
+
* @see {@link ListJobsCommandInput} for command's `input` shape.
|
|
73
|
+
* @see {@link ListJobsCommandOutput} for command's `response` shape.
|
|
74
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
77
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InternalServerException} (server fault)
|
|
80
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
83
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ValidationException} (client fault)
|
|
86
|
+
* A standard error for input validation failures.
|
|
87
|
+
* This should be thrown by services when a member of the input structure
|
|
88
|
+
* falls outside of the modeled or documented constraints.
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
92
|
+
*
|
|
93
|
+
*
|
|
94
|
+
* @example List async jobs
|
|
95
|
+
* ```javascript
|
|
96
|
+
* //
|
|
97
|
+
* const input = {
|
|
98
|
+
* maxResults: 10,
|
|
99
|
+
* status: "SUCCESS"
|
|
100
|
+
* };
|
|
101
|
+
* const command = new ListJobsCommand(input);
|
|
102
|
+
* const response = await client.send(command);
|
|
103
|
+
* /* response is
|
|
104
|
+
* {
|
|
105
|
+
* jobs: [
|
|
106
|
+
* {
|
|
107
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
108
|
+
* createdAt: 1727130000,
|
|
109
|
+
* jobId: "job-abc12345678901234",
|
|
110
|
+
* operationType: "CreateRegistrationsFromBrandProfile",
|
|
111
|
+
* status: "SUCCESS",
|
|
112
|
+
* updatedAt: 1727130060
|
|
113
|
+
* }
|
|
114
|
+
* ]
|
|
115
|
+
* }
|
|
116
|
+
* *\/
|
|
117
|
+
* ```
|
|
118
|
+
*
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
export declare class ListJobsCommand extends ListJobsCommand_base {
|
|
122
|
+
/** @internal type navigation helper, not in runtime. */
|
|
123
|
+
protected static __types: {
|
|
124
|
+
api: {
|
|
125
|
+
input: ListJobsInput;
|
|
126
|
+
output: ListJobsOutput;
|
|
127
|
+
};
|
|
128
|
+
sdk: {
|
|
129
|
+
input: ListJobsCommandInput;
|
|
130
|
+
output: ListJobsCommandOutput;
|
|
131
|
+
};
|
|
132
|
+
};
|
|
133
|
+
}
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListNotifyCodeConfigurationsInput, ListNotifyCodeConfigurationsOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListNotifyCodeConfigurationsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListNotifyCodeConfigurationsCommandInput extends ListNotifyCodeConfigurationsInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListNotifyCodeConfigurationsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListNotifyCodeConfigurationsCommandOutput extends ListNotifyCodeConfigurationsOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListNotifyCodeConfigurationsCommand_base: {
|
|
22
|
+
new (input: ListNotifyCodeConfigurationsCommandInput): import("@smithy/core/client").CommandImpl<ListNotifyCodeConfigurationsCommandInput, ListNotifyCodeConfigurationsCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (...[input]: [] | [ListNotifyCodeConfigurationsCommandInput]): import("@smithy/core/client").CommandImpl<ListNotifyCodeConfigurationsCommandInput, ListNotifyCodeConfigurationsCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves a paginated list of the notify code configurations in your account.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, ListNotifyCodeConfigurationsCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, ListNotifyCodeConfigurationsCommand } = 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 = { // ListNotifyCodeConfigurationsInput
|
|
37
|
+
* maxResults: Number("int"),
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* };
|
|
40
|
+
* const command = new ListNotifyCodeConfigurationsCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ListNotifyCodeConfigurationsOutput
|
|
43
|
+
* // notifyCodeConfigurations: [ // NotifyCodeConfigurationList // required
|
|
44
|
+
* // { // NotifyCodeConfiguration
|
|
45
|
+
* // notifyCodeConfigurationId: "STRING_VALUE", // required
|
|
46
|
+
* // notifyCodeConfigurationArn: "STRING_VALUE", // required
|
|
47
|
+
* // notifyCodeConfigurationName: "STRING_VALUE", // required
|
|
48
|
+
* // codeConfigurationParameters: { // CodeConfigurationParameters
|
|
49
|
+
* // codeType: "NUMERIC" || "ALPHA" || "ALPHANUMERIC",
|
|
50
|
+
* // codeLength: Number("int"),
|
|
51
|
+
* // validityPeriodMinutes: Number("int"),
|
|
52
|
+
* // maxAttempts: Number("int"),
|
|
53
|
+
* // },
|
|
54
|
+
* // channelParameters: { // ChannelParameters
|
|
55
|
+
* // text: { // TextParameters
|
|
56
|
+
* // inlineTemplateBody: "STRING_VALUE",
|
|
57
|
+
* // destinationCountryParameters: { // DestinationCountryParameters
|
|
58
|
+
* // "<keys>": "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // },
|
|
61
|
+
* // voice: { // VoiceParameters
|
|
62
|
+
* // inlineTemplateBody: "STRING_VALUE",
|
|
63
|
+
* // languageCode: "STRING_VALUE",
|
|
64
|
+
* // voiceId: "STRING_VALUE",
|
|
65
|
+
* // voiceMessageBodyTextType: "TEXT" || "SSML",
|
|
66
|
+
* // },
|
|
67
|
+
* // notify: { // NotifyParameters
|
|
68
|
+
* // notifyTemplateId: "STRING_VALUE",
|
|
69
|
+
* // voiceId: "STRING_VALUE",
|
|
70
|
+
* // },
|
|
71
|
+
* // whatsApp: { // WhatsAppParameters
|
|
72
|
+
* // whatsAppTemplateName: "STRING_VALUE",
|
|
73
|
+
* // languageCode: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // },
|
|
76
|
+
* // deletionProtectionEnabled: true || false, // required
|
|
77
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
78
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
79
|
+
* // },
|
|
80
|
+
* // ],
|
|
81
|
+
* // nextToken: "STRING_VALUE",
|
|
82
|
+
* // };
|
|
83
|
+
*
|
|
84
|
+
* ```
|
|
85
|
+
*
|
|
86
|
+
* @param ListNotifyCodeConfigurationsCommandInput - {@link ListNotifyCodeConfigurationsCommandInput}
|
|
87
|
+
* @returns {@link ListNotifyCodeConfigurationsCommandOutput}
|
|
88
|
+
* @see {@link ListNotifyCodeConfigurationsCommandInput} for command's `input` shape.
|
|
89
|
+
* @see {@link ListNotifyCodeConfigurationsCommandOutput} for command's `response` shape.
|
|
90
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
93
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link InternalServerException} (server fault)
|
|
96
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
99
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link ValidationException} (client fault)
|
|
102
|
+
* A standard error for input validation failures.
|
|
103
|
+
* This should be thrown by services when a member of the input structure
|
|
104
|
+
* falls outside of the modeled or documented constraints.
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
107
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
108
|
+
*
|
|
109
|
+
*
|
|
110
|
+
* @example List notify code configurations
|
|
111
|
+
* ```javascript
|
|
112
|
+
* //
|
|
113
|
+
* const input = {
|
|
114
|
+
* maxResults: 10
|
|
115
|
+
* };
|
|
116
|
+
* const command = new ListNotifyCodeConfigurationsCommand(input);
|
|
117
|
+
* const response = await client.send(command);
|
|
118
|
+
* /* response is
|
|
119
|
+
* {
|
|
120
|
+
* notifyCodeConfigurations: [
|
|
121
|
+
* {
|
|
122
|
+
* channelParameters: {
|
|
123
|
+
* text: {
|
|
124
|
+
* inlineTemplateBody: "Your verification code is {{code}}."
|
|
125
|
+
* }
|
|
126
|
+
* },
|
|
127
|
+
* codeConfigurationParameters: {
|
|
128
|
+
* codeLength: 6,
|
|
129
|
+
* codeType: "NUMERIC",
|
|
130
|
+
* maxAttempts: 3,
|
|
131
|
+
* validityPeriodMinutes: 10
|
|
132
|
+
* },
|
|
133
|
+
* createdAt: 1727130000,
|
|
134
|
+
* deletionProtectionEnabled: false,
|
|
135
|
+
* notifyCodeConfigurationArn: "arn:aws:end-user-messaging:us-east-1:123456789012:notify-code-configuration/ncc-abc12345678901234",
|
|
136
|
+
* notifyCodeConfigurationId: "ncc-abc12345678901234",
|
|
137
|
+
* notifyCodeConfigurationName: "SignupOtp",
|
|
138
|
+
* updatedAt: 1727130000
|
|
139
|
+
* }
|
|
140
|
+
* ]
|
|
141
|
+
* }
|
|
142
|
+
* *\/
|
|
143
|
+
* ```
|
|
144
|
+
*
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
export declare class ListNotifyCodeConfigurationsCommand extends ListNotifyCodeConfigurationsCommand_base {
|
|
148
|
+
/** @internal type navigation helper, not in runtime. */
|
|
149
|
+
protected static __types: {
|
|
150
|
+
api: {
|
|
151
|
+
input: ListNotifyCodeConfigurationsInput;
|
|
152
|
+
output: ListNotifyCodeConfigurationsOutput;
|
|
153
|
+
};
|
|
154
|
+
sdk: {
|
|
155
|
+
input: ListNotifyCodeConfigurationsCommandInput;
|
|
156
|
+
output: ListNotifyCodeConfigurationsCommandOutput;
|
|
157
|
+
};
|
|
158
|
+
};
|
|
159
|
+
}
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListRegistrationsFromBrandProfileInput, ListRegistrationsFromBrandProfileOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListRegistrationsFromBrandProfileCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListRegistrationsFromBrandProfileCommandInput extends ListRegistrationsFromBrandProfileInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListRegistrationsFromBrandProfileCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListRegistrationsFromBrandProfileCommandOutput extends ListRegistrationsFromBrandProfileOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListRegistrationsFromBrandProfileCommand_base: {
|
|
22
|
+
new (input: ListRegistrationsFromBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<ListRegistrationsFromBrandProfileCommandInput, ListRegistrationsFromBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: ListRegistrationsFromBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<ListRegistrationsFromBrandProfileCommandInput, ListRegistrationsFromBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization 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, ListRegistrationsFromBrandProfileCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, ListRegistrationsFromBrandProfileCommand } = 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 = { // ListRegistrationsFromBrandProfileInput
|
|
37
|
+
* brandProfileId: "STRING_VALUE", // required
|
|
38
|
+
* maxResults: Number("int"),
|
|
39
|
+
* nextToken: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListRegistrationsFromBrandProfileCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListRegistrationsFromBrandProfileOutput
|
|
44
|
+
* // registrationAssociations: [ // RegistrationAssociationSummaryList // required
|
|
45
|
+
* // { // RegistrationAssociationSummary
|
|
46
|
+
* // registrationId: "STRING_VALUE", // required
|
|
47
|
+
* // registrationType: "STRING_VALUE", // required
|
|
48
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // smartMatchUsed: true || false, // required
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // nextToken: "STRING_VALUE",
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param ListRegistrationsFromBrandProfileCommandInput - {@link ListRegistrationsFromBrandProfileCommandInput}
|
|
58
|
+
* @returns {@link ListRegistrationsFromBrandProfileCommandOutput}
|
|
59
|
+
* @see {@link ListRegistrationsFromBrandProfileCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link ListRegistrationsFromBrandProfileCommandOutput} 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 List registrations created from a brand profile
|
|
85
|
+
* ```javascript
|
|
86
|
+
* //
|
|
87
|
+
* const input = {
|
|
88
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
89
|
+
* maxResults: 10
|
|
90
|
+
* };
|
|
91
|
+
* const command = new ListRegistrationsFromBrandProfileCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* /* response is
|
|
94
|
+
* {
|
|
95
|
+
* registrationAssociations: [
|
|
96
|
+
* {
|
|
97
|
+
* createdAt: 1727130000,
|
|
98
|
+
* registrationId: "reg-abc12345678901234",
|
|
99
|
+
* registrationType: "US_TOLL_FREE_REGISTRATION",
|
|
100
|
+
* smartMatchUsed: true
|
|
101
|
+
* }
|
|
102
|
+
* ]
|
|
103
|
+
* }
|
|
104
|
+
* *\/
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export declare class ListRegistrationsFromBrandProfileCommand extends ListRegistrationsFromBrandProfileCommand_base {
|
|
110
|
+
/** @internal type navigation helper, not in runtime. */
|
|
111
|
+
protected static __types: {
|
|
112
|
+
api: {
|
|
113
|
+
input: ListRegistrationsFromBrandProfileInput;
|
|
114
|
+
output: ListRegistrationsFromBrandProfileOutput;
|
|
115
|
+
};
|
|
116
|
+
sdk: {
|
|
117
|
+
input: ListRegistrationsFromBrandProfileCommandInput;
|
|
118
|
+
output: ListRegistrationsFromBrandProfileCommandOutput;
|
|
119
|
+
};
|
|
120
|
+
};
|
|
121
|
+
}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListTagsForResourceInput, ListTagsForResourceOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListTagsForResourceCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListTagsForResourceCommandInput extends ListTagsForResourceInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListTagsForResourceCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListTagsForResourceCommand_base: {
|
|
22
|
+
new (input: ListTagsForResourceCommandInput): import("@smithy/core/client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: ListTagsForResourceCommandInput): import("@smithy/core/client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves the tags that are associated with 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, ListTagsForResourceCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, ListTagsForResourceCommand } = 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 = { // ListTagsForResourceInput
|
|
37
|
+
* resourceArn: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // ListTagsForResourceOutput
|
|
42
|
+
* // tags: [ // TagList
|
|
43
|
+
* // { // Tag
|
|
44
|
+
* // key: "STRING_VALUE", // required
|
|
45
|
+
* // value: "STRING_VALUE", // required
|
|
46
|
+
* // },
|
|
47
|
+
* // ],
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
|
|
53
|
+
* @returns {@link ListTagsForResourceCommandOutput}
|
|
54
|
+
* @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
+
* <p>You do not have sufficient access to perform this action.</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 List tags on a resource
|
|
80
|
+
* ```javascript
|
|
81
|
+
* //
|
|
82
|
+
* const input = {
|
|
83
|
+
* resourceArn: "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234"
|
|
84
|
+
* };
|
|
85
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
86
|
+
* const response = await client.send(command);
|
|
87
|
+
* /* response is
|
|
88
|
+
* {
|
|
89
|
+
* tags: [
|
|
90
|
+
* {
|
|
91
|
+
* key: "Environment",
|
|
92
|
+
* value: "Production"
|
|
93
|
+
* }
|
|
94
|
+
* ]
|
|
95
|
+
* }
|
|
96
|
+
* *\/
|
|
97
|
+
* ```
|
|
98
|
+
*
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
|
|
102
|
+
/** @internal type navigation helper, not in runtime. */
|
|
103
|
+
protected static __types: {
|
|
104
|
+
api: {
|
|
105
|
+
input: ListTagsForResourceInput;
|
|
106
|
+
output: ListTagsForResourceOutput;
|
|
107
|
+
};
|
|
108
|
+
sdk: {
|
|
109
|
+
input: ListTagsForResourceCommandInput;
|
|
110
|
+
output: ListTagsForResourceCommandOutput;
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
}
|