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