@aws-sdk/client-support 3.529.1 → 3.535.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/dist-types/Support.d.ts +5 -1
- package/dist-types/SupportClient.d.ts +1 -1
- package/dist-types/commands/AddAttachmentsToSetCommand.d.ts +3 -2
- package/dist-types/commands/AddCommunicationToCaseCommand.d.ts +2 -1
- package/dist-types/commands/CreateCaseCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAttachmentCommand.d.ts +3 -2
- package/dist-types/commands/DescribeCasesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeCommunicationsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeCreateCaseOptionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeServicesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeSeverityLevelsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeSupportedLanguagesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTrustedAdvisorCheckRefreshStatusesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTrustedAdvisorCheckResultCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTrustedAdvisorCheckSummariesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTrustedAdvisorChecksCommand.d.ts +2 -1
- package/dist-types/commands/RefreshTrustedAdvisorCheckCommand.d.ts +2 -1
- package/dist-types/commands/ResolveCaseCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +186 -186
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/Support.d.ts +4 -0
- package/dist-types/ts3.4/commands/AddAttachmentsToSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AddCommunicationToCaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateCaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAttachmentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeCasesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeCommunicationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeCreateCaseOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeServicesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeSeverityLevelsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeSupportedLanguagesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeTrustedAdvisorCheckRefreshStatusesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeTrustedAdvisorCheckResultCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeTrustedAdvisorCheckSummariesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeTrustedAdvisorChecksCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RefreshTrustedAdvisorCheckCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ResolveCaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { SupportServiceException as __BaseException } from "./SupportServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>An attachment to a case communication. The attachment consists of the file name and
|
|
6
5
|
* the content of the file.</p>
|
|
6
|
+
* @public
|
|
7
7
|
*/
|
|
8
8
|
export interface Attachment {
|
|
9
9
|
/**
|
|
10
|
-
* @public
|
|
11
10
|
* <p>The name of the attachment file.</p>
|
|
11
|
+
* @public
|
|
12
12
|
*/
|
|
13
13
|
fileName?: string;
|
|
14
14
|
/**
|
|
15
|
-
* @public
|
|
16
15
|
* <p>The content of the attachment file.</p>
|
|
16
|
+
* @public
|
|
17
17
|
*/
|
|
18
18
|
data?: Uint8Array;
|
|
19
19
|
}
|
|
@@ -22,15 +22,14 @@ export interface Attachment {
|
|
|
22
22
|
*/
|
|
23
23
|
export interface AddAttachmentsToSetRequest {
|
|
24
24
|
/**
|
|
25
|
-
* @public
|
|
26
25
|
* <p>The ID of the attachment set. If an <code>attachmentSetId</code> is not specified, a
|
|
27
26
|
* new attachment set is created, and the ID of the set is returned in the response. If an
|
|
28
27
|
* <code>attachmentSetId</code> is specified, the attachments are added to the
|
|
29
28
|
* specified set, if it exists.</p>
|
|
29
|
+
* @public
|
|
30
30
|
*/
|
|
31
31
|
attachmentSetId?: string;
|
|
32
32
|
/**
|
|
33
|
-
* @public
|
|
34
33
|
* <p>One or more attachments to add to the set. You can add up to three attachments per
|
|
35
34
|
* set. The size limit is 5 MB per attachment.</p>
|
|
36
35
|
* <p>In the <code>Attachment</code> object, use the <code>data</code> parameter to specify
|
|
@@ -38,32 +37,33 @@ export interface AddAttachmentsToSetRequest {
|
|
|
38
37
|
* <code>data</code> appear as <code>blob</code>, which is represented as a
|
|
39
38
|
* base64-encoded string. The value for <code>fileName</code> is the name of the
|
|
40
39
|
* attachment, such as <code>troubleshoot-screenshot.png</code>.</p>
|
|
40
|
+
* @public
|
|
41
41
|
*/
|
|
42
42
|
attachments: Attachment[] | undefined;
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
|
-
* @public
|
|
46
45
|
* <p>The ID and expiry time of the attachment set returned by the <a>AddAttachmentsToSet</a> operation.</p>
|
|
46
|
+
* @public
|
|
47
47
|
*/
|
|
48
48
|
export interface AddAttachmentsToSetResponse {
|
|
49
49
|
/**
|
|
50
|
-
* @public
|
|
51
50
|
* <p>The ID of the attachment set. If an <code>attachmentSetId</code> was not specified, a
|
|
52
51
|
* new attachment set is created, and the ID of the set is returned in the response. If an
|
|
53
52
|
* <code>attachmentSetId</code> was specified, the attachments are added to the
|
|
54
53
|
* specified set, if it exists.</p>
|
|
54
|
+
* @public
|
|
55
55
|
*/
|
|
56
56
|
attachmentSetId?: string;
|
|
57
57
|
/**
|
|
58
|
-
* @public
|
|
59
58
|
* <p>The time and date when the attachment set expires.</p>
|
|
59
|
+
* @public
|
|
60
60
|
*/
|
|
61
61
|
expiryTime?: string;
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
-
* @public
|
|
65
64
|
* <p>The limit for the number of attachment sets created in a short period of time has been
|
|
66
65
|
* exceeded.</p>
|
|
66
|
+
* @public
|
|
67
67
|
*/
|
|
68
68
|
export declare class AttachmentLimitExceeded extends __BaseException {
|
|
69
69
|
readonly name: "AttachmentLimitExceeded";
|
|
@@ -74,9 +74,9 @@ export declare class AttachmentLimitExceeded extends __BaseException {
|
|
|
74
74
|
constructor(opts: __ExceptionOptionType<AttachmentLimitExceeded, __BaseException>);
|
|
75
75
|
}
|
|
76
76
|
/**
|
|
77
|
-
* @public
|
|
78
77
|
* <p>The expiration time of the attachment set has passed. The set expires 1 hour after it
|
|
79
78
|
* is created.</p>
|
|
79
|
+
* @public
|
|
80
80
|
*/
|
|
81
81
|
export declare class AttachmentSetExpired extends __BaseException {
|
|
82
82
|
readonly name: "AttachmentSetExpired";
|
|
@@ -87,8 +87,8 @@ export declare class AttachmentSetExpired extends __BaseException {
|
|
|
87
87
|
constructor(opts: __ExceptionOptionType<AttachmentSetExpired, __BaseException>);
|
|
88
88
|
}
|
|
89
89
|
/**
|
|
90
|
-
* @public
|
|
91
90
|
* <p>An attachment set with the specified ID could not be found.</p>
|
|
91
|
+
* @public
|
|
92
92
|
*/
|
|
93
93
|
export declare class AttachmentSetIdNotFound extends __BaseException {
|
|
94
94
|
readonly name: "AttachmentSetIdNotFound";
|
|
@@ -99,9 +99,9 @@ export declare class AttachmentSetIdNotFound extends __BaseException {
|
|
|
99
99
|
constructor(opts: __ExceptionOptionType<AttachmentSetIdNotFound, __BaseException>);
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* @public
|
|
103
102
|
* <p>A limit for the size of an attachment set has been exceeded. The limits are three
|
|
104
103
|
* attachments and 5 MB per attachment.</p>
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
export declare class AttachmentSetSizeLimitExceeded extends __BaseException {
|
|
107
107
|
readonly name: "AttachmentSetSizeLimitExceeded";
|
|
@@ -112,8 +112,8 @@ export declare class AttachmentSetSizeLimitExceeded extends __BaseException {
|
|
|
112
112
|
constructor(opts: __ExceptionOptionType<AttachmentSetSizeLimitExceeded, __BaseException>);
|
|
113
113
|
}
|
|
114
114
|
/**
|
|
115
|
-
* @public
|
|
116
115
|
* <p>An internal server error occurred.</p>
|
|
116
|
+
* @public
|
|
117
117
|
*/
|
|
118
118
|
export declare class InternalServerError extends __BaseException {
|
|
119
119
|
readonly name: "InternalServerError";
|
|
@@ -128,46 +128,46 @@ export declare class InternalServerError extends __BaseException {
|
|
|
128
128
|
*/
|
|
129
129
|
export interface AddCommunicationToCaseRequest {
|
|
130
130
|
/**
|
|
131
|
-
* @public
|
|
132
131
|
* <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
|
|
133
132
|
* string formatted as shown in this example:
|
|
134
133
|
* case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
|
|
135
134
|
* </p>
|
|
135
|
+
* @public
|
|
136
136
|
*/
|
|
137
137
|
caseId?: string;
|
|
138
138
|
/**
|
|
139
|
-
* @public
|
|
140
139
|
* <p>The body of an email communication to add to the support case.</p>
|
|
140
|
+
* @public
|
|
141
141
|
*/
|
|
142
142
|
communicationBody: string | undefined;
|
|
143
143
|
/**
|
|
144
|
-
* @public
|
|
145
144
|
* <p>The email addresses in the CC line of an email to be added to the support case.</p>
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
ccEmailAddresses?: string[];
|
|
148
148
|
/**
|
|
149
|
-
* @public
|
|
150
149
|
* <p>The ID of a set of one or more attachments for the communication to add to the case.
|
|
151
150
|
* Create the set by calling <a>AddAttachmentsToSet</a>
|
|
152
151
|
* </p>
|
|
152
|
+
* @public
|
|
153
153
|
*/
|
|
154
154
|
attachmentSetId?: string;
|
|
155
155
|
}
|
|
156
156
|
/**
|
|
157
|
-
* @public
|
|
158
157
|
* <p>The result of the <a>AddCommunicationToCase</a> operation.</p>
|
|
158
|
+
* @public
|
|
159
159
|
*/
|
|
160
160
|
export interface AddCommunicationToCaseResponse {
|
|
161
161
|
/**
|
|
162
|
-
* @public
|
|
163
162
|
* <p>True if <a>AddCommunicationToCase</a> succeeds. Otherwise, returns an
|
|
164
163
|
* error.</p>
|
|
164
|
+
* @public
|
|
165
165
|
*/
|
|
166
166
|
result?: boolean;
|
|
167
167
|
}
|
|
168
168
|
/**
|
|
169
|
-
* @public
|
|
170
169
|
* <p>The requested <code>caseId</code> couldn't be located.</p>
|
|
170
|
+
* @public
|
|
171
171
|
*/
|
|
172
172
|
export declare class CaseIdNotFound extends __BaseException {
|
|
173
173
|
readonly name: "CaseIdNotFound";
|
|
@@ -178,25 +178,25 @@ export declare class CaseIdNotFound extends __BaseException {
|
|
|
178
178
|
constructor(opts: __ExceptionOptionType<CaseIdNotFound, __BaseException>);
|
|
179
179
|
}
|
|
180
180
|
/**
|
|
181
|
-
* @public
|
|
182
181
|
* <p>The file name and ID of an attachment to a case communication. You can use the ID to
|
|
183
182
|
* retrieve the attachment with the <a>DescribeAttachment</a> operation.</p>
|
|
183
|
+
* @public
|
|
184
184
|
*/
|
|
185
185
|
export interface AttachmentDetails {
|
|
186
186
|
/**
|
|
187
|
-
* @public
|
|
188
187
|
* <p>The ID of the attachment.</p>
|
|
188
|
+
* @public
|
|
189
189
|
*/
|
|
190
190
|
attachmentId?: string;
|
|
191
191
|
/**
|
|
192
|
-
* @public
|
|
193
192
|
* <p>The file name of the attachment.</p>
|
|
193
|
+
* @public
|
|
194
194
|
*/
|
|
195
195
|
fileName?: string;
|
|
196
196
|
}
|
|
197
197
|
/**
|
|
198
|
-
* @public
|
|
199
198
|
* <p>An attachment with the specified ID could not be found.</p>
|
|
199
|
+
* @public
|
|
200
200
|
*/
|
|
201
201
|
export declare class AttachmentIdNotFound extends __BaseException {
|
|
202
202
|
readonly name: "AttachmentIdNotFound";
|
|
@@ -207,8 +207,8 @@ export declare class AttachmentIdNotFound extends __BaseException {
|
|
|
207
207
|
constructor(opts: __ExceptionOptionType<AttachmentIdNotFound, __BaseException>);
|
|
208
208
|
}
|
|
209
209
|
/**
|
|
210
|
-
* @public
|
|
211
210
|
* <p>The case creation limit for the account has been exceeded.</p>
|
|
211
|
+
* @public
|
|
212
212
|
*/
|
|
213
213
|
export declare class CaseCreationLimitExceeded extends __BaseException {
|
|
214
214
|
readonly name: "CaseCreationLimitExceeded";
|
|
@@ -223,18 +223,17 @@ export declare class CaseCreationLimitExceeded extends __BaseException {
|
|
|
223
223
|
*/
|
|
224
224
|
export interface CreateCaseRequest {
|
|
225
225
|
/**
|
|
226
|
-
* @public
|
|
227
226
|
* <p>The title of the support case. The title appears in the <b>Subject</b> field on the Amazon Web Services Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</p>
|
|
227
|
+
* @public
|
|
228
228
|
*/
|
|
229
229
|
subject: string | undefined;
|
|
230
230
|
/**
|
|
231
|
-
* @public
|
|
232
231
|
* <p>The code for the Amazon Web Services service. You can use the <a>DescribeServices</a>
|
|
233
232
|
* operation to get the possible <code>serviceCode</code> values.</p>
|
|
233
|
+
* @public
|
|
234
234
|
*/
|
|
235
235
|
serviceCode?: string;
|
|
236
236
|
/**
|
|
237
|
-
* @public
|
|
238
237
|
* <p>A value that indicates the urgency of the case. This value determines the response
|
|
239
238
|
* time according to your service level agreement with Amazon Web Services Support. You can use the <a>DescribeSeverityLevels</a> operation to get the possible values for
|
|
240
239
|
* <code>severityCode</code>. </p>
|
|
@@ -244,67 +243,68 @@ export interface CreateCaseRequest {
|
|
|
244
243
|
* <p>The availability of severity levels depends on the support plan for the
|
|
245
244
|
* Amazon Web Services account.</p>
|
|
246
245
|
* </note>
|
|
246
|
+
* @public
|
|
247
247
|
*/
|
|
248
248
|
severityCode?: string;
|
|
249
249
|
/**
|
|
250
|
-
* @public
|
|
251
250
|
* <p>The category of problem for the support case. You also use the <a>DescribeServices</a> operation to get the category code for a service. Each
|
|
252
251
|
* Amazon Web Services service defines its own set of category codes.</p>
|
|
252
|
+
* @public
|
|
253
253
|
*/
|
|
254
254
|
categoryCode?: string;
|
|
255
255
|
/**
|
|
256
|
-
* @public
|
|
257
256
|
* <p>The communication body text that describes the issue. This text appears in the
|
|
258
257
|
* <b>Description</b> field on the Amazon Web Services Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</p>
|
|
258
|
+
* @public
|
|
259
259
|
*/
|
|
260
260
|
communicationBody: string | undefined;
|
|
261
261
|
/**
|
|
262
|
-
* @public
|
|
263
262
|
* <p>A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support
|
|
264
263
|
* identifies the account that creates the case when you specify your Amazon Web Services credentials in
|
|
265
264
|
* an HTTP POST method or use the <a href="http://aws.amazon.com/tools/">Amazon Web Services SDKs</a>.
|
|
266
265
|
* </p>
|
|
266
|
+
* @public
|
|
267
267
|
*/
|
|
268
268
|
ccEmailAddresses?: string[];
|
|
269
269
|
/**
|
|
270
|
-
* @public
|
|
271
270
|
* <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
|
|
272
271
|
* currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
|
|
273
272
|
* code for the <code>language</code> parameter if you want support in that language.</p>
|
|
273
|
+
* @public
|
|
274
274
|
*/
|
|
275
275
|
language?: string;
|
|
276
276
|
/**
|
|
277
|
-
* @public
|
|
278
277
|
* <p>The type of issue for the case. You can specify <code>customer-service</code> or
|
|
279
278
|
* <code>technical</code>. If you don't specify a value, the default is
|
|
280
279
|
* <code>technical</code>.</p>
|
|
280
|
+
* @public
|
|
281
281
|
*/
|
|
282
282
|
issueType?: string;
|
|
283
283
|
/**
|
|
284
|
-
* @public
|
|
285
284
|
* <p>The ID of a set of one or more attachments for the case. Create the set by using the
|
|
286
285
|
* <a>AddAttachmentsToSet</a> operation.</p>
|
|
286
|
+
* @public
|
|
287
287
|
*/
|
|
288
288
|
attachmentSetId?: string;
|
|
289
289
|
}
|
|
290
290
|
/**
|
|
291
|
-
* @public
|
|
292
291
|
* <p>The support case ID returned by a successful completion of the <a>CreateCase</a> operation.</p>
|
|
292
|
+
* @public
|
|
293
293
|
*/
|
|
294
294
|
export interface CreateCaseResponse {
|
|
295
295
|
/**
|
|
296
|
-
* @public
|
|
297
296
|
* <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
|
|
298
297
|
* string in the following format:
|
|
299
298
|
* case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
|
|
300
299
|
* </p>
|
|
300
|
+
* @public
|
|
301
301
|
*/
|
|
302
302
|
caseId?: string;
|
|
303
303
|
}
|
|
304
304
|
/**
|
|
305
|
-
* @public
|
|
306
305
|
* <p>The limit for the number of <a>DescribeAttachment</a> requests in a short
|
|
307
306
|
* period of time has been exceeded.</p>
|
|
307
|
+
* @public
|
|
308
308
|
*/
|
|
309
309
|
export declare class DescribeAttachmentLimitExceeded extends __BaseException {
|
|
310
310
|
readonly name: "DescribeAttachmentLimitExceeded";
|
|
@@ -319,23 +319,23 @@ export declare class DescribeAttachmentLimitExceeded extends __BaseException {
|
|
|
319
319
|
*/
|
|
320
320
|
export interface DescribeAttachmentRequest {
|
|
321
321
|
/**
|
|
322
|
-
* @public
|
|
323
322
|
* <p>The ID of the attachment to return. Attachment IDs are returned by the <a>DescribeCommunications</a> operation.</p>
|
|
323
|
+
* @public
|
|
324
324
|
*/
|
|
325
325
|
attachmentId: string | undefined;
|
|
326
326
|
}
|
|
327
327
|
/**
|
|
328
|
-
* @public
|
|
329
328
|
* <p>The content and file name of the attachment returned by the <a>DescribeAttachment</a> operation.</p>
|
|
329
|
+
* @public
|
|
330
330
|
*/
|
|
331
331
|
export interface DescribeAttachmentResponse {
|
|
332
332
|
/**
|
|
333
|
-
* @public
|
|
334
333
|
* <p>This object includes the attachment content and file name.</p>
|
|
335
334
|
* <p>In the previous response syntax, the value for the <code>data</code> parameter appears
|
|
336
335
|
* as <code>blob</code>, which is represented as a base64-encoded string. The value for
|
|
337
336
|
* <code>fileName</code> is the name of the attachment, such as
|
|
338
337
|
* <code>troubleshoot-screenshot.png</code>.</p>
|
|
338
|
+
* @public
|
|
339
339
|
*/
|
|
340
340
|
attachment?: Attachment;
|
|
341
341
|
}
|
|
@@ -344,116 +344,115 @@ export interface DescribeAttachmentResponse {
|
|
|
344
344
|
*/
|
|
345
345
|
export interface DescribeCasesRequest {
|
|
346
346
|
/**
|
|
347
|
-
* @public
|
|
348
347
|
* <p>A list of ID numbers of the support cases you want returned. The maximum number of
|
|
349
348
|
* cases is 100.</p>
|
|
349
|
+
* @public
|
|
350
350
|
*/
|
|
351
351
|
caseIdList?: string[];
|
|
352
352
|
/**
|
|
353
|
-
* @public
|
|
354
353
|
* <p>The ID displayed for a case in the Amazon Web Services Support Center user interface.</p>
|
|
354
|
+
* @public
|
|
355
355
|
*/
|
|
356
356
|
displayId?: string;
|
|
357
357
|
/**
|
|
358
|
-
* @public
|
|
359
358
|
* <p>The start date for a filtered date search on support case communications. Case
|
|
360
359
|
* communications are available for 12 months after creation.</p>
|
|
360
|
+
* @public
|
|
361
361
|
*/
|
|
362
362
|
afterTime?: string;
|
|
363
363
|
/**
|
|
364
|
-
* @public
|
|
365
364
|
* <p>The end date for a filtered date search on support case communications. Case
|
|
366
365
|
* communications are available for 12 months after creation.</p>
|
|
366
|
+
* @public
|
|
367
367
|
*/
|
|
368
368
|
beforeTime?: string;
|
|
369
369
|
/**
|
|
370
|
-
* @public
|
|
371
370
|
* <p>Specifies whether to include resolved support cases in the <code>DescribeCases</code>
|
|
372
371
|
* response. By default, resolved cases aren't included.</p>
|
|
372
|
+
* @public
|
|
373
373
|
*/
|
|
374
374
|
includeResolvedCases?: boolean;
|
|
375
375
|
/**
|
|
376
|
-
* @public
|
|
377
376
|
* <p>A resumption point for pagination.</p>
|
|
377
|
+
* @public
|
|
378
378
|
*/
|
|
379
379
|
nextToken?: string;
|
|
380
380
|
/**
|
|
381
|
-
* @public
|
|
382
381
|
* <p>The maximum number of results to return before paginating.</p>
|
|
382
|
+
* @public
|
|
383
383
|
*/
|
|
384
384
|
maxResults?: number;
|
|
385
385
|
/**
|
|
386
|
-
* @public
|
|
387
386
|
* <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
|
|
388
387
|
* currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
|
|
389
388
|
* code for the <code>language</code> parameter if you want support in that language.</p>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
language?: string;
|
|
392
392
|
/**
|
|
393
|
-
* @public
|
|
394
393
|
* <p>Specifies whether to include communications in the <code>DescribeCases</code>
|
|
395
394
|
* response. By default, communications are included.</p>
|
|
395
|
+
* @public
|
|
396
396
|
*/
|
|
397
397
|
includeCommunications?: boolean;
|
|
398
398
|
}
|
|
399
399
|
/**
|
|
400
|
-
* @public
|
|
401
400
|
* <p>A communication associated with a support case. The communication consists of the case
|
|
402
401
|
* ID, the message body, attachment information, the submitter of the communication, and
|
|
403
402
|
* the date and time of the communication.</p>
|
|
403
|
+
* @public
|
|
404
404
|
*/
|
|
405
405
|
export interface Communication {
|
|
406
406
|
/**
|
|
407
|
-
* @public
|
|
408
407
|
* <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
|
|
409
408
|
* string formatted as shown in this example:
|
|
410
409
|
* case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
|
|
411
410
|
* </p>
|
|
411
|
+
* @public
|
|
412
412
|
*/
|
|
413
413
|
caseId?: string;
|
|
414
414
|
/**
|
|
415
|
-
* @public
|
|
416
415
|
* <p>The text of the communication between the customer and Amazon Web Services Support.</p>
|
|
416
|
+
* @public
|
|
417
417
|
*/
|
|
418
418
|
body?: string;
|
|
419
419
|
/**
|
|
420
|
-
* @public
|
|
421
420
|
* <p>The identity of the account that submitted, or responded to, the support case.
|
|
422
421
|
* Customer entries include the IAM role as well as the email address (for example,
|
|
423
422
|
* "AdminRole (Role) <janedoe@example.com>). Entries from the Amazon Web Services Support team display
|
|
424
423
|
* "Amazon Web Services," and don't show an email address.
|
|
425
424
|
* </p>
|
|
425
|
+
* @public
|
|
426
426
|
*/
|
|
427
427
|
submittedBy?: string;
|
|
428
428
|
/**
|
|
429
|
-
* @public
|
|
430
429
|
* <p>The time the communication was created.</p>
|
|
430
|
+
* @public
|
|
431
431
|
*/
|
|
432
432
|
timeCreated?: string;
|
|
433
433
|
/**
|
|
434
|
-
* @public
|
|
435
434
|
* <p>Information about the attachments to the case communication.</p>
|
|
435
|
+
* @public
|
|
436
436
|
*/
|
|
437
437
|
attachmentSet?: AttachmentDetails[];
|
|
438
438
|
}
|
|
439
439
|
/**
|
|
440
|
-
* @public
|
|
441
440
|
* <p>The five most recent communications associated with the case.</p>
|
|
441
|
+
* @public
|
|
442
442
|
*/
|
|
443
443
|
export interface RecentCaseCommunications {
|
|
444
444
|
/**
|
|
445
|
-
* @public
|
|
446
445
|
* <p>The five most recent communications associated with the case.</p>
|
|
446
|
+
* @public
|
|
447
447
|
*/
|
|
448
448
|
communications?: Communication[];
|
|
449
449
|
/**
|
|
450
|
-
* @public
|
|
451
450
|
* <p>A resumption point for pagination.</p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
nextToken?: string;
|
|
454
454
|
}
|
|
455
455
|
/**
|
|
456
|
-
* @public
|
|
457
456
|
* <p>A JSON-formatted object that contains the metadata for a support case. It is contained
|
|
458
457
|
* in the response from a <a>DescribeCases</a> request. <b>CaseDetails</b> contains the following fields:</p>
|
|
459
458
|
* <ul>
|
|
@@ -557,29 +556,29 @@ export interface RecentCaseCommunications {
|
|
|
557
556
|
* created, in ISO-8601 format.</p>
|
|
558
557
|
* </li>
|
|
559
558
|
* </ul>
|
|
559
|
+
* @public
|
|
560
560
|
*/
|
|
561
561
|
export interface CaseDetails {
|
|
562
562
|
/**
|
|
563
|
-
* @public
|
|
564
563
|
* <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
|
|
565
564
|
* string formatted as shown in this example:
|
|
566
565
|
* case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
|
|
567
566
|
* </p>
|
|
567
|
+
* @public
|
|
568
568
|
*/
|
|
569
569
|
caseId?: string;
|
|
570
570
|
/**
|
|
571
|
-
* @public
|
|
572
571
|
* <p>The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric
|
|
573
572
|
* string.</p>
|
|
573
|
+
* @public
|
|
574
574
|
*/
|
|
575
575
|
displayId?: string;
|
|
576
576
|
/**
|
|
577
|
-
* @public
|
|
578
577
|
* <p>The subject line for the case in the Amazon Web Services Support Center.</p>
|
|
578
|
+
* @public
|
|
579
579
|
*/
|
|
580
580
|
subject?: string;
|
|
581
581
|
/**
|
|
582
|
-
* @public
|
|
583
582
|
* <p>The status of the case.</p>
|
|
584
583
|
* <p>Valid values:</p>
|
|
585
584
|
* <ul>
|
|
@@ -614,69 +613,70 @@ export interface CaseDetails {
|
|
|
614
613
|
* </p>
|
|
615
614
|
* </li>
|
|
616
615
|
* </ul>
|
|
616
|
+
* @public
|
|
617
617
|
*/
|
|
618
618
|
status?: string;
|
|
619
619
|
/**
|
|
620
|
-
* @public
|
|
621
620
|
* <p>The code for the Amazon Web Services service. You can get a list of codes and the corresponding
|
|
622
621
|
* service names by calling <a>DescribeServices</a>.</p>
|
|
622
|
+
* @public
|
|
623
623
|
*/
|
|
624
624
|
serviceCode?: string;
|
|
625
625
|
/**
|
|
626
|
-
* @public
|
|
627
626
|
* <p>The category of problem for the support case.</p>
|
|
627
|
+
* @public
|
|
628
628
|
*/
|
|
629
629
|
categoryCode?: string;
|
|
630
630
|
/**
|
|
631
|
-
* @public
|
|
632
631
|
* <p>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</p>
|
|
632
|
+
* @public
|
|
633
633
|
*/
|
|
634
634
|
severityCode?: string;
|
|
635
635
|
/**
|
|
636
|
-
* @public
|
|
637
636
|
* <p>The email address of the account that submitted the case.</p>
|
|
637
|
+
* @public
|
|
638
638
|
*/
|
|
639
639
|
submittedBy?: string;
|
|
640
640
|
/**
|
|
641
|
-
* @public
|
|
642
641
|
* <p>The time that the case was created in the Amazon Web Services Support Center.</p>
|
|
642
|
+
* @public
|
|
643
643
|
*/
|
|
644
644
|
timeCreated?: string;
|
|
645
645
|
/**
|
|
646
|
-
* @public
|
|
647
646
|
* <p>The five most recent communications between you and Amazon Web Services Support Center, including the
|
|
648
647
|
* IDs of any attachments to the communications. Also includes a <code>nextToken</code>
|
|
649
648
|
* that you can use to retrieve earlier communications.</p>
|
|
649
|
+
* @public
|
|
650
650
|
*/
|
|
651
651
|
recentCommunications?: RecentCaseCommunications;
|
|
652
652
|
/**
|
|
653
|
-
* @public
|
|
654
653
|
* <p>The email addresses that receive copies of communication about the case.</p>
|
|
654
|
+
* @public
|
|
655
655
|
*/
|
|
656
656
|
ccEmailAddresses?: string[];
|
|
657
657
|
/**
|
|
658
|
-
* @public
|
|
659
658
|
* <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
|
|
660
659
|
* currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
|
|
661
660
|
* code for the <code>language</code> parameter if you want support in that language.</p>
|
|
661
|
+
* @public
|
|
662
662
|
*/
|
|
663
663
|
language?: string;
|
|
664
664
|
}
|
|
665
665
|
/**
|
|
666
|
-
* @public
|
|
667
666
|
* <p>Returns an array of <a href="https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html">CaseDetails</a>
|
|
668
667
|
* objects and a <code>nextToken</code> that defines a point for pagination in the result
|
|
669
668
|
* set.</p>
|
|
669
|
+
* @public
|
|
670
670
|
*/
|
|
671
671
|
export interface DescribeCasesResponse {
|
|
672
672
|
/**
|
|
673
|
-
* @public
|
|
674
673
|
* <p>The details for the cases that match the request.</p>
|
|
674
|
+
* @public
|
|
675
675
|
*/
|
|
676
676
|
cases?: CaseDetails[];
|
|
677
677
|
/**
|
|
678
|
-
* @public
|
|
679
678
|
* <p>A resumption point for pagination.</p>
|
|
679
|
+
* @public
|
|
680
680
|
*/
|
|
681
681
|
nextToken?: string;
|
|
682
682
|
}
|
|
@@ -685,50 +685,50 @@ export interface DescribeCasesResponse {
|
|
|
685
685
|
*/
|
|
686
686
|
export interface DescribeCommunicationsRequest {
|
|
687
687
|
/**
|
|
688
|
-
* @public
|
|
689
688
|
* <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
|
|
690
689
|
* string formatted as shown in this example:
|
|
691
690
|
* case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
|
|
692
691
|
* </p>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
caseId: string | undefined;
|
|
695
695
|
/**
|
|
696
|
-
* @public
|
|
697
696
|
* <p>The end date for a filtered date search on support case communications. Case
|
|
698
697
|
* communications are available for 12 months after creation.</p>
|
|
698
|
+
* @public
|
|
699
699
|
*/
|
|
700
700
|
beforeTime?: string;
|
|
701
701
|
/**
|
|
702
|
-
* @public
|
|
703
702
|
* <p>The start date for a filtered date search on support case communications. Case
|
|
704
703
|
* communications are available for 12 months after creation.</p>
|
|
704
|
+
* @public
|
|
705
705
|
*/
|
|
706
706
|
afterTime?: string;
|
|
707
707
|
/**
|
|
708
|
-
* @public
|
|
709
708
|
* <p>A resumption point for pagination.</p>
|
|
709
|
+
* @public
|
|
710
710
|
*/
|
|
711
711
|
nextToken?: string;
|
|
712
712
|
/**
|
|
713
|
-
* @public
|
|
714
713
|
* <p>The maximum number of results to return before paginating.</p>
|
|
714
|
+
* @public
|
|
715
715
|
*/
|
|
716
716
|
maxResults?: number;
|
|
717
717
|
}
|
|
718
718
|
/**
|
|
719
|
-
* @public
|
|
720
719
|
* <p>The communications returned by the <a>DescribeCommunications</a>
|
|
721
720
|
* operation.</p>
|
|
721
|
+
* @public
|
|
722
722
|
*/
|
|
723
723
|
export interface DescribeCommunicationsResponse {
|
|
724
724
|
/**
|
|
725
|
-
* @public
|
|
726
725
|
* <p>The communications for the case.</p>
|
|
726
|
+
* @public
|
|
727
727
|
*/
|
|
728
728
|
communications?: Communication[];
|
|
729
729
|
/**
|
|
730
|
-
* @public
|
|
731
730
|
* <p>A resumption point for pagination.</p>
|
|
731
|
+
* @public
|
|
732
732
|
*/
|
|
733
733
|
nextToken?: string;
|
|
734
734
|
}
|
|
@@ -737,74 +737,73 @@ export interface DescribeCommunicationsResponse {
|
|
|
737
737
|
*/
|
|
738
738
|
export interface DescribeCreateCaseOptionsRequest {
|
|
739
739
|
/**
|
|
740
|
-
* @public
|
|
741
740
|
* <p>The type of issue for the case. You can specify <code>customer-service</code> or
|
|
742
741
|
* <code>technical</code>. If you don't specify a value, the default is
|
|
743
742
|
* <code>technical</code>.</p>
|
|
743
|
+
* @public
|
|
744
744
|
*/
|
|
745
745
|
issueType: string | undefined;
|
|
746
746
|
/**
|
|
747
|
-
* @public
|
|
748
747
|
* <p>The code for the Amazon Web Services service. You can use the <a>DescribeServices</a>
|
|
749
748
|
* operation to get the possible <code>serviceCode</code> values.</p>
|
|
749
|
+
* @public
|
|
750
750
|
*/
|
|
751
751
|
serviceCode: string | undefined;
|
|
752
752
|
/**
|
|
753
|
-
* @public
|
|
754
753
|
* <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
|
|
755
754
|
* currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
|
|
756
755
|
* code for the <code>language</code> parameter if you want support in that language.</p>
|
|
756
|
+
* @public
|
|
757
757
|
*/
|
|
758
758
|
language: string | undefined;
|
|
759
759
|
/**
|
|
760
|
-
* @public
|
|
761
760
|
* <p>The category of problem for the support case. You also use the <a>DescribeServices</a> operation to get the category code for a service. Each
|
|
762
761
|
* Amazon Web Services service defines its own set of category codes.</p>
|
|
762
|
+
* @public
|
|
763
763
|
*/
|
|
764
764
|
categoryCode: string | undefined;
|
|
765
765
|
}
|
|
766
766
|
/**
|
|
767
|
-
* @public
|
|
768
767
|
* <p>Date and time (UTC) format in RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.</p>
|
|
768
|
+
* @public
|
|
769
769
|
*/
|
|
770
770
|
export interface DateInterval {
|
|
771
771
|
/**
|
|
772
|
-
* @public
|
|
773
772
|
* <p>
|
|
774
773
|
* A JSON object containing start and date time (UTC). Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.
|
|
775
774
|
* </p>
|
|
775
|
+
* @public
|
|
776
776
|
*/
|
|
777
777
|
startDateTime?: string;
|
|
778
778
|
/**
|
|
779
|
-
* @public
|
|
780
779
|
* <p>
|
|
781
780
|
* End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.
|
|
782
781
|
* </p>
|
|
782
|
+
* @public
|
|
783
783
|
*/
|
|
784
784
|
endDateTime?: string;
|
|
785
785
|
}
|
|
786
786
|
/**
|
|
787
|
-
* @public
|
|
788
787
|
* <p>Time range object with <code>startTime</code> and <code>endTime</code> range in RFC 3339 format. <code>'HH:mm:ss.SSS'</code>.</p>
|
|
788
|
+
* @public
|
|
789
789
|
*/
|
|
790
790
|
export interface SupportedHour {
|
|
791
791
|
/**
|
|
792
|
-
* @public
|
|
793
792
|
* <p>
|
|
794
793
|
* Start Time. RFC 3339 format <code>'HH:mm:ss.SSS'</code>.
|
|
795
794
|
* </p>
|
|
795
|
+
* @public
|
|
796
796
|
*/
|
|
797
797
|
startTime?: string;
|
|
798
798
|
/**
|
|
799
|
-
* @public
|
|
800
799
|
* <p>
|
|
801
800
|
* End Time. RFC 3339 format <code>'HH:mm:ss.SSS'</code>.
|
|
802
801
|
* </p>
|
|
802
|
+
* @public
|
|
803
803
|
*/
|
|
804
804
|
endTime?: string;
|
|
805
805
|
}
|
|
806
806
|
/**
|
|
807
|
-
* @public
|
|
808
807
|
* <p>A JSON-formatted object that contains the CommunicationTypeOptions for creating a case for a certain
|
|
809
808
|
* communication channel. It is contained in the response from a <a>DescribeCreateCaseOptions</a> request. <b>CommunicationTypeOptions</b> contains the following fields:</p>
|
|
810
809
|
* <ul>
|
|
@@ -831,27 +830,28 @@ export interface SupportedHour {
|
|
|
831
830
|
* </p>
|
|
832
831
|
* </li>
|
|
833
832
|
* </ul>
|
|
833
|
+
* @public
|
|
834
834
|
*/
|
|
835
835
|
export interface CommunicationTypeOptions {
|
|
836
836
|
/**
|
|
837
|
-
* @public
|
|
838
837
|
* <p>
|
|
839
838
|
* A string value indicating the communication type. At the moment the type value can assume one of 3 values at the moment chat, web and call.
|
|
840
839
|
* </p>
|
|
840
|
+
* @public
|
|
841
841
|
*/
|
|
842
842
|
type?: string;
|
|
843
843
|
/**
|
|
844
|
-
* @public
|
|
845
844
|
* <p>
|
|
846
845
|
* A JSON-formatted list containing time ranges when support is available.
|
|
847
846
|
* </p>
|
|
847
|
+
* @public
|
|
848
848
|
*/
|
|
849
849
|
supportedHours?: SupportedHour[];
|
|
850
850
|
/**
|
|
851
|
-
* @public
|
|
852
851
|
* <p>
|
|
853
852
|
* A JSON-formatted list containing date and time ranges for periods without support
|
|
854
853
|
* </p>
|
|
854
|
+
* @public
|
|
855
855
|
*/
|
|
856
856
|
datesWithoutSupport?: DateInterval[];
|
|
857
857
|
}
|
|
@@ -860,7 +860,6 @@ export interface CommunicationTypeOptions {
|
|
|
860
860
|
*/
|
|
861
861
|
export interface DescribeCreateCaseOptionsResponse {
|
|
862
862
|
/**
|
|
863
|
-
* @public
|
|
864
863
|
* <p>Language availability can be any of the following:</p>
|
|
865
864
|
* <ul>
|
|
866
865
|
* <li>
|
|
@@ -879,22 +878,23 @@ export interface DescribeCreateCaseOptionsResponse {
|
|
|
879
878
|
* </p>
|
|
880
879
|
* </li>
|
|
881
880
|
* </ul>
|
|
881
|
+
* @public
|
|
882
882
|
*/
|
|
883
883
|
languageAvailability?: string;
|
|
884
884
|
/**
|
|
885
|
-
* @public
|
|
886
885
|
* <p>
|
|
887
886
|
* A JSON-formatted array that contains the available communication type options, along with the available support
|
|
888
887
|
* timeframes for the given inputs.
|
|
889
888
|
* </p>
|
|
889
|
+
* @public
|
|
890
890
|
*/
|
|
891
891
|
communicationTypes?: CommunicationTypeOptions[];
|
|
892
892
|
}
|
|
893
893
|
/**
|
|
894
|
-
* @public
|
|
895
894
|
* <p>
|
|
896
895
|
* You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
|
|
897
896
|
* </p>
|
|
897
|
+
* @public
|
|
898
898
|
*/
|
|
899
899
|
export declare class ThrottlingException extends __BaseException {
|
|
900
900
|
readonly name: "ThrottlingException";
|
|
@@ -909,71 +909,71 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
909
909
|
*/
|
|
910
910
|
export interface DescribeServicesRequest {
|
|
911
911
|
/**
|
|
912
|
-
* @public
|
|
913
912
|
* <p>A JSON-formatted list of service codes available for Amazon Web Services services.</p>
|
|
913
|
+
* @public
|
|
914
914
|
*/
|
|
915
915
|
serviceCodeList?: string[];
|
|
916
916
|
/**
|
|
917
|
-
* @public
|
|
918
917
|
* <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
|
|
919
918
|
* currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
|
|
920
919
|
* code for the <code>language</code> parameter if you want support in that language.</p>
|
|
920
|
+
* @public
|
|
921
921
|
*/
|
|
922
922
|
language?: string;
|
|
923
923
|
}
|
|
924
924
|
/**
|
|
925
|
-
* @public
|
|
926
925
|
* <p>A JSON-formatted name/value pair that represents the category name and category code
|
|
927
926
|
* of the problem, selected from the <a>DescribeServices</a> response for each
|
|
928
927
|
* Amazon Web Services service.</p>
|
|
928
|
+
* @public
|
|
929
929
|
*/
|
|
930
930
|
export interface Category {
|
|
931
931
|
/**
|
|
932
|
-
* @public
|
|
933
932
|
* <p>The category code for the support case.</p>
|
|
933
|
+
* @public
|
|
934
934
|
*/
|
|
935
935
|
code?: string;
|
|
936
936
|
/**
|
|
937
|
-
* @public
|
|
938
937
|
* <p>The category name for the support case.</p>
|
|
938
|
+
* @public
|
|
939
939
|
*/
|
|
940
940
|
name?: string;
|
|
941
941
|
}
|
|
942
942
|
/**
|
|
943
|
-
* @public
|
|
944
943
|
* <p>Information about an Amazon Web Services service returned by the <a>DescribeServices</a>
|
|
945
944
|
* operation.</p>
|
|
945
|
+
* @public
|
|
946
946
|
*/
|
|
947
947
|
export interface Service {
|
|
948
948
|
/**
|
|
949
|
-
* @public
|
|
950
949
|
* <p>The code for an Amazon Web Services service returned by the <a>DescribeServices</a>
|
|
951
950
|
* response. The <code>name</code> element contains the corresponding friendly name.</p>
|
|
951
|
+
* @public
|
|
952
952
|
*/
|
|
953
953
|
code?: string;
|
|
954
954
|
/**
|
|
955
|
-
* @public
|
|
956
955
|
* <p>The friendly name for an Amazon Web Services service. The <code>code</code> element contains the
|
|
957
956
|
* corresponding code.</p>
|
|
957
|
+
* @public
|
|
958
958
|
*/
|
|
959
959
|
name?: string;
|
|
960
960
|
/**
|
|
961
|
-
* @public
|
|
962
961
|
* <p>A list of categories that describe the type of support issue a case describes.
|
|
963
962
|
* Categories consist of a category name and a category code. Category names and codes are
|
|
964
963
|
* passed to Amazon Web Services Support when you call <a>CreateCase</a>.</p>
|
|
964
|
+
* @public
|
|
965
965
|
*/
|
|
966
966
|
categories?: Category[];
|
|
967
967
|
}
|
|
968
968
|
/**
|
|
969
|
-
* @public
|
|
970
969
|
* <p>The list of Amazon Web Services services returned by the <a>DescribeServices</a>
|
|
971
970
|
* operation.</p>
|
|
971
|
+
* @public
|
|
972
972
|
*/
|
|
973
973
|
export interface DescribeServicesResponse {
|
|
974
974
|
/**
|
|
975
|
-
* @public
|
|
976
975
|
* <p>A JSON-formatted list of Amazon Web Services services.</p>
|
|
976
|
+
* @public
|
|
977
977
|
*/
|
|
978
978
|
services?: Service[];
|
|
979
979
|
}
|
|
@@ -982,31 +982,30 @@ export interface DescribeServicesResponse {
|
|
|
982
982
|
*/
|
|
983
983
|
export interface DescribeSeverityLevelsRequest {
|
|
984
984
|
/**
|
|
985
|
-
* @public
|
|
986
985
|
* <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
|
|
987
986
|
* currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1
|
|
988
987
|
* code for the <code>language</code> parameter if you want support in that language.</p>
|
|
988
|
+
* @public
|
|
989
989
|
*/
|
|
990
990
|
language?: string;
|
|
991
991
|
}
|
|
992
992
|
/**
|
|
993
|
-
* @public
|
|
994
993
|
* <p>A code and name pair that represents the severity level of a support case. The
|
|
995
994
|
* available values depend on the support plan for the account. For more information, see
|
|
996
995
|
* <a href="https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity">Choosing a
|
|
997
996
|
* severity</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
|
|
997
|
+
* @public
|
|
998
998
|
*/
|
|
999
999
|
export interface SeverityLevel {
|
|
1000
1000
|
/**
|
|
1001
|
-
* @public
|
|
1002
1001
|
* <p>The code for case severity level.</p>
|
|
1003
1002
|
* <p>Valid values: <code>low</code> | <code>normal</code> | <code>high</code> |
|
|
1004
1003
|
* <code>urgent</code> | <code>critical</code>
|
|
1005
1004
|
* </p>
|
|
1005
|
+
* @public
|
|
1006
1006
|
*/
|
|
1007
1007
|
code?: string;
|
|
1008
1008
|
/**
|
|
1009
|
-
* @public
|
|
1010
1009
|
* <p>The name of the severity level that corresponds to the severity level code.</p>
|
|
1011
1010
|
* <note>
|
|
1012
1011
|
* <p>The values returned by the API are different from the values that appear in the
|
|
@@ -1038,19 +1037,20 @@ export interface SeverityLevel {
|
|
|
1038
1037
|
* </note>
|
|
1039
1038
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity">Choosing a
|
|
1040
1039
|
* severity</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
|
|
1040
|
+
* @public
|
|
1041
1041
|
*/
|
|
1042
1042
|
name?: string;
|
|
1043
1043
|
}
|
|
1044
1044
|
/**
|
|
1045
|
-
* @public
|
|
1046
1045
|
* <p>The list of severity levels returned by the <a>DescribeSeverityLevels</a>
|
|
1047
1046
|
* operation.</p>
|
|
1047
|
+
* @public
|
|
1048
1048
|
*/
|
|
1049
1049
|
export interface DescribeSeverityLevelsResponse {
|
|
1050
1050
|
/**
|
|
1051
|
-
* @public
|
|
1052
1051
|
* <p>The available severity levels for the support case. Available severity levels are
|
|
1053
1052
|
* defined by your service level agreement with Amazon Web Services.</p>
|
|
1053
|
+
* @public
|
|
1054
1054
|
*/
|
|
1055
1055
|
severityLevels?: SeverityLevel[];
|
|
1056
1056
|
}
|
|
@@ -1059,52 +1059,52 @@ export interface DescribeSeverityLevelsResponse {
|
|
|
1059
1059
|
*/
|
|
1060
1060
|
export interface DescribeSupportedLanguagesRequest {
|
|
1061
1061
|
/**
|
|
1062
|
-
* @public
|
|
1063
1062
|
* <p>The type of issue for the case. You can specify <code>customer-service</code> or
|
|
1064
1063
|
* <code>technical</code>.</p>
|
|
1064
|
+
* @public
|
|
1065
1065
|
*/
|
|
1066
1066
|
issueType: string | undefined;
|
|
1067
1067
|
/**
|
|
1068
|
-
* @public
|
|
1069
1068
|
* <p>The code for the Amazon Web Services service. You can use the <a>DescribeServices</a>
|
|
1070
1069
|
* operation to get the possible <code>serviceCode</code> values.</p>
|
|
1070
|
+
* @public
|
|
1071
1071
|
*/
|
|
1072
1072
|
serviceCode: string | undefined;
|
|
1073
1073
|
/**
|
|
1074
|
-
* @public
|
|
1075
1074
|
* <p>The category of problem for the support case. You also use the <a>DescribeServices</a> operation to get the category code for a service. Each
|
|
1076
1075
|
* Amazon Web Services service defines its own set of category codes.</p>
|
|
1076
|
+
* @public
|
|
1077
1077
|
*/
|
|
1078
1078
|
categoryCode: string | undefined;
|
|
1079
1079
|
}
|
|
1080
1080
|
/**
|
|
1081
|
-
* @public
|
|
1082
1081
|
* <p>
|
|
1083
1082
|
* A JSON-formatted object that contains the available ISO 639-1 language <code>code</code>,
|
|
1084
1083
|
* <code>language</code> name and langauge <code>display</code> value. The language code is what should be used
|
|
1085
1084
|
* in the <a>CreateCase</a> call.
|
|
1086
1085
|
* </p>
|
|
1086
|
+
* @public
|
|
1087
1087
|
*/
|
|
1088
1088
|
export interface SupportedLanguage {
|
|
1089
1089
|
/**
|
|
1090
|
-
* @public
|
|
1091
1090
|
* <p>
|
|
1092
1091
|
* 2 digit ISO 639-1 code. e.g. <code>en</code>
|
|
1093
1092
|
* </p>
|
|
1093
|
+
* @public
|
|
1094
1094
|
*/
|
|
1095
1095
|
code?: string;
|
|
1096
1096
|
/**
|
|
1097
|
-
* @public
|
|
1098
1097
|
* <p>
|
|
1099
1098
|
* Full language description e.g. <code>ENGLISH</code>
|
|
1100
1099
|
* </p>
|
|
1100
|
+
* @public
|
|
1101
1101
|
*/
|
|
1102
1102
|
language?: string;
|
|
1103
1103
|
/**
|
|
1104
|
-
* @public
|
|
1105
1104
|
* <p>
|
|
1106
1105
|
* Language display value e.g. <code>ENGLISH</code>
|
|
1107
1106
|
* </p>
|
|
1107
|
+
* @public
|
|
1108
1108
|
*/
|
|
1109
1109
|
display?: string;
|
|
1110
1110
|
}
|
|
@@ -1113,10 +1113,10 @@ export interface SupportedLanguage {
|
|
|
1113
1113
|
*/
|
|
1114
1114
|
export interface DescribeSupportedLanguagesResponse {
|
|
1115
1115
|
/**
|
|
1116
|
-
* @public
|
|
1117
1116
|
* <p>
|
|
1118
1117
|
* A JSON-formatted array that contains the available ISO 639-1 language codes.
|
|
1119
1118
|
* </p>
|
|
1119
|
+
* @public
|
|
1120
1120
|
*/
|
|
1121
1121
|
supportedLanguages?: SupportedLanguage[];
|
|
1122
1122
|
}
|
|
@@ -1125,27 +1125,26 @@ export interface DescribeSupportedLanguagesResponse {
|
|
|
1125
1125
|
*/
|
|
1126
1126
|
export interface DescribeTrustedAdvisorCheckRefreshStatusesRequest {
|
|
1127
1127
|
/**
|
|
1128
|
-
* @public
|
|
1129
1128
|
* <p>The IDs of the Trusted Advisor checks to get the status.</p>
|
|
1130
1129
|
* <note>
|
|
1131
1130
|
* <p>If you specify the check ID of a check that is automatically refreshed, you might
|
|
1132
1131
|
* see an <code>InvalidParameterValue</code> error.</p>
|
|
1133
1132
|
* </note>
|
|
1133
|
+
* @public
|
|
1134
1134
|
*/
|
|
1135
1135
|
checkIds: string[] | undefined;
|
|
1136
1136
|
}
|
|
1137
1137
|
/**
|
|
1138
|
-
* @public
|
|
1139
1138
|
* <p>The refresh status of a Trusted Advisor check.</p>
|
|
1139
|
+
* @public
|
|
1140
1140
|
*/
|
|
1141
1141
|
export interface TrustedAdvisorCheckRefreshStatus {
|
|
1142
1142
|
/**
|
|
1143
|
-
* @public
|
|
1144
1143
|
* <p>The unique identifier for the Trusted Advisor check.</p>
|
|
1144
|
+
* @public
|
|
1145
1145
|
*/
|
|
1146
1146
|
checkId: string | undefined;
|
|
1147
1147
|
/**
|
|
1148
|
-
* @public
|
|
1149
1148
|
* <p>The status of the Trusted Advisor check for which a refresh has been requested:
|
|
1150
1149
|
* </p>
|
|
1151
1150
|
* <ul>
|
|
@@ -1173,38 +1172,38 @@ export interface TrustedAdvisorCheckRefreshStatus {
|
|
|
1173
1172
|
* <code>abandoned</code> - The check refresh has failed</p>
|
|
1174
1173
|
* </li>
|
|
1175
1174
|
* </ul>
|
|
1175
|
+
* @public
|
|
1176
1176
|
*/
|
|
1177
1177
|
status: string | undefined;
|
|
1178
1178
|
/**
|
|
1179
|
-
* @public
|
|
1180
1179
|
* <p>The amount of time, in milliseconds, until the Trusted Advisor check is eligible for
|
|
1181
1180
|
* refresh.</p>
|
|
1181
|
+
* @public
|
|
1182
1182
|
*/
|
|
1183
1183
|
millisUntilNextRefreshable: number | undefined;
|
|
1184
1184
|
}
|
|
1185
1185
|
/**
|
|
1186
|
-
* @public
|
|
1187
1186
|
* <p>The statuses of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> operation.</p>
|
|
1187
|
+
* @public
|
|
1188
1188
|
*/
|
|
1189
1189
|
export interface DescribeTrustedAdvisorCheckRefreshStatusesResponse {
|
|
1190
1190
|
/**
|
|
1191
|
-
* @public
|
|
1192
1191
|
* <p>The refresh status of the specified Trusted Advisor checks.</p>
|
|
1192
|
+
* @public
|
|
1193
1193
|
*/
|
|
1194
1194
|
statuses: TrustedAdvisorCheckRefreshStatus[] | undefined;
|
|
1195
1195
|
}
|
|
1196
1196
|
/**
|
|
1197
|
-
* @public
|
|
1198
1197
|
* <p></p>
|
|
1198
|
+
* @public
|
|
1199
1199
|
*/
|
|
1200
1200
|
export interface DescribeTrustedAdvisorCheckResultRequest {
|
|
1201
1201
|
/**
|
|
1202
|
-
* @public
|
|
1203
1202
|
* <p>The unique identifier for the Trusted Advisor check.</p>
|
|
1203
|
+
* @public
|
|
1204
1204
|
*/
|
|
1205
1205
|
checkId: string | undefined;
|
|
1206
1206
|
/**
|
|
1207
|
-
* @public
|
|
1208
1207
|
* <p>The ISO 639-1 code for the language that you want your check results to appear
|
|
1209
1208
|
* in.</p>
|
|
1210
1209
|
* <p>The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:</p>
|
|
@@ -1254,150 +1253,151 @@ export interface DescribeTrustedAdvisorCheckResultRequest {
|
|
|
1254
1253
|
* </p>
|
|
1255
1254
|
* </li>
|
|
1256
1255
|
* </ul>
|
|
1256
|
+
* @public
|
|
1257
1257
|
*/
|
|
1258
1258
|
language?: string;
|
|
1259
1259
|
}
|
|
1260
1260
|
/**
|
|
1261
|
-
* @public
|
|
1262
1261
|
* <p>The estimated cost savings that might be realized if the recommended operations are
|
|
1263
1262
|
* taken.</p>
|
|
1263
|
+
* @public
|
|
1264
1264
|
*/
|
|
1265
1265
|
export interface TrustedAdvisorCostOptimizingSummary {
|
|
1266
1266
|
/**
|
|
1267
|
-
* @public
|
|
1268
1267
|
* <p>The estimated monthly savings that might be realized if the recommended operations are
|
|
1269
1268
|
* taken.</p>
|
|
1269
|
+
* @public
|
|
1270
1270
|
*/
|
|
1271
1271
|
estimatedMonthlySavings: number | undefined;
|
|
1272
1272
|
/**
|
|
1273
|
-
* @public
|
|
1274
1273
|
* <p>The estimated percentage of savings that might be realized if the recommended
|
|
1275
1274
|
* operations are taken.</p>
|
|
1275
|
+
* @public
|
|
1276
1276
|
*/
|
|
1277
1277
|
estimatedPercentMonthlySavings: number | undefined;
|
|
1278
1278
|
}
|
|
1279
1279
|
/**
|
|
1280
|
-
* @public
|
|
1281
1280
|
* <p>The container for summary information that relates to the category of the Trusted Advisor
|
|
1282
1281
|
* check.</p>
|
|
1282
|
+
* @public
|
|
1283
1283
|
*/
|
|
1284
1284
|
export interface TrustedAdvisorCategorySpecificSummary {
|
|
1285
1285
|
/**
|
|
1286
|
-
* @public
|
|
1287
1286
|
* <p>The summary information about cost savings for a Trusted Advisor check that is in the Cost
|
|
1288
1287
|
* Optimizing category.</p>
|
|
1288
|
+
* @public
|
|
1289
1289
|
*/
|
|
1290
1290
|
costOptimizing?: TrustedAdvisorCostOptimizingSummary;
|
|
1291
1291
|
}
|
|
1292
1292
|
/**
|
|
1293
|
-
* @public
|
|
1294
1293
|
* <p>Contains information about a resource identified by a Trusted Advisor check.</p>
|
|
1294
|
+
* @public
|
|
1295
1295
|
*/
|
|
1296
1296
|
export interface TrustedAdvisorResourceDetail {
|
|
1297
1297
|
/**
|
|
1298
|
-
* @public
|
|
1299
1298
|
* <p>The status code for the resource identified in the Trusted Advisor check.</p>
|
|
1299
|
+
* @public
|
|
1300
1300
|
*/
|
|
1301
1301
|
status: string | undefined;
|
|
1302
1302
|
/**
|
|
1303
|
-
* @public
|
|
1304
1303
|
* <p>The Amazon Web Services Region in which the identified resource is located.</p>
|
|
1304
|
+
* @public
|
|
1305
1305
|
*/
|
|
1306
1306
|
region?: string;
|
|
1307
1307
|
/**
|
|
1308
|
-
* @public
|
|
1309
1308
|
* <p>The unique identifier for the identified resource.</p>
|
|
1309
|
+
* @public
|
|
1310
1310
|
*/
|
|
1311
1311
|
resourceId: string | undefined;
|
|
1312
1312
|
/**
|
|
1313
|
-
* @public
|
|
1314
1313
|
* <p>Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as
|
|
1315
1314
|
* suppressed by the user.</p>
|
|
1315
|
+
* @public
|
|
1316
1316
|
*/
|
|
1317
1317
|
isSuppressed?: boolean;
|
|
1318
1318
|
/**
|
|
1319
|
-
* @public
|
|
1320
1319
|
* <p>Additional information about the identified resource. The exact metadata and its order
|
|
1321
1320
|
* can be obtained by inspecting the <a>TrustedAdvisorCheckDescription</a>
|
|
1322
1321
|
* object returned by the call to <a>DescribeTrustedAdvisorChecks</a>. <b>Metadata</b> contains all the data that is shown in the Excel
|
|
1323
1322
|
* download, even in those cases where the UI shows just summary data.</p>
|
|
1323
|
+
* @public
|
|
1324
1324
|
*/
|
|
1325
1325
|
metadata: string[] | undefined;
|
|
1326
1326
|
}
|
|
1327
1327
|
/**
|
|
1328
|
-
* @public
|
|
1329
1328
|
* <p>Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>.</p>
|
|
1329
|
+
* @public
|
|
1330
1330
|
*/
|
|
1331
1331
|
export interface TrustedAdvisorResourcesSummary {
|
|
1332
1332
|
/**
|
|
1333
|
-
* @public
|
|
1334
1333
|
* <p>The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.</p>
|
|
1334
|
+
* @public
|
|
1335
1335
|
*/
|
|
1336
1336
|
resourcesProcessed: number | undefined;
|
|
1337
1337
|
/**
|
|
1338
|
-
* @public
|
|
1339
1338
|
* <p>The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.</p>
|
|
1339
|
+
* @public
|
|
1340
1340
|
*/
|
|
1341
1341
|
resourcesFlagged: number | undefined;
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p>The number of Amazon Web Services resources ignored by Trusted Advisor because information was
|
|
1345
1344
|
* unavailable.</p>
|
|
1345
|
+
* @public
|
|
1346
1346
|
*/
|
|
1347
1347
|
resourcesIgnored: number | undefined;
|
|
1348
1348
|
/**
|
|
1349
|
-
* @public
|
|
1350
1349
|
* <p>The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as
|
|
1351
1350
|
* suppressed by the user.</p>
|
|
1351
|
+
* @public
|
|
1352
1352
|
*/
|
|
1353
1353
|
resourcesSuppressed: number | undefined;
|
|
1354
1354
|
}
|
|
1355
1355
|
/**
|
|
1356
|
-
* @public
|
|
1357
1356
|
* <p>The results of a Trusted Advisor check returned by <a>DescribeTrustedAdvisorCheckResult</a>.</p>
|
|
1357
|
+
* @public
|
|
1358
1358
|
*/
|
|
1359
1359
|
export interface TrustedAdvisorCheckResult {
|
|
1360
1360
|
/**
|
|
1361
|
-
* @public
|
|
1362
1361
|
* <p>The unique identifier for the Trusted Advisor check.</p>
|
|
1362
|
+
* @public
|
|
1363
1363
|
*/
|
|
1364
1364
|
checkId: string | undefined;
|
|
1365
1365
|
/**
|
|
1366
|
-
* @public
|
|
1367
1366
|
* <p>The time of the last refresh of the check.</p>
|
|
1367
|
+
* @public
|
|
1368
1368
|
*/
|
|
1369
1369
|
timestamp: string | undefined;
|
|
1370
1370
|
/**
|
|
1371
|
-
* @public
|
|
1372
1371
|
* <p>The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or
|
|
1373
1372
|
* "not_available".</p>
|
|
1373
|
+
* @public
|
|
1374
1374
|
*/
|
|
1375
1375
|
status: string | undefined;
|
|
1376
1376
|
/**
|
|
1377
|
-
* @public
|
|
1378
1377
|
* <p>Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>.</p>
|
|
1378
|
+
* @public
|
|
1379
1379
|
*/
|
|
1380
1380
|
resourcesSummary: TrustedAdvisorResourcesSummary | undefined;
|
|
1381
1381
|
/**
|
|
1382
|
-
* @public
|
|
1383
1382
|
* <p>Summary information that relates to the category of the check. Cost Optimizing is the
|
|
1384
1383
|
* only category that is currently supported.</p>
|
|
1384
|
+
* @public
|
|
1385
1385
|
*/
|
|
1386
1386
|
categorySpecificSummary: TrustedAdvisorCategorySpecificSummary | undefined;
|
|
1387
1387
|
/**
|
|
1388
|
-
* @public
|
|
1389
1388
|
* <p>The details about each resource listed in the check result.</p>
|
|
1389
|
+
* @public
|
|
1390
1390
|
*/
|
|
1391
1391
|
flaggedResources: TrustedAdvisorResourceDetail[] | undefined;
|
|
1392
1392
|
}
|
|
1393
1393
|
/**
|
|
1394
|
-
* @public
|
|
1395
1394
|
* <p>The result of the Trusted Advisor check returned by the <a>DescribeTrustedAdvisorCheckResult</a> operation.</p>
|
|
1395
|
+
* @public
|
|
1396
1396
|
*/
|
|
1397
1397
|
export interface DescribeTrustedAdvisorCheckResultResponse {
|
|
1398
1398
|
/**
|
|
1399
|
-
* @public
|
|
1400
1399
|
* <p>The detailed results of the Trusted Advisor check.</p>
|
|
1400
|
+
* @public
|
|
1401
1401
|
*/
|
|
1402
1402
|
result?: TrustedAdvisorCheckResult;
|
|
1403
1403
|
}
|
|
@@ -1406,7 +1406,6 @@ export interface DescribeTrustedAdvisorCheckResultResponse {
|
|
|
1406
1406
|
*/
|
|
1407
1407
|
export interface DescribeTrustedAdvisorChecksRequest {
|
|
1408
1408
|
/**
|
|
1409
|
-
* @public
|
|
1410
1409
|
* <p>The ISO 639-1 code for the language that you want your checks to appear in.</p>
|
|
1411
1410
|
* <p>The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:</p>
|
|
1412
1411
|
* <ul>
|
|
@@ -1455,53 +1454,54 @@ export interface DescribeTrustedAdvisorChecksRequest {
|
|
|
1455
1454
|
* </p>
|
|
1456
1455
|
* </li>
|
|
1457
1456
|
* </ul>
|
|
1457
|
+
* @public
|
|
1458
1458
|
*/
|
|
1459
1459
|
language: string | undefined;
|
|
1460
1460
|
}
|
|
1461
1461
|
/**
|
|
1462
|
-
* @public
|
|
1463
1462
|
* <p>The description and metadata for a Trusted Advisor check.</p>
|
|
1463
|
+
* @public
|
|
1464
1464
|
*/
|
|
1465
1465
|
export interface TrustedAdvisorCheckDescription {
|
|
1466
1466
|
/**
|
|
1467
|
-
* @public
|
|
1468
1467
|
* <p>The unique identifier for the Trusted Advisor check.</p>
|
|
1468
|
+
* @public
|
|
1469
1469
|
*/
|
|
1470
1470
|
id: string | undefined;
|
|
1471
1471
|
/**
|
|
1472
|
-
* @public
|
|
1473
1472
|
* <p>The display name for the Trusted Advisor check.</p>
|
|
1473
|
+
* @public
|
|
1474
1474
|
*/
|
|
1475
1475
|
name: string | undefined;
|
|
1476
1476
|
/**
|
|
1477
|
-
* @public
|
|
1478
1477
|
* <p>The description of the Trusted Advisor check, which includes the alert criteria and
|
|
1479
1478
|
* recommended operations (contains HTML markup).</p>
|
|
1479
|
+
* @public
|
|
1480
1480
|
*/
|
|
1481
1481
|
description: string | undefined;
|
|
1482
1482
|
/**
|
|
1483
|
-
* @public
|
|
1484
1483
|
* <p>The category of the Trusted Advisor check.</p>
|
|
1484
|
+
* @public
|
|
1485
1485
|
*/
|
|
1486
1486
|
category: string | undefined;
|
|
1487
1487
|
/**
|
|
1488
|
-
* @public
|
|
1489
1488
|
* <p>The column headings for the data returned by the Trusted Advisor check. The order of the
|
|
1490
1489
|
* headings corresponds to the order of the data in the <b>Metadata</b> element of the <a>TrustedAdvisorResourceDetail</a>
|
|
1491
1490
|
* for the check. <b>Metadata</b> contains all the data that is
|
|
1492
1491
|
* shown in the Excel download, even in those cases where the UI shows just summary data.
|
|
1493
1492
|
* </p>
|
|
1493
|
+
* @public
|
|
1494
1494
|
*/
|
|
1495
1495
|
metadata: string[] | undefined;
|
|
1496
1496
|
}
|
|
1497
1497
|
/**
|
|
1498
|
-
* @public
|
|
1499
1498
|
* <p>Information about the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorChecks</a> operation.</p>
|
|
1499
|
+
* @public
|
|
1500
1500
|
*/
|
|
1501
1501
|
export interface DescribeTrustedAdvisorChecksResponse {
|
|
1502
1502
|
/**
|
|
1503
|
-
* @public
|
|
1504
1503
|
* <p>Information about all available Trusted Advisor checks.</p>
|
|
1504
|
+
* @public
|
|
1505
1505
|
*/
|
|
1506
1506
|
checks: TrustedAdvisorCheckDescription[] | undefined;
|
|
1507
1507
|
}
|
|
@@ -1510,85 +1510,85 @@ export interface DescribeTrustedAdvisorChecksResponse {
|
|
|
1510
1510
|
*/
|
|
1511
1511
|
export interface DescribeTrustedAdvisorCheckSummariesRequest {
|
|
1512
1512
|
/**
|
|
1513
|
-
* @public
|
|
1514
1513
|
* <p>The IDs of the Trusted Advisor checks.</p>
|
|
1514
|
+
* @public
|
|
1515
1515
|
*/
|
|
1516
1516
|
checkIds: string[] | undefined;
|
|
1517
1517
|
}
|
|
1518
1518
|
/**
|
|
1519
|
-
* @public
|
|
1520
1519
|
* <p>A summary of a Trusted Advisor check result, including the alert status, last refresh, and
|
|
1521
1520
|
* number of resources examined.</p>
|
|
1521
|
+
* @public
|
|
1522
1522
|
*/
|
|
1523
1523
|
export interface TrustedAdvisorCheckSummary {
|
|
1524
1524
|
/**
|
|
1525
|
-
* @public
|
|
1526
1525
|
* <p>The unique identifier for the Trusted Advisor check.</p>
|
|
1526
|
+
* @public
|
|
1527
1527
|
*/
|
|
1528
1528
|
checkId: string | undefined;
|
|
1529
1529
|
/**
|
|
1530
|
-
* @public
|
|
1531
1530
|
* <p>The time of the last refresh of the check.</p>
|
|
1531
|
+
* @public
|
|
1532
1532
|
*/
|
|
1533
1533
|
timestamp: string | undefined;
|
|
1534
1534
|
/**
|
|
1535
|
-
* @public
|
|
1536
1535
|
* <p>The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or
|
|
1537
1536
|
* "not_available".</p>
|
|
1537
|
+
* @public
|
|
1538
1538
|
*/
|
|
1539
1539
|
status: string | undefined;
|
|
1540
1540
|
/**
|
|
1541
|
-
* @public
|
|
1542
1541
|
* <p>Specifies whether the Trusted Advisor check has flagged resources.</p>
|
|
1542
|
+
* @public
|
|
1543
1543
|
*/
|
|
1544
1544
|
hasFlaggedResources?: boolean;
|
|
1545
1545
|
/**
|
|
1546
|
-
* @public
|
|
1547
1546
|
* <p>Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>.</p>
|
|
1547
|
+
* @public
|
|
1548
1548
|
*/
|
|
1549
1549
|
resourcesSummary: TrustedAdvisorResourcesSummary | undefined;
|
|
1550
1550
|
/**
|
|
1551
|
-
* @public
|
|
1552
1551
|
* <p>Summary information that relates to the category of the check. Cost Optimizing is the
|
|
1553
1552
|
* only category that is currently supported.</p>
|
|
1553
|
+
* @public
|
|
1554
1554
|
*/
|
|
1555
1555
|
categorySpecificSummary: TrustedAdvisorCategorySpecificSummary | undefined;
|
|
1556
1556
|
}
|
|
1557
1557
|
/**
|
|
1558
|
-
* @public
|
|
1559
1558
|
* <p>The summaries of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckSummaries</a> operation.</p>
|
|
1559
|
+
* @public
|
|
1560
1560
|
*/
|
|
1561
1561
|
export interface DescribeTrustedAdvisorCheckSummariesResponse {
|
|
1562
1562
|
/**
|
|
1563
|
-
* @public
|
|
1564
1563
|
* <p>The summary information for the requested Trusted Advisor checks.</p>
|
|
1564
|
+
* @public
|
|
1565
1565
|
*/
|
|
1566
1566
|
summaries: TrustedAdvisorCheckSummary[] | undefined;
|
|
1567
1567
|
}
|
|
1568
1568
|
/**
|
|
1569
|
-
* @public
|
|
1570
1569
|
* <p></p>
|
|
1570
|
+
* @public
|
|
1571
1571
|
*/
|
|
1572
1572
|
export interface RefreshTrustedAdvisorCheckRequest {
|
|
1573
1573
|
/**
|
|
1574
|
-
* @public
|
|
1575
1574
|
* <p>The unique identifier for the Trusted Advisor check to refresh.</p>
|
|
1576
1575
|
* <note>
|
|
1577
1576
|
* <p>Specifying the check ID of a check that is automatically refreshed causes an
|
|
1578
1577
|
* <code>InvalidParameterValue</code> error.</p>
|
|
1579
1578
|
* </note>
|
|
1579
|
+
* @public
|
|
1580
1580
|
*/
|
|
1581
1581
|
checkId: string | undefined;
|
|
1582
1582
|
}
|
|
1583
1583
|
/**
|
|
1584
|
-
* @public
|
|
1585
1584
|
* <p>The current refresh status of a Trusted Advisor check.</p>
|
|
1585
|
+
* @public
|
|
1586
1586
|
*/
|
|
1587
1587
|
export interface RefreshTrustedAdvisorCheckResponse {
|
|
1588
1588
|
/**
|
|
1589
|
-
* @public
|
|
1590
1589
|
* <p>The current refresh status for a check, including the amount of time until the check
|
|
1591
1590
|
* is eligible for refresh.</p>
|
|
1591
|
+
* @public
|
|
1592
1592
|
*/
|
|
1593
1593
|
status: TrustedAdvisorCheckRefreshStatus | undefined;
|
|
1594
1594
|
}
|
|
@@ -1597,28 +1597,28 @@ export interface RefreshTrustedAdvisorCheckResponse {
|
|
|
1597
1597
|
*/
|
|
1598
1598
|
export interface ResolveCaseRequest {
|
|
1599
1599
|
/**
|
|
1600
|
-
* @public
|
|
1601
1600
|
* <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
|
|
1602
1601
|
* string formatted as shown in this example:
|
|
1603
1602
|
* case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>
|
|
1604
1603
|
* </p>
|
|
1604
|
+
* @public
|
|
1605
1605
|
*/
|
|
1606
1606
|
caseId?: string;
|
|
1607
1607
|
}
|
|
1608
1608
|
/**
|
|
1609
|
-
* @public
|
|
1610
1609
|
* <p>The status of the case returned by the <a>ResolveCase</a> operation.</p>
|
|
1610
|
+
* @public
|
|
1611
1611
|
*/
|
|
1612
1612
|
export interface ResolveCaseResponse {
|
|
1613
1613
|
/**
|
|
1614
|
-
* @public
|
|
1615
1614
|
* <p>The status of the case when the <a>ResolveCase</a> request was sent.</p>
|
|
1615
|
+
* @public
|
|
1616
1616
|
*/
|
|
1617
1617
|
initialCaseStatus?: string;
|
|
1618
1618
|
/**
|
|
1619
|
-
* @public
|
|
1620
1619
|
* <p>The status of the case after the <a>ResolveCase</a> request was
|
|
1621
1620
|
* processed.</p>
|
|
1621
|
+
* @public
|
|
1622
1622
|
*/
|
|
1623
1623
|
finalCaseStatus?: string;
|
|
1624
1624
|
}
|