@aws-sdk/client-support 3.235.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 CHANGED
@@ -22,68 +22,38 @@ results in JSON format.</p>
22
22
  API. </p>
23
23
  </li>
24
24
  <li>
25
- <p>If you call the Amazon Web Services Support API from an account that does not have a
25
+ <p>If you call the Amazon Web Services Support API from an account that doesn't have a
26
26
  Business, Enterprise On-Ramp, or Enterprise Support plan, the
27
27
  <code>SubscriptionRequiredException</code> error message appears. For
28
28
  information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p>
29
29
  </li>
30
30
  </ul>
31
31
  </note>
32
- <p>The Amazon Web Services Support service also exposes a set of <a href="http://aws.amazon.com/premiumsupport/trustedadvisor/">Trusted Advisor</a> features. You can
33
- retrieve a list of checks and their descriptions, get check results, specify checks to
34
- refresh, and get the refresh status of checks.</p>
35
- <p>The following list describes the Amazon Web Services Support case management operations:</p>
32
+ <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
33
+ checks and their descriptions, get check results, specify checks to refresh, and get the
34
+ refresh status of checks.</p>
35
+ <p>You can manage your support cases with the following Amazon Web Services Support API operations:</p>
36
36
  <ul>
37
37
  <li>
38
- <p> Service names, issue categories, and available severity levels - The
39
- <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return Amazon Web Services service names,
40
- service codes, service categories, and problem severity levels. You use these
41
- values when you call the <a>CreateCase</a> operation.</p>
42
- </li>
43
- <li>
44
- <p> Case creation, case details, and case resolution - The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations
38
+ <p>The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations
45
39
  create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.</p>
46
40
  </li>
47
41
  <li>
48
- <p> Case communication - The <a>DescribeCommunications</a>,
49
- <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications
50
- and attachments to Amazon Web Services Support cases.</p>
51
- </li>
52
- </ul>
53
- <p>The following list describes the operations available from the Amazon Web Services Support service for
54
- Trusted Advisor:</p>
55
- <ul>
56
- <li>
57
- <p>
58
- <a>DescribeTrustedAdvisorChecks</a> returns the list of checks that
59
- run against your Amazon Web Services resources.</p>
60
- </li>
61
- <li>
62
- <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
63
- check that you specified.</p>
64
- </li>
65
- <li>
66
- <p>
67
- <a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized
68
- results for one or more Trusted Advisor checks.</p>
69
- </li>
70
- <li>
71
- <p>
72
- <a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a
73
- specified check.</p>
42
+ <p>The <a>DescribeCommunications</a>, <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications and attachments to Amazon Web Services Support
43
+ cases.</p>
74
44
  </li>
75
45
  <li>
76
- <p>
77
- <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh
78
- status of one or more checks.</p>
46
+ <p>The <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return Amazon Web Service names, service codes, service categories, and problem
47
+ severity levels. You use these values when you call the <a>CreateCase</a> operation.</p>
79
48
  </li>
80
49
  </ul>
50
+ <p>You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more
51
+ information, see <a href="https://docs.aws.amazon.com/">Trusted Advisor</a> in the
52
+ <i>Amazon Web Services Support User Guide</i>.</p>
81
53
  <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
82
54
  Process</a>.</p>
83
- <p>See <a href="https://docs.aws.amazon.com/awssupport/latest/user/Welcome.html">About the
84
- Amazon Web Services Support API</a> in the <i>Amazon Web Services Support User Guide</i> for
85
- information about how to use this service to create and manage your support cases, and
86
- how to call Trusted Advisor for results of checks on your resources.</p>
55
+ <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
56
+ Amazon Web Services Support API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
87
57
 
88
58
  ## Installing
