@aws-sdk/client-support 3.312.0 → 3.316.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.
Files changed (7) hide show
  1. package/dist-cjs/Support.js +18 -196
  2. package/dist-cjs/protocols/Aws_json1_1.js +124 -520
  3. package/dist-es/Support.js +18 -196
  4. package/dist-es/protocols/Aws_json1_1.js +125 -521
  5. package/dist-types/Support.d.ts +64 -419
  6. package/dist-types/ts3.4/Support.d.ts +2 -1
  7. package/package.json +6 -6
package/dist-types/Support.d.ts CHANGED
@@ -14,493 +14,138 @@ import { DescribeTrustedAdvisorCheckSummariesCommandInput, DescribeTrustedAdviso
14
14
  import { RefreshTrustedAdvisorCheckCommandInput, RefreshTrustedAdvisorCheckCommandOutput } from "./commands/RefreshTrustedAdvisorCheckCommand";
15
15
  import { ResolveCaseCommandInput, ResolveCaseCommandOutput } from "./commands/ResolveCaseCommand";
16
16
  import { SupportClient } from "./SupportClient";
17
- /**
18
- * @public
19
- * <fullname>Amazon Web Services Support</fullname>
20
- * <p>The <i>Amazon Web Services Support API Reference</i> is intended for programmers who need detailed
21
- * information about the Amazon Web Services Support operations and data types. You can use the API to manage
22
- * your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return
23
- * results in JSON format.</p>
24
- * <note>
25
- * <ul>
26
- * <li>
27
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
28
- * API. </p>
29
- * </li>
30
- * <li>
31
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
32
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
33
- * <code>SubscriptionRequiredException</code> error message appears. For
34
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
35
- * </li>
36
- * </ul>
37
- * </note>
38
- * <p>You can also use the Amazon Web Services Support API to access features for <a href="http://aws.amazon.com/premiumsupport/trustedadvisor/">Trusted Advisor</a>. You can return a list of
39
- * checks and their descriptions, get check results, specify checks to refresh, and get the
40
- * refresh status of checks.</p>
41
- * <p>You can manage your support cases with the following Amazon Web Services Support API operations:</p>
42
- * <ul>
43
- * <li>
44
- * <p>The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations
45
- * create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.</p>
46
- * </li>
47
- * <li>
48
- * <p>The <a>DescribeCommunications</a>, <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications and attachments to Amazon Web Services Support
49
- * cases.</p>
50
- * </li>
51
- * <li>
52
- * <p>The <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return Amazon Web Service names, service codes, service categories, and problem
53
- * severity levels. You use these values when you call the <a>CreateCase</a> operation.</p>
54
- * </li>
55
- * </ul>
56
- * <p>You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more
57
- * information, see <a href="https://docs.aws.amazon.com/">Trusted Advisor</a> in the
58
- * <i>Amazon Web Services Support User Guide</i>.</p>
59
- * <p>For authentication of requests, Amazon Web Services Support uses <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing
60
- * Process</a>.</p>
61
- * <p>For more information about this service and the endpoints to use, see <a href="https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html">About the
62
- * Amazon Web Services Support API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
63
- */
64
- export declare class Support extends SupportClient {
17
+ export interface Support {
65
18
  /**
66
- * @public
67
- * <p>Adds one or more attachments to an attachment set. </p>
68
- * <p>An attachment set is a temporary container for attachments that you add to a case or
69
- * case communication. The set is available for 1 hour after it's created. The
70
- * <code>expiryTime</code> returned in the response is when the set expires. </p>
71
- * <note>
72
- * <ul>
73
- * <li>
74
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
75
- * API. </p>
76
- * </li>
77
- * <li>
78
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
79
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
80
- * <code>SubscriptionRequiredException</code> error message appears. For
81
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
82
- * </li>
83
- * </ul>
84
- * </note>
19
+ * @see {@link AddAttachmentsToSetCommand}
85
20
  */
86
21
  addAttachmentsToSet(args: AddAttachmentsToSetCommandInput, options?: __HttpHandlerOptions): Promise<AddAttachmentsToSetCommandOutput>;
87
22
  addAttachmentsToSet(args: AddAttachmentsToSetCommandInput, cb: (err: any, data?: AddAttachmentsToSetCommandOutput) => void): void;
88
23
  addAttachmentsToSet(args: AddAttachmentsToSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddAttachmentsToSetCommandOutput) => void): void;
89
24
  /**
90
- * @public
91
- * <p>Adds additional customer communication to an Amazon Web Services Support case. Use the <code>caseId</code>
92
- * parameter to identify the case to which to add communication. You can list a set of
93
- * email addresses to copy on the communication by using the <code>ccEmailAddresses</code>
94
- * parameter. The <code>communicationBody</code> value contains the text of the
95
- * communication.</p>
96
- * <note>
97
- * <ul>
98
- * <li>
99
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
100
- * API. </p>
101
- * </li>
102
- * <li>
103
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
104
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
105
- * <code>SubscriptionRequiredException</code> error message appears. For
106
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
107
- * </li>
108
- * </ul>
109
- * </note>
25
+ * @see {@link AddCommunicationToCaseCommand}
110
26
  */
111
27
  addCommunicationToCase(args: AddCommunicationToCaseCommandInput, options?: __HttpHandlerOptions): Promise<AddCommunicationToCaseCommandOutput>;
112
28
  addCommunicationToCase(args: AddCommunicationToCaseCommandInput, cb: (err: any, data?: AddCommunicationToCaseCommandOutput) => void): void;
113
29
  addCommunicationToCase(args: AddCommunicationToCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddCommunicationToCaseCommandOutput) => void): void;
114
30
  /**
115
- * @public
116
- * <p>Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case
117
- * in the Amazon Web Services Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create
118
- * Case</a> page.</p>
119
- * <p>The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a
120
- * service limit increase in the following ways: </p>
121
- * <ul>
122
- * <li>
123
- * <p>Submit a request from the Amazon Web Services Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</p>
124
- * </li>
125
- * <li>
126
- * <p>Use the Service Quotas <a href="https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html">RequestServiceQuotaIncrease</a> operation.</p>
127
- * </li>
128
- * </ul>
129
- * <p>A successful <code>CreateCase</code> request returns an Amazon Web Services Support case number. You can use
130
- * the <a>DescribeCases</a> operation and specify the case number to get
131
- * existing Amazon Web Services Support cases. After you create a case, use the <a>AddCommunicationToCase</a> operation to add additional communication or
132
- * attachments to an existing case.</p>
133
- * <p>The <code>caseId</code> is separate from the <code>displayId</code> that appears in
134
- * the <a href="https://console.aws.amazon.com/support">Amazon Web Services Support Center</a>. Use the <a>DescribeCases</a> operation to get the <code>displayId</code>.</p>
135
- * <note>
136
- * <ul>
137
- * <li>
138
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
139
- * API. </p>
140
- * </li>
141
- * <li>
142
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
143
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
144
- * <code>SubscriptionRequiredException</code> error message appears. For
145
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
146
- * </li>
147
- * </ul>
148
- * </note>
31
+ * @see {@link CreateCaseCommand}
149
32
  */
150
33
  createCase(args: CreateCaseCommandInput, options?: __HttpHandlerOptions): Promise<CreateCaseCommandOutput>;
151
34
  createCase(args: CreateCaseCommandInput, cb: (err: any, data?: CreateCaseCommandOutput) => void): void;
152
35
  createCase(args: CreateCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCaseCommandOutput) => void): void;
