aws-sdk-support 1.22.1 → 1.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-support.rb +3 -1
- data/lib/aws-sdk-support/client.rb +261 -98
- data/lib/aws-sdk-support/client_api.rb +2 -0
- data/lib/aws-sdk-support/errors.rb +2 -0
- data/lib/aws-sdk-support/resource.rb +2 -0
- data/lib/aws-sdk-support/types.rb +28 -18
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5e4a17b947690a4992fc7993a8660c82fe307309c51346d1918987eb35517e6d
|
4
|
+
data.tar.gz: c9e70ccbfe10d626a093e3ffda61b654caa4aa3d9791ffcf85f9ea3bc41610e9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1547a58239e4066d0f62fa85c4fed3e3aafa3ef32bd17b91b86c4b928d74b3e93c7b73cb2e5b018bc4f67ec40e9919b039182c4baf2cbe10aba149e654df9adf
|
7
|
+
data.tar.gz: 283603f42fdbd8828381ca2b97ef7b5957a3830a125eb41be29cbd3bfcfcacce0efa9f8e40ca455e1218e95649352644f258250406e959e7d5568d8f1e00b9f0
|
data/lib/aws-sdk-support.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-support/customizations'
|
|
45
47
|
# @service
|
46
48
|
module Aws::Support
|
47
49
|
|
48
|
-
GEM_VERSION = '1.
|
50
|
+
GEM_VERSION = '1.23.0'
|
49
51
|
|
50
52
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -327,6 +329,20 @@ module Aws::Support
|
|
327
329
|
# after it's created. The `expiryTime` returned in the response is when
|
328
330
|
# the set expires.
|
329
331
|
#
|
332
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
333
|
+
# Support API.
|
334
|
+
#
|
335
|
+
# * If you call the AWS Support API from an account that does not have a
|
336
|
+
# Business or Enterprise support plan, the
|
337
|
+
# `SubscriptionRequiredException` error message appears. For
|
338
|
+
# information about changing your support plan, see [AWS Support][1].
|
339
|
+
#
|
340
|
+
# </note>
|
341
|
+
#
|
342
|
+
#
|
343
|
+
#
|
344
|
+
# [1]: http://aws.amazon.com/premiumsupport/
|
345
|
+
#
|
330
346
|
# @option params [String] :attachment_set_id
|
331
347
|
# The ID of the attachment set. If an `attachmentSetId` is not
|
332
348
|
# specified, a new attachment set is created, and the ID of the set is
|
@@ -374,16 +390,25 @@ module Aws::Support
|
|
374
390
|
req.send_request(options)
|
375
391
|
end
|
376
392
|
|
377
|
-
# Adds additional customer communication to an AWS Support case.
|
378
|
-
#
|
379
|
-
# can list a set of email addresses to copy on the communication
|
380
|
-
# the `ccEmailAddresses`
|
381
|
-
# the text of the communication.
|
393
|
+
# Adds additional customer communication to an AWS Support case. Use the
|
394
|
+
# `caseId` parameter to identify the case to which to add communication.
|
395
|
+
# You can list a set of email addresses to copy on the communication by
|
396
|
+
# using the `ccEmailAddresses` parameter. The `communicationBody` value
|
397
|
+
# contains the text of the communication.
|
398
|
+
#
|
399
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
400
|
+
# Support API.
|
401
|
+
#
|
402
|
+
# * If you call the AWS Support API from an account that does not have a
|
403
|
+
# Business or Enterprise support plan, the
|
404
|
+
# `SubscriptionRequiredException` error message appears. For
|
405
|
+
# information about changing your support plan, see [AWS Support][1].
|
406
|
+
#
|
407
|
+
# </note>
|
408
|
+
#
|
382
409
|
#
|
383
|
-
# The response indicates the success or failure of the request.
|
384
410
|
#
|
385
|
-
#
|
386
|
-
# Center.
|
411
|
+
# [1]: http://aws.amazon.com/premiumsupport/
|
387
412
|
#
|
388
413
|
# @option params [String] :case_id
|
389
414
|
# The AWS Support case ID requested or returned in the call. The case ID
|
@@ -438,17 +463,23 @@ module Aws::Support
|
|
438
463
|
#
|
439
464
|
# * Use the Service Quotas [RequestServiceQuotaIncrease][2] operation.
|
440
465
|
#
|
441
|
-
# A successful CreateCase request returns an AWS Support case number.
|
466
|
+
# A successful `CreateCase` request returns an AWS Support case number.
|
442
467
|
# You can use the DescribeCases operation and specify the case number to
|
443
|
-
# get existing AWS Support cases. After you create a case,
|
444
|
-
#
|
445
|
-
#
|
468
|
+
# get existing AWS Support cases. After you create a case, use the
|
469
|
+
# AddCommunicationToCase operation to add additional communication or
|
470
|
+
# attachments to an existing case.
|
471
|
+
#
|
472
|
+
# The `caseId` is separate from the `displayId` that appears in the [AWS
|
473
|
+
# Support Center][3]. Use the DescribeCases operation to get the
|
474
|
+
# `displayId`.
|
446
475
|
#
|
447
|
-
# <note markdown="1"> *
|
448
|
-
#
|
449
|
-
# the `displayId`.
|
476
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
477
|
+
# Support API.
|
450
478
|
#
|
451
|
-
#
|
479
|
+
# * If you call the AWS Support API from an account that does not have a
|
480
|
+
# Business or Enterprise support plan, the
|
481
|
+
# `SubscriptionRequiredException` error message appears. For
|
482
|
+
# information about changing your support plan, see [AWS Support][4].
|
452
483
|
#
|
453
484
|
# </note>
|
454
485
|
#
|
@@ -457,6 +488,7 @@ module Aws::Support
|
|
457
488
|
# [1]: https://console.aws.amazon.com/support/home#/case/create
|
458
489
|
# [2]: https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html
|
459
490
|
# [3]: https://console.aws.amazon.com/support
|
491
|
+
# [4]: http://aws.amazon.com/premiumsupport/
|
460
492
|
#
|
461
493
|
# @option params [required, String] :subject
|
462
494
|
# The title of the AWS Support case. The title appears in the
|
@@ -565,6 +597,20 @@ module Aws::Support
|
|
565
597
|
# are returned in the AttachmentDetails objects that are returned by the
|
566
598
|
# DescribeCommunications operation.
|
567
599
|
#
|
600
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
601
|
+
# Support API.
|
602
|
+
#
|
603
|
+
# * If you call the AWS Support API from an account that does not have a
|
604
|
+
# Business or Enterprise support plan, the
|
605
|
+
# `SubscriptionRequiredException` error message appears. For
|
606
|
+
# information about changing your support plan, see [AWS Support][1].
|
607
|
+
#
|
608
|
+
# </note>
|
609
|
+
#
|
610
|
+
#
|
611
|
+
#
|
612
|
+
# [1]: http://aws.amazon.com/premiumsupport/
|
613
|
+
#
|
568
614
|
# @option params [required, String] :attachment_id
|
569
615
|
# The ID of the attachment to return. Attachment IDs are returned by the
|
570
616
|
# DescribeCommunications operation.
|
@@ -594,22 +640,36 @@ module Aws::Support
|
|
594
640
|
end
|
595
641
|
|
596
642
|
# Returns a list of cases that you specify by passing one or more case
|
597
|
-
# IDs.
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
# Case data is available for 12 months after creation. If a case was
|
603
|
-
# created more than 12 months ago, a request for data might cause an
|
604
|
-
# error.
|
643
|
+
# IDs. You can use the `afterTime` and `beforeTime` parameters to filter
|
644
|
+
# the cases by date. You can set values for the `includeResolvedCases`
|
645
|
+
# and `includeCommunications` parameters to specify how much information
|
646
|
+
# to return.
|
605
647
|
#
|
606
648
|
# The response returns the following in JSON format:
|
607
649
|
#
|
608
|
-
# * One or more CaseDetails data types.
|
650
|
+
# * One or more [CaseDetails][1] data types.
|
609
651
|
#
|
610
652
|
# * One or more `nextToken` values, which specify where to paginate the
|
611
653
|
# returned records represented by the `CaseDetails` objects.
|
612
654
|
#
|
655
|
+
# Case data is available for 12 months after creation. If a case was
|
656
|
+
# created more than 12 months ago, a request might return an error.
|
657
|
+
#
|
658
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
659
|
+
# Support API.
|
660
|
+
#
|
661
|
+
# * If you call the AWS Support API from an account that does not have a
|
662
|
+
# Business or Enterprise support plan, the
|
663
|
+
# `SubscriptionRequiredException` error message appears. For
|
664
|
+
# information about changing your support plan, see [AWS Support][2].
|
665
|
+
#
|
666
|
+
# </note>
|
667
|
+
#
|
668
|
+
#
|
669
|
+
#
|
670
|
+
# [1]: https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html
|
671
|
+
# [2]: http://aws.amazon.com/premiumsupport/
|
672
|
+
#
|
613
673
|
# @option params [Array<String>] :case_id_list
|
614
674
|
# A list of ID numbers of the support cases you want returned. The
|
615
675
|
# maximum number of cases is 100.
|
@@ -628,8 +688,8 @@ module Aws::Support
|
|
628
688
|
# creation.
|
629
689
|
#
|
630
690
|
# @option params [Boolean] :include_resolved_cases
|
631
|
-
# Specifies whether resolved support cases
|
632
|
-
# DescribeCases
|
691
|
+
# Specifies whether to include resolved support cases in the
|
692
|
+
# `DescribeCases` response. By default, resolved cases aren't included.
|
633
693
|
#
|
634
694
|
# @option params [String] :next_token
|
635
695
|
# A resumption point for pagination.
|
@@ -644,8 +704,8 @@ module Aws::Support
|
|
644
704
|
# them.
|
645
705
|
#
|
646
706
|
# @option params [Boolean] :include_communications
|
647
|
-
# Specifies whether
|
648
|
-
#
|
707
|
+
# Specifies whether to include communications in the `DescribeCases`
|
708
|
+
# response. By default, communications are incuded.
|
649
709
|
#
|
650
710
|
# @return [Types::DescribeCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
651
711
|
#
|
@@ -703,19 +763,33 @@ module Aws::Support
|
|
703
763
|
req.send_request(options)
|
704
764
|
end
|
705
765
|
|
706
|
-
# Returns communications
|
707
|
-
#
|
708
|
-
#
|
709
|
-
#
|
766
|
+
# Returns communications and attachments for one or more support cases.
|
767
|
+
# Use the `afterTime` and `beforeTime` parameters to filter by date. You
|
768
|
+
# can use the `caseId` parameter to restrict the results to a specific
|
769
|
+
# case.
|
710
770
|
#
|
711
771
|
# Case data is available for 12 months after creation. If a case was
|
712
772
|
# created more than 12 months ago, a request for data might cause an
|
713
773
|
# error.
|
714
774
|
#
|
715
775
|
# You can use the `maxResults` and `nextToken` parameters to control the
|
716
|
-
# pagination of the
|
717
|
-
# you want
|
718
|
-
# resumption of pagination.
|
776
|
+
# pagination of the results. Set `maxResults` to the number of cases
|
777
|
+
# that you want to display on each page, and use `nextToken` to specify
|
778
|
+
# the resumption of pagination.
|
779
|
+
#
|
780
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
781
|
+
# Support API.
|
782
|
+
#
|
783
|
+
# * If you call the AWS Support API from an account that does not have a
|
784
|
+
# Business or Enterprise support plan, the
|
785
|
+
# `SubscriptionRequiredException` error message appears. For
|
786
|
+
# information about changing your support plan, see [AWS Support][1].
|
787
|
+
#
|
788
|
+
# </note>
|
789
|
+
#
|
790
|
+
#
|
791
|
+
#
|
792
|
+
# [1]: http://aws.amazon.com/premiumsupport/
|
719
793
|
#
|
720
794
|
# @option params [required, String] :case_id
|
721
795
|
# The AWS Support case ID requested or returned in the call. The case ID
|
@@ -777,22 +851,32 @@ module Aws::Support
|
|
777
851
|
end
|
778
852
|
|
779
853
|
# Returns the current list of AWS services and a list of service
|
780
|
-
# categories
|
781
|
-
#
|
782
|
-
#
|
854
|
+
# categories for each service. You then use service names and categories
|
855
|
+
# in your CreateCase requests. Each AWS service has its own set of
|
856
|
+
# categories.
|
857
|
+
#
|
858
|
+
# The service codes and category codes correspond to the values that
|
859
|
+
# appear in the **Service** and **Category** lists on the AWS Support
|
860
|
+
# Center [Create Case][1] page. The values in those fields don't
|
861
|
+
# necessarily match the service codes and categories returned by the
|
862
|
+
# `DescribeServices` operation. Always use the service codes and
|
863
|
+
# categories that the `DescribeServices` operation returns, so that you
|
864
|
+
# have the most recent set of service and category codes.
|
865
|
+
#
|
866
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
867
|
+
# Support API.
|
868
|
+
#
|
869
|
+
# * If you call the AWS Support API from an account that does not have a
|
870
|
+
# Business or Enterprise support plan, the
|
871
|
+
# `SubscriptionRequiredException` error message appears. For
|
872
|
+
# information about changing your support plan, see [AWS Support][2].
|
783
873
|
#
|
784
|
-
#
|
785
|
-
# displayed in the **Service** and **Category** drop-down lists on the
|
786
|
-
# AWS Support Center [Create Case][1] page. The values in those fields,
|
787
|
-
# however, do not necessarily match the service codes and categories
|
788
|
-
# returned by the `DescribeServices` request. Always use the service
|
789
|
-
# codes and categories obtained programmatically. This practice ensures
|
790
|
-
# that you always have the most recent set of service and category
|
791
|
-
# codes.
|
874
|
+
# </note>
|
792
875
|
#
|
793
876
|
#
|
794
877
|
#
|
795
878
|
# [1]: https://console.aws.amazon.com/support/home#/case/create
|
879
|
+
# [2]: http://aws.amazon.com/premiumsupport/
|
796
880
|
#
|
797
881
|
# @option params [Array<String>] :service_code_list
|
798
882
|
# A JSON-formatted list of service codes available for AWS services.
|
@@ -834,7 +918,21 @@ module Aws::Support
|
|
834
918
|
|
835
919
|
# Returns the list of severity levels that you can assign to an AWS
|
836
920
|
# Support case. The severity level for a case is also a field in the
|
837
|
-
# CaseDetails data type
|
921
|
+
# CaseDetails data type that you include for a CreateCase request.
|
922
|
+
#
|
923
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
924
|
+
# Support API.
|
925
|
+
#
|
926
|
+
# * If you call the AWS Support API from an account that does not have a
|
927
|
+
# Business or Enterprise support plan, the
|
928
|
+
# `SubscriptionRequiredException` error message appears. For
|
929
|
+
# information about changing your support plan, see [AWS Support][1].
|
930
|
+
#
|
931
|
+
# </note>
|
932
|
+
#
|
933
|
+
#
|
934
|
+
#
|
935
|
+
# [1]: http://aws.amazon.com/premiumsupport/
|
838
936
|
#
|
839
937
|
# @option params [String] :language
|
840
938
|
# The ISO 639-1 code for the language in which AWS provides support. AWS
|
@@ -867,21 +965,37 @@ module Aws::Support
|
|
867
965
|
req.send_request(options)
|
868
966
|
end
|
869
967
|
|
870
|
-
# Returns the refresh status of the Trusted Advisor checks that have
|
871
|
-
# specified check IDs.
|
872
|
-
# DescribeTrustedAdvisorChecks.
|
968
|
+
# Returns the refresh status of the AWS Trusted Advisor checks that have
|
969
|
+
# the specified check IDs. You can get the check IDs by calling the
|
970
|
+
# DescribeTrustedAdvisorChecks operation.
|
971
|
+
#
|
972
|
+
# Some checks are refreshed automatically, and you can't return their
|
973
|
+
# refresh statuses by using the
|
974
|
+
# `DescribeTrustedAdvisorCheckRefreshStatuses` operation. If you call
|
975
|
+
# this operation for these checks, you might see an
|
976
|
+
# `InvalidParameterValue` error.
|
873
977
|
#
|
874
|
-
# <note markdown="1">
|
875
|
-
#
|
876
|
-
#
|
877
|
-
#
|
978
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
979
|
+
# Support API.
|
980
|
+
#
|
981
|
+
# * If you call the AWS Support API from an account that does not have a
|
982
|
+
# Business or Enterprise support plan, the
|
983
|
+
# `SubscriptionRequiredException` error message appears. For
|
984
|
+
# information about changing your support plan, see [AWS Support][1].
|
878
985
|
#
|
879
986
|
# </note>
|
880
987
|
#
|
988
|
+
#
|
989
|
+
#
|
990
|
+
# [1]: http://aws.amazon.com/premiumsupport/
|
991
|
+
#
|
881
992
|
# @option params [required, Array<String>] :check_ids
|
882
|
-
# The IDs of the Trusted Advisor checks to get the status of.
|
883
|
-
#
|
884
|
-
#
|
993
|
+
# The IDs of the Trusted Advisor checks to get the status of.
|
994
|
+
#
|
995
|
+
# <note markdown="1"> If you specify the check ID of a check that is automatically
|
996
|
+
# refreshed, you might see an `InvalidParameterValue` error.
|
997
|
+
#
|
998
|
+
# </note>
|
885
999
|
#
|
886
1000
|
# @return [Types::DescribeTrustedAdvisorCheckRefreshStatusesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
887
1001
|
#
|
@@ -909,9 +1023,9 @@ module Aws::Support
|
|
909
1023
|
req.send_request(options)
|
910
1024
|
end
|
911
1025
|
|
912
|
-
# Returns the results of the Trusted Advisor check that has the
|
913
|
-
# specified check ID.
|
914
|
-
# DescribeTrustedAdvisorChecks.
|
1026
|
+
# Returns the results of the AWS Trusted Advisor check that has the
|
1027
|
+
# specified check ID. You can get the check IDs by calling the
|
1028
|
+
# DescribeTrustedAdvisorChecks operation.
|
915
1029
|
#
|
916
1030
|
# The response contains a TrustedAdvisorCheckResult object, which
|
917
1031
|
# contains these three objects:
|
@@ -924,12 +1038,26 @@ module Aws::Support
|
|
924
1038
|
#
|
925
1039
|
# In addition, the response contains these fields:
|
926
1040
|
#
|
927
|
-
# * **status
|
1041
|
+
# * **status** - The alert status of the check: "ok" (green),
|
928
1042
|
# "warning" (yellow), "error" (red), or "not\_available".
|
929
1043
|
#
|
930
|
-
# * **timestamp
|
1044
|
+
# * **timestamp** - The time of the last refresh of the check.
|
1045
|
+
#
|
1046
|
+
# * **checkId** - The unique identifier for the check.
|
931
1047
|
#
|
932
|
-
# *
|
1048
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
1049
|
+
# Support API.
|
1050
|
+
#
|
1051
|
+
# * If you call the AWS Support API from an account that does not have a
|
1052
|
+
# Business or Enterprise support plan, the
|
1053
|
+
# `SubscriptionRequiredException` error message appears. For
|
1054
|
+
# information about changing your support plan, see [AWS Support][1].
|
1055
|
+
#
|
1056
|
+
# </note>
|
1057
|
+
#
|
1058
|
+
#
|
1059
|
+
#
|
1060
|
+
# [1]: http://aws.amazon.com/premiumsupport/
|
933
1061
|
#
|
934
1062
|
# @option params [required, String] :check_id
|
935
1063
|
# The unique identifier for the Trusted Advisor check.
|
@@ -979,12 +1107,26 @@ module Aws::Support
|
|
979
1107
|
req.send_request(options)
|
980
1108
|
end
|
981
1109
|
|
982
|
-
# Returns the
|
983
|
-
#
|
984
|
-
#
|
1110
|
+
# Returns the results for the AWS Trusted Advisor check summaries for
|
1111
|
+
# the check IDs that you specified. You can get the check IDs by calling
|
1112
|
+
# the DescribeTrustedAdvisorChecks operation.
|
985
1113
|
#
|
986
1114
|
# The response contains an array of TrustedAdvisorCheckSummary objects.
|
987
1115
|
#
|
1116
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
1117
|
+
# Support API.
|
1118
|
+
#
|
1119
|
+
# * If you call the AWS Support API from an account that does not have a
|
1120
|
+
# Business or Enterprise support plan, the
|
1121
|
+
# `SubscriptionRequiredException` error message appears. For
|
1122
|
+
# information about changing your support plan, see [AWS Support][1].
|
1123
|
+
#
|
1124
|
+
# </note>
|
1125
|
+
#
|
1126
|
+
#
|
1127
|
+
#
|
1128
|
+
# [1]: http://aws.amazon.com/premiumsupport/
|
1129
|
+
#
|
988
1130
|
# @option params [required, Array<String>] :check_ids
|
989
1131
|
# The IDs of the Trusted Advisor checks.
|
990
1132
|
#
|
@@ -1021,12 +1163,26 @@ module Aws::Support
|
|
1021
1163
|
req.send_request(options)
|
1022
1164
|
end
|
1023
1165
|
|
1024
|
-
# Returns information about all available Trusted Advisor checks,
|
1025
|
-
# including name, ID, category, description, and metadata. You must
|
1026
|
-
# specify a language code
|
1027
|
-
#
|
1028
|
-
# TrustedAdvisorCheckDescription for each check.
|
1029
|
-
# to us-east-1.
|
1166
|
+
# Returns information about all available AWS Trusted Advisor checks,
|
1167
|
+
# including the name, ID, category, description, and metadata. You must
|
1168
|
+
# specify a language code. The AWS Support API currently supports
|
1169
|
+
# English ("en") and Japanese ("ja"). The response contains a
|
1170
|
+
# TrustedAdvisorCheckDescription object for each check. You must set the
|
1171
|
+
# AWS Region to us-east-1.
|
1172
|
+
#
|
1173
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
1174
|
+
# Support API.
|
1175
|
+
#
|
1176
|
+
# * If you call the AWS Support API from an account that does not have a
|
1177
|
+
# Business or Enterprise support plan, the
|
1178
|
+
# `SubscriptionRequiredException` error message appears. For
|
1179
|
+
# information about changing your support plan, see [AWS Support][1].
|
1180
|
+
#
|
1181
|
+
# </note>
|
1182
|
+
#
|
1183
|
+
#
|
1184
|
+
#
|
1185
|
+
# [1]: http://aws.amazon.com/premiumsupport/
|
1030
1186
|
#
|
1031
1187
|
# @option params [required, String] :language
|
1032
1188
|
# The ISO 639-1 code for the language in which AWS provides support. AWS
|
@@ -1063,38 +1219,31 @@ module Aws::Support
|
|
1063
1219
|
req.send_request(options)
|
1064
1220
|
end
|
1065
1221
|
|
1066
|
-
#
|
1067
|
-
# check ID.
|
1068
|
-
# DescribeTrustedAdvisorChecks.
|
1222
|
+
# Refreshes the AWS Trusted Advisor check that you specify using the
|
1223
|
+
# check ID. You can get the check IDs by calling the
|
1224
|
+
# DescribeTrustedAdvisorChecks operation.
|
1069
1225
|
#
|
1070
|
-
# <note markdown="1"> Some checks are refreshed automatically
|
1071
|
-
#
|
1072
|
-
#
|
1226
|
+
# <note markdown="1"> Some checks are refreshed automatically. If you call the
|
1227
|
+
# `RefreshTrustedAdvisorCheck` operation to refresh them, you might see
|
1228
|
+
# the `InvalidParameterValue` error.
|
1073
1229
|
#
|
1074
1230
|
# </note>
|
1075
1231
|
#
|
1076
|
-
# The response contains a TrustedAdvisorCheckRefreshStatus object
|
1077
|
-
# contains these fields:
|
1078
|
-
#
|
1079
|
-
# * **status.** The refresh status of the check:
|
1080
|
-
#
|
1081
|
-
# * `none:` The check is not refreshed or the non-success status
|
1082
|
-
# exceeds the timeout
|
1232
|
+
# The response contains a TrustedAdvisorCheckRefreshStatus object.
|
1083
1233
|
#
|
1084
|
-
#
|
1085
|
-
#
|
1234
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
1235
|
+
# Support API.
|
1086
1236
|
#
|
1087
|
-
#
|
1088
|
-
#
|
1237
|
+
# * If you call the AWS Support API from an account that does not have a
|
1238
|
+
# Business or Enterprise support plan, the
|
1239
|
+
# `SubscriptionRequiredException` error message appears. For
|
1240
|
+
# information about changing your support plan, see [AWS Support][1].
|
1089
1241
|
#
|
1090
|
-
#
|
1242
|
+
# </note>
|
1091
1243
|
#
|
1092
|
-
# * `abandoned:` The check refresh has failed
|
1093
1244
|
#
|
1094
|
-
# * **millisUntilNextRefreshable.** The amount of time, in milliseconds,
|
1095
|
-
# until the check is eligible for refresh.
|
1096
1245
|
#
|
1097
|
-
#
|
1246
|
+
# [1]: http://aws.amazon.com/premiumsupport/
|
1098
1247
|
#
|
1099
1248
|
# @option params [required, String] :check_id
|
1100
1249
|
# The unique identifier for the Trusted Advisor check to refresh.
|
@@ -1126,8 +1275,22 @@ module Aws::Support
|
|
1126
1275
|
req.send_request(options)
|
1127
1276
|
end
|
1128
1277
|
|
1129
|
-
#
|
1130
|
-
# the state of the case
|
1278
|
+
# Resolves a support case. This operation takes a `caseId` and returns
|
1279
|
+
# the initial and final state of the case.
|
1280
|
+
#
|
1281
|
+
# <note markdown="1"> * You must have a Business or Enterprise support plan to use the AWS
|
1282
|
+
# Support API.
|
1283
|
+
#
|
1284
|
+
# * If you call the AWS Support API from an account that does not have a
|
1285
|
+
# Business or Enterprise support plan, the
|
1286
|
+
# `SubscriptionRequiredException` error message appears. For
|
1287
|
+
# information about changing your support plan, see [AWS Support][1].
|
1288
|
+
#
|
1289
|
+
# </note>
|
1290
|
+
#
|
1291
|
+
#
|
1292
|
+
#
|
1293
|
+
# [1]: http://aws.amazon.com/premiumsupport/
|
1131
1294
|
#
|
1132
1295
|
# @option params [String] :case_id
|
1133
1296
|
# The AWS Support case ID requested or returned in the call. The case ID
|
@@ -1172,7 +1335,7 @@ module Aws::Support
|
|
1172
1335
|
params: params,
|
1173
1336
|
config: config)
|
1174
1337
|
context[:gem_name] = 'aws-sdk-support'
|
1175
|
-
context[:gem_version] = '1.
|
1338
|
+
context[:gem_version] = '1.23.0'
|
1176
1339
|
Seahorse::Client::Request.new(handlers, context)
|
1177
1340
|
end
|
1178
1341
|
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -69,8 +71,6 @@ module Aws::Support
|
|
69
71
|
include Aws::Structure
|
70
72
|
end
|
71
73
|
|
72
|
-
# To be written.
|
73
|
-
#
|
74
74
|
# @note When making an API call, you may pass AddCommunicationToCaseRequest
|
75
75
|
# data as a hash:
|
76
76
|
#
|
@@ -258,7 +258,7 @@ module Aws::Support
|
|
258
258
|
end
|
259
259
|
|
260
260
|
# A JSON-formatted object that contains the metadata for a support case.
|
261
|
-
# It is contained the response from a DescribeCases request.
|
261
|
+
# It is contained in the response from a DescribeCases request.
|
262
262
|
# **CaseDetails** contains the following fields:
|
263
263
|
#
|
264
264
|
# * **caseId.** The AWS Support case ID requested or returned in the
|
@@ -277,12 +277,12 @@ module Aws::Support
|
|
277
277
|
# and Japanese ("ja"). Language parameters must be passed explicitly
|
278
278
|
# for operations that take them.
|
279
279
|
#
|
280
|
+
# * **nextToken.** A resumption point for pagination.
|
281
|
+
#
|
280
282
|
# * **recentCommunications.** One or more Communication objects. Fields
|
281
283
|
# of these objects are `attachments`, `body`, `caseId`, `submittedBy`,
|
282
284
|
# and `timeCreated`.
|
283
285
|
#
|
284
|
-
# * **nextToken.** A resumption point for pagination.
|
285
|
-
#
|
286
286
|
# * **serviceCode.** The identifier for the AWS service that corresponds
|
287
287
|
# to the service code defined in the call to DescribeServices.
|
288
288
|
#
|
@@ -365,7 +365,7 @@ module Aws::Support
|
|
365
365
|
# @return [String]
|
366
366
|
#
|
367
367
|
# @!attribute [rw] time_created
|
368
|
-
# The time that the case was
|
368
|
+
# The time that the case was created in the AWS Support Center.
|
369
369
|
# @return [String]
|
370
370
|
#
|
371
371
|
# @!attribute [rw] recent_communications
|
@@ -695,8 +695,9 @@ module Aws::Support
|
|
695
695
|
# @return [String]
|
696
696
|
#
|
697
697
|
# @!attribute [rw] include_resolved_cases
|
698
|
-
# Specifies whether resolved support cases
|
699
|
-
# DescribeCases
|
698
|
+
# Specifies whether to include resolved support cases in the
|
699
|
+
# `DescribeCases` response. By default, resolved cases aren't
|
700
|
+
# included.
|
700
701
|
# @return [Boolean]
|
701
702
|
#
|
702
703
|
# @!attribute [rw] next_token
|
@@ -715,8 +716,8 @@ module Aws::Support
|
|
715
716
|
# @return [String]
|
716
717
|
#
|
717
718
|
# @!attribute [rw] include_communications
|
718
|
-
# Specifies whether
|
719
|
-
#
|
719
|
+
# Specifies whether to include communications in the `DescribeCases`
|
720
|
+
# response. By default, communications are incuded.
|
720
721
|
# @return [Boolean]
|
721
722
|
#
|
722
723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeCasesRequest AWS API Documentation
|
@@ -734,8 +735,12 @@ module Aws::Support
|
|
734
735
|
include Aws::Structure
|
735
736
|
end
|
736
737
|
|
737
|
-
# Returns an array of CaseDetails objects and a `nextToken` that
|
738
|
-
# a point for pagination in the result set.
|
738
|
+
# Returns an array of [CaseDetails][1] objects and a `nextToken` that
|
739
|
+
# defines a point for pagination in the result set.
|
740
|
+
#
|
741
|
+
#
|
742
|
+
#
|
743
|
+
# [1]: https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html
|
739
744
|
#
|
740
745
|
# @!attribute [rw] cases
|
741
746
|
# The details for the cases that match the request.
|
@@ -905,8 +910,11 @@ module Aws::Support
|
|
905
910
|
#
|
906
911
|
# @!attribute [rw] check_ids
|
907
912
|
# The IDs of the Trusted Advisor checks to get the status of.
|
908
|
-
#
|
909
|
-
#
|
913
|
+
#
|
914
|
+
# <note markdown="1"> If you specify the check ID of a check that is automatically
|
915
|
+
# refreshed, you might see an `InvalidParameterValue` error.
|
916
|
+
#
|
917
|
+
# </note>
|
910
918
|
# @return [Array<String>]
|
911
919
|
#
|
912
920
|
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatusesRequest AWS API Documentation
|
@@ -1173,11 +1181,12 @@ module Aws::Support
|
|
1173
1181
|
|
1174
1182
|
# A code and name pair that represents the severity level of a support
|
1175
1183
|
# case. The available values depend on the support plan for the account.
|
1176
|
-
# For more information, see [Choosing a
|
1184
|
+
# For more information, see [Choosing a severity][1] in the *AWS Support
|
1185
|
+
# User Guide*.
|
1177
1186
|
#
|
1178
1187
|
#
|
1179
1188
|
#
|
1180
|
-
# [1]: https://docs.aws.amazon.com/awssupport/latest/user/
|
1189
|
+
# [1]: https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity
|
1181
1190
|
#
|
1182
1191
|
# @!attribute [rw] code
|
1183
1192
|
# The code for case severity level.
|
@@ -1207,11 +1216,12 @@ module Aws::Support
|
|
1207
1216
|
#
|
1208
1217
|
# </note>
|
1209
1218
|
#
|
1210
|
-
# For more information, see [Choosing a
|
1219
|
+
# For more information, see [Choosing a severity][1] in the *AWS
|
1220
|
+
# Support User Guide*.
|
1211
1221
|
#
|
1212
1222
|
#
|
1213
1223
|
#
|
1214
|
-
# [1]: https://docs.aws.amazon.com/awssupport/latest/user/
|
1224
|
+
# [1]: https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity
|
1215
1225
|
# @return [String]
|
1216
1226
|
#
|
1217
1227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/support-2013-04-15/SeverityLevel AWS API Documentation
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-support
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.23.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-06-
|
11
|
+
date: 2020-06-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|