@aws-sdk/client-partnercentral-benefits 3.942.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 +341 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +1344 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +56 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +41 -0
- package/dist-es/PartnerCentralBenefits.js +41 -0
- package/dist-es/PartnerCentralBenefitsClient.js +50 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/AmendBenefitApplicationCommand.js +16 -0
- package/dist-es/commands/AssociateBenefitApplicationResourceCommand.js +16 -0
- package/dist-es/commands/CancelBenefitApplicationCommand.js +16 -0
- package/dist-es/commands/CreateBenefitApplicationCommand.js +16 -0
- package/dist-es/commands/DisassociateBenefitApplicationResourceCommand.js +16 -0
- package/dist-es/commands/GetBenefitAllocationCommand.js +16 -0
- package/dist-es/commands/GetBenefitApplicationCommand.js +16 -0
- package/dist-es/commands/GetBenefitCommand.js +16 -0
- package/dist-es/commands/ListBenefitAllocationsCommand.js +16 -0
- package/dist-es/commands/ListBenefitApplicationsCommand.js +16 -0
- package/dist-es/commands/ListBenefitsCommand.js +16 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +16 -0
- package/dist-es/commands/RecallBenefitApplicationCommand.js +16 -0
- package/dist-es/commands/SubmitBenefitApplicationCommand.js +16 -0
- package/dist-es/commands/TagResourceCommand.js +16 -0
- package/dist-es/commands/UntagResourceCommand.js +16 -0
- package/dist-es/commands/UpdateBenefitApplicationCommand.js +16 -0
- package/dist-es/commands/index.js +17 -0
- package/dist-es/endpoint/EndpointParameters.js +11 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +7 -0
- package/dist-es/models/PartnerCentralBenefitsServiceException.js +8 -0
- package/dist-es/models/enums.js +153 -0
- package/dist-es/models/errors.js +110 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListBenefitAllocationsPaginator.js +4 -0
- package/dist-es/pagination/ListBenefitApplicationsPaginator.js +4 -0
- package/dist-es/pagination/ListBenefitsPaginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +51 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +37 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +699 -0
- package/dist-types/PartnerCentralBenefits.d.ts +129 -0
- package/dist-types/PartnerCentralBenefitsClient.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/commands/AmendBenefitApplicationCommand.d.ts +100 -0
- package/dist-types/commands/AssociateBenefitApplicationResourceCommand.d.ts +96 -0
- package/dist-types/commands/CancelBenefitApplicationCommand.d.ts +93 -0
- package/dist-types/commands/CreateBenefitApplicationCommand.d.ts +126 -0
- package/dist-types/commands/DisassociateBenefitApplicationResourceCommand.d.ts +96 -0
- package/dist-types/commands/GetBenefitAllocationCommand.d.ts +158 -0
- package/dist-types/commands/GetBenefitApplicationCommand.d.ts +139 -0
- package/dist-types/commands/GetBenefitCommand.d.ts +102 -0
- package/dist-types/commands/ListBenefitAllocationsCommand.d.ts +123 -0
- package/dist-types/commands/ListBenefitApplicationsCommand.d.ts +141 -0
- package/dist-types/commands/ListBenefitsCommand.d.ts +116 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +94 -0
- package/dist-types/commands/RecallBenefitApplicationCommand.d.ts +93 -0
- package/dist-types/commands/SubmitBenefitApplicationCommand.d.ts +91 -0
- package/dist-types/commands/TagResourceCommand.d.ts +99 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +96 -0
- package/dist-types/commands/UpdateBenefitApplicationCommand.d.ts +115 -0
- package/dist-types/commands/index.d.ts +17 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +32 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +16 -0
- package/dist-types/models/PartnerCentralBenefitsServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +225 -0
- package/dist-types/models/errors.d.ts +149 -0
- package/dist-types/models/models_0.d.ts +1450 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListBenefitAllocationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListBenefitApplicationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListBenefitsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/runtimeConfig.browser.d.ts +51 -0
- package/dist-types/runtimeConfig.d.ts +51 -0
- package/dist-types/runtimeConfig.native.d.ts +50 -0
- package/dist-types/runtimeConfig.shared.d.ts +22 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +107 -0
- package/dist-types/ts3.4/PartnerCentralBenefits.d.ts +308 -0
- package/dist-types/ts3.4/PartnerCentralBenefitsClient.d.ts +228 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
- package/dist-types/ts3.4/commands/AmendBenefitApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/AssociateBenefitApplicationResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CancelBenefitApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateBenefitApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisassociateBenefitApplicationResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetBenefitAllocationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetBenefitApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetBenefitCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListBenefitAllocationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListBenefitApplicationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListBenefitsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/RecallBenefitApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SubmitBenefitApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateBenefitApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +17 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +11 -0
- package/dist-types/ts3.4/models/PartnerCentralBenefitsServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/enums.d.ts +167 -0
- package/dist-types/ts3.4/models/errors.d.ts +64 -0
- package/dist-types/ts3.4/models/models_0.d.ts +376 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListBenefitAllocationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListBenefitApplicationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListBenefitsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +101 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +27 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +113 -0
- package/package.json +99 -0
|
@@ -0,0 +1,1450 @@
|
|
|
1
|
+
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
+
import { BenefitAllocationStatus, BenefitApplicationStatus, BenefitStatus, CurrencyCode, FileType, FulfillmentType, ResourceType, ValidationExceptionErrorCode } from "./enums";
|
|
3
|
+
/**
|
|
4
|
+
* <p>Contains information about access-based benefit fulfillment, such as service permissions or feature access.</p>
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface AccessDetails {
|
|
8
|
+
/**
|
|
9
|
+
* <p>A description of the access privileges or permissions granted by this benefit.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
Description?: string | undefined;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* <p>Represents a specific change to be made to a benefit application field.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
export interface Amendment {
|
|
19
|
+
/**
|
|
20
|
+
* <p>The JSON path or field identifier specifying which field in the benefit application to modify.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
FieldPath: string | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* <p>The new value to set for the specified field in the benefit application.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
NewValue: string | undefined;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export interface AmendBenefitApplicationInput {
|
|
34
|
+
/**
|
|
35
|
+
* <p>The catalog identifier that specifies which benefit catalog the application belongs to.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
Catalog: string | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* <p>A unique, case-sensitive identifier to ensure idempotent processing of the amendment request.</p>
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
ClientToken: string | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* <p>The current revision number of the benefit application to ensure optimistic concurrency control.</p>
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
Revision: string | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* <p>The unique identifier of the benefit application to be amended.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
Identifier: string | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* <p>A descriptive reason explaining why the benefit application is being amended.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
AmendmentReason: string | undefined;
|
|
59
|
+
/**
|
|
60
|
+
* <p>A list of specific field amendments to apply to the benefit application.</p>
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
Amendments: Amendment[] | undefined;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
export interface AmendBenefitApplicationOutput {
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* <p>Represents a field-specific validation error with detailed information.</p>
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
export interface ValidationExceptionField {
|
|
75
|
+
/**
|
|
76
|
+
* <p>The name of the field that failed validation.</p>
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
Name: string | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* <p>A detailed message explaining why the field validation failed.</p>
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
Message: string | undefined;
|
|
85
|
+
/**
|
|
86
|
+
* <p>An error code explaining why the field validation failed.</p>
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
Code?: ValidationExceptionErrorCode | undefined;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
export interface AssociateBenefitApplicationResourceInput {
|
|
95
|
+
/**
|
|
96
|
+
* <p>The catalog identifier that specifies which benefit catalog the application belongs to.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
Catalog: string | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* <p>The unique identifier of the benefit application to associate the resource with.</p>
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
BenefitApplicationIdentifier: string | undefined;
|
|
105
|
+
/**
|
|
106
|
+
* <p>The Amazon Resource Name (ARN) of the AWS resource to associate with the benefit application.</p>
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
ResourceArn: string | undefined;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
export interface AssociateBenefitApplicationResourceOutput {
|
|
115
|
+
/**
|
|
116
|
+
* <p>The unique identifier of the benefit application after the resource association.</p>
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
Id?: string | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* <p>The Amazon Resource Name (ARN) of the benefit application after the resource association.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
Arn?: string | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* <p>The updated revision number of the benefit application after the resource association.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
Revision?: string | undefined;
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* <p>Represents an AWS resource that is associated with a benefit application for tracking and management.</p>
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
export interface AssociatedResource {
|
|
136
|
+
/**
|
|
137
|
+
* <p>The type of AWS resource (e.g., EC2 instance, S3 bucket, Lambda function).</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
ResourceType?: ResourceType | undefined;
|
|
141
|
+
/**
|
|
142
|
+
* <p>The unique identifier of the AWS resource within its service.</p>
|
|
143
|
+
*
|
|
144
|
+
* @deprecated This field is no longer used
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
ResourceIdentifier?: string | undefined;
|
|
148
|
+
/**
|
|
149
|
+
* <p>The Amazon Resource Name (ARN) that uniquely identifies the AWS resource.</p>
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
ResourceArn?: string | undefined;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* <p>A summary view of a benefit allocation containing key information for list operations.</p>
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
export interface BenefitAllocationSummary {
|
|
159
|
+
/**
|
|
160
|
+
* <p>The unique identifier of the benefit allocation.</p>
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
Id?: string | undefined;
|
|
164
|
+
/**
|
|
165
|
+
* <p>The catalog identifier that the benefit allocation belongs to.</p>
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
168
|
+
Catalog?: string | undefined;
|
|
169
|
+
/**
|
|
170
|
+
* <p>The Amazon Resource Name (ARN) of the benefit allocation.</p>
|
|
171
|
+
* @public
|
|
172
|
+
*/
|
|
173
|
+
Arn?: string | undefined;
|
|
174
|
+
/**
|
|
175
|
+
* <p>The current status of the benefit allocation.</p>
|
|
176
|
+
* @public
|
|
177
|
+
*/
|
|
178
|
+
Status?: BenefitAllocationStatus | undefined;
|
|
179
|
+
/**
|
|
180
|
+
* <p>Additional information explaining the current status of the benefit allocation.</p>
|
|
181
|
+
* @public
|
|
182
|
+
*/
|
|
183
|
+
StatusReason?: string | undefined;
|
|
184
|
+
/**
|
|
185
|
+
* <p>The human-readable name of the benefit allocation.</p>
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
Name?: string | undefined;
|
|
189
|
+
/**
|
|
190
|
+
* <p>The identifier of the benefit that this allocation is based on.</p>
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
193
|
+
BenefitId?: string | undefined;
|
|
194
|
+
/**
|
|
195
|
+
* <p>The identifier of the benefit application that resulted in this allocation.</p>
|
|
196
|
+
* @public
|
|
197
|
+
*/
|
|
198
|
+
BenefitApplicationId?: string | undefined;
|
|
199
|
+
/**
|
|
200
|
+
* <p>The fulfillment types used for this benefit allocation.</p>
|
|
201
|
+
* @public
|
|
202
|
+
*/
|
|
203
|
+
FulfillmentTypes?: FulfillmentType[] | undefined;
|
|
204
|
+
/**
|
|
205
|
+
* <p>The timestamp when the benefit allocation was created.</p>
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
CreatedAt?: Date | undefined;
|
|
209
|
+
/**
|
|
210
|
+
* <p>The timestamp when the benefit allocation expires.</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
ExpiresAt?: Date | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* <p>The identifiers of the benefits applicable for this allocation.</p>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
ApplicableBenefitIds?: string[] | undefined;
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* <p>A summary view of a benefit application containing key information for list operations.</p>
|
|
222
|
+
* @public
|
|
223
|
+
*/
|
|
224
|
+
export interface BenefitApplicationSummary {
|
|
225
|
+
/**
|
|
226
|
+
* <p>The catalog identifier that the benefit application belongs to.</p>
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
229
|
+
Catalog?: string | undefined;
|
|
230
|
+
/**
|
|
231
|
+
* <p>The human-readable name of the benefit application.</p>
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
Name?: string | undefined;
|
|
235
|
+
/**
|
|
236
|
+
* <p>The unique identifier of the benefit application.</p>
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
Id?: string | undefined;
|
|
240
|
+
/**
|
|
241
|
+
* <p>The Amazon Resource Name (ARN) of the benefit application.</p>
|
|
242
|
+
* @public
|
|
243
|
+
*/
|
|
244
|
+
Arn?: string | undefined;
|
|
245
|
+
/**
|
|
246
|
+
* <p>The identifier of the benefit being requested in this application.</p>
|
|
247
|
+
* @public
|
|
248
|
+
*/
|
|
249
|
+
BenefitId?: string | undefined;
|
|
250
|
+
/**
|
|
251
|
+
* <p>The AWS partner programs associated with this benefit application.</p>
|
|
252
|
+
* @public
|
|
253
|
+
*/
|
|
254
|
+
Programs?: string[] | undefined;
|
|
255
|
+
/**
|
|
256
|
+
* <p>The fulfillment types requested for this benefit application.</p>
|
|
257
|
+
* @public
|
|
258
|
+
*/
|
|
259
|
+
FulfillmentTypes?: FulfillmentType[] | undefined;
|
|
260
|
+
/**
|
|
261
|
+
* <p>The current processing status of the benefit application.</p>
|
|
262
|
+
* @public
|
|
263
|
+
*/
|
|
264
|
+
Status?: BenefitApplicationStatus | undefined;
|
|
265
|
+
/**
|
|
266
|
+
* <p>The current stage in the benefit application processing workflow..</p>
|
|
267
|
+
* @public
|
|
268
|
+
*/
|
|
269
|
+
Stage?: string | undefined;
|
|
270
|
+
/**
|
|
271
|
+
* <p>The timestamp when the benefit application was created.</p>
|
|
272
|
+
* @public
|
|
273
|
+
*/
|
|
274
|
+
CreatedAt?: Date | undefined;
|
|
275
|
+
/**
|
|
276
|
+
* <p>The timestamp when the benefit application was last updated.</p>
|
|
277
|
+
* @public
|
|
278
|
+
*/
|
|
279
|
+
UpdatedAt?: Date | undefined;
|
|
280
|
+
/**
|
|
281
|
+
* <p>Additional attributes and metadata associated with the benefit application.</p>
|
|
282
|
+
* @public
|
|
283
|
+
*/
|
|
284
|
+
BenefitApplicationDetails?: Record<string, string> | undefined;
|
|
285
|
+
/**
|
|
286
|
+
* <p>AWS resources that are associated with this benefit application.</p>
|
|
287
|
+
* @public
|
|
288
|
+
*/
|
|
289
|
+
AssociatedResources?: string[] | undefined;
|
|
290
|
+
}
|
|
291
|
+
/**
|
|
292
|
+
* <p>A summary view of a benefit containing key information for list operations.</p>
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
export interface BenefitSummary {
|
|
296
|
+
/**
|
|
297
|
+
* <p>The unique identifier of the benefit.</p>
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
Id?: string | undefined;
|
|
301
|
+
/**
|
|
302
|
+
* <p>The catalog identifier that the benefit belongs to.</p>
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
Catalog?: string | undefined;
|
|
306
|
+
/**
|
|
307
|
+
* <p>The Amazon Resource Name (ARN) of the benefit.</p>
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
Arn?: string | undefined;
|
|
311
|
+
/**
|
|
312
|
+
* <p>The human-readable name of the benefit.</p>
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
Name?: string | undefined;
|
|
316
|
+
/**
|
|
317
|
+
* <p>A brief description of the benefit and its purpose.</p>
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
Description?: string | undefined;
|
|
321
|
+
/**
|
|
322
|
+
* <p>The AWS partner programs that this benefit is associated with.</p>
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
Programs?: string[] | undefined;
|
|
326
|
+
/**
|
|
327
|
+
* <p>The available fulfillment types for this benefit.</p>
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
FulfillmentTypes?: FulfillmentType[] | undefined;
|
|
331
|
+
/**
|
|
332
|
+
* <p>The current status of the benefit.</p>
|
|
333
|
+
* @public
|
|
334
|
+
*/
|
|
335
|
+
Status?: BenefitStatus | undefined;
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* @public
|
|
339
|
+
*/
|
|
340
|
+
export interface CancelBenefitApplicationInput {
|
|
341
|
+
/**
|
|
342
|
+
* <p>The catalog identifier that specifies which benefit catalog the application belongs to.</p>
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
345
|
+
Catalog: string | undefined;
|
|
346
|
+
/**
|
|
347
|
+
* <p>A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.</p>
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
ClientToken: string | undefined;
|
|
351
|
+
/**
|
|
352
|
+
* <p>The unique identifier of the benefit application to cancel.</p>
|
|
353
|
+
* @public
|
|
354
|
+
*/
|
|
355
|
+
Identifier: string | undefined;
|
|
356
|
+
/**
|
|
357
|
+
* <p>A descriptive reason explaining why the benefit application is being cancelled.</p>
|
|
358
|
+
* @public
|
|
359
|
+
*/
|
|
360
|
+
Reason?: string | undefined;
|
|
361
|
+
}
|
|
362
|
+
/**
|
|
363
|
+
* @public
|
|
364
|
+
*/
|
|
365
|
+
export interface CancelBenefitApplicationOutput {
|
|
366
|
+
}
|
|
367
|
+
/**
|
|
368
|
+
* <p>Represents a monetary amount with its associated currency.</p>
|
|
369
|
+
* @public
|
|
370
|
+
*/
|
|
371
|
+
export interface MonetaryValue {
|
|
372
|
+
/**
|
|
373
|
+
* <p>The numeric amount of the monetary value.</p>
|
|
374
|
+
* @public
|
|
375
|
+
*/
|
|
376
|
+
Amount: string | undefined;
|
|
377
|
+
/**
|
|
378
|
+
* <p>The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.</p>
|
|
379
|
+
* @public
|
|
380
|
+
*/
|
|
381
|
+
CurrencyCode: CurrencyCode | undefined;
|
|
382
|
+
}
|
|
383
|
+
/**
|
|
384
|
+
* <p>Represents detailed information about a specific issuance of benefit value.</p>
|
|
385
|
+
* @public
|
|
386
|
+
*/
|
|
387
|
+
export interface IssuanceDetail {
|
|
388
|
+
/**
|
|
389
|
+
* <p>The unique identifier for this specific issuance.</p>
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
392
|
+
IssuanceId?: string | undefined;
|
|
393
|
+
/**
|
|
394
|
+
* <p>The monetary amount or value that was issued in this specific issuance.</p>
|
|
395
|
+
* @public
|
|
396
|
+
*/
|
|
397
|
+
IssuanceAmount?: MonetaryValue | undefined;
|
|
398
|
+
/**
|
|
399
|
+
* <p>The timestamp when this specific issuance was processed.</p>
|
|
400
|
+
* @public
|
|
401
|
+
*/
|
|
402
|
+
IssuedAt?: Date | undefined;
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* <p>Contains information about consumable benefit fulfillment, such as usage quotas or service limits.</p>
|
|
406
|
+
* @public
|
|
407
|
+
*/
|
|
408
|
+
export interface ConsumableDetails {
|
|
409
|
+
/**
|
|
410
|
+
* <p>The total amount of the consumable benefit that has been allocated.</p>
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
AllocatedAmount?: MonetaryValue | undefined;
|
|
414
|
+
/**
|
|
415
|
+
* <p>The remaining amount of the consumable benefit that is still available for use.</p>
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
RemainingAmount?: MonetaryValue | undefined;
|
|
419
|
+
/**
|
|
420
|
+
* <p>The amount of the consumable benefit that has already been used.</p>
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
UtilizedAmount?: MonetaryValue | undefined;
|
|
424
|
+
/**
|
|
425
|
+
* <p>Detailed information about how the consumable benefit was issued and distributed.</p>
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
IssuanceDetails?: IssuanceDetail | undefined;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* <p>Represents contact information for a partner representative.</p>
|
|
432
|
+
* @public
|
|
433
|
+
*/
|
|
434
|
+
export interface Contact {
|
|
435
|
+
/**
|
|
436
|
+
* <p>The email address of the contact person.</p>
|
|
437
|
+
* @public
|
|
438
|
+
*/
|
|
439
|
+
Email?: string | undefined;
|
|
440
|
+
/**
|
|
441
|
+
* <p>The first name of the contact person.</p>
|
|
442
|
+
* @public
|
|
443
|
+
*/
|
|
444
|
+
FirstName?: string | undefined;
|
|
445
|
+
/**
|
|
446
|
+
* <p>The last name of the contact person.</p>
|
|
447
|
+
* @public
|
|
448
|
+
*/
|
|
449
|
+
LastName?: string | undefined;
|
|
450
|
+
/**
|
|
451
|
+
* <p>The business title or role of the contact person within the organization.</p>
|
|
452
|
+
* @public
|
|
453
|
+
*/
|
|
454
|
+
BusinessTitle?: string | undefined;
|
|
455
|
+
/**
|
|
456
|
+
* <p>The phone number of the contact person.</p>
|
|
457
|
+
* @public
|
|
458
|
+
*/
|
|
459
|
+
Phone?: string | undefined;
|
|
460
|
+
}
|
|
461
|
+
/**
|
|
462
|
+
* <p>Represents input information for uploading a file to a benefit application.</p>
|
|
463
|
+
* @public
|
|
464
|
+
*/
|
|
465
|
+
export interface FileInput {
|
|
466
|
+
/**
|
|
467
|
+
* <p>The URI or location where the file should be stored or has been uploaded.</p>
|
|
468
|
+
* @public
|
|
469
|
+
*/
|
|
470
|
+
FileURI: string | undefined;
|
|
471
|
+
/**
|
|
472
|
+
* <p>The business purpose or use case that this file supports in the benefit application.</p>
|
|
473
|
+
* @public
|
|
474
|
+
*/
|
|
475
|
+
BusinessUseCase?: string | undefined;
|
|
476
|
+
}
|
|
477
|
+
/**
|
|
478
|
+
* <p>Represents a key-value pair used for categorizing and organizing AWS resources.</p>
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
export interface Tag {
|
|
482
|
+
/**
|
|
483
|
+
* <p>The tag key, which acts as a category or label for the tag.</p>
|
|
484
|
+
* @public
|
|
485
|
+
*/
|
|
486
|
+
Key: string | undefined;
|
|
487
|
+
/**
|
|
488
|
+
* <p>The tag value, which provides additional information or context for the tag key.</p>
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
Value: string | undefined;
|
|
492
|
+
}
|
|
493
|
+
/**
|
|
494
|
+
* @public
|
|
495
|
+
*/
|
|
496
|
+
export interface CreateBenefitApplicationInput {
|
|
497
|
+
/**
|
|
498
|
+
* <p>The catalog identifier that specifies which benefit catalog to create the application in.</p>
|
|
499
|
+
* @public
|
|
500
|
+
*/
|
|
501
|
+
Catalog: string | undefined;
|
|
502
|
+
/**
|
|
503
|
+
* <p>A unique, case-sensitive identifier to ensure idempotent processing of the creation request.</p>
|
|
504
|
+
* @public
|
|
505
|
+
*/
|
|
506
|
+
ClientToken: string | undefined;
|
|
507
|
+
/**
|
|
508
|
+
* <p>A human-readable name for the benefit application.</p>
|
|
509
|
+
* @public
|
|
510
|
+
*/
|
|
511
|
+
Name?: string | undefined;
|
|
512
|
+
/**
|
|
513
|
+
* <p>A detailed description of the benefit application and its intended use.</p>
|
|
514
|
+
* @public
|
|
515
|
+
*/
|
|
516
|
+
Description?: string | undefined;
|
|
517
|
+
/**
|
|
518
|
+
* <p>The unique identifier of the benefit being requested in this application.</p>
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
521
|
+
BenefitIdentifier: string | undefined;
|
|
522
|
+
/**
|
|
523
|
+
* <p>The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).</p>
|
|
524
|
+
* @public
|
|
525
|
+
*/
|
|
526
|
+
FulfillmentTypes?: FulfillmentType[] | undefined;
|
|
527
|
+
/**
|
|
528
|
+
* <p>Detailed information and requirements specific to the benefit being requested.</p>
|
|
529
|
+
* @public
|
|
530
|
+
*/
|
|
531
|
+
BenefitApplicationDetails?: __DocumentType | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* <p>Key-value pairs to categorize and organize the benefit application.</p>
|
|
534
|
+
* @public
|
|
535
|
+
*/
|
|
536
|
+
Tags?: Tag[] | undefined;
|
|
537
|
+
/**
|
|
538
|
+
* <p>AWS resources that are associated with this benefit application.</p>
|
|
539
|
+
* @public
|
|
540
|
+
*/
|
|
541
|
+
AssociatedResources?: string[] | undefined;
|
|
542
|
+
/**
|
|
543
|
+
* <p>Contact information for partner representatives responsible for this benefit application.</p>
|
|
544
|
+
* @public
|
|
545
|
+
*/
|
|
546
|
+
PartnerContacts?: Contact[] | undefined;
|
|
547
|
+
/**
|
|
548
|
+
* <p>Supporting documents and files attached to the benefit application.</p>
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
FileDetails?: FileInput[] | undefined;
|
|
552
|
+
}
|
|
553
|
+
/**
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
export interface CreateBenefitApplicationOutput {
|
|
557
|
+
/**
|
|
558
|
+
* <p>The unique identifier assigned to the newly created benefit application.</p>
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
Id?: string | undefined;
|
|
562
|
+
/**
|
|
563
|
+
* <p>The Amazon Resource Name (ARN) of the newly created benefit application.</p>
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
Arn?: string | undefined;
|
|
567
|
+
/**
|
|
568
|
+
* <p>The initial revision number of the newly created benefit application.</p>
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
571
|
+
Revision?: string | undefined;
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
* <p>Represents an AWS credit code that can be applied to an AWS account for billing purposes.</p>
|
|
575
|
+
* @public
|
|
576
|
+
*/
|
|
577
|
+
export interface CreditCode {
|
|
578
|
+
/**
|
|
579
|
+
* <p>The AWS account ID that the credit code is associated with or can be applied to.</p>
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
AwsAccountId: string | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* <p>The monetary value of the credit code.</p>
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
Value: MonetaryValue | undefined;
|
|
588
|
+
/**
|
|
589
|
+
* <p>The actual credit code string that can be redeemed in the AWS billing console.</p>
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
AwsCreditCode: string | undefined;
|
|
593
|
+
/**
|
|
594
|
+
* <p>The current status of the credit code (e.g., active, redeemed, expired).</p>
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
Status: BenefitAllocationStatus | undefined;
|
|
598
|
+
/**
|
|
599
|
+
* <p>The timestamp when the credit code was issued.</p>
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
IssuedAt: Date | undefined;
|
|
603
|
+
/**
|
|
604
|
+
* <p>The timestamp when the credit code expires and can no longer be redeemed.</p>
|
|
605
|
+
* @public
|
|
606
|
+
*/
|
|
607
|
+
ExpiresAt: Date | undefined;
|
|
608
|
+
}
|
|
609
|
+
/**
|
|
610
|
+
* <p>Contains information about credit-based benefit fulfillment, including AWS promotional credits.</p>
|
|
611
|
+
* @public
|
|
612
|
+
*/
|
|
613
|
+
export interface CreditDetails {
|
|
614
|
+
/**
|
|
615
|
+
* <p>The total amount of credits that have been allocated for this benefit.</p>
|
|
616
|
+
* @public
|
|
617
|
+
*/
|
|
618
|
+
AllocatedAmount: MonetaryValue | undefined;
|
|
619
|
+
/**
|
|
620
|
+
* <p>The amount of credits that have actually been issued and are available for use.</p>
|
|
621
|
+
* @public
|
|
622
|
+
*/
|
|
623
|
+
IssuedAmount: MonetaryValue | undefined;
|
|
624
|
+
/**
|
|
625
|
+
* <p>A list of credit codes that have been generated for this benefit allocation.</p>
|
|
626
|
+
* @public
|
|
627
|
+
*/
|
|
628
|
+
Codes: CreditCode[] | undefined;
|
|
629
|
+
}
|
|
630
|
+
/**
|
|
631
|
+
* @public
|
|
632
|
+
*/
|
|
633
|
+
export interface DisassociateBenefitApplicationResourceInput {
|
|
634
|
+
/**
|
|
635
|
+
* <p>The catalog identifier that specifies which benefit catalog the application belongs to.</p>
|
|
636
|
+
* @public
|
|
637
|
+
*/
|
|
638
|
+
Catalog: string | undefined;
|
|
639
|
+
/**
|
|
640
|
+
* <p>The unique identifier of the benefit application to disassociate the resource from.</p>
|
|
641
|
+
* @public
|
|
642
|
+
*/
|
|
643
|
+
BenefitApplicationIdentifier: string | undefined;
|
|
644
|
+
/**
|
|
645
|
+
* <p>The Amazon Resource Name (ARN) of the AWS resource to disassociate from the benefit application.</p>
|
|
646
|
+
* @public
|
|
647
|
+
*/
|
|
648
|
+
ResourceArn: string | undefined;
|
|
649
|
+
}
|
|
650
|
+
/**
|
|
651
|
+
* @public
|
|
652
|
+
*/
|
|
653
|
+
export interface DisassociateBenefitApplicationResourceOutput {
|
|
654
|
+
/**
|
|
655
|
+
* <p>The unique identifier of the benefit application after the resource disassociation.</p>
|
|
656
|
+
* @public
|
|
657
|
+
*/
|
|
658
|
+
Id?: string | undefined;
|
|
659
|
+
/**
|
|
660
|
+
* <p>The Amazon Resource Name (ARN) of the benefit application after the resource disassociation.</p>
|
|
661
|
+
* @public
|
|
662
|
+
*/
|
|
663
|
+
Arn?: string | undefined;
|
|
664
|
+
/**
|
|
665
|
+
* <p>The updated revision number of the benefit application after the resource disassociation.</p>
|
|
666
|
+
* @public
|
|
667
|
+
*/
|
|
668
|
+
Revision?: string | undefined;
|
|
669
|
+
}
|
|
670
|
+
/**
|
|
671
|
+
* <p>Contains information about disbursement-based benefit fulfillment, such as direct payments or reimbursements.</p>
|
|
672
|
+
* @public
|
|
673
|
+
*/
|
|
674
|
+
export interface DisbursementDetails {
|
|
675
|
+
/**
|
|
676
|
+
* <p>The total amount that has been disbursed for this benefit allocation.</p>
|
|
677
|
+
* @public
|
|
678
|
+
*/
|
|
679
|
+
DisbursedAmount?: MonetaryValue | undefined;
|
|
680
|
+
/**
|
|
681
|
+
* <p>Detailed information about how the disbursement was issued and processed.</p>
|
|
682
|
+
* @public
|
|
683
|
+
*/
|
|
684
|
+
IssuanceDetails?: IssuanceDetail | undefined;
|
|
685
|
+
}
|
|
686
|
+
/**
|
|
687
|
+
* <p>Represents detailed information about a file attached to a benefit application.</p>
|
|
688
|
+
* @public
|
|
689
|
+
*/
|
|
690
|
+
export interface FileDetail {
|
|
691
|
+
/**
|
|
692
|
+
* <p>The URI or location where the file is stored.</p>
|
|
693
|
+
* @public
|
|
694
|
+
*/
|
|
695
|
+
FileURI: string | undefined;
|
|
696
|
+
/**
|
|
697
|
+
* <p>The business purpose or use case that this file supports in the benefit application.</p>
|
|
698
|
+
* @public
|
|
699
|
+
*/
|
|
700
|
+
BusinessUseCase?: string | undefined;
|
|
701
|
+
/**
|
|
702
|
+
* <p>The original name of the uploaded file.</p>
|
|
703
|
+
* @public
|
|
704
|
+
*/
|
|
705
|
+
FileName?: string | undefined;
|
|
706
|
+
/**
|
|
707
|
+
* <p>The current processing status of the file (e.g., uploaded, processing, approved, rejected).</p>
|
|
708
|
+
* @public
|
|
709
|
+
*/
|
|
710
|
+
FileStatus?: string | undefined;
|
|
711
|
+
/**
|
|
712
|
+
* <p>The reason for that particulat file status.</p>
|
|
713
|
+
* @public
|
|
714
|
+
*/
|
|
715
|
+
FileStatusReason?: string | undefined;
|
|
716
|
+
/**
|
|
717
|
+
* <p>The type or category of the file (e.g., document, image, spreadsheet).</p>
|
|
718
|
+
* @public
|
|
719
|
+
*/
|
|
720
|
+
FileType?: FileType | undefined;
|
|
721
|
+
/**
|
|
722
|
+
* <p>The identifier of the user who uploaded the file.</p>
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
CreatedBy?: string | undefined;
|
|
726
|
+
/**
|
|
727
|
+
* <p>The timestamp when the file was uploaded.</p>
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
CreatedAt?: Date | undefined;
|
|
731
|
+
}
|
|
732
|
+
/**
|
|
733
|
+
* <p>Contains comprehensive information about how a benefit allocation is fulfilled across different fulfillment types.</p>
|
|
734
|
+
* @public
|
|
735
|
+
*/
|
|
736
|
+
export type FulfillmentDetails = FulfillmentDetails.AccessDetailsMember | FulfillmentDetails.ConsumableDetailsMember | FulfillmentDetails.CreditDetailsMember | FulfillmentDetails.DisbursementDetailsMember | FulfillmentDetails.$UnknownMember;
|
|
737
|
+
/**
|
|
738
|
+
* @public
|
|
739
|
+
*/
|
|
740
|
+
export declare namespace FulfillmentDetails {
|
|
741
|
+
/**
|
|
742
|
+
* <p>Details about disbursement-based fulfillment, if applicable to this benefit allocation.</p>
|
|
743
|
+
* @public
|
|
744
|
+
*/
|
|
745
|
+
interface DisbursementDetailsMember {
|
|
746
|
+
DisbursementDetails: DisbursementDetails;
|
|
747
|
+
ConsumableDetails?: never;
|
|
748
|
+
CreditDetails?: never;
|
|
749
|
+
AccessDetails?: never;
|
|
750
|
+
$unknown?: never;
|
|
751
|
+
}
|
|
752
|
+
/**
|
|
753
|
+
* <p>Details about consumable-based fulfillment, if applicable to this benefit allocation.</p>
|
|
754
|
+
* @public
|
|
755
|
+
*/
|
|
756
|
+
interface ConsumableDetailsMember {
|
|
757
|
+
DisbursementDetails?: never;
|
|
758
|
+
ConsumableDetails: ConsumableDetails;
|
|
759
|
+
CreditDetails?: never;
|
|
760
|
+
AccessDetails?: never;
|
|
761
|
+
$unknown?: never;
|
|
762
|
+
}
|
|
763
|
+
/**
|
|
764
|
+
* <p>Details about credit-based fulfillment, if applicable to this benefit allocation.</p>
|
|
765
|
+
* @public
|
|
766
|
+
*/
|
|
767
|
+
interface CreditDetailsMember {
|
|
768
|
+
DisbursementDetails?: never;
|
|
769
|
+
ConsumableDetails?: never;
|
|
770
|
+
CreditDetails: CreditDetails;
|
|
771
|
+
AccessDetails?: never;
|
|
772
|
+
$unknown?: never;
|
|
773
|
+
}
|
|
774
|
+
/**
|
|
775
|
+
* <p>Details about access-based fulfillment, if applicable to this benefit allocation.</p>
|
|
776
|
+
* @public
|
|
777
|
+
*/
|
|
778
|
+
interface AccessDetailsMember {
|
|
779
|
+
DisbursementDetails?: never;
|
|
780
|
+
ConsumableDetails?: never;
|
|
781
|
+
CreditDetails?: never;
|
|
782
|
+
AccessDetails: AccessDetails;
|
|
783
|
+
$unknown?: never;
|
|
784
|
+
}
|
|
785
|
+
/**
|
|
786
|
+
* @public
|
|
787
|
+
*/
|
|
788
|
+
interface $UnknownMember {
|
|
789
|
+
DisbursementDetails?: never;
|
|
790
|
+
ConsumableDetails?: never;
|
|
791
|
+
CreditDetails?: never;
|
|
792
|
+
AccessDetails?: never;
|
|
793
|
+
$unknown: [string, any];
|
|
794
|
+
}
|
|
795
|
+
/**
|
|
796
|
+
* @deprecated unused in schema-serde mode.
|
|
797
|
+
*
|
|
798
|
+
*/
|
|
799
|
+
interface Visitor<T> {
|
|
800
|
+
DisbursementDetails: (value: DisbursementDetails) => T;
|
|
801
|
+
ConsumableDetails: (value: ConsumableDetails) => T;
|
|
802
|
+
CreditDetails: (value: CreditDetails) => T;
|
|
803
|
+
AccessDetails: (value: AccessDetails) => T;
|
|
804
|
+
_: (name: string, value: any) => T;
|
|
805
|
+
}
|
|
806
|
+
}
|
|
807
|
+
/**
|
|
808
|
+
* @public
|
|
809
|
+
*/
|
|
810
|
+
export interface GetBenefitInput {
|
|
811
|
+
/**
|
|
812
|
+
* <p>The catalog identifier that specifies which benefit catalog to query.</p>
|
|
813
|
+
* @public
|
|
814
|
+
*/
|
|
815
|
+
Catalog: string | undefined;
|
|
816
|
+
/**
|
|
817
|
+
* <p>The unique identifier of the benefit to retrieve.</p>
|
|
818
|
+
* @public
|
|
819
|
+
*/
|
|
820
|
+
Identifier: string | undefined;
|
|
821
|
+
}
|
|
822
|
+
/**
|
|
823
|
+
* @public
|
|
824
|
+
*/
|
|
825
|
+
export interface GetBenefitOutput {
|
|
826
|
+
/**
|
|
827
|
+
* <p>The unique identifier of the benefit.</p>
|
|
828
|
+
* @public
|
|
829
|
+
*/
|
|
830
|
+
Id?: string | undefined;
|
|
831
|
+
/**
|
|
832
|
+
* <p>The catalog identifier that the benefit belongs to.</p>
|
|
833
|
+
* @public
|
|
834
|
+
*/
|
|
835
|
+
Catalog?: string | undefined;
|
|
836
|
+
/**
|
|
837
|
+
* <p>The Amazon Resource Name (ARN) of the benefit.</p>
|
|
838
|
+
* @public
|
|
839
|
+
*/
|
|
840
|
+
Arn?: string | undefined;
|
|
841
|
+
/**
|
|
842
|
+
* <p>The human-readable name of the benefit.</p>
|
|
843
|
+
* @public
|
|
844
|
+
*/
|
|
845
|
+
Name?: string | undefined;
|
|
846
|
+
/**
|
|
847
|
+
* <p>A detailed description of the benefit and its purpose.</p>
|
|
848
|
+
* @public
|
|
849
|
+
*/
|
|
850
|
+
Description?: string | undefined;
|
|
851
|
+
/**
|
|
852
|
+
* <p>The AWS partner programs that this benefit is associated with.</p>
|
|
853
|
+
* @public
|
|
854
|
+
*/
|
|
855
|
+
Programs?: string[] | undefined;
|
|
856
|
+
/**
|
|
857
|
+
* <p>The available fulfillment types for this benefit (e.g., credits, access, disbursement).</p>
|
|
858
|
+
* @public
|
|
859
|
+
*/
|
|
860
|
+
FulfillmentTypes?: FulfillmentType[] | undefined;
|
|
861
|
+
/**
|
|
862
|
+
* <p>The schema definition that describes the required fields for requesting this benefit.</p>
|
|
863
|
+
* @public
|
|
864
|
+
*/
|
|
865
|
+
BenefitRequestSchema?: __DocumentType | undefined;
|
|
866
|
+
/**
|
|
867
|
+
* <p>The current status of the benefit (e.g., active, inactive, deprecated).</p>
|
|
868
|
+
* @public
|
|
869
|
+
*/
|
|
870
|
+
Status?: BenefitStatus | undefined;
|
|
871
|
+
}
|
|
872
|
+
/**
|
|
873
|
+
* @public
|
|
874
|
+
*/
|
|
875
|
+
export interface GetBenefitAllocationInput {
|
|
876
|
+
/**
|
|
877
|
+
* <p>The catalog identifier that specifies which benefit catalog to query.</p>
|
|
878
|
+
* @public
|
|
879
|
+
*/
|
|
880
|
+
Catalog: string | undefined;
|
|
881
|
+
/**
|
|
882
|
+
* <p>The unique identifier of the benefit allocation to retrieve.</p>
|
|
883
|
+
* @public
|
|
884
|
+
*/
|
|
885
|
+
Identifier: string | undefined;
|
|
886
|
+
}
|
|
887
|
+
/**
|
|
888
|
+
* @public
|
|
889
|
+
*/
|
|
890
|
+
export interface GetBenefitAllocationOutput {
|
|
891
|
+
/**
|
|
892
|
+
* <p>The unique identifier of the benefit allocation.</p>
|
|
893
|
+
* @public
|
|
894
|
+
*/
|
|
895
|
+
Id?: string | undefined;
|
|
896
|
+
/**
|
|
897
|
+
* <p>The catalog identifier that the benefit allocation belongs to.</p>
|
|
898
|
+
* @public
|
|
899
|
+
*/
|
|
900
|
+
Catalog?: string | undefined;
|
|
901
|
+
/**
|
|
902
|
+
* <p>The Amazon Resource Name (ARN) of the benefit allocation.</p>
|
|
903
|
+
* @public
|
|
904
|
+
*/
|
|
905
|
+
Arn?: string | undefined;
|
|
906
|
+
/**
|
|
907
|
+
* <p>The human-readable name of the benefit allocation.</p>
|
|
908
|
+
* @public
|
|
909
|
+
*/
|
|
910
|
+
Name?: string | undefined;
|
|
911
|
+
/**
|
|
912
|
+
* <p>A detailed description of the benefit allocation.</p>
|
|
913
|
+
* @public
|
|
914
|
+
*/
|
|
915
|
+
Description?: string | undefined;
|
|
916
|
+
/**
|
|
917
|
+
* <p>The current status of the benefit allocation (e.g., active, expired, consumed).</p>
|
|
918
|
+
* @public
|
|
919
|
+
*/
|
|
920
|
+
Status?: BenefitAllocationStatus | undefined;
|
|
921
|
+
/**
|
|
922
|
+
* <p>Additional information explaining the current status of the benefit allocation.</p>
|
|
923
|
+
* @public
|
|
924
|
+
*/
|
|
925
|
+
StatusReason?: string | undefined;
|
|
926
|
+
/**
|
|
927
|
+
* <p>The identifier of the benefit application that resulted in this allocation.</p>
|
|
928
|
+
* @public
|
|
929
|
+
*/
|
|
930
|
+
BenefitApplicationId?: string | undefined;
|
|
931
|
+
/**
|
|
932
|
+
* <p>The identifier of the benefit that this allocation is based on.</p>
|
|
933
|
+
* @public
|
|
934
|
+
*/
|
|
935
|
+
BenefitId?: string | undefined;
|
|
936
|
+
/**
|
|
937
|
+
* <p>The fulfillment type used for this benefit allocation.</p>
|
|
938
|
+
* @public
|
|
939
|
+
*/
|
|
940
|
+
FulfillmentType?: FulfillmentType | undefined;
|
|
941
|
+
/**
|
|
942
|
+
* <p>A list of benefit identifiers that this allocation can be applied to.</p>
|
|
943
|
+
* @public
|
|
944
|
+
*/
|
|
945
|
+
ApplicableBenefitIds?: string[] | undefined;
|
|
946
|
+
/**
|
|
947
|
+
* <p>Detailed information about how the benefit allocation is fulfilled.</p>
|
|
948
|
+
* @public
|
|
949
|
+
*/
|
|
950
|
+
FulfillmentDetail?: FulfillmentDetails | undefined;
|
|
951
|
+
/**
|
|
952
|
+
* <p>The timestamp when the benefit allocation was created.</p>
|
|
953
|
+
* @public
|
|
954
|
+
*/
|
|
955
|
+
CreatedAt?: Date | undefined;
|
|
956
|
+
/**
|
|
957
|
+
* <p>The timestamp when the benefit allocation was last updated.</p>
|
|
958
|
+
* @public
|
|
959
|
+
*/
|
|
960
|
+
UpdatedAt?: Date | undefined;
|
|
961
|
+
/**
|
|
962
|
+
* <p>The timestamp when the benefit allocation becomes active and usable.</p>
|
|
963
|
+
* @public
|
|
964
|
+
*/
|
|
965
|
+
StartsAt?: Date | undefined;
|
|
966
|
+
/**
|
|
967
|
+
* <p>The timestamp when the benefit allocation expires and is no longer usable.</p>
|
|
968
|
+
* @public
|
|
969
|
+
*/
|
|
970
|
+
ExpiresAt?: Date | undefined;
|
|
971
|
+
}
|
|
972
|
+
/**
|
|
973
|
+
* @public
|
|
974
|
+
*/
|
|
975
|
+
export interface GetBenefitApplicationInput {
|
|
976
|
+
/**
|
|
977
|
+
* <p>The catalog identifier that specifies which benefit catalog to query.</p>
|
|
978
|
+
* @public
|
|
979
|
+
*/
|
|
980
|
+
Catalog: string | undefined;
|
|
981
|
+
/**
|
|
982
|
+
* <p>The unique identifier of the benefit application to retrieve.</p>
|
|
983
|
+
* @public
|
|
984
|
+
*/
|
|
985
|
+
Identifier: string | undefined;
|
|
986
|
+
}
|
|
987
|
+
/**
|
|
988
|
+
* @public
|
|
989
|
+
*/
|
|
990
|
+
export interface GetBenefitApplicationOutput {
|
|
991
|
+
/**
|
|
992
|
+
* <p>The unique identifier of the benefit application.</p>
|
|
993
|
+
* @public
|
|
994
|
+
*/
|
|
995
|
+
Id?: string | undefined;
|
|
996
|
+
/**
|
|
997
|
+
* <p>The Amazon Resource Name (ARN) of the benefit application.</p>
|
|
998
|
+
* @public
|
|
999
|
+
*/
|
|
1000
|
+
Arn?: string | undefined;
|
|
1001
|
+
/**
|
|
1002
|
+
* <p>The catalog identifier that the benefit application belongs to.</p>
|
|
1003
|
+
* @public
|
|
1004
|
+
*/
|
|
1005
|
+
Catalog?: string | undefined;
|
|
1006
|
+
/**
|
|
1007
|
+
* <p>The identifier of the benefit being requested in this application.</p>
|
|
1008
|
+
* @public
|
|
1009
|
+
*/
|
|
1010
|
+
BenefitId?: string | undefined;
|
|
1011
|
+
/**
|
|
1012
|
+
* <p>The human-readable name of the benefit application.</p>
|
|
1013
|
+
* @public
|
|
1014
|
+
*/
|
|
1015
|
+
Name?: string | undefined;
|
|
1016
|
+
/**
|
|
1017
|
+
* <p>A detailed description of the benefit application.</p>
|
|
1018
|
+
* @public
|
|
1019
|
+
*/
|
|
1020
|
+
Description?: string | undefined;
|
|
1021
|
+
/**
|
|
1022
|
+
* <p>The fulfillment types requested for this benefit application.</p>
|
|
1023
|
+
* @public
|
|
1024
|
+
*/
|
|
1025
|
+
FulfillmentTypes?: FulfillmentType[] | undefined;
|
|
1026
|
+
/**
|
|
1027
|
+
* <p>Detailed information and requirements specific to the benefit being requested.</p>
|
|
1028
|
+
* @public
|
|
1029
|
+
*/
|
|
1030
|
+
BenefitApplicationDetails?: __DocumentType | undefined;
|
|
1031
|
+
/**
|
|
1032
|
+
* <p>The AWS partner programs associated with this benefit application.</p>
|
|
1033
|
+
* @public
|
|
1034
|
+
*/
|
|
1035
|
+
Programs?: string[] | undefined;
|
|
1036
|
+
/**
|
|
1037
|
+
* <p>The current processing status of the benefit application.</p>
|
|
1038
|
+
* @public
|
|
1039
|
+
*/
|
|
1040
|
+
Status?: BenefitApplicationStatus | undefined;
|
|
1041
|
+
/**
|
|
1042
|
+
* <p>The current stage in the benefit application processing workflow.</p>
|
|
1043
|
+
* @public
|
|
1044
|
+
*/
|
|
1045
|
+
Stage?: string | undefined;
|
|
1046
|
+
/**
|
|
1047
|
+
* <p>Additional information explaining the current status of the benefit application.</p>
|
|
1048
|
+
* @public
|
|
1049
|
+
*/
|
|
1050
|
+
StatusReason?: string | undefined;
|
|
1051
|
+
/**
|
|
1052
|
+
* <p>A standardized code representing the reason for the current status.</p>
|
|
1053
|
+
*
|
|
1054
|
+
* @deprecated This field is no longer used
|
|
1055
|
+
* @public
|
|
1056
|
+
*/
|
|
1057
|
+
StatusReasonCode?: string | undefined;
|
|
1058
|
+
/**
|
|
1059
|
+
* <p>The list of standardized codes representing the reason for the current status.</p>
|
|
1060
|
+
* @public
|
|
1061
|
+
*/
|
|
1062
|
+
StatusReasonCodes?: string[] | undefined;
|
|
1063
|
+
/**
|
|
1064
|
+
* <p>The timestamp when the benefit application was created.</p>
|
|
1065
|
+
* @public
|
|
1066
|
+
*/
|
|
1067
|
+
CreatedAt?: Date | undefined;
|
|
1068
|
+
/**
|
|
1069
|
+
* <p>The timestamp when the benefit application was last updated.</p>
|
|
1070
|
+
* @public
|
|
1071
|
+
*/
|
|
1072
|
+
UpdatedAt?: Date | undefined;
|
|
1073
|
+
/**
|
|
1074
|
+
* <p>The current revision number of the benefit application.</p>
|
|
1075
|
+
* @public
|
|
1076
|
+
*/
|
|
1077
|
+
Revision?: string | undefined;
|
|
1078
|
+
/**
|
|
1079
|
+
* <p>AWS resources that are associated with this benefit application.</p>
|
|
1080
|
+
* @public
|
|
1081
|
+
*/
|
|
1082
|
+
AssociatedResources?: string[] | undefined;
|
|
1083
|
+
/**
|
|
1084
|
+
* <p>Contact information for partner representatives responsible for this benefit application.</p>
|
|
1085
|
+
* @public
|
|
1086
|
+
*/
|
|
1087
|
+
PartnerContacts?: Contact[] | undefined;
|
|
1088
|
+
/**
|
|
1089
|
+
* <p>Supporting documents and files attached to the benefit application.</p>
|
|
1090
|
+
* @public
|
|
1091
|
+
*/
|
|
1092
|
+
FileDetails?: FileDetail[] | undefined;
|
|
1093
|
+
}
|
|
1094
|
+
/**
|
|
1095
|
+
* @public
|
|
1096
|
+
*/
|
|
1097
|
+
export interface ListBenefitAllocationsInput {
|
|
1098
|
+
/**
|
|
1099
|
+
* <p>The catalog identifier to filter benefit allocations by catalog.</p>
|
|
1100
|
+
* @public
|
|
1101
|
+
*/
|
|
1102
|
+
Catalog: string | undefined;
|
|
1103
|
+
/**
|
|
1104
|
+
* <p>Filter benefit allocations by specific fulfillment types.</p>
|
|
1105
|
+
* @public
|
|
1106
|
+
*/
|
|
1107
|
+
FulfillmentTypes?: FulfillmentType[] | undefined;
|
|
1108
|
+
/**
|
|
1109
|
+
* <p>Filter benefit allocations by specific benefit identifiers.</p>
|
|
1110
|
+
* @public
|
|
1111
|
+
*/
|
|
1112
|
+
BenefitIdentifiers?: string[] | undefined;
|
|
1113
|
+
/**
|
|
1114
|
+
* <p>Filter benefit allocations by specific benefit application identifiers.</p>
|
|
1115
|
+
* @public
|
|
1116
|
+
*/
|
|
1117
|
+
BenefitApplicationIdentifiers?: string[] | undefined;
|
|
1118
|
+
/**
|
|
1119
|
+
* <p>Filter benefit allocations by their current status.</p>
|
|
1120
|
+
* @public
|
|
1121
|
+
*/
|
|
1122
|
+
Status?: BenefitAllocationStatus[] | undefined;
|
|
1123
|
+
/**
|
|
1124
|
+
* <p>The maximum number of benefit allocations to return in a single response.</p>
|
|
1125
|
+
* @public
|
|
1126
|
+
*/
|
|
1127
|
+
MaxResults?: number | undefined;
|
|
1128
|
+
/**
|
|
1129
|
+
* <p>A pagination token to retrieve the next set of results from a previous request.</p>
|
|
1130
|
+
* @public
|
|
1131
|
+
*/
|
|
1132
|
+
NextToken?: string | undefined;
|
|
1133
|
+
}
|
|
1134
|
+
/**
|
|
1135
|
+
* @public
|
|
1136
|
+
*/
|
|
1137
|
+
export interface ListBenefitAllocationsOutput {
|
|
1138
|
+
/**
|
|
1139
|
+
* <p>A list of benefit allocation summaries matching the specified criteria.</p>
|
|
1140
|
+
* @public
|
|
1141
|
+
*/
|
|
1142
|
+
BenefitAllocationSummaries?: BenefitAllocationSummary[] | undefined;
|
|
1143
|
+
/**
|
|
1144
|
+
* <p>A pagination token to retrieve the next set of results, if more results are available.</p>
|
|
1145
|
+
* @public
|
|
1146
|
+
*/
|
|
1147
|
+
NextToken?: string | undefined;
|
|
1148
|
+
}
|
|
1149
|
+
/**
|
|
1150
|
+
* @public
|
|
1151
|
+
*/
|
|
1152
|
+
export interface ListBenefitApplicationsInput {
|
|
1153
|
+
/**
|
|
1154
|
+
* <p>The catalog identifier to filter benefit applications by catalog.</p>
|
|
1155
|
+
* @public
|
|
1156
|
+
*/
|
|
1157
|
+
Catalog: string | undefined;
|
|
1158
|
+
/**
|
|
1159
|
+
* <p>Filter benefit applications by specific AWS partner programs.</p>
|
|
1160
|
+
* @public
|
|
1161
|
+
*/
|
|
1162
|
+
Programs?: string[] | undefined;
|
|
1163
|
+
/**
|
|
1164
|
+
* <p>Filter benefit applications by specific fulfillment types.</p>
|
|
1165
|
+
* @public
|
|
1166
|
+
*/
|
|
1167
|
+
FulfillmentTypes?: FulfillmentType[] | undefined;
|
|
1168
|
+
/**
|
|
1169
|
+
* <p>Filter benefit applications by specific benefit identifiers.</p>
|
|
1170
|
+
* @public
|
|
1171
|
+
*/
|
|
1172
|
+
BenefitIdentifiers?: string[] | undefined;
|
|
1173
|
+
/**
|
|
1174
|
+
* <p>Filter benefit applications by their current processing status.</p>
|
|
1175
|
+
* @public
|
|
1176
|
+
*/
|
|
1177
|
+
Status?: BenefitApplicationStatus[] | undefined;
|
|
1178
|
+
/**
|
|
1179
|
+
* <p>Filter benefit applications by their current processing stage.</p>
|
|
1180
|
+
* @public
|
|
1181
|
+
*/
|
|
1182
|
+
Stages?: string[] | undefined;
|
|
1183
|
+
/**
|
|
1184
|
+
* <p>Filter benefit applications by associated AWS resources.</p>
|
|
1185
|
+
*
|
|
1186
|
+
* @deprecated This field is no longer used.
|
|
1187
|
+
* @public
|
|
1188
|
+
*/
|
|
1189
|
+
AssociatedResources?: AssociatedResource[] | undefined;
|
|
1190
|
+
/**
|
|
1191
|
+
* <p>Filter benefit applications by specific AWS resource ARNs.</p>
|
|
1192
|
+
* @public
|
|
1193
|
+
*/
|
|
1194
|
+
AssociatedResourceArns?: string[] | undefined;
|
|
1195
|
+
/**
|
|
1196
|
+
* <p>The maximum number of benefit applications to return in a single response.</p>
|
|
1197
|
+
* @public
|
|
1198
|
+
*/
|
|
1199
|
+
MaxResults?: number | undefined;
|
|
1200
|
+
/**
|
|
1201
|
+
* <p>A pagination token to retrieve the next set of results from a previous request.</p>
|
|
1202
|
+
* @public
|
|
1203
|
+
*/
|
|
1204
|
+
NextToken?: string | undefined;
|
|
1205
|
+
}
|
|
1206
|
+
/**
|
|
1207
|
+
* @public
|
|
1208
|
+
*/
|
|
1209
|
+
export interface ListBenefitApplicationsOutput {
|
|
1210
|
+
/**
|
|
1211
|
+
* <p>A list of benefit application summaries matching the specified criteria.</p>
|
|
1212
|
+
* @public
|
|
1213
|
+
*/
|
|
1214
|
+
BenefitApplicationSummaries?: BenefitApplicationSummary[] | undefined;
|
|
1215
|
+
/**
|
|
1216
|
+
* <p>A pagination token to retrieve the next set of results, if more results are available.</p>
|
|
1217
|
+
* @public
|
|
1218
|
+
*/
|
|
1219
|
+
NextToken?: string | undefined;
|
|
1220
|
+
}
|
|
1221
|
+
/**
|
|
1222
|
+
* @public
|
|
1223
|
+
*/
|
|
1224
|
+
export interface ListBenefitsInput {
|
|
1225
|
+
/**
|
|
1226
|
+
* <p>The catalog identifier to filter benefits by catalog.</p>
|
|
1227
|
+
* @public
|
|
1228
|
+
*/
|
|
1229
|
+
Catalog: string | undefined;
|
|
1230
|
+
/**
|
|
1231
|
+
* <p>Filter benefits by specific AWS partner programs.</p>
|
|
1232
|
+
* @public
|
|
1233
|
+
*/
|
|
1234
|
+
Programs?: string[] | undefined;
|
|
1235
|
+
/**
|
|
1236
|
+
* <p>Filter benefits by specific fulfillment types.</p>
|
|
1237
|
+
* @public
|
|
1238
|
+
*/
|
|
1239
|
+
FulfillmentTypes?: FulfillmentType[] | undefined;
|
|
1240
|
+
/**
|
|
1241
|
+
* <p>Filter benefits by their current status.</p>
|
|
1242
|
+
* @public
|
|
1243
|
+
*/
|
|
1244
|
+
Status?: BenefitStatus[] | undefined;
|
|
1245
|
+
/**
|
|
1246
|
+
* <p>The maximum number of benefits to return in a single response.</p>
|
|
1247
|
+
* @public
|
|
1248
|
+
*/
|
|
1249
|
+
MaxResults?: number | undefined;
|
|
1250
|
+
/**
|
|
1251
|
+
* <p>A pagination token to retrieve the next set of results from a previous request.</p>
|
|
1252
|
+
* @public
|
|
1253
|
+
*/
|
|
1254
|
+
NextToken?: string | undefined;
|
|
1255
|
+
}
|
|
1256
|
+
/**
|
|
1257
|
+
* @public
|
|
1258
|
+
*/
|
|
1259
|
+
export interface ListBenefitsOutput {
|
|
1260
|
+
/**
|
|
1261
|
+
* <p>A list of benefit summaries matching the specified criteria.</p>
|
|
1262
|
+
* @public
|
|
1263
|
+
*/
|
|
1264
|
+
BenefitSummaries?: BenefitSummary[] | undefined;
|
|
1265
|
+
/**
|
|
1266
|
+
* <p>A pagination token to retrieve the next set of results, if more results are available.</p>
|
|
1267
|
+
* @public
|
|
1268
|
+
*/
|
|
1269
|
+
NextToken?: string | undefined;
|
|
1270
|
+
}
|
|
1271
|
+
/**
|
|
1272
|
+
* @public
|
|
1273
|
+
*/
|
|
1274
|
+
export interface ListTagsForResourceRequest {
|
|
1275
|
+
/**
|
|
1276
|
+
* <p>The Amazon Resource Name (ARN) of the resource to list tags for.</p>
|
|
1277
|
+
* @public
|
|
1278
|
+
*/
|
|
1279
|
+
resourceArn: string | undefined;
|
|
1280
|
+
}
|
|
1281
|
+
/**
|
|
1282
|
+
* @public
|
|
1283
|
+
*/
|
|
1284
|
+
export interface ListTagsForResourceResponse {
|
|
1285
|
+
/**
|
|
1286
|
+
* <p>A list of key-value pairs representing the tags associated with the resource.</p>
|
|
1287
|
+
* @public
|
|
1288
|
+
*/
|
|
1289
|
+
tags?: Tag[] | undefined;
|
|
1290
|
+
}
|
|
1291
|
+
/**
|
|
1292
|
+
* @public
|
|
1293
|
+
*/
|
|
1294
|
+
export interface RecallBenefitApplicationInput {
|
|
1295
|
+
/**
|
|
1296
|
+
* <p>The catalog identifier that specifies which benefit catalog the application belongs to.</p>
|
|
1297
|
+
* @public
|
|
1298
|
+
*/
|
|
1299
|
+
Catalog: string | undefined;
|
|
1300
|
+
/**
|
|
1301
|
+
* <p>A unique, case-sensitive identifier to ensure idempotent processing of the recall request.</p>
|
|
1302
|
+
* @public
|
|
1303
|
+
*/
|
|
1304
|
+
ClientToken?: string | undefined;
|
|
1305
|
+
/**
|
|
1306
|
+
* <p>The unique identifier of the benefit application to recall.</p>
|
|
1307
|
+
* @public
|
|
1308
|
+
*/
|
|
1309
|
+
Identifier: string | undefined;
|
|
1310
|
+
/**
|
|
1311
|
+
* <p>A descriptive reason explaining why the benefit application is being recalled.</p>
|
|
1312
|
+
* @public
|
|
1313
|
+
*/
|
|
1314
|
+
Reason: string | undefined;
|
|
1315
|
+
}
|
|
1316
|
+
/**
|
|
1317
|
+
* @public
|
|
1318
|
+
*/
|
|
1319
|
+
export interface RecallBenefitApplicationOutput {
|
|
1320
|
+
}
|
|
1321
|
+
/**
|
|
1322
|
+
* @public
|
|
1323
|
+
*/
|
|
1324
|
+
export interface SubmitBenefitApplicationInput {
|
|
1325
|
+
/**
|
|
1326
|
+
* <p>The catalog identifier that specifies which benefit catalog the application belongs to.</p>
|
|
1327
|
+
* @public
|
|
1328
|
+
*/
|
|
1329
|
+
Catalog: string | undefined;
|
|
1330
|
+
/**
|
|
1331
|
+
* <p>The unique identifier of the benefit application to submit.</p>
|
|
1332
|
+
* @public
|
|
1333
|
+
*/
|
|
1334
|
+
Identifier: string | undefined;
|
|
1335
|
+
}
|
|
1336
|
+
/**
|
|
1337
|
+
* @public
|
|
1338
|
+
*/
|
|
1339
|
+
export interface SubmitBenefitApplicationOutput {
|
|
1340
|
+
}
|
|
1341
|
+
/**
|
|
1342
|
+
* @public
|
|
1343
|
+
*/
|
|
1344
|
+
export interface TagResourceRequest {
|
|
1345
|
+
/**
|
|
1346
|
+
* <p>The Amazon Resource Name (ARN) of the resource to add tags to.</p>
|
|
1347
|
+
* @public
|
|
1348
|
+
*/
|
|
1349
|
+
resourceArn: string | undefined;
|
|
1350
|
+
/**
|
|
1351
|
+
* <p>A list of key-value pairs to add as tags to the resource.</p>
|
|
1352
|
+
* @public
|
|
1353
|
+
*/
|
|
1354
|
+
tags: Tag[] | undefined;
|
|
1355
|
+
}
|
|
1356
|
+
/**
|
|
1357
|
+
* @public
|
|
1358
|
+
*/
|
|
1359
|
+
export interface TagResourceResponse {
|
|
1360
|
+
}
|
|
1361
|
+
/**
|
|
1362
|
+
* @public
|
|
1363
|
+
*/
|
|
1364
|
+
export interface UntagResourceRequest {
|
|
1365
|
+
/**
|
|
1366
|
+
* <p>The Amazon Resource Name (ARN) of the resource to remove tags from.</p>
|
|
1367
|
+
* @public
|
|
1368
|
+
*/
|
|
1369
|
+
resourceArn: string | undefined;
|
|
1370
|
+
/**
|
|
1371
|
+
* <p>A list of tag keys to remove from the resource.</p>
|
|
1372
|
+
* @public
|
|
1373
|
+
*/
|
|
1374
|
+
tagKeys: string[] | undefined;
|
|
1375
|
+
}
|
|
1376
|
+
/**
|
|
1377
|
+
* @public
|
|
1378
|
+
*/
|
|
1379
|
+
export interface UntagResourceResponse {
|
|
1380
|
+
}
|
|
1381
|
+
/**
|
|
1382
|
+
* @public
|
|
1383
|
+
*/
|
|
1384
|
+
export interface UpdateBenefitApplicationInput {
|
|
1385
|
+
/**
|
|
1386
|
+
* <p>The catalog identifier that specifies which benefit catalog the application belongs to.</p>
|
|
1387
|
+
* @public
|
|
1388
|
+
*/
|
|
1389
|
+
Catalog: string | undefined;
|
|
1390
|
+
/**
|
|
1391
|
+
* <p>A unique, case-sensitive identifier to ensure idempotent processing of the update request.</p>
|
|
1392
|
+
* @public
|
|
1393
|
+
*/
|
|
1394
|
+
ClientToken: string | undefined;
|
|
1395
|
+
/**
|
|
1396
|
+
* <p>The updated human-readable name for the benefit application.</p>
|
|
1397
|
+
* @public
|
|
1398
|
+
*/
|
|
1399
|
+
Name?: string | undefined;
|
|
1400
|
+
/**
|
|
1401
|
+
* <p>The updated detailed description of the benefit application.</p>
|
|
1402
|
+
* @public
|
|
1403
|
+
*/
|
|
1404
|
+
Description?: string | undefined;
|
|
1405
|
+
/**
|
|
1406
|
+
* <p>The unique identifier of the benefit application to update.</p>
|
|
1407
|
+
* @public
|
|
1408
|
+
*/
|
|
1409
|
+
Identifier: string | undefined;
|
|
1410
|
+
/**
|
|
1411
|
+
* <p>The current revision number of the benefit application to ensure optimistic concurrency control.</p>
|
|
1412
|
+
* @public
|
|
1413
|
+
*/
|
|
1414
|
+
Revision: string | undefined;
|
|
1415
|
+
/**
|
|
1416
|
+
* <p>Updated detailed information and requirements specific to the benefit being requested.</p>
|
|
1417
|
+
* @public
|
|
1418
|
+
*/
|
|
1419
|
+
BenefitApplicationDetails?: __DocumentType | undefined;
|
|
1420
|
+
/**
|
|
1421
|
+
* <p>Updated contact information for partner representatives responsible for this benefit application.</p>
|
|
1422
|
+
* @public
|
|
1423
|
+
*/
|
|
1424
|
+
PartnerContacts?: Contact[] | undefined;
|
|
1425
|
+
/**
|
|
1426
|
+
* <p>Updated supporting documents and files attached to the benefit application.</p>
|
|
1427
|
+
* @public
|
|
1428
|
+
*/
|
|
1429
|
+
FileDetails?: FileInput[] | undefined;
|
|
1430
|
+
}
|
|
1431
|
+
/**
|
|
1432
|
+
* @public
|
|
1433
|
+
*/
|
|
1434
|
+
export interface UpdateBenefitApplicationOutput {
|
|
1435
|
+
/**
|
|
1436
|
+
* <p>The unique identifier of the updated benefit application.</p>
|
|
1437
|
+
* @public
|
|
1438
|
+
*/
|
|
1439
|
+
Id?: string | undefined;
|
|
1440
|
+
/**
|
|
1441
|
+
* <p>The Amazon Resource Name (ARN) of the updated benefit application.</p>
|
|
1442
|
+
* @public
|
|
1443
|
+
*/
|
|
1444
|
+
Arn?: string | undefined;
|
|
1445
|
+
/**
|
|
1446
|
+
* <p>The new revision number of the benefit application after the update.</p>
|
|
1447
|
+
* @public
|
|
1448
|
+
*/
|
|
1449
|
+
Revision?: string | undefined;
|
|
1450
|
+
}
|