153
36
  /**
154
- * @public
155
- * <p>Returns the attachment that has the specified ID. Attachments can include screenshots,
156
- * error logs, or other files that describe your issue. Attachment IDs are generated by the
157
- * case management system when you add an attachment to a case or case communication.
158
- * Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are
159
- * returned by the <a>DescribeCommunications</a> operation.</p>
160
- * <note>
161
- * <ul>
162
- * <li>
163
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
164
- * API. </p>
165
- * </li>
166
- * <li>
167
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
168
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
169
- * <code>SubscriptionRequiredException</code> error message appears. For
170
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
171
- * </li>
172
- * </ul>
173
- * </note>
37
+ * @see {@link DescribeAttachmentCommand}
174
38
  */
175
39
  describeAttachment(args: DescribeAttachmentCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAttachmentCommandOutput>;
176
40
  describeAttachment(args: DescribeAttachmentCommandInput, cb: (err: any, data?: DescribeAttachmentCommandOutput) => void): void;
177
41
  describeAttachment(args: DescribeAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAttachmentCommandOutput) => void): void;
178
42
  /**
179
- * @public
180
- * <p>Returns a list of cases that you specify by passing one or more case IDs. You can use
181
- * the <code>afterTime</code> and <code>beforeTime</code> parameters to filter the cases by
182
- * date. You can set values for the <code>includeResolvedCases</code> and
183
- * <code>includeCommunications</code> parameters to specify how much information to
184
- * return.</p>
185
- * <p>The response returns the following in JSON format:</p>
186
- * <ul>
187
- * <li>
188
- * <p>One or more <a href="https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html">CaseDetails</a> data types.</p>
189
- * </li>
190
- * <li>
191
- * <p>One or more <code>nextToken</code> values, which specify where to paginate the
192
- * returned records represented by the <code>CaseDetails</code> objects.</p>
193
- * </li>
194
- * </ul>
195
- * <p>Case data is available for 12 months after creation. If a case was created more than
196
- * 12 months ago, a request might return an error.</p>
197
- * <note>
198
- * <ul>
199
- * <li>
200
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
201
- * API. </p>
202
- * </li>
203
- * <li>
204
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
205
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
206
- * <code>SubscriptionRequiredException</code> error message appears. For
207
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
208
- * </li>
209
- * </ul>
210
- * </note>
43
+ * @see {@link DescribeCasesCommand}
211
44
  */
