@aws-sdk/client-support 3.235.0 → 3.238.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 +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- 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 +5 -4
|
@@ -138,79 +138,49 @@ export interface SupportClientResolvedConfig extends SupportClientResolvedConfig
|
|
|
138
138
|
}
|
|
139
139
|
/**
|
|
140
140
|
* <fullname>Amazon Web Services Support</fullname>
|
|
141
|
-
*
|
|
141
|
+
* <p>The <i>Amazon Web Services Support API Reference</i> is intended for programmers who need detailed
|
|
142
142
|
* information about the Amazon Web Services Support operations and data types. You can use the API to manage
|
|
143
143
|
* your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return
|
|
144
144
|
* results in JSON format.</p>
|
|
145
|
-
*
|
|
145
|
+
* <note>
|
|
146
146
|
* <ul>
|
|
147
147
|
* <li>
|
|
148
|
-
*
|
|
148
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
149
149
|
* API. </p>
|
|
150
|
-
*
|
|
150
|
+
* </li>
|
|
151
151
|
* <li>
|
|
152
|
-
*
|
|
152
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
153
153
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
154
154
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
155
155
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
156
|
-
*
|
|
156
|
+
* </li>
|
|
157
157
|
* </ul>
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
* refresh
|
|
162
|
-
*
|
|
163
|
-
*
|
|
158
|
+
* </note>
|
|
159
|
+
* <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
|
|
160
|
+
* checks and their descriptions, get check results, specify checks to refresh, and get the
|
|
161
|
+
* refresh status of checks.</p>
|
|
162
|
+
* <p>You can manage your support cases with the following Amazon Web Services Support API operations:</p>
|
|
163
|
+
* <ul>
|
|
164
164
|
* <li>
|
|
165
|
-
*
|
|
166
|
-
* <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return Amazon Web Services service names,
|
|
167
|
-
* service codes, service categories, and problem severity levels. You use these
|
|
168
|
-
* values when you call the <a>CreateCase</a> operation.</p>
|
|
169
|
-
* </li>
|
|
170
|
-
* <li>
|
|
171
|
-
* <p> Case creation, case details, and case resolution - The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations
|
|
165
|
+
* <p>The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations
|
|
172
166
|
* create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.</p>
|
|
173
167
|
* </li>
|
|
174
168
|
* <li>
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
* and attachments to Amazon Web Services Support cases.</p>
|
|
178
|
-
* </li>
|
|
179
|
-
* </ul>
|
|
180
|
-
* <p>The following list describes the operations available from the Amazon Web Services Support service for
|
|
181
|
-
* Trusted Advisor:</p>
|
|
182
|
-
* <ul>
|
|
183
|
-
* <li>
|
|
184
|
-
* <p>
|
|
185
|
-
* <a>DescribeTrustedAdvisorChecks</a> returns the list of checks that
|
|
186
|
-
* run against your Amazon Web Services resources.</p>
|
|
187
|
-
* </li>
|
|
188
|
-
* <li>
|
|
189
|
-
* <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
|
|
190
|
-
* check that you specified.</p>
|
|
191
|
-
* </li>
|
|
192
|
-
* <li>
|
|
193
|
-
* <p>
|
|
194
|
-
* <a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized
|
|
195
|
-
* results for one or more Trusted Advisor checks.</p>
|
|
196
|
-
* </li>
|
|
197
|
-
* <li>
|
|
198
|
-
* <p>
|
|
199
|
-
* <a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a
|
|
200
|
-
* specified check.</p>
|
|
169
|
+
* <p>The <a>DescribeCommunications</a>, <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications and attachments to Amazon Web Services Support
|
|
170
|
+
* cases.</p>
|
|
201
171
|
* </li>
|
|
202
172
|
* <li>
|
|
203
|
-
*
|
|
204
|
-
* <a>
|
|
205
|
-
* status of one or more checks.</p>
|
|
173
|
+
* <p>The <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return Amazon Web Service names, service codes, service categories, and problem
|
|
174
|
+
* severity levels. You use these values when you call the <a>CreateCase</a> operation.</p>
|
|
206
175
|
* </li>
|
|
207
176
|
* </ul>
|
|
208
|
-
*
|
|
177
|
+
* <p>You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more
|
|
178
|
+
* information, see <a href="https://docs.aws.amazon.com/">Trusted Advisor</a> in the
|
|
179
|
+
* <i>Amazon Web Services Support User Guide</i>.</p>
|
|
180
|
+
* <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
|
|
209
181
|
* Process</a>.</p>
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
* information about how to use this service to create and manage your support cases, and
|
|
213
|
-
* how to call Trusted Advisor for results of checks on your resources.</p>
|
|
182
|
+
* <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
|
|
183
|
+
* Amazon Web Services Support API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
|
|
214
184
|
*/
|
|
215
185
|
export declare class SupportClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SupportClientResolvedConfig> {
|
|
216
186
|
/**
|
|
@@ -9,23 +9,23 @@ export interface AddAttachmentsToSetCommandOutput extends AddAttachmentsToSetRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Adds one or more attachments to an attachment set. </p>
|
|
12
|
-
*
|
|
12
|
+
* <p>An attachment set is a temporary container for attachments that you add to a case or
|
|
13
13
|
* case communication. The set is available for 1 hour after it's created. The
|
|
14
14
|
* <code>expiryTime</code> returned in the response is when the set expires. </p>
|
|
15
|
-
*
|
|
15
|
+
* <note>
|
|
16
16
|
* <ul>
|
|
17
17
|
* <li>
|
|
18
|
-
*
|
|
18
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
19
19
|
* API. </p>
|
|
20
|
-
*
|
|
20
|
+
* </li>
|
|
21
21
|
* <li>
|
|
22
|
-
*
|
|
22
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
23
23
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
24
24
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
25
25
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
26
|
-
*
|
|
26
|
+
* </li>
|
|
27
27
|
* </ul>
|
|
28
|
-
*
|
|
28
|
+
* </note>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|
|
@@ -13,21 +13,20 @@ export interface AddCommunicationToCaseCommandOutput extends AddCommunicationToC
|
|
|
13
13
|
* email addresses to copy on the communication by using the <code>ccEmailAddresses</code>
|
|
14
14
|
* parameter. The <code>communicationBody</code> value contains the text of the
|
|
15
15
|
* communication.</p>
|
|
16
|
-
*
|
|
17
|
-
* <note>
|
|
16
|
+
* <note>
|
|
18
17
|
* <ul>
|
|
19
18
|
* <li>
|
|
20
|
-
*
|
|
19
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
21
20
|
* API. </p>
|
|
22
|
-
*
|
|
21
|
+
* </li>
|
|
23
22
|
* <li>
|
|
24
|
-
*
|
|
23
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
25
24
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
26
25
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
27
26
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
28
|
-
*
|
|
27
|
+
* </li>
|
|
29
28
|
* </ul>
|
|
30
|
-
*
|
|
29
|
+
* </note>
|
|
31
30
|
* @example
|
|
32
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
32
|
* ```javascript
|
|
@@ -11,36 +11,36 @@ export interface CreateCaseCommandOutput extends CreateCaseResponse, __MetadataB
|
|
|
11
11
|
* <p>Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case
|
|
12
12
|
* in the Amazon Web Services Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create
|
|
13
13
|
* Case</a> page.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a
|
|
15
15
|
* service limit increase in the following ways: </p>
|
|
16
|
-
*
|
|
16
|
+
* <ul>
|
|
17
17
|
* <li>
|
|
18
|
-
*
|
|
18
|
+
* <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>
|
|
19
19
|
* </li>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
21
|
+
* <p>Use the Service Quotas <a href="https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html">RequestServiceQuotaIncrease</a> operation.</p>
|
|
22
22
|
* </li>
|
|
23
23
|
* </ul>
|
|
24
|
-
*
|
|
24
|
+
* <p>A successful <code>CreateCase</code> request returns an Amazon Web Services Support case number. You can use
|
|
25
25
|
* the <a>DescribeCases</a> operation and specify the case number to get
|
|
26
26
|
* existing Amazon Web Services Support cases. After you create a case, use the <a>AddCommunicationToCase</a> operation to add additional communication or
|
|
27
27
|
* attachments to an existing case.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>The <code>caseId</code> is separate from the <code>displayId</code> that appears in
|
|
29
29
|
* 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>
|
|
30
|
-
*
|
|
30
|
+
* <note>
|
|
31
31
|
* <ul>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
34
34
|
* API. </p>
|
|
35
|
-
*
|
|
35
|
+
* </li>
|
|
36
36
|
* <li>
|
|
37
|
-
*
|
|
37
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
38
38
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
39
39
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
40
40
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
41
|
-
*
|
|
41
|
+
* </li>
|
|
42
42
|
* </ul>
|
|
43
|
-
*
|
|
43
|
+
* </note>
|
|
44
44
|
* @example
|
|
45
45
|
* Use a bare-bones client and the command you need to make an API call.
|
|
46
46
|
* ```javascript
|
|
@@ -13,20 +13,20 @@ export interface DescribeAttachmentCommandOutput extends DescribeAttachmentRespo
|
|
|
13
13
|
* case management system when you add an attachment to a case or case communication.
|
|
14
14
|
* Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are
|
|
15
15
|
* returned by the <a>DescribeCommunications</a> operation.</p>
|
|
16
|
-
*
|
|
16
|
+
* <note>
|
|
17
17
|
* <ul>
|
|
18
18
|
* <li>
|
|
19
|
-
*
|
|
19
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
20
20
|
* API. </p>
|
|
21
|
-
*
|
|
21
|
+
* </li>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
23
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
24
24
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
25
25
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
26
26
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
27
|
-
*
|
|
27
|
+
* </li>
|
|
28
28
|
* </ul>
|
|
29
|
-
*
|
|
29
|
+
* </note>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -13,32 +13,32 @@ export interface DescribeCasesCommandOutput extends DescribeCasesResponse, __Met
|
|
|
13
13
|
* date. You can set values for the <code>includeResolvedCases</code> and
|
|
14
14
|
* <code>includeCommunications</code> parameters to specify how much information to
|
|
15
15
|
* return.</p>
|
|
16
|
-
*
|
|
17
|
-
*
|
|
16
|
+
* <p>The response returns the following in JSON format:</p>
|
|
17
|
+
* <ul>
|
|
18
18
|
* <li>
|
|
19
|
-
*
|
|
19
|
+
* <p>One or more <a href="https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html">CaseDetails</a> data types.</p>
|
|
20
20
|
* </li>
|
|
21
21
|
* <li>
|
|
22
|
-
*
|
|
22
|
+
* <p>One or more <code>nextToken</code> values, which specify where to paginate the
|
|
23
23
|
* returned records represented by the <code>CaseDetails</code> objects.</p>
|
|
24
24
|
* </li>
|
|
25
25
|
* </ul>
|
|
26
|
-
*
|
|
26
|
+
* <p>Case data is available for 12 months after creation. If a case was created more than
|
|
27
27
|
* 12 months ago, a request might return an error.</p>
|
|
28
|
-
*
|
|
28
|
+
* <note>
|
|
29
29
|
* <ul>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
32
32
|
* API. </p>
|
|
33
|
-
*
|
|
33
|
+
* </li>
|
|
34
34
|
* <li>
|
|
35
|
-
*
|
|
35
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
36
36
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
37
37
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
38
38
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
39
|
-
*
|
|
39
|
+
* </li>
|
|
40
40
|
* </ul>
|
|
41
|
-
*
|
|
41
|
+
* </note>
|
|
42
42
|
* @example
|
|
43
43
|
* Use a bare-bones client and the command you need to make an API call.
|
|
44
44
|
* ```javascript
|
|
@@ -12,26 +12,26 @@ export interface DescribeCommunicationsCommandOutput extends DescribeCommunicati
|
|
|
12
12
|
* <code>afterTime</code> and <code>beforeTime</code> parameters to filter by date. You
|
|
13
13
|
* can use the <code>caseId</code> parameter to restrict the results to a specific
|
|
14
14
|
* case.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Case data is available for 12 months after creation. If a case was created more than
|
|
16
16
|
* 12 months ago, a request for data might cause an error.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>You can use the <code>maxResults</code> and <code>nextToken</code> parameters to
|
|
18
18
|
* control the pagination of the results. Set <code>maxResults</code> to the number of
|
|
19
19
|
* cases that you want to display on each page, and use <code>nextToken</code> to specify
|
|
20
20
|
* the resumption of pagination.</p>
|
|
21
|
-
*
|
|
21
|
+
* <note>
|
|
22
22
|
* <ul>
|
|
23
23
|
* <li>
|
|
24
|
-
*
|
|
24
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
25
25
|
* API. </p>
|
|
26
|
-
*
|
|
26
|
+
* </li>
|
|
27
27
|
* <li>
|
|
28
|
-
*
|
|
28
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
29
29
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
30
30
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
31
31
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
32
|
-
*
|
|
32
|
+
* </li>
|
|
33
33
|
* </ul>
|
|
34
|
-
*
|
|
34
|
+
* </note>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -11,26 +11,26 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse,
|
|
|
11
11
|
* <p>Returns the current list of Amazon Web Services services and a list of service categories for each
|
|
12
12
|
* service. You then use service names and categories in your <a>CreateCase</a>
|
|
13
13
|
* requests. Each Amazon Web Services service has its own set of categories.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>The service codes and category codes correspond to the values that appear in the
|
|
15
15
|
* <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
|
|
16
16
|
* don't necessarily match the service codes and categories returned by the
|
|
17
17
|
* <code>DescribeServices</code> operation. Always use the service codes and categories
|
|
18
18
|
* that the <code>DescribeServices</code> operation returns, so that you have the most
|
|
19
19
|
* recent set of service and category codes.</p>
|
|
20
|
-
*
|
|
20
|
+
* <note>
|
|
21
21
|
* <ul>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
23
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
24
24
|
* API. </p>
|
|
25
|
-
*
|
|
25
|
+
* </li>
|
|
26
26
|
* <li>
|
|
27
|
-
*
|
|
27
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
28
28
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
29
29
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
30
30
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
31
|
-
*
|
|
31
|
+
* </li>
|
|
32
32
|
* </ul>
|
|
33
|
-
*
|
|
33
|
+
* </note>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
36
|
* ```javascript
|
|
@@ -8,23 +8,23 @@ export interface DescribeSeverityLevelsCommandInput extends DescribeSeverityLeve
|
|
|
8
8
|
export interface DescribeSeverityLevelsCommandOutput extends DescribeSeverityLevelsResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Returns the list of severity levels that you can assign to a support case. The
|
|
12
|
-
* level for a case is also a field in the <a>CaseDetails</a> data type
|
|
13
|
-
* include for a <a>CreateCase</a> request.</p>
|
|
14
|
-
*
|
|
11
|
+
* <p>Returns the list of severity levels that you can assign to a support case. The
|
|
12
|
+
* severity level for a case is also a field in the <a>CaseDetails</a> data type
|
|
13
|
+
* that you include for a <a>CreateCase</a> request.</p>
|
|
14
|
+
* <note>
|
|
15
15
|
* <ul>
|
|
16
16
|
* <li>
|
|
17
|
-
*
|
|
17
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
18
18
|
* API. </p>
|
|
19
|
-
*
|
|
19
|
+
* </li>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
21
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
22
22
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
23
23
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
24
24
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
25
|
-
*
|
|
25
|
+
* </li>
|
|
26
26
|
* </ul>
|
|
27
|
-
*
|
|
27
|
+
* </note>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -10,24 +10,28 @@ export interface DescribeTrustedAdvisorCheckRefreshStatusesCommandOutput extends
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns the refresh status of the Trusted Advisor checks that have the specified check
|
|
12
12
|
* IDs. You can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a> operation.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>Some checks are refreshed automatically, and you can't return their refresh statuses
|
|
14
14
|
* by using the <code>DescribeTrustedAdvisorCheckRefreshStatuses</code> operation. If you
|
|
15
15
|
* call this operation for these checks, you might see an
|
|
16
16
|
* <code>InvalidParameterValue</code> error.</p>
|
|
17
|
-
*
|
|
17
|
+
* <note>
|
|
18
18
|
* <ul>
|
|
19
19
|
* <li>
|
|
20
|
-
*
|
|
20
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
21
21
|
* API. </p>
|
|
22
|
-
*
|
|
22
|
+
* </li>
|
|
23
23
|
* <li>
|
|
24
|
-
*
|
|
24
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
25
25
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
26
26
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
27
27
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
28
|
-
*
|
|
28
|
+
* </li>
|
|
29
29
|
* </ul>
|
|
30
|
-
*
|
|
30
|
+
* </note>
|
|
31
|
+
* <p>To call the Trusted Advisor operations in
|
|
32
|
+
* the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland)
|
|
33
|
+
* 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
|
|
34
|
+
* API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
|
|
31
35
|
* @example
|
|
32
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
37
|
* ```javascript
|
|
@@ -11,59 +11,62 @@ export interface DescribeTrustedAdvisorCheckResultCommandOutput extends Describe
|
|
|
11
11
|
* <p>Returns the results of the Trusted Advisor check that has the specified check ID. You
|
|
12
12
|
* can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a>
|
|
13
13
|
* operation.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>The response contains a <a>TrustedAdvisorCheckResult</a> object, which
|
|
15
15
|
* contains these three objects:</p>
|
|
16
|
-
*
|
|
16
|
+
* <ul>
|
|
17
17
|
* <li>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
18
|
+
* <p>
|
|
19
|
+
* <a>TrustedAdvisorCategorySpecificSummary</a>
|
|
20
|
+
* </p>
|
|
21
21
|
* </li>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
23
|
+
* <p>
|
|
24
|
+
* <a>TrustedAdvisorResourceDetail</a>
|
|
25
|
+
* </p>
|
|
26
26
|
* </li>
|
|
27
27
|
* <li>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
28
|
+
* <p>
|
|
29
|
+
* <a>TrustedAdvisorResourcesSummary</a>
|
|
30
|
+
* </p>
|
|
31
31
|
* </li>
|
|
32
32
|
* </ul>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
33
|
+
* <p>In addition, the response contains these fields:</p>
|
|
34
|
+
* <ul>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
37
|
-
*
|
|
36
|
+
* <p>
|
|
37
|
+
* <b>status</b> - The alert status of the check
|
|
38
38
|
* can be <code>ok</code> (green), <code>warning</code> (yellow),
|
|
39
39
|
* <code>error</code> (red), or <code>not_available</code>.</p>
|
|
40
40
|
* </li>
|
|
41
41
|
* <li>
|
|
42
|
-
*
|
|
43
|
-
*
|
|
42
|
+
* <p>
|
|
43
|
+
* <b>timestamp</b> - The time of the last refresh
|
|
44
44
|
* of the check.</p>
|
|
45
45
|
* </li>
|
|
46
46
|
* <li>
|
|
47
|
-
*
|
|
48
|
-
*
|
|
47
|
+
* <p>
|
|
48
|
+
* <b>checkId</b> - The unique identifier for the
|
|
49
49
|
* check.</p>
|
|
50
50
|
* </li>
|
|
51
51
|
* </ul>
|
|
52
|
-
*
|
|
53
|
-
* <note>
|
|
52
|
+
* <note>
|
|
54
53
|
* <ul>
|
|
55
54
|
* <li>
|
|
56
|
-
*
|
|
55
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
57
56
|
* API. </p>
|
|
58
|
-
*
|
|
57
|
+
* </li>
|
|
59
58
|
* <li>
|
|
60
|
-
*
|
|
59
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
61
60
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
62
61
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
63
62
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
64
|
-
*
|
|
63
|
+
* </li>
|
|
65
64
|
* </ul>
|
|
66
|
-
*
|
|
65
|
+
* </note>
|
|
66
|
+
* <p>To call the Trusted Advisor operations in
|
|
67
|
+
* the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland)
|
|
68
|
+
* 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
|
|
69
|
+
* API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
|
|
67
70
|
* @example
|
|
68
71
|
* Use a bare-bones client and the command you need to make an API call.
|
|
69
72
|
* ```javascript
|
|
@@ -10,22 +10,26 @@ export interface DescribeTrustedAdvisorCheckSummariesCommandOutput extends Descr
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns the results for the Trusted Advisor check summaries for the check IDs that you
|
|
12
12
|
* specified. You can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a> operation.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>The response contains an array of <a>TrustedAdvisorCheckSummary</a>
|
|
14
14
|
* objects.</p>
|
|
15
|
-
*
|
|
15
|
+
* <note>
|
|
16
16
|
* <ul>
|
|
17
17
|
* <li>
|
|
18
|
-
*
|
|
18
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support
|
|
19
19
|
* API. </p>
|
|
20
|
-
*
|
|
20
|
+
* </li>
|
|
21
21
|
* <li>
|
|
22
|
-
*
|
|
22
|
+
* <p>If you call the Amazon Web Services Support API from an account that doesn't have a
|
|
23
23
|
* Business, Enterprise On-Ramp, or Enterprise Support plan, the
|
|
24
24
|
* <code>SubscriptionRequiredException</code> error message appears. For
|
|
25
25
|
* information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
|
|
26
|
-
*
|
|
26
|
+
* </li>
|
|
27
27
|
* </ul>
|
|
28
|
-
*
|
|
28
|
+
* </note>
|
|
29
|
+
* <p>To call the Trusted Advisor operations in
|
|
30
|
+
* the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland)
|
|
31
|
+
* 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
|
|
32
|
+
* API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
|
|
29
33
|
* @example
|
|
30
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
35
|
* ```javascript
|