89
59
 
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ruleSet = void 0;
4
- const y = "fn", z = "argv", A = "ref";
5
- const a = false, b = true, c = "String", d = "Boolean", e = "PartitionResult", f = "tree", g = "error", h = "endpoint", i = "stringEquals", j = "us-gov-west-1", k = "https://support.us-gov-west-1.amazonaws.com", l = "sigv4", m = "support", n = { [A]: "Region" }, o = { [A]: "Endpoint" }, p = { [y]: "booleanEquals", [z]: [{ [A]: "UseFIPS" }, true] }, q = { [y]: "booleanEquals", [z]: [{ [A]: "UseDualStack" }, true] }, r = {}, s = { [y]: "booleanEquals", [z]: [true, { [y]: "getAttr", [z]: [{ [A]: e }, "supportsFIPS"] }] }, t = { [y]: "booleanEquals", [z]: [true, { [y]: "getAttr", [z]: [{ [A]: e }, "supportsDualStack"] }] }, u = [o], v = [p], w = [], x = [q];
6
- const _data = { version: "1.0", parameters: { Region: { builtIn: "AWS::Region", required: a, documentation: "The AWS region used to dispatch the request.", type: c }, UseDualStack: { builtIn: "AWS::UseDualStack", required: b, default: a, documentation: "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", type: d }, UseFIPS: { builtIn: "AWS::UseFIPS", required: b, default: a, documentation: "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", type: d }, Endpoint: { builtIn: "SDK::Endpoint", required: a, documentation: "Override the endpoint used to send this request", type: c } }, rules: [{ conditions: [{ [y]: "aws.partition", [z]: [n], assign: e }], type: f, rules: [{ conditions: [{ [y]: "isSet", [z]: u }, { [y]: "parseURL", [z]: u, assign: "url" }], type: f, rules: [{ conditions: v, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: g }, { conditions: w, type: f, rules: [{ conditions: x, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: g }, { conditions: w, endpoint: { url: o, properties: r, headers: r }, type: h }] }] }, { conditions: [p, q], type: f, rules: [{ conditions: [s, t], type: f, rules: [{ conditions: w, endpoint: { url: "https://support-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, type: h }] }, { conditions: w, error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: g }] }, { conditions: v, type: f, rules: [{ conditions: [s], type: f, rules: [{ conditions: w, type: f, rules: [{ conditions: [{ [y]: i, [z]: [n, j] }], endpoint: { url: k, properties: r, headers: r }, type: h }, { conditions: w, endpoint: { url: "https://support-fips.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, type: h }] }] }, { conditions: w, error: "FIPS is enabled but this partition does not support FIPS", type: g }] }, { conditions: x, type: f, rules: [{ conditions: [t], type: f, rules: [{ conditions: w, endpoint: { url: "https://support.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, type: h }] }, { conditions: w, error: "DualStack is enabled but this partition does not support DualStack", type: g }] }, { conditions: w, type: f, rules: [{ conditions: [{ [y]: i, [z]: [n, "aws-global"] }], endpoint: { url: "https://support.us-east-1.amazonaws.com", properties: { authSchemes: [{ name: l, signingName: m, signingRegion: "us-east-1" }] }, headers: r }, type: h }, { conditions: [{ [y]: i, [z]: [n, "aws-cn-global"] }], endpoint: { url: "https://support.cn-north-1.amazonaws.com.cn", properties: { authSchemes: [{ name: l, signingName: m, signingRegion: "cn-north-1" }] }, headers: r }, type: h }, { conditions: [{ [y]: i, [z]: [n, "aws-us-gov-global"] }], endpoint: { url: k, properties: { authSchemes: [{ name: l, signingName: m, signingRegion: j }] }, headers: r }, type: h }, { conditions: [{ [y]: i, [z]: [n, "aws-iso-global"] }], endpoint: { url: "https://support.us-iso-east-1.c2s.ic.gov", properties: { authSchemes: [{ name: l, signingName: m, signingRegion: "us-iso-east-1" }] }, headers: r }, type: h }, { conditions: [{ [y]: i, [z]: [n, "aws-iso-b-global"] }], endpoint: { url: "https://support.us-isob-east-1.sc2s.sgov.gov", properties: { authSchemes: [{ name: l, signingName: m, signingRegion: "us-isob-east-1" }] }, headers: r }, type: h }, { conditions: w, endpoint: { url: "https://support.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, type: h }] }] }] };
4
+ const w = "fn", x = "argv", y = "ref";
5
+ const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = "stringEquals", i = "us-gov-west-1", j = "https://support.us-gov-west-1.amazonaws.com", k = "sigv4", l = "support", m = { "required": true, "default": false, "type": "Boolean" }, n = { [y]: "Region" }, o = { [y]: "Endpoint" }, p = { [w]: "booleanEquals", [x]: [{ [y]: "UseFIPS" }, true] }, q = { [w]: "booleanEquals", [x]: [{ [y]: "UseDualStack" }, true] }, r = {}, s = { [w]: "booleanEquals", [x]: [true, { [w]: "getAttr", [x]: [{ [y]: d }, "supportsFIPS"] }] }, t = { [w]: "booleanEquals", [x]: [true, { [w]: "getAttr", [x]: [{ [y]: d }, "supportsDualStack"] }] }, u = [p], v = [q];
6
+ const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: m, UseFIPS: m, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [w]: "aws.partition", [x]: [n], assign: d }], type: e, rules: [{ conditions: [{ [w]: "isSet", [x]: [o] }], type: e, rules: [{ conditions: u, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: v, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: o, properties: r, headers: r }, type: g }] }] }, { conditions: [p, q], type: e, rules: [{ conditions: [s, t], type: e, rules: [{ endpoint: { url: "https://support-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, type: g }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: u, type: e, rules: [{ conditions: [s], type: e, rules: [{ type: e, rules: [{ conditions: [{ [w]: h, [x]: [n, i] }], endpoint: { url: j, properties: r, headers: r }, type: g }, { endpoint: { url: "https://support-fips.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, type: g }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: v, type: e, rules: [{ conditions: [t], type: e, rules: [{ endpoint: { url: "https://support.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, type: g }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { type: e, rules: [{ conditions: [{ [w]: h, [x]: [n, "aws-global"] }], endpoint: { url: "https://support.us-east-1.amazonaws.com", properties: { authSchemes: [{ name: k, signingRegion: "us-east-1", signingName: l }] }, headers: r }, type: g }, { conditions: [{ [w]: h, [x]: [n, "aws-cn-global"] }], endpoint: { url: "https://support.cn-north-1.amazonaws.com.cn", properties: { authSchemes: [{ name: k, signingRegion: "cn-north-1", signingName: l }] }, headers: r }, type: g }, { conditions: [{ [w]: h, [x]: [n, "aws-us-gov-global"] }], endpoint: { url: j, properties: { authSchemes: [{ name: k, signingRegion: i, signingName: l }] }, headers: r }, type: g }, { conditions: [{ [w]: h, [x]: [n, "aws-iso-global"] }], endpoint: { url: "https://support.us-iso-east-1.c2s.ic.gov", properties: { authSchemes: [{ name: k, signingRegion: "us-iso-east-1", signingName: l }] }, headers: r }, type: g }, { conditions: [{ [w]: h, [x]: [n, "aws-iso-b-global"] }], endpoint: { url: "https://support.us-isob-east-1.sc2s.sgov.gov", properties: { authSchemes: [{ name: k, signingRegion: "us-isob-east-1", signingName: l }] }, headers: r }, type: g }, { endpoint: { url: "https://support.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, type: g }] }] }] };
7
7
  exports.ruleSet = _data;
@@ -1,4 +1,4 @@
1
- const y = "fn", z = "argv", A = "ref";
2
- const a = false, b = true, c = "String", d = "Boolean", e = "PartitionResult", f = "tree", g = "error", h = "endpoint", i = "stringEquals", j = "us-gov-west-1", k = "https://support.us-gov-west-1.amazonaws.com", l = "sigv4", m = "support", n = { [A]: "Region" }, o = { [A]: "Endpoint" }, p = { [y]: "booleanEquals", [z]: [{ [A]: "UseFIPS" }, true] }, q = { [y]: "booleanEquals", [z]: [{ [A]: "UseDualStack" }, true] }, r = {}, s = { [y]: "booleanEquals", [z]: [true, { [y]: "getAttr", [z]: [{ [A]: e }, "supportsFIPS"] }] }, t = { [y]: "booleanEquals", [z]: [true, { [y]: "getAttr", [z]: [{ [A]: e }, "supportsDualStack"] }] }, u = [o], v = [p], w = [], x = [q];
3
- const _data = { version: "1.0", parameters: { Region: { builtIn: "AWS::Region", required: a, documentation: "The AWS region used to dispatch the request.", type: c }, UseDualStack: { builtIn: "AWS::UseDualStack", required: b, default: a, documentation: "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", type: d }, UseFIPS: { builtIn: "AWS::UseFIPS", required: b, default: a, documentation: "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", type: d }, Endpoint: { builtIn: "SDK::Endpoint", required: a, documentation: "Override the endpoint used to send this request", type: c } }, rules: [{ conditions: [{ [y]: "aws.partition", [z]: [n], assign: e }], type: f, rules: [{ conditions: [{ [y]: "isSet", [z]: u }, { [y]: "parseURL", [z]: u, assign: "url" }], type: f, rules: [{ conditions: v, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: g }, { conditions: w, type: f, rules: [{ conditions: x, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: g }, { conditions: w, endpoint: { url: o, properties: r, headers: r }, type: h }] }] }, { conditions: [p, q], type: f, rules: [{ conditions: [s, t], type: f, rules: [{ conditions: w, endpoint: { url: "https://support-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, type: h }] }, { conditions: w, error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: g }] }, { conditions: v, type: f, rules: [{ conditions: [s], type: f, rules: [{ conditions: w, type: f, rules: [{ conditions: [{ [y]: i, [z]: [n, j] }], endpoint: { url: k, properties: r, headers: r }, type: h }, { conditions: w, endpoint: { url: "https://support-fips.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, type: h }] }] }, { conditions: w, error: "FIPS is enabled but this partition does not support FIPS", type: g }] }, { conditions: x, type: f, rules: [{ conditions: [t], type: f, rules: [{ conditions: w, endpoint: { url: "https://support.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, type: h }] }, { conditions: w, error: "DualStack is enabled but this partition does not support DualStack", type: g }] }, { conditions: w, type: f, rules: [{ conditions: [{ [y]: i, [z]: [n, "aws-global"] }], endpoint: { url: "https://support.us-east-1.amazonaws.com", properties: { authSchemes: [{ name: l, signingName: m, signingRegion: "us-east-1" }] }, headers: r }, type: h }, { conditions: [{ [y]: i, [z]: [n, "aws-cn-global"] }], endpoint: { url: "https://support.cn-north-1.amazonaws.com.cn", properties: { authSchemes: [{ name: l, signingName: m, signingRegion: "cn-north-1" }] }, headers: r }, type: h }, { conditions: [{ [y]: i, [z]: [n, "aws-us-gov-global"] }], endpoint: { url: k, properties: { authSchemes: [{ name: l, signingName: m, signingRegion: j }] }, headers: r }, type: h }, { conditions: [{ [y]: i, [z]: [n, "aws-iso-global"] }], endpoint: { url: "https://support.us-iso-east-1.c2s.ic.gov", properties: { authSchemes: [{ name: l, signingName: m, signingRegion: "us-iso-east-1" }] }, headers: r }, type: h }, { conditions: [{ [y]: i, [z]: [n, "aws-iso-b-global"] }], endpoint: { url: "https://support.us-isob-east-1.sc2s.sgov.gov", properties: { authSchemes: [{ name: l, signingName: m, signingRegion: "us-isob-east-1" }] }, headers: r }, type: h }, { conditions: w, endpoint: { url: "https://support.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, type: h }] }] }] };
1
+ const w = "fn", x = "argv", y = "ref";
2
+ const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = "stringEquals", i = "us-gov-west-1", j = "https://support.us-gov-west-1.amazonaws.com", k = "sigv4", l = "support", m = { "required": true, "default": false, "type": "Boolean" }, n = { [y]: "Region" }, o = { [y]: "Endpoint" }, p = { [w]: "booleanEquals", [x]: [{ [y]: "UseFIPS" }, true] }, q = { [w]: "booleanEquals", [x]: [{ [y]: "UseDualStack" }, true] }, r = {}, s = { [w]: "booleanEquals", [x]: [true, { [w]: "getAttr", [x]: [{ [y]: d }, "supportsFIPS"] }] }, t = { [w]: "booleanEquals", [x]: [true, { [w]: "getAttr", [x]: [{ [y]: d }, "supportsDualStack"] }] }, u = [p], v = [q];
3
+ const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: m, UseFIPS: m, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [w]: "aws.partition", [x]: [n], assign: d }], type: e, rules: [{ conditions: [{ [w]: "isSet", [x]: [o] }], type: e, rules: [{ conditions: u, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: v, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: o, properties: r, headers: r }, type: g }] }] }, { conditions: [p, q], type: e, rules: [{ conditions: [s, t], type: e, rules: [{ endpoint: { url: "https://support-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, type: g }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: u, type: e, rules: [{ conditions: [s], type: e, rules: [{ type: e, rules: [{ conditions: [{ [w]: h, [x]: [n, i] }], endpoint: { url: j, properties: r, headers: r }, type: g }, { endpoint: { url: "https://support-fips.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, type: g }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: v, type: e, rules: [{ conditions: [t], type: e, rules: [{ endpoint: { url: "https://support.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: r, headers: r }, type: g }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { type: e, rules: [{ conditions: [{ [w]: h, [x]: [n, "aws-global"] }], endpoint: { url: "https://support.us-east-1.amazonaws.com", properties: { authSchemes: [{ name: k, signingRegion: "us-east-1", signingName: l }] }, headers: r }, type: g }, { conditions: [{ [w]: h, [x]: [n, "aws-cn-global"] }], endpoint: { url: "https://support.cn-north-1.amazonaws.com.cn", properties: { authSchemes: [{ name: k, signingRegion: "cn-north-1", signingName: l }] }, headers: r }, type: g }, { conditions: [{ [w]: h, [x]: [n, "aws-us-gov-global"] }], endpoint: { url: j, properties: { authSchemes: [{ name: k, signingRegion: i, signingName: l }] }, headers: r }, type: g }, { conditions: [{ [w]: h, [x]: [n, "aws-iso-global"] }], endpoint: { url: "https://support.us-iso-east-1.c2s.ic.gov", properties: { authSchemes: [{ name: k, signingRegion: "us-iso-east-1", signingName: l }] }, headers: r }, type: g }, { conditions: [{ [w]: h, [x]: [n, "aws-iso-b-global"] }], endpoint: { url: "https://support.us-isob-east-1.sc2s.sgov.gov", properties: { authSchemes: [{ name: k, signingRegion: "us-isob-east-1", signingName: l }] }, headers: r }, type: g }, { endpoint: { url: "https://support.{Region}.{PartitionResult#dnsSuffix}", properties: r, headers: r }, type: g }] }] }] };
4
4
  export const ruleSet = _data;