212
45
  describeCases(args: DescribeCasesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCasesCommandOutput>;
213
46
  describeCases(args: DescribeCasesCommandInput, cb: (err: any, data?: DescribeCasesCommandOutput) => void): void;
214
47
  describeCases(args: DescribeCasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCasesCommandOutput) => void): void;
215
48
  /**
216
- * @public
217
- * <p>Returns communications and attachments for one or more support cases. Use the
218
- * <code>afterTime</code> and <code>beforeTime</code> parameters to filter by date. You
219
- * can use the <code>caseId</code> parameter to restrict the results to a specific
220
- * case.</p>
221
- * <p>Case data is available for 12 months after creation. If a case was created more than
222
- * 12 months ago, a request for data might cause an error.</p>
223
- * <p>You can use the <code>maxResults</code> and <code>nextToken</code> parameters to
224
- * control the pagination of the results. Set <code>maxResults</code> to the number of
225
- * cases that you want to display on each page, and use <code>nextToken</code> to specify
226
- * the resumption of pagination.</p>
227
- * <note>
228
- * <ul>
229
- * <li>
230
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
231
- * API. </p>
232
- * </li>
233
- * <li>
234
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
235
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
236
- * <code>SubscriptionRequiredException</code> error message appears. For
237
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
238
- * </li>
239
- * </ul>
240
- * </note>
49
+ * @see {@link DescribeCommunicationsCommand}
241
50
  */
242
51
  describeCommunications(args: DescribeCommunicationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCommunicationsCommandOutput>;
243
52
  describeCommunications(args: DescribeCommunicationsCommandInput, cb: (err: any, data?: DescribeCommunicationsCommandOutput) => void): void;
244
53
  describeCommunications(args: DescribeCommunicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCommunicationsCommandOutput) => void): void;
245
54
  /**
246
- * @public
247
- * <p>Returns the current list of Amazon Web Services services and a list of service categories for each
248
- * service. You then use service names and categories in your <a>CreateCase</a>
249
- * requests. Each Amazon Web Services service has its own set of categories.</p>
250
- * <p>The service codes and category codes correspond to the values that appear in the
251
- * <b>Service</b> and <b>Category</b> lists on the Amazon Web Services Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields
252
- * don't necessarily match the service codes and categories returned by the
253
- * <code>DescribeServices</code> operation. Always use the service codes and categories
254
- * that the <code>DescribeServices</code> operation returns, so that you have the most
255
- * recent set of service and category codes.</p>
256
- * <note>
257
- * <ul>
258
- * <li>
259
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
260
- * API. </p>
261
- * </li>
262
- * <li>
263
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
264
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
265
- * <code>SubscriptionRequiredException</code> error message appears. For
266
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
267
- * </li>
268
- * </ul>
269
- * </note>
55
+ * @see {@link DescribeServicesCommand}
270
56
  */
271
57
  describeServices(args: DescribeServicesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeServicesCommandOutput>;
272
58
  describeServices(args: DescribeServicesCommandInput, cb: (err: any, data?: DescribeServicesCommandOutput) => void): void;
273
59
  describeServices(args: DescribeServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServicesCommandOutput) => void): void;
274
60
  /**
275
- * @public
276
- * <p>Returns the list of severity levels that you can assign to a support case. The
277
- * severity level for a case is also a field in the <a>CaseDetails</a> data type
278
- * that you include for a <a>CreateCase</a> request.</p>
279
- * <note>
280
- * <ul>
281
- * <li>
282
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
283
- * API. </p>
284
- * </li>
285
- * <li>
286
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
287
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
288
- * <code>SubscriptionRequiredException</code> error message appears. For
289
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
290
- * </li>
291
- * </ul>
292
- * </note>
61
+ * @see {@link DescribeSeverityLevelsCommand}
293
62
  */
294
63
  describeSeverityLevels(args: DescribeSeverityLevelsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSeverityLevelsCommandOutput>;
295
64
  describeSeverityLevels(args: DescribeSeverityLevelsCommandInput, cb: (err: any, data?: DescribeSeverityLevelsCommandOutput) => void): void;
296
65
  describeSeverityLevels(args: DescribeSeverityLevelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSeverityLevelsCommandOutput) => void): void;
297
66
  /**
298
- * @public
299
- * <p>Returns the refresh status of the Trusted Advisor checks that have the specified check
300
- * IDs. You can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a> operation.</p>
301
- * <p>Some checks are refreshed automatically, and you can't return their refresh statuses
302
- * by using the <code>DescribeTrustedAdvisorCheckRefreshStatuses</code> operation. If you
303
- * call this operation for these checks, you might see an
304
- * <code>InvalidParameterValue</code> error.</p>
305
- * <note>
306
- * <ul>
307
- * <li>
308
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
309
- * API. </p>
310
- * </li>
311
- * <li>
312
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
313
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
314
- * <code>SubscriptionRequiredException</code> error message appears. For
315
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
316
- * </li>
317
- * </ul>
318
- * </note>
319
- * <p>To call the Trusted Advisor operations in
320
- * the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland)
321
- * endpoints don't support the Trusted Advisor operations. For more information, see <a href="https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint">About the Amazon Web Services Support
322
- * API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
67
+ * @see {@link DescribeTrustedAdvisorCheckRefreshStatusesCommand}
323
68
  */
324
69
  describeTrustedAdvisorCheckRefreshStatuses(args: DescribeTrustedAdvisorCheckRefreshStatusesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTrustedAdvisorCheckRefreshStatusesCommandOutput>;
325
70
  describeTrustedAdvisorCheckRefreshStatuses(args: DescribeTrustedAdvisorCheckRefreshStatusesCommandInput, cb: (err: any, data?: DescribeTrustedAdvisorCheckRefreshStatusesCommandOutput) => void): void;
326
71
  describeTrustedAdvisorCheckRefreshStatuses(args: DescribeTrustedAdvisorCheckRefreshStatusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrustedAdvisorCheckRefreshStatusesCommandOutput) => void): void;
327
72
  /**
328
- * @public
329
- * <p>Returns the results of the Trusted Advisor check that has the specified check ID. You
330
- * can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a>
331
- * operation.</p>
332
- * <p>The response contains a <a>TrustedAdvisorCheckResult</a> object, which
333
- * contains these three objects:</p>
334
- * <ul>
335
- * <li>
336
- * <p>
337
- * <a>TrustedAdvisorCategorySpecificSummary</a>
338
- * </p>
339
- * </li>
340
- * <li>
341
- * <p>
342
- * <a>TrustedAdvisorResourceDetail</a>
343
- * </p>
344
- * </li>
345
- * <li>
346
- * <p>
347
- * <a>TrustedAdvisorResourcesSummary</a>
348
- * </p>
349
- * </li>
350
- * </ul>
351
- * <p>In addition, the response contains these fields:</p>
352
- * <ul>
353
- * <li>
354
- * <p>
355
- * <b>status</b> - The alert status of the check
356
- * can be <code>ok</code> (green), <code>warning</code> (yellow),
357
- * <code>error</code> (red), or <code>not_available</code>.</p>
358
- * </li>
359
- * <li>
360
- * <p>
361
- * <b>timestamp</b> - The time of the last refresh
362
- * of the check.</p>
363
- * </li>
364
- * <li>
365
- * <p>
366
- * <b>checkId</b> - The unique identifier for the
367
- * check.</p>
368
- * </li>
369
- * </ul>
370
- * <note>
371
- * <ul>
372
- * <li>
373
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
374
- * API. </p>
375
- * </li>
376
- * <li>
377
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
378
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
379
- * <code>SubscriptionRequiredException</code> error message appears. For
380
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
381
- * </li>
382
- * </ul>
383
- * </note>
384
- * <p>To call the Trusted Advisor operations in
385
- * the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland)
386
- * endpoints don't support the Trusted Advisor operations. For more information, see <a href="https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint">About the Amazon Web Services Support
387
- * API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
73
+ * @see {@link DescribeTrustedAdvisorCheckResultCommand}
388
74
  */
389
75
  describeTrustedAdvisorCheckResult(args: DescribeTrustedAdvisorCheckResultCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTrustedAdvisorCheckResultCommandOutput>;
390
76
  describeTrustedAdvisorCheckResult(args: DescribeTrustedAdvisorCheckResultCommandInput, cb: (err: any, data?: DescribeTrustedAdvisorCheckResultCommandOutput) => void): void;
391
77
  describeTrustedAdvisorCheckResult(args: DescribeTrustedAdvisorCheckResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrustedAdvisorCheckResultCommandOutput) => void): void;
392
78
  /**
393
- * @public
394
- * <p>Returns information about all available Trusted Advisor checks, including the name, ID,
395
- * category, description, and metadata. You must specify a language code.</p>
396
- * <p>The response contains a <a>TrustedAdvisorCheckDescription</a> object for
397
- * each check. You must set the Amazon Web Services Region to us-east-1.</p>
398
- * <note>
399
- * <ul>
400
- * <li>
401
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. </p>
402
- * </li>
403
- * <li>
404
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
405
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the <code>SubscriptionRequiredException</code> error
406
- * message appears. For information about changing your support plan, see
407
- * <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
408
- * </li>
409
- * <li>
410
- * <p>The names and descriptions for Trusted Advisor checks are subject to change. We
411
- * recommend that you specify the check ID in your code to uniquely identify a
412
- * check.</p>
413
- * </li>
414
- * </ul>
415
- * </note>
416
- * <p>To call the Trusted Advisor operations in
417
- * the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland)
418
- * endpoints don't support the Trusted Advisor operations. For more information, see <a href="https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint">About the Amazon Web Services Support
419
- * API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
79
+ * @see {@link DescribeTrustedAdvisorChecksCommand}
420
80
  */
421
81
  describeTrustedAdvisorChecks(args: DescribeTrustedAdvisorChecksCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTrustedAdvisorChecksCommandOutput>;
422
82
  describeTrustedAdvisorChecks(args: DescribeTrustedAdvisorChecksCommandInput, cb: (err: any, data?: DescribeTrustedAdvisorChecksCommandOutput) => void): void;
423
83
  describeTrustedAdvisorChecks(args: DescribeTrustedAdvisorChecksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrustedAdvisorChecksCommandOutput) => void): void;
424
84
  /**
425
- * @public
426
- * <p>Returns the results for the Trusted Advisor check summaries for the check IDs that you
427
- * specified. You can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a> operation.</p>
428
- * <p>The response contains an array of <a>TrustedAdvisorCheckSummary</a>
429
- * objects.</p>
430
- * <note>
431
- * <ul>
432
- * <li>
433
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
434
- * API. </p>
435
- * </li>
436
- * <li>
437
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
438
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
439
- * <code>SubscriptionRequiredException</code> error message appears. For
440
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
441
- * </li>
442
- * </ul>
443
- * </note>
444
- * <p>To call the Trusted Advisor operations in
445
- * the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland)
446
- * endpoints don't support the Trusted Advisor operations. For more information, see <a href="https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint">About the Amazon Web Services Support
447
- * API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
85
+ * @see {@link DescribeTrustedAdvisorCheckSummariesCommand}
448
86
  */
449
87
  describeTrustedAdvisorCheckSummaries(args: DescribeTrustedAdvisorCheckSummariesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTrustedAdvisorCheckSummariesCommandOutput>;
450
88
  describeTrustedAdvisorCheckSummaries(args: DescribeTrustedAdvisorCheckSummariesCommandInput, cb: (err: any, data?: DescribeTrustedAdvisorCheckSummariesCommandOutput) => void): void;
451
89
  describeTrustedAdvisorCheckSummaries(args: DescribeTrustedAdvisorCheckSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrustedAdvisorCheckSummariesCommandOutput) => void): void;
452
90
  /**
453
- * @public
454
- * <p>Refreshes the Trusted Advisor check that you specify using the check ID. You can get the
455
- * check IDs by calling the <a>DescribeTrustedAdvisorChecks</a>
456
- * operation.</p>
457
- * <p>Some checks are refreshed automatically. If you call the
458
- * <code>RefreshTrustedAdvisorCheck</code> operation to refresh them, you might see
459
- * the <code>InvalidParameterValue</code> error.</p>
460
- * <p>The response contains a <a>TrustedAdvisorCheckRefreshStatus</a>
461
- * object.</p>
462
- * <note>
463
- * <ul>
464
- * <li>
465
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
466
- * API. </p>
467
- * </li>
468
- * <li>
469
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
470
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
471
- * <code>SubscriptionRequiredException</code> error message appears. For
472
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
473
- * </li>
474
- * </ul>
475
- * </note>
476
- * <p>To call the Trusted Advisor operations in
477
- * the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland)
478
- * endpoints don't support the Trusted Advisor operations. For more information, see <a href="https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint">About the Amazon Web Services Support
479
- * API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
91
+ * @see {@link RefreshTrustedAdvisorCheckCommand}
480
92
  */
481
93
  refreshTrustedAdvisorCheck(args: RefreshTrustedAdvisorCheckCommandInput, options?: __HttpHandlerOptions): Promise<RefreshTrustedAdvisorCheckCommandOutput>;
482
94
  refreshTrustedAdvisorCheck(args: RefreshTrustedAdvisorCheckCommandInput, cb: (err: any, data?: RefreshTrustedAdvisorCheckCommandOutput) => void): void;
483
95
  refreshTrustedAdvisorCheck(args: RefreshTrustedAdvisorCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RefreshTrustedAdvisorCheckCommandOutput) => void): void;
484
96
  /**
485
- * @public
486
- * <p>Resolves a support case. This operation takes a <code>caseId</code> and returns the
487
- * initial and final state of the case.</p>
488
- * <note>
489
- * <ul>
490
- * <li>
491
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
492
- * API. </p>
493
- * </li>
494
- * <li>
495
- * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
496
- * Business, Enterprise On-Ramp, or Enterprise Support plan, the
497
- * <code>SubscriptionRequiredException</code> error message appears. For
498
- * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
499
- * </li>
500
- * </ul>
501
- * </note>
97
+ * @see {@link ResolveCaseCommand}
502
98
  */
503
99
  resolveCase(args: ResolveCaseCommandInput, options?: __HttpHandlerOptions): Promise<ResolveCaseCommandOutput>;
504
100
  resolveCase(args: ResolveCaseCommandInput, cb: (err: any, data?: ResolveCaseCommandOutput) => void): void;
505
101
  resolveCase(args: ResolveCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResolveCaseCommandOutput) => void): void;
506
102
  }
103
+ /**
104
+ * @public
105
+ * <fullname>Amazon Web Services Support</fullname>
106
+ * <p>The <i>Amazon Web Services Support API Reference</i> is intended for programmers who need detailed
107
+ * information about the Amazon Web Services Support operations and data types. You can use the API to manage
108
+ * your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return
109
+ * results in JSON format.</p>
110
+ * <note>
111
+ * <ul>
112
+ * <li>
113
+ * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
114
+ * API. </p>
115
+ * </li>
116
+ * <li>
117
+ * <p>If you call the Amazon Web Services Support API from an account that doesn't have a
118
+ * Business, Enterprise On-Ramp, or Enterprise Support plan, the
119
+ * <code>SubscriptionRequiredException</code> error message appears. For
120
+ * information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
121
+ * </li>
122
+ * </ul>
123
+ * </note>
124
+ * <p>You can also use the Amazon Web Services Support API to access features for <a href="http://aws.amazon.com/premiumsupport/trustedadvisor/">Trusted Advisor</a>. You can return a list of
125
+ * checks and their descriptions, get check results, specify checks to refresh, and get the
126
+ * refresh status of checks.</p>
127
+ * <p>You can manage your support cases with the following Amazon Web Services Support API operations:</p>
128
+ * <ul>
129
+ * <li>
130
+ * <p>The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations
131
+ * create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.</p>
132
+ * </li>
133
+ * <li>
134
+ * <p>The <a>DescribeCommunications</a>, <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications and attachments to Amazon Web Services Support
135
+ * cases.</p>
136
+ * </li>
137
+ * <li>
138
+ * <p>The <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return Amazon Web Service names, service codes, service categories, and problem
139
+ * severity levels. You use these values when you call the <a>CreateCase</a> operation.</p>
140
+ * </li>
141
+ * </ul>
142
+ * <p>You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more
143
+ * information, see <a href="https://docs.aws.amazon.com/">Trusted Advisor</a> in the
144
+ * <i>Amazon Web Services Support User Guide</i>.</p>
145
+ * <p>For authentication of requests, Amazon Web Services Support uses <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing
146
+ * Process</a>.</p>
147
+ * <p>For more information about this service and the endpoints to use, see <a href="https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html">About the
148
+ * Amazon Web Services Support API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
149
+ */
150
+ export declare class Support extends SupportClient implements Support {
151
+ }
package/dist-types/ts3.4/Support.d.ts CHANGED
@@ -56,7 +56,7 @@ import {
56
56
  ResolveCaseCommandOutput,
57
57
  } from "./commands/ResolveCaseCommand";
58
58
  import { SupportClient } from "./SupportClient";
59
- export declare class Support extends SupportClient {
59
+ export interface Support {
60
60
  addAttachmentsToSet(
61
61
  args: AddAttachmentsToSetCommandInput,
62
62
  options?: __HttpHandlerOptions
@@ -258,3 +258,4 @@ export declare class Support extends SupportClient {
258
258
  cb: (err: any, data?: ResolveCaseCommandOutput) => void
259
259
  ): void;
260
260
  }
261
+ export declare class Support extends SupportClient implements Support {}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-support",
3
3
  "description": "AWS SDK for JavaScript Support Client for Node.js, Browser and React Native",
4
- "version": "3.312.0",
4
+ "version": "3.316.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.312.0",
24
+ "@aws-sdk/client-sts": "3.316.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.310.0",
26
+ "@aws-sdk/credential-provider-node": "3.316.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -40,14 +40,14 @@
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.310.0",
43
+ "@aws-sdk/smithy-client": "3.316.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.310.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.310.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.316.0",
51
51
  "@aws-sdk/util-endpoints": "3.310.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",