aws-sdk-resourceexplorer2 1.41.0 → 1.42.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-resourceexplorer2/client.rb +537 -192
- data/lib/aws-sdk-resourceexplorer2/client_api.rb +320 -50
- data/lib/aws-sdk-resourceexplorer2/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-resourceexplorer2/errors.rb +4 -4
- data/lib/aws-sdk-resourceexplorer2/types.rb +821 -335
- data/lib/aws-sdk-resourceexplorer2/waiters.rb +15 -0
- data/lib/aws-sdk-resourceexplorer2.rb +2 -1
- data/sig/client.rbs +131 -39
- data/sig/errors.rbs +1 -1
- data/sig/types.rbs +178 -47
- metadata +2 -1
@@ -531,8 +531,8 @@ module Aws::ResourceExplorer2
|
|
531
531
|
#
|
532
532
|
# @return [Types::BatchGetViewOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
533
533
|
#
|
534
|
-
# * {Types::BatchGetViewOutput#errors #errors} => Array<Types::BatchGetViewError>
|
535
534
|
# * {Types::BatchGetViewOutput#views #views} => Array<Types::View>
|
535
|
+
# * {Types::BatchGetViewOutput#errors #errors} => Array<Types::BatchGetViewError>
|
536
536
|
#
|
537
537
|
# @example Request syntax with placeholder values
|
538
538
|
#
|
@@ -542,17 +542,17 @@ module Aws::ResourceExplorer2
|
|
542
542
|
#
|
543
543
|
# @example Response structure
|
544
544
|
#
|
545
|
-
# resp.errors #=> Array
|
546
|
-
# resp.errors[0].error_message #=> String
|
547
|
-
# resp.errors[0].view_arn #=> String
|
548
545
|
# resp.views #=> Array
|
549
|
-
# resp.views[0].
|
550
|
-
# resp.views[0].included_properties #=> Array
|
551
|
-
# resp.views[0].included_properties[0].name #=> String
|
552
|
-
# resp.views[0].last_updated_at #=> Time
|
546
|
+
# resp.views[0].view_arn #=> String
|
553
547
|
# resp.views[0].owner #=> String
|
548
|
+
# resp.views[0].last_updated_at #=> Time
|
554
549
|
# resp.views[0].scope #=> String
|
555
|
-
# resp.views[0].
|
550
|
+
# resp.views[0].included_properties #=> Array
|
551
|
+
# resp.views[0].included_properties[0].name #=> String
|
552
|
+
# resp.views[0].filters.filter_string #=> String
|
553
|
+
# resp.errors #=> Array
|
554
|
+
# resp.errors[0].view_arn #=> String
|
555
|
+
# resp.errors[0].error_message #=> String
|
556
556
|
#
|
557
557
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/BatchGetView AWS API Documentation
|
558
558
|
#
|
@@ -644,8 +644,8 @@ module Aws::ResourceExplorer2
|
|
644
644
|
# @return [Types::CreateIndexOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
645
645
|
#
|
646
646
|
# * {Types::CreateIndexOutput#arn #arn} => String
|
647
|
-
# * {Types::CreateIndexOutput#created_at #created_at} => Time
|
648
647
|
# * {Types::CreateIndexOutput#state #state} => String
|
648
|
+
# * {Types::CreateIndexOutput#created_at #created_at} => Time
|
649
649
|
#
|
650
650
|
# @example Request syntax with placeholder values
|
651
651
|
#
|
@@ -659,8 +659,8 @@ module Aws::ResourceExplorer2
|
|
659
659
|
# @example Response structure
|
660
660
|
#
|
661
661
|
# resp.arn #=> String
|
662
|
-
# resp.created_at #=> Time
|
663
662
|
# resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING"
|
663
|
+
# resp.created_at #=> Time
|
664
664
|
#
|
665
665
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateIndex AWS API Documentation
|
666
666
|
#
|
@@ -671,6 +671,51 @@ module Aws::ResourceExplorer2
|
|
671
671
|
req.send_request(options)
|
672
672
|
end
|
673
673
|
|
674
|
+
# Creates a Resource Explorer setup configuration across multiple Amazon
|
675
|
+
# Web Services Regions. This operation sets up indexes and views in the
|
676
|
+
# specified Regions. This operation can also be used to set an
|
677
|
+
# aggregator Region for cross-Region resource search.
|
678
|
+
#
|
679
|
+
# @option params [required, Array<String>] :region_list
|
680
|
+
# A list of Amazon Web Services Regions where Resource Explorer should
|
681
|
+
# be configured. Each Region in the list will have a user-owned index
|
682
|
+
# created.
|
683
|
+
#
|
684
|
+
# @option params [Array<String>] :aggregator_regions
|
685
|
+
# A list of Amazon Web Services Regions that should be configured as
|
686
|
+
# aggregator Regions. Aggregator Regions receive replicated index
|
687
|
+
# information from all other Regions where there is a user-owned index.
|
688
|
+
#
|
689
|
+
# @option params [required, String] :view_name
|
690
|
+
# The name for the view to be created as part of the Resource Explorer
|
691
|
+
# setup. The view name must be unique within the Amazon Web Services
|
692
|
+
# account and Region.
|
693
|
+
#
|
694
|
+
# @return [Types::CreateResourceExplorerSetupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
695
|
+
#
|
696
|
+
# * {Types::CreateResourceExplorerSetupOutput#task_id #task_id} => String
|
697
|
+
#
|
698
|
+
# @example Request syntax with placeholder values
|
699
|
+
#
|
700
|
+
# resp = client.create_resource_explorer_setup({
|
701
|
+
# region_list: ["CreateResourceExplorerSetupInputRegionListListMemberString"], # required
|
702
|
+
# aggregator_regions: ["CreateResourceExplorerSetupInputAggregatorRegionsListMemberString"],
|
703
|
+
# view_name: "CreateResourceExplorerSetupInputViewNameString", # required
|
704
|
+
# })
|
705
|
+
#
|
706
|
+
# @example Response structure
|
707
|
+
#
|
708
|
+
# resp.task_id #=> String
|
709
|
+
#
|
710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateResourceExplorerSetup AWS API Documentation
|
711
|
+
#
|
712
|
+
# @overload create_resource_explorer_setup(params = {})
|
713
|
+
# @param [Hash] params ({})
|
714
|
+
def create_resource_explorer_setup(params = {}, options = {})
|
715
|
+
req = build_request(:create_resource_explorer_setup, params)
|
716
|
+
req.send_request(options)
|
717
|
+
end
|
718
|
+
|
674
719
|
# Creates a view that users can query by using the Search operation.
|
675
720
|
# Results from queries that you make using this view include only
|
676
721
|
# resources that match the view's `Filters`. For more information about
|
@@ -700,6 +745,26 @@ module Aws::ResourceExplorer2
|
|
700
745
|
#
|
701
746
|
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
702
747
|
#
|
748
|
+
# @option params [required, String] :view_name
|
749
|
+
# The name of the new view. This name appears in the list of views in
|
750
|
+
# Resource Explorer.
|
751
|
+
#
|
752
|
+
# The name must be no more than 64 characters long, and can include
|
753
|
+
# letters, digits, and the dash (-) character. The name must be unique
|
754
|
+
# within its Amazon Web Services Region.
|
755
|
+
#
|
756
|
+
# @option params [Array<Types::IncludedProperty>] :included_properties
|
757
|
+
# Specifies optional fields that you want included in search results
|
758
|
+
# from this view. It is a list of objects that each describe a field to
|
759
|
+
# include.
|
760
|
+
#
|
761
|
+
# The default is an empty list, with no optional fields included in the
|
762
|
+
# results.
|
763
|
+
#
|
764
|
+
# @option params [String] :scope
|
765
|
+
# The root ARN of the account, an organizational unit (OU), or an
|
766
|
+
# organization ARN. If left empty, the default is account.
|
767
|
+
#
|
703
768
|
# @option params [Types::SearchFilter] :filters
|
704
769
|
# An array of strings that specify which resources are included in the
|
705
770
|
# results of queries made using this view. When you use this view in a
|
@@ -723,29 +788,9 @@ module Aws::ResourceExplorer2
|
|
723
788
|
# [2]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters
|
724
789
|
# [3]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators
|
725
790
|
#
|
726
|
-
# @option params [Array<Types::IncludedProperty>] :included_properties
|
727
|
-
# Specifies optional fields that you want included in search results
|
728
|
-
# from this view. It is a list of objects that each describe a field to
|
729
|
-
# include.
|
730
|
-
#
|
731
|
-
# The default is an empty list, with no optional fields included in the
|
732
|
-
# results.
|
733
|
-
#
|
734
|
-
# @option params [String] :scope
|
735
|
-
# The root ARN of the account, an organizational unit (OU), or an
|
736
|
-
# organization ARN. If left empty, the default is account.
|
737
|
-
#
|
738
791
|
# @option params [Hash<String,String>] :tags
|
739
792
|
# Tag key and value pairs that are attached to the view.
|
740
793
|
#
|
741
|
-
# @option params [required, String] :view_name
|
742
|
-
# The name of the new view. This name appears in the list of views in
|
743
|
-
# Resource Explorer.
|
744
|
-
#
|
745
|
-
# The name must be no more than 64 characters long, and can include
|
746
|
-
# letters, digits, and the dash (-) character. The name must be unique
|
747
|
-
# within its Amazon Web Services Region.
|
748
|
-
#
|
749
794
|
# @return [Types::CreateViewOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
750
795
|
#
|
751
796
|
# * {Types::CreateViewOutput#view #view} => Types::View
|
@@ -754,30 +799,30 @@ module Aws::ResourceExplorer2
|
|
754
799
|
#
|
755
800
|
# resp = client.create_view({
|
756
801
|
# client_token: "CreateViewInputClientTokenString",
|
757
|
-
#
|
758
|
-
# filter_string: "SearchFilterFilterStringString", # required
|
759
|
-
# },
|
802
|
+
# view_name: "ViewName", # required
|
760
803
|
# included_properties: [
|
761
804
|
# {
|
762
805
|
# name: "IncludedPropertyNameString", # required
|
763
806
|
# },
|
764
807
|
# ],
|
765
808
|
# scope: "CreateViewInputScopeString",
|
809
|
+
# filters: {
|
810
|
+
# filter_string: "SearchFilterFilterStringString", # required
|
811
|
+
# },
|
766
812
|
# tags: {
|
767
813
|
# "String" => "String",
|
768
814
|
# },
|
769
|
-
# view_name: "ViewName", # required
|
770
815
|
# })
|
771
816
|
#
|
772
817
|
# @example Response structure
|
773
818
|
#
|
774
|
-
# resp.view.
|
775
|
-
# resp.view.included_properties #=> Array
|
776
|
-
# resp.view.included_properties[0].name #=> String
|
777
|
-
# resp.view.last_updated_at #=> Time
|
819
|
+
# resp.view.view_arn #=> String
|
778
820
|
# resp.view.owner #=> String
|
821
|
+
# resp.view.last_updated_at #=> Time
|
779
822
|
# resp.view.scope #=> String
|
780
|
-
# resp.view.
|
823
|
+
# resp.view.included_properties #=> Array
|
824
|
+
# resp.view.included_properties[0].name #=> String
|
825
|
+
# resp.view.filters.filter_string #=> String
|
781
826
|
#
|
782
827
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateView AWS API Documentation
|
783
828
|
#
|
@@ -815,8 +860,8 @@ module Aws::ResourceExplorer2
|
|
815
860
|
# @return [Types::DeleteIndexOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
816
861
|
#
|
817
862
|
# * {Types::DeleteIndexOutput#arn #arn} => String
|
818
|
-
# * {Types::DeleteIndexOutput#last_updated_at #last_updated_at} => Time
|
819
863
|
# * {Types::DeleteIndexOutput#state #state} => String
|
864
|
+
# * {Types::DeleteIndexOutput#last_updated_at #last_updated_at} => Time
|
820
865
|
#
|
821
866
|
# @example Request syntax with placeholder values
|
822
867
|
#
|
@@ -827,8 +872,8 @@ module Aws::ResourceExplorer2
|
|
827
872
|
# @example Response structure
|
828
873
|
#
|
829
874
|
# resp.arn #=> String
|
830
|
-
# resp.last_updated_at #=> Time
|
831
875
|
# resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING"
|
876
|
+
# resp.last_updated_at #=> Time
|
832
877
|
#
|
833
878
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteIndex AWS API Documentation
|
834
879
|
#
|
@@ -839,6 +884,45 @@ module Aws::ResourceExplorer2
|
|
839
884
|
req.send_request(options)
|
840
885
|
end
|
841
886
|
|
887
|
+
# Deletes a Resource Explorer setup configuration. This operation
|
888
|
+
# removes indexes and views from the specified Regions or all Regions
|
889
|
+
# where Resource Explorer is configured.
|
890
|
+
#
|
891
|
+
# @option params [Array<String>] :region_list
|
892
|
+
# A list of Amazon Web Services Regions from which to delete the
|
893
|
+
# Resource Explorer configuration. If not specified, the operation uses
|
894
|
+
# the `DeleteInAllRegions` parameter to determine scope.
|
895
|
+
#
|
896
|
+
# @option params [Boolean] :delete_in_all_regions
|
897
|
+
# Specifies whether to delete Resource Explorer configuration from all
|
898
|
+
# Regions where it is currently enabled. If this parameter is set to
|
899
|
+
# `true`, a value for `RegionList` must not be provided. Otherwise, the
|
900
|
+
# operation fails with a `ValidationException` error.
|
901
|
+
#
|
902
|
+
# @return [Types::DeleteResourceExplorerSetupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
903
|
+
#
|
904
|
+
# * {Types::DeleteResourceExplorerSetupOutput#task_id #task_id} => String
|
905
|
+
#
|
906
|
+
# @example Request syntax with placeholder values
|
907
|
+
#
|
908
|
+
# resp = client.delete_resource_explorer_setup({
|
909
|
+
# region_list: ["RegionListMemberString"],
|
910
|
+
# delete_in_all_regions: false,
|
911
|
+
# })
|
912
|
+
#
|
913
|
+
# @example Response structure
|
914
|
+
#
|
915
|
+
# resp.task_id #=> String
|
916
|
+
#
|
917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteResourceExplorerSetup AWS API Documentation
|
918
|
+
#
|
919
|
+
# @overload delete_resource_explorer_setup(params = {})
|
920
|
+
# @param [Hash] params ({})
|
921
|
+
def delete_resource_explorer_setup(params = {}, options = {})
|
922
|
+
req = build_request(:delete_resource_explorer_setup, params)
|
923
|
+
req.send_request(options)
|
924
|
+
end
|
925
|
+
|
842
926
|
# Deletes the specified view.
|
843
927
|
#
|
844
928
|
# If the specified view is the default view for its Amazon Web Services
|
@@ -949,27 +1033,27 @@ module Aws::ResourceExplorer2
|
|
949
1033
|
# @return [Types::GetIndexOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
950
1034
|
#
|
951
1035
|
# * {Types::GetIndexOutput#arn #arn} => String
|
952
|
-
# * {Types::GetIndexOutput#
|
953
|
-
# * {Types::GetIndexOutput#
|
1036
|
+
# * {Types::GetIndexOutput#type #type} => String
|
1037
|
+
# * {Types::GetIndexOutput#state #state} => String
|
954
1038
|
# * {Types::GetIndexOutput#replicating_from #replicating_from} => Array<String>
|
955
1039
|
# * {Types::GetIndexOutput#replicating_to #replicating_to} => Array<String>
|
956
|
-
# * {Types::GetIndexOutput#
|
1040
|
+
# * {Types::GetIndexOutput#created_at #created_at} => Time
|
1041
|
+
# * {Types::GetIndexOutput#last_updated_at #last_updated_at} => Time
|
957
1042
|
# * {Types::GetIndexOutput#tags #tags} => Hash<String,String>
|
958
|
-
# * {Types::GetIndexOutput#type #type} => String
|
959
1043
|
#
|
960
1044
|
# @example Response structure
|
961
1045
|
#
|
962
1046
|
# resp.arn #=> String
|
963
|
-
# resp.
|
964
|
-
# resp.
|
1047
|
+
# resp.type #=> String, one of "LOCAL", "AGGREGATOR"
|
1048
|
+
# resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING"
|
965
1049
|
# resp.replicating_from #=> Array
|
966
1050
|
# resp.replicating_from[0] #=> String
|
967
1051
|
# resp.replicating_to #=> Array
|
968
1052
|
# resp.replicating_to[0] #=> String
|
969
|
-
# resp.
|
1053
|
+
# resp.created_at #=> Time
|
1054
|
+
# resp.last_updated_at #=> Time
|
970
1055
|
# resp.tags #=> Hash
|
971
1056
|
# resp.tags["String"] #=> String
|
972
|
-
# resp.type #=> String, one of "LOCAL", "AGGREGATOR"
|
973
1057
|
#
|
974
1058
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetIndex AWS API Documentation
|
975
1059
|
#
|
@@ -1002,16 +1086,16 @@ module Aws::ResourceExplorer2
|
|
1002
1086
|
#
|
1003
1087
|
# @example Response structure
|
1004
1088
|
#
|
1005
|
-
# resp.managed_view.filters.filter_string #=> String
|
1006
|
-
# resp.managed_view.included_properties #=> Array
|
1007
|
-
# resp.managed_view.included_properties[0].name #=> String
|
1008
|
-
# resp.managed_view.last_updated_at #=> Time
|
1009
1089
|
# resp.managed_view.managed_view_arn #=> String
|
1010
1090
|
# resp.managed_view.managed_view_name #=> String
|
1091
|
+
# resp.managed_view.trusted_service #=> String
|
1092
|
+
# resp.managed_view.last_updated_at #=> Time
|
1011
1093
|
# resp.managed_view.owner #=> String
|
1012
|
-
# resp.managed_view.resource_policy #=> String
|
1013
1094
|
# resp.managed_view.scope #=> String
|
1014
|
-
# resp.managed_view.
|
1095
|
+
# resp.managed_view.included_properties #=> Array
|
1096
|
+
# resp.managed_view.included_properties[0].name #=> String
|
1097
|
+
# resp.managed_view.filters.filter_string #=> String
|
1098
|
+
# resp.managed_view.resource_policy #=> String
|
1015
1099
|
# resp.managed_view.version #=> String
|
1016
1100
|
#
|
1017
1101
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetManagedView AWS API Documentation
|
@@ -1023,6 +1107,128 @@ module Aws::ResourceExplorer2
|
|
1023
1107
|
req.send_request(options)
|
1024
1108
|
end
|
1025
1109
|
|
1110
|
+
# Retrieves the status and details of a Resource Explorer setup
|
1111
|
+
# operation. This operation returns information about the progress of
|
1112
|
+
# creating or deleting Resource Explorer configurations across Regions.
|
1113
|
+
#
|
1114
|
+
# @option params [required, String] :task_id
|
1115
|
+
# The unique identifier of the setup task to retrieve status information
|
1116
|
+
# for. This ID is returned by `CreateResourceExplorerSetup` or
|
1117
|
+
# `DeleteResourceExplorerSetup` operations.
|
1118
|
+
#
|
1119
|
+
# @option params [Integer] :max_results
|
1120
|
+
# The maximum number of Region status results to return in a single
|
1121
|
+
# response. Valid values are between `1` and `100`.
|
1122
|
+
#
|
1123
|
+
# @option params [String] :next_token
|
1124
|
+
# The pagination token from a previous `GetResourceExplorerSetup`
|
1125
|
+
# response. Use this token to retrieve the next set of results.
|
1126
|
+
#
|
1127
|
+
# @return [Types::GetResourceExplorerSetupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1128
|
+
#
|
1129
|
+
# * {Types::GetResourceExplorerSetupOutput#regions #regions} => Array<Types::RegionStatus>
|
1130
|
+
# * {Types::GetResourceExplorerSetupOutput#next_token #next_token} => String
|
1131
|
+
#
|
1132
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1133
|
+
#
|
1134
|
+
# @example Request syntax with placeholder values
|
1135
|
+
#
|
1136
|
+
# resp = client.get_resource_explorer_setup({
|
1137
|
+
# task_id: "GetResourceExplorerSetupInputTaskIdString", # required
|
1138
|
+
# max_results: 1,
|
1139
|
+
# next_token: "GetResourceExplorerSetupInputNextTokenString",
|
1140
|
+
# })
|
1141
|
+
#
|
1142
|
+
# @example Response structure
|
1143
|
+
#
|
1144
|
+
# resp.regions #=> Array
|
1145
|
+
# resp.regions[0].region #=> String
|
1146
|
+
# resp.regions[0].index.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS", "SKIPPED"
|
1147
|
+
# resp.regions[0].index.index.region #=> String
|
1148
|
+
# resp.regions[0].index.index.arn #=> String
|
1149
|
+
# resp.regions[0].index.index.type #=> String, one of "LOCAL", "AGGREGATOR"
|
1150
|
+
# resp.regions[0].index.error_details.code #=> String
|
1151
|
+
# resp.regions[0].index.error_details.message #=> String
|
1152
|
+
# resp.regions[0].view.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS", "SKIPPED"
|
1153
|
+
# resp.regions[0].view.view.view_arn #=> String
|
1154
|
+
# resp.regions[0].view.view.owner #=> String
|
1155
|
+
# resp.regions[0].view.view.last_updated_at #=> Time
|
1156
|
+
# resp.regions[0].view.view.scope #=> String
|
1157
|
+
# resp.regions[0].view.view.included_properties #=> Array
|
1158
|
+
# resp.regions[0].view.view.included_properties[0].name #=> String
|
1159
|
+
# resp.regions[0].view.view.filters.filter_string #=> String
|
1160
|
+
# resp.regions[0].view.error_details.code #=> String
|
1161
|
+
# resp.regions[0].view.error_details.message #=> String
|
1162
|
+
# resp.next_token #=> String
|
1163
|
+
#
|
1164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetResourceExplorerSetup AWS API Documentation
|
1165
|
+
#
|
1166
|
+
# @overload get_resource_explorer_setup(params = {})
|
1167
|
+
# @param [Hash] params ({})
|
1168
|
+
def get_resource_explorer_setup(params = {}, options = {})
|
1169
|
+
req = build_request(:get_resource_explorer_setup, params)
|
1170
|
+
req.send_request(options)
|
1171
|
+
end
|
1172
|
+
|
1173
|
+
# Retrieves information about the Resource Explorer index in the current
|
1174
|
+
# Amazon Web Services Region. This operation returns the ARN and type of
|
1175
|
+
# the index if one exists.
|
1176
|
+
#
|
1177
|
+
# @return [Types::GetServiceIndexOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1178
|
+
#
|
1179
|
+
# * {Types::GetServiceIndexOutput#arn #arn} => String
|
1180
|
+
# * {Types::GetServiceIndexOutput#type #type} => String
|
1181
|
+
#
|
1182
|
+
# @example Response structure
|
1183
|
+
#
|
1184
|
+
# resp.arn #=> String
|
1185
|
+
# resp.type #=> String, one of "LOCAL", "AGGREGATOR"
|
1186
|
+
#
|
1187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetServiceIndex AWS API Documentation
|
1188
|
+
#
|
1189
|
+
# @overload get_service_index(params = {})
|
1190
|
+
# @param [Hash] params ({})
|
1191
|
+
def get_service_index(params = {}, options = {})
|
1192
|
+
req = build_request(:get_service_index, params)
|
1193
|
+
req.send_request(options)
|
1194
|
+
end
|
1195
|
+
|
1196
|
+
# Retrieves details about a specific Resource Explorer service view.
|
1197
|
+
# This operation returns the configuration and properties of the
|
1198
|
+
# specified view.
|
1199
|
+
#
|
1200
|
+
# @option params [required, String] :service_view_arn
|
1201
|
+
# The Amazon Resource Name (ARN) of the service view to retrieve details
|
1202
|
+
# for.
|
1203
|
+
#
|
1204
|
+
# @return [Types::GetServiceViewOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1205
|
+
#
|
1206
|
+
# * {Types::GetServiceViewOutput#view #view} => Types::ServiceView
|
1207
|
+
#
|
1208
|
+
# @example Request syntax with placeholder values
|
1209
|
+
#
|
1210
|
+
# resp = client.get_service_view({
|
1211
|
+
# service_view_arn: "GetServiceViewInputServiceViewArnString", # required
|
1212
|
+
# })
|
1213
|
+
#
|
1214
|
+
# @example Response structure
|
1215
|
+
#
|
1216
|
+
# resp.view.service_view_arn #=> String
|
1217
|
+
# resp.view.filters.filter_string #=> String
|
1218
|
+
# resp.view.included_properties #=> Array
|
1219
|
+
# resp.view.included_properties[0].name #=> String
|
1220
|
+
# resp.view.streaming_access_for_service #=> String
|
1221
|
+
# resp.view.scope_type #=> String
|
1222
|
+
#
|
1223
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetServiceView AWS API Documentation
|
1224
|
+
#
|
1225
|
+
# @overload get_service_view(params = {})
|
1226
|
+
# @param [Hash] params ({})
|
1227
|
+
def get_service_view(params = {}, options = {})
|
1228
|
+
req = build_request(:get_service_view, params)
|
1229
|
+
req.send_request(options)
|
1230
|
+
end
|
1231
|
+
|
1026
1232
|
# Retrieves details of the specified view.
|
1027
1233
|
#
|
1028
1234
|
# @option params [required, String] :view_arn
|
@@ -1035,8 +1241,8 @@ module Aws::ResourceExplorer2
|
|
1035
1241
|
#
|
1036
1242
|
# @return [Types::GetViewOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1037
1243
|
#
|
1038
|
-
# * {Types::GetViewOutput#tags #tags} => Hash<String,String>
|
1039
1244
|
# * {Types::GetViewOutput#view #view} => Types::View
|
1245
|
+
# * {Types::GetViewOutput#tags #tags} => Hash<String,String>
|
1040
1246
|
#
|
1041
1247
|
# @example Request syntax with placeholder values
|
1042
1248
|
#
|
@@ -1046,15 +1252,15 @@ module Aws::ResourceExplorer2
|
|
1046
1252
|
#
|
1047
1253
|
# @example Response structure
|
1048
1254
|
#
|
1049
|
-
# resp.
|
1050
|
-
# resp.tags["String"] #=> String
|
1051
|
-
# resp.view.filters.filter_string #=> String
|
1052
|
-
# resp.view.included_properties #=> Array
|
1053
|
-
# resp.view.included_properties[0].name #=> String
|
1054
|
-
# resp.view.last_updated_at #=> Time
|
1255
|
+
# resp.view.view_arn #=> String
|
1055
1256
|
# resp.view.owner #=> String
|
1257
|
+
# resp.view.last_updated_at #=> Time
|
1056
1258
|
# resp.view.scope #=> String
|
1057
|
-
# resp.view.
|
1259
|
+
# resp.view.included_properties #=> Array
|
1260
|
+
# resp.view.included_properties[0].name #=> String
|
1261
|
+
# resp.view.filters.filter_string #=> String
|
1262
|
+
# resp.tags #=> Hash
|
1263
|
+
# resp.tags["String"] #=> String
|
1058
1264
|
#
|
1059
1265
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetView AWS API Documentation
|
1060
1266
|
#
|
@@ -1069,6 +1275,16 @@ module Aws::ResourceExplorer2
|
|
1069
1275
|
# that are currently collecting resource information for Amazon Web
|
1070
1276
|
# Services Resource Explorer.
|
1071
1277
|
#
|
1278
|
+
# @option params [String] :type
|
1279
|
+
# If specified, limits the output to only indexes of the specified Type,
|
1280
|
+
# either `LOCAL` or `AGGREGATOR`.
|
1281
|
+
#
|
1282
|
+
# Use this option to discover the aggregator index for your account.
|
1283
|
+
#
|
1284
|
+
# @option params [Array<String>] :regions
|
1285
|
+
# If specified, limits the response to only information about the index
|
1286
|
+
# in the specified list of Amazon Web Services Regions.
|
1287
|
+
#
|
1072
1288
|
# @option params [Integer] :max_results
|
1073
1289
|
# The maximum number of results that you want included on each page of
|
1074
1290
|
# the response. If you do not include this parameter, it defaults to a
|
@@ -1092,16 +1308,6 @@ module Aws::ResourceExplorer2
|
|
1092
1308
|
# the output should continue from. The pagination tokens expire after 24
|
1093
1309
|
# hours.
|
1094
1310
|
#
|
1095
|
-
# @option params [Array<String>] :regions
|
1096
|
-
# If specified, limits the response to only information about the index
|
1097
|
-
# in the specified list of Amazon Web Services Regions.
|
1098
|
-
#
|
1099
|
-
# @option params [String] :type
|
1100
|
-
# If specified, limits the output to only indexes of the specified Type,
|
1101
|
-
# either `LOCAL` or `AGGREGATOR`.
|
1102
|
-
#
|
1103
|
-
# Use this option to discover the aggregator index for your account.
|
1104
|
-
#
|
1105
1311
|
# @return [Types::ListIndexesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1106
1312
|
#
|
1107
1313
|
# * {Types::ListIndexesOutput#indexes #indexes} => Array<Types::Index>
|
@@ -1112,17 +1318,17 @@ module Aws::ResourceExplorer2
|
|
1112
1318
|
# @example Request syntax with placeholder values
|
1113
1319
|
#
|
1114
1320
|
# resp = client.list_indexes({
|
1321
|
+
# type: "LOCAL", # accepts LOCAL, AGGREGATOR
|
1322
|
+
# regions: ["ListIndexesInputRegionsListMemberString"],
|
1115
1323
|
# max_results: 1,
|
1116
1324
|
# next_token: "ListIndexesInputNextTokenString",
|
1117
|
-
# regions: ["String"],
|
1118
|
-
# type: "LOCAL", # accepts LOCAL, AGGREGATOR
|
1119
1325
|
# })
|
1120
1326
|
#
|
1121
1327
|
# @example Response structure
|
1122
1328
|
#
|
1123
1329
|
# resp.indexes #=> Array
|
1124
|
-
# resp.indexes[0].arn #=> String
|
1125
1330
|
# resp.indexes[0].region #=> String
|
1331
|
+
# resp.indexes[0].arn #=> String
|
1126
1332
|
# resp.indexes[0].type #=> String, one of "LOCAL", "AGGREGATOR"
|
1127
1333
|
# resp.next_token #=> String
|
1128
1334
|
#
|
@@ -1187,8 +1393,8 @@ module Aws::ResourceExplorer2
|
|
1187
1393
|
#
|
1188
1394
|
# resp.indexes #=> Array
|
1189
1395
|
# resp.indexes[0].account_id #=> String
|
1190
|
-
# resp.indexes[0].arn #=> String
|
1191
1396
|
# resp.indexes[0].region #=> String
|
1397
|
+
# resp.indexes[0].arn #=> String
|
1192
1398
|
# resp.indexes[0].type #=> String, one of "LOCAL", "AGGREGATOR"
|
1193
1399
|
# resp.next_token #=> String
|
1194
1400
|
#
|
@@ -1238,8 +1444,8 @@ module Aws::ResourceExplorer2
|
|
1238
1444
|
#
|
1239
1445
|
# @return [Types::ListManagedViewsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1240
1446
|
#
|
1241
|
-
# * {Types::ListManagedViewsOutput#managed_views #managed_views} => Array<String>
|
1242
1447
|
# * {Types::ListManagedViewsOutput#next_token #next_token} => String
|
1448
|
+
# * {Types::ListManagedViewsOutput#managed_views #managed_views} => Array<String>
|
1243
1449
|
#
|
1244
1450
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1245
1451
|
#
|
@@ -1253,9 +1459,9 @@ module Aws::ResourceExplorer2
|
|
1253
1459
|
#
|
1254
1460
|
# @example Response structure
|
1255
1461
|
#
|
1462
|
+
# resp.next_token #=> String
|
1256
1463
|
# resp.managed_views #=> Array
|
1257
1464
|
# resp.managed_views[0] #=> String
|
1258
|
-
# resp.next_token #=> String
|
1259
1465
|
#
|
1260
1466
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListManagedViews AWS API Documentation
|
1261
1467
|
#
|
@@ -1309,19 +1515,6 @@ module Aws::ResourceExplorer2
|
|
1309
1515
|
#
|
1310
1516
|
# </note>
|
1311
1517
|
#
|
1312
|
-
# @option params [String] :next_token
|
1313
|
-
# The parameter for receiving additional results if you receive a
|
1314
|
-
# `NextToken` response in a previous request. A `NextToken` response
|
1315
|
-
# indicates that more output is available. Set this parameter to the
|
1316
|
-
# value of the previous call's `NextToken` response to indicate where
|
1317
|
-
# the output should continue from. The pagination tokens expire after 24
|
1318
|
-
# hours.
|
1319
|
-
#
|
1320
|
-
# <note markdown="1"> The `ListResources` operation does not generate a `NextToken` if you
|
1321
|
-
# set `MaxResults` to 1000.
|
1322
|
-
#
|
1323
|
-
# </note>
|
1324
|
-
#
|
1325
1518
|
# @option params [String] :view_arn
|
1326
1519
|
# Specifies the Amazon resource name (ARN) of the view to use for the
|
1327
1520
|
# query. If you don't specify a value for this parameter, then the
|
@@ -1331,10 +1524,23 @@ module Aws::ResourceExplorer2
|
|
1331
1524
|
# to use the default view, then the operation fails with a 401
|
1332
1525
|
# Unauthorized exception.
|
1333
1526
|
#
|
1527
|
+
# @option params [String] :next_token
|
1528
|
+
# The parameter for receiving additional results if you receive a
|
1529
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1530
|
+
# indicates that more output is available. Set this parameter to the
|
1531
|
+
# value of the previous call's `NextToken` response to indicate where
|
1532
|
+
# the output should continue from. The pagination tokens expire after 24
|
1533
|
+
# hours.
|
1534
|
+
#
|
1535
|
+
# <note markdown="1"> The `ListResources` operation does not generate a `NextToken` if you
|
1536
|
+
# set `MaxResults` to 1000.
|
1537
|
+
#
|
1538
|
+
# </note>
|
1539
|
+
#
|
1334
1540
|
# @return [Types::ListResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1335
1541
|
#
|
1336
|
-
# * {Types::ListResourcesOutput#next_token #next_token} => String
|
1337
1542
|
# * {Types::ListResourcesOutput#resources #resources} => Array<Types::Resource>
|
1543
|
+
# * {Types::ListResourcesOutput#next_token #next_token} => String
|
1338
1544
|
# * {Types::ListResourcesOutput#view_arn #view_arn} => String
|
1339
1545
|
#
|
1340
1546
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1346,23 +1552,23 @@ module Aws::ResourceExplorer2
|
|
1346
1552
|
# filter_string: "SearchFilterFilterStringString", # required
|
1347
1553
|
# },
|
1348
1554
|
# max_results: 1,
|
1349
|
-
# next_token: "ListResourcesInputNextTokenString",
|
1350
1555
|
# view_arn: "ListResourcesInputViewArnString",
|
1556
|
+
# next_token: "ListResourcesInputNextTokenString",
|
1351
1557
|
# })
|
1352
1558
|
#
|
1353
1559
|
# @example Response structure
|
1354
1560
|
#
|
1355
|
-
# resp.next_token #=> String
|
1356
1561
|
# resp.resources #=> Array
|
1357
1562
|
# resp.resources[0].arn #=> String
|
1358
|
-
# resp.resources[0].last_reported_at #=> Time
|
1359
1563
|
# resp.resources[0].owning_account_id #=> String
|
1360
|
-
# resp.resources[0].properties #=> Array
|
1361
|
-
# resp.resources[0].properties[0].last_reported_at #=> Time
|
1362
|
-
# resp.resources[0].properties[0].name #=> String
|
1363
1564
|
# resp.resources[0].region #=> String
|
1364
1565
|
# resp.resources[0].resource_type #=> String
|
1365
1566
|
# resp.resources[0].service #=> String
|
1567
|
+
# resp.resources[0].last_reported_at #=> Time
|
1568
|
+
# resp.resources[0].properties #=> Array
|
1569
|
+
# resp.resources[0].properties[0].name #=> String
|
1570
|
+
# resp.resources[0].properties[0].last_reported_at #=> Time
|
1571
|
+
# resp.next_token #=> String
|
1366
1572
|
# resp.view_arn #=> String
|
1367
1573
|
#
|
1368
1574
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListResources AWS API Documentation
|
@@ -1374,9 +1580,156 @@ module Aws::ResourceExplorer2
|
|
1374
1580
|
req.send_request(options)
|
1375
1581
|
end
|
1376
1582
|
|
1583
|
+
# Lists all Resource Explorer indexes across the specified Amazon Web
|
1584
|
+
# Services Regions. This operation returns information about indexes
|
1585
|
+
# including their ARNs, types, and Regions.
|
1586
|
+
#
|
1587
|
+
# @option params [Array<String>] :regions
|
1588
|
+
# A list of Amazon Web Services Regions to include in the search for
|
1589
|
+
# indexes. If not specified, indexes from all Regions are returned.
|
1590
|
+
#
|
1591
|
+
# @option params [Integer] :max_results
|
1592
|
+
# The maximum number of index results to return in a single response.
|
1593
|
+
# Valid values are between `1` and `100`.
|
1594
|
+
#
|
1595
|
+
# @option params [String] :next_token
|
1596
|
+
# The pagination token from a previous `ListServiceIndexes` response.
|
1597
|
+
# Use this token to retrieve the next set of results.
|
1598
|
+
#
|
1599
|
+
# @return [Types::ListServiceIndexesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1600
|
+
#
|
1601
|
+
# * {Types::ListServiceIndexesOutput#indexes #indexes} => Array<Types::Index>
|
1602
|
+
# * {Types::ListServiceIndexesOutput#next_token #next_token} => String
|
1603
|
+
#
|
1604
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1605
|
+
#
|
1606
|
+
# @example Request syntax with placeholder values
|
1607
|
+
#
|
1608
|
+
# resp = client.list_service_indexes({
|
1609
|
+
# regions: ["ListServiceIndexesInputRegionsListMemberString"],
|
1610
|
+
# max_results: 1,
|
1611
|
+
# next_token: "ListServiceIndexesInputNextTokenString",
|
1612
|
+
# })
|
1613
|
+
#
|
1614
|
+
# @example Response structure
|
1615
|
+
#
|
1616
|
+
# resp.indexes #=> Array
|
1617
|
+
# resp.indexes[0].region #=> String
|
1618
|
+
# resp.indexes[0].arn #=> String
|
1619
|
+
# resp.indexes[0].type #=> String, one of "LOCAL", "AGGREGATOR"
|
1620
|
+
# resp.next_token #=> String
|
1621
|
+
#
|
1622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListServiceIndexes AWS API Documentation
|
1623
|
+
#
|
1624
|
+
# @overload list_service_indexes(params = {})
|
1625
|
+
# @param [Hash] params ({})
|
1626
|
+
def list_service_indexes(params = {}, options = {})
|
1627
|
+
req = build_request(:list_service_indexes, params)
|
1628
|
+
req.send_request(options)
|
1629
|
+
end
|
1630
|
+
|
1631
|
+
# Lists all Resource Explorer service views available in the current
|
1632
|
+
# Amazon Web Services account. This operation returns the ARNs of
|
1633
|
+
# available service views.
|
1634
|
+
#
|
1635
|
+
# @option params [Integer] :max_results
|
1636
|
+
# The maximum number of service view results to return in a single
|
1637
|
+
# response. Valid values are between `1` and `50`.
|
1638
|
+
#
|
1639
|
+
# @option params [String] :next_token
|
1640
|
+
# The pagination token from a previous `ListServiceViews` response. Use
|
1641
|
+
# this token to retrieve the next set of results.
|
1642
|
+
#
|
1643
|
+
# @return [Types::ListServiceViewsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1644
|
+
#
|
1645
|
+
# * {Types::ListServiceViewsOutput#next_token #next_token} => String
|
1646
|
+
# * {Types::ListServiceViewsOutput#service_views #service_views} => Array<String>
|
1647
|
+
#
|
1648
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1649
|
+
#
|
1650
|
+
# @example Request syntax with placeholder values
|
1651
|
+
#
|
1652
|
+
# resp = client.list_service_views({
|
1653
|
+
# max_results: 1,
|
1654
|
+
# next_token: "String",
|
1655
|
+
# })
|
1656
|
+
#
|
1657
|
+
# @example Response structure
|
1658
|
+
#
|
1659
|
+
# resp.next_token #=> String
|
1660
|
+
# resp.service_views #=> Array
|
1661
|
+
# resp.service_views[0] #=> String
|
1662
|
+
#
|
1663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListServiceViews AWS API Documentation
|
1664
|
+
#
|
1665
|
+
# @overload list_service_views(params = {})
|
1666
|
+
# @param [Hash] params ({})
|
1667
|
+
def list_service_views(params = {}, options = {})
|
1668
|
+
req = build_request(:list_service_views, params)
|
1669
|
+
req.send_request(options)
|
1670
|
+
end
|
1671
|
+
|
1672
|
+
# Returns a list of Amazon Web Services services that have been granted
|
1673
|
+
# streaming access to your Resource Explorer data. Streaming access
|
1674
|
+
# allows Amazon Web Services services to receive real-time updates about
|
1675
|
+
# your resources as they are indexed by Resource Explorer.
|
1676
|
+
#
|
1677
|
+
# @option params [Integer] :max_results
|
1678
|
+
# The maximum number of streaming access entries to return in the
|
1679
|
+
# response. If there are more results available, the response includes a
|
1680
|
+
# NextToken value that you can use in a subsequent call to get the next
|
1681
|
+
# set of results. The value must be between 1 and 50. If you don't
|
1682
|
+
# specify a value, the default is 50.
|
1683
|
+
#
|
1684
|
+
# @option params [String] :next_token
|
1685
|
+
# The parameter for receiving additional results if you receive a
|
1686
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1687
|
+
# indicates that more output is available. Set this parameter to the
|
1688
|
+
# value of the previous call's `NextToken` response to indicate where
|
1689
|
+
# the output should continue from. The pagination tokens expire after 24
|
1690
|
+
# hours.
|
1691
|
+
#
|
1692
|
+
# @return [Types::ListStreamingAccessForServicesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1693
|
+
#
|
1694
|
+
# * {Types::ListStreamingAccessForServicesOutput#streaming_access_for_services #streaming_access_for_services} => Array<Types::StreamingAccessDetails>
|
1695
|
+
# * {Types::ListStreamingAccessForServicesOutput#next_token #next_token} => String
|
1696
|
+
#
|
1697
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1698
|
+
#
|
1699
|
+
# @example Request syntax with placeholder values
|
1700
|
+
#
|
1701
|
+
# resp = client.list_streaming_access_for_services({
|
1702
|
+
# max_results: 1,
|
1703
|
+
# next_token: "String",
|
1704
|
+
# })
|
1705
|
+
#
|
1706
|
+
# @example Response structure
|
1707
|
+
#
|
1708
|
+
# resp.streaming_access_for_services #=> Array
|
1709
|
+
# resp.streaming_access_for_services[0].service_principal #=> String
|
1710
|
+
# resp.streaming_access_for_services[0].created_at #=> Time
|
1711
|
+
# resp.next_token #=> String
|
1712
|
+
#
|
1713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListStreamingAccessForServices AWS API Documentation
|
1714
|
+
#
|
1715
|
+
# @overload list_streaming_access_for_services(params = {})
|
1716
|
+
# @param [Hash] params ({})
|
1717
|
+
def list_streaming_access_for_services(params = {}, options = {})
|
1718
|
+
req = build_request(:list_streaming_access_for_services, params)
|
1719
|
+
req.send_request(options)
|
1720
|
+
end
|
1721
|
+
|
1377
1722
|
# Retrieves a list of all resource types currently supported by Amazon
|
1378
1723
|
# Web Services Resource Explorer.
|
1379
1724
|
#
|
1725
|
+
# @option params [String] :next_token
|
1726
|
+
# The parameter for receiving additional results if you receive a
|
1727
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1728
|
+
# indicates that more output is available. Set this parameter to the
|
1729
|
+
# value of the previous call's `NextToken` response to indicate where
|
1730
|
+
# the output should continue from. The pagination tokens expire after 24
|
1731
|
+
# hours.
|
1732
|
+
#
|
1380
1733
|
# @option params [Integer] :max_results
|
1381
1734
|
# The maximum number of results that you want included on each page of
|
1382
1735
|
# the response. If you do not include this parameter, it defaults to a
|
@@ -1392,34 +1745,26 @@ module Aws::ResourceExplorer2
|
|
1392
1745
|
#
|
1393
1746
|
# </note>
|
1394
1747
|
#
|
1395
|
-
# @option params [String] :next_token
|
1396
|
-
# The parameter for receiving additional results if you receive a
|
1397
|
-
# `NextToken` response in a previous request. A `NextToken` response
|
1398
|
-
# indicates that more output is available. Set this parameter to the
|
1399
|
-
# value of the previous call's `NextToken` response to indicate where
|
1400
|
-
# the output should continue from. The pagination tokens expire after 24
|
1401
|
-
# hours.
|
1402
|
-
#
|
1403
1748
|
# @return [Types::ListSupportedResourceTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1404
1749
|
#
|
1405
|
-
# * {Types::ListSupportedResourceTypesOutput#next_token #next_token} => String
|
1406
1750
|
# * {Types::ListSupportedResourceTypesOutput#resource_types #resource_types} => Array<Types::SupportedResourceType>
|
1751
|
+
# * {Types::ListSupportedResourceTypesOutput#next_token #next_token} => String
|
1407
1752
|
#
|
1408
1753
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1409
1754
|
#
|
1410
1755
|
# @example Request syntax with placeholder values
|
1411
1756
|
#
|
1412
1757
|
# resp = client.list_supported_resource_types({
|
1413
|
-
# max_results: 1,
|
1414
1758
|
# next_token: "String",
|
1759
|
+
# max_results: 1,
|
1415
1760
|
# })
|
1416
1761
|
#
|
1417
1762
|
# @example Response structure
|
1418
1763
|
#
|
1419
|
-
# resp.next_token #=> String
|
1420
1764
|
# resp.resource_types #=> Array
|
1421
|
-
# resp.resource_types[0].resource_type #=> String
|
1422
1765
|
# resp.resource_types[0].service #=> String
|
1766
|
+
# resp.resource_types[0].resource_type #=> String
|
1767
|
+
# resp.next_token #=> String
|
1423
1768
|
#
|
1424
1769
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListSupportedResourceTypes AWS API Documentation
|
1425
1770
|
#
|
@@ -1479,6 +1824,14 @@ module Aws::ResourceExplorer2
|
|
1479
1824
|
#
|
1480
1825
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1481
1826
|
#
|
1827
|
+
# @option params [String] :next_token
|
1828
|
+
# The parameter for receiving additional results if you receive a
|
1829
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1830
|
+
# indicates that more output is available. Set this parameter to the
|
1831
|
+
# value of the previous call's `NextToken` response to indicate where
|
1832
|
+
# the output should continue from. The pagination tokens expire after 24
|
1833
|
+
# hours.
|
1834
|
+
#
|
1482
1835
|
# @option params [Integer] :max_results
|
1483
1836
|
# The maximum number of results that you want included on each page of
|
1484
1837
|
# the response. If you do not include this parameter, it defaults to a
|
@@ -1494,33 +1847,25 @@ module Aws::ResourceExplorer2
|
|
1494
1847
|
#
|
1495
1848
|
# </note>
|
1496
1849
|
#
|
1497
|
-
# @option params [String] :next_token
|
1498
|
-
# The parameter for receiving additional results if you receive a
|
1499
|
-
# `NextToken` response in a previous request. A `NextToken` response
|
1500
|
-
# indicates that more output is available. Set this parameter to the
|
1501
|
-
# value of the previous call's `NextToken` response to indicate where
|
1502
|
-
# the output should continue from. The pagination tokens expire after 24
|
1503
|
-
# hours.
|
1504
|
-
#
|
1505
1850
|
# @return [Types::ListViewsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1506
1851
|
#
|
1507
|
-
# * {Types::ListViewsOutput#next_token #next_token} => String
|
1508
1852
|
# * {Types::ListViewsOutput#views #views} => Array<String>
|
1853
|
+
# * {Types::ListViewsOutput#next_token #next_token} => String
|
1509
1854
|
#
|
1510
1855
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1511
1856
|
#
|
1512
1857
|
# @example Request syntax with placeholder values
|
1513
1858
|
#
|
1514
1859
|
# resp = client.list_views({
|
1515
|
-
# max_results: 1,
|
1516
1860
|
# next_token: "String",
|
1861
|
+
# max_results: 1,
|
1517
1862
|
# })
|
1518
1863
|
#
|
1519
1864
|
# @example Response structure
|
1520
1865
|
#
|
1521
|
-
# resp.next_token #=> String
|
1522
1866
|
# resp.views #=> Array
|
1523
1867
|
# resp.views[0] #=> String
|
1868
|
+
# resp.next_token #=> String
|
1524
1869
|
#
|
1525
1870
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListViews AWS API Documentation
|
1526
1871
|
#
|
@@ -1553,29 +1898,6 @@ module Aws::ResourceExplorer2
|
|
1553
1898
|
# [1]: https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html
|
1554
1899
|
# [2]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/troubleshooting_search.html
|
1555
1900
|
#
|
1556
|
-
# @option params [Integer] :max_results
|
1557
|
-
# The maximum number of results that you want included on each page of
|
1558
|
-
# the response. If you do not include this parameter, it defaults to a
|
1559
|
-
# value appropriate to the operation. If additional items exist beyond
|
1560
|
-
# those included in the current response, the `NextToken` response
|
1561
|
-
# element is present and has a value (is not null). Include that value
|
1562
|
-
# as the `NextToken` request parameter in the next call to the operation
|
1563
|
-
# to get the next part of the results.
|
1564
|
-
#
|
1565
|
-
# <note markdown="1"> An API operation can return fewer results than the maximum even when
|
1566
|
-
# there are more results available. You should check `NextToken` after
|
1567
|
-
# every operation to ensure that you receive all of the results.
|
1568
|
-
#
|
1569
|
-
# </note>
|
1570
|
-
#
|
1571
|
-
# @option params [String] :next_token
|
1572
|
-
# The parameter for receiving additional results if you receive a
|
1573
|
-
# `NextToken` response in a previous request. A `NextToken` response
|
1574
|
-
# indicates that more output is available. Set this parameter to the
|
1575
|
-
# value of the previous call's `NextToken` response to indicate where
|
1576
|
-
# the output should continue from. The pagination tokens expire after 24
|
1577
|
-
# hours.
|
1578
|
-
#
|
1579
1901
|
# @option params [required, String] :query_string
|
1580
1902
|
# A string that includes keywords and filters that specify the resources
|
1581
1903
|
# that you want to include in the results.
|
@@ -1596,6 +1918,21 @@ module Aws::ResourceExplorer2
|
|
1596
1918
|
#
|
1597
1919
|
# [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html
|
1598
1920
|
#
|
1921
|
+
# @option params [Integer] :max_results
|
1922
|
+
# The maximum number of results that you want included on each page of
|
1923
|
+
# the response. If you do not include this parameter, it defaults to a
|
1924
|
+
# value appropriate to the operation. If additional items exist beyond
|
1925
|
+
# those included in the current response, the `NextToken` response
|
1926
|
+
# element is present and has a value (is not null). Include that value
|
1927
|
+
# as the `NextToken` request parameter in the next call to the operation
|
1928
|
+
# to get the next part of the results.
|
1929
|
+
#
|
1930
|
+
# <note markdown="1"> An API operation can return fewer results than the maximum even when
|
1931
|
+
# there are more results available. You should check `NextToken` after
|
1932
|
+
# every operation to ensure that you receive all of the results.
|
1933
|
+
#
|
1934
|
+
# </note>
|
1935
|
+
#
|
1599
1936
|
# @option params [String] :view_arn
|
1600
1937
|
# Specifies the [Amazon resource name (ARN)][1] of the view to use for
|
1601
1938
|
# the query. If you don't specify a value for this parameter, then the
|
@@ -1609,40 +1946,48 @@ module Aws::ResourceExplorer2
|
|
1609
1946
|
#
|
1610
1947
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1611
1948
|
#
|
1949
|
+
# @option params [String] :next_token
|
1950
|
+
# The parameter for receiving additional results if you receive a
|
1951
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1952
|
+
# indicates that more output is available. Set this parameter to the
|
1953
|
+
# value of the previous call's `NextToken` response to indicate where
|
1954
|
+
# the output should continue from. The pagination tokens expire after 24
|
1955
|
+
# hours.
|
1956
|
+
#
|
1612
1957
|
# @return [Types::SearchOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1613
1958
|
#
|
1614
|
-
# * {Types::SearchOutput#count #count} => Types::ResourceCount
|
1615
|
-
# * {Types::SearchOutput#next_token #next_token} => String
|
1616
1959
|
# * {Types::SearchOutput#resources #resources} => Array<Types::Resource>
|
1960
|
+
# * {Types::SearchOutput#next_token #next_token} => String
|
1617
1961
|
# * {Types::SearchOutput#view_arn #view_arn} => String
|
1962
|
+
# * {Types::SearchOutput#count #count} => Types::ResourceCount
|
1618
1963
|
#
|
1619
1964
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1620
1965
|
#
|
1621
1966
|
# @example Request syntax with placeholder values
|
1622
1967
|
#
|
1623
1968
|
# resp = client.search({
|
1624
|
-
# max_results: 1,
|
1625
|
-
# next_token: "SearchInputNextTokenString",
|
1626
1969
|
# query_string: "QueryString", # required
|
1970
|
+
# max_results: 1,
|
1627
1971
|
# view_arn: "SearchInputViewArnString",
|
1972
|
+
# next_token: "SearchInputNextTokenString",
|
1628
1973
|
# })
|
1629
1974
|
#
|
1630
1975
|
# @example Response structure
|
1631
1976
|
#
|
1632
|
-
# resp.count.complete #=> Boolean
|
1633
|
-
# resp.count.total_resources #=> Integer
|
1634
|
-
# resp.next_token #=> String
|
1635
1977
|
# resp.resources #=> Array
|
1636
1978
|
# resp.resources[0].arn #=> String
|
1637
|
-
# resp.resources[0].last_reported_at #=> Time
|
1638
1979
|
# resp.resources[0].owning_account_id #=> String
|
1639
|
-
# resp.resources[0].properties #=> Array
|
1640
|
-
# resp.resources[0].properties[0].last_reported_at #=> Time
|
1641
|
-
# resp.resources[0].properties[0].name #=> String
|
1642
1980
|
# resp.resources[0].region #=> String
|
1643
1981
|
# resp.resources[0].resource_type #=> String
|
1644
1982
|
# resp.resources[0].service #=> String
|
1983
|
+
# resp.resources[0].last_reported_at #=> Time
|
1984
|
+
# resp.resources[0].properties #=> Array
|
1985
|
+
# resp.resources[0].properties[0].name #=> String
|
1986
|
+
# resp.resources[0].properties[0].last_reported_at #=> Time
|
1987
|
+
# resp.next_token #=> String
|
1645
1988
|
# resp.view_arn #=> String
|
1989
|
+
# resp.count.total_resources #=> Integer
|
1990
|
+
# resp.count.complete #=> Boolean
|
1646
1991
|
#
|
1647
1992
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/Search AWS API Documentation
|
1648
1993
|
#
|
@@ -1656,23 +2001,23 @@ module Aws::ResourceExplorer2
|
|
1656
2001
|
# Adds one or more tag key and value pairs to an Amazon Web Services
|
1657
2002
|
# Resource Explorer view or index.
|
1658
2003
|
#
|
1659
|
-
# @option params [Hash<String,String>] :tags
|
1660
|
-
# A list of tag key and value pairs that you want to attach to the
|
1661
|
-
# specified view or index.
|
1662
|
-
#
|
1663
2004
|
# @option params [required, String] :resource_arn
|
1664
2005
|
# The Amazon Resource Name (ARN) of the view or index that you want to
|
1665
2006
|
# attach tags to.
|
1666
2007
|
#
|
2008
|
+
# @option params [Hash<String,String>] :tags
|
2009
|
+
# A list of tag key and value pairs that you want to attach to the
|
2010
|
+
# specified view or index.
|
2011
|
+
#
|
1667
2012
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1668
2013
|
#
|
1669
2014
|
# @example Request syntax with placeholder values
|
1670
2015
|
#
|
1671
2016
|
# resp = client.tag_resource({
|
2017
|
+
# resource_arn: "String", # required
|
1672
2018
|
# tags: {
|
1673
2019
|
# "String" => "String",
|
1674
2020
|
# },
|
1675
|
-
# resource_arn: "String", # required
|
1676
2021
|
# })
|
1677
2022
|
#
|
1678
2023
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/TagResource AWS API Documentation
|
@@ -1794,9 +2139,9 @@ module Aws::ResourceExplorer2
|
|
1794
2139
|
# @return [Types::UpdateIndexTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1795
2140
|
#
|
1796
2141
|
# * {Types::UpdateIndexTypeOutput#arn #arn} => String
|
1797
|
-
# * {Types::UpdateIndexTypeOutput#last_updated_at #last_updated_at} => Time
|
1798
|
-
# * {Types::UpdateIndexTypeOutput#state #state} => String
|
1799
2142
|
# * {Types::UpdateIndexTypeOutput#type #type} => String
|
2143
|
+
# * {Types::UpdateIndexTypeOutput#state #state} => String
|
2144
|
+
# * {Types::UpdateIndexTypeOutput#last_updated_at #last_updated_at} => Time
|
1800
2145
|
#
|
1801
2146
|
# @example Request syntax with placeholder values
|
1802
2147
|
#
|
@@ -1808,9 +2153,9 @@ module Aws::ResourceExplorer2
|
|
1808
2153
|
# @example Response structure
|
1809
2154
|
#
|
1810
2155
|
# resp.arn #=> String
|
1811
|
-
# resp.last_updated_at #=> Time
|
1812
|
-
# resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING"
|
1813
2156
|
# resp.type #=> String, one of "LOCAL", "AGGREGATOR"
|
2157
|
+
# resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING"
|
2158
|
+
# resp.last_updated_at #=> Time
|
1814
2159
|
#
|
1815
2160
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateIndexType AWS API Documentation
|
1816
2161
|
#
|
@@ -1825,6 +2170,22 @@ module Aws::ResourceExplorer2
|
|
1825
2170
|
# string and the list of included properties. You can't change the name
|
1826
2171
|
# of the view.
|
1827
2172
|
#
|
2173
|
+
# @option params [required, String] :view_arn
|
2174
|
+
# The [Amazon resource name (ARN)][1] of the view that you want to
|
2175
|
+
# modify.
|
2176
|
+
#
|
2177
|
+
#
|
2178
|
+
#
|
2179
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
2180
|
+
#
|
2181
|
+
# @option params [Array<Types::IncludedProperty>] :included_properties
|
2182
|
+
# Specifies optional fields that you want included in search results
|
2183
|
+
# from this view. It is a list of objects that each describe a field to
|
2184
|
+
# include.
|
2185
|
+
#
|
2186
|
+
# The default is an empty list, with no optional fields included in the
|
2187
|
+
# results.
|
2188
|
+
#
|
1828
2189
|
# @option params [Types::SearchFilter] :filters
|
1829
2190
|
# An array of strings that specify which resources are included in the
|
1830
2191
|
# results of queries made using this view. When you use this view in a
|
@@ -1848,22 +2209,6 @@ module Aws::ResourceExplorer2
|
|
1848
2209
|
# [2]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters
|
1849
2210
|
# [3]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators
|
1850
2211
|
#
|
1851
|
-
# @option params [Array<Types::IncludedProperty>] :included_properties
|
1852
|
-
# Specifies optional fields that you want included in search results
|
1853
|
-
# from this view. It is a list of objects that each describe a field to
|
1854
|
-
# include.
|
1855
|
-
#
|
1856
|
-
# The default is an empty list, with no optional fields included in the
|
1857
|
-
# results.
|
1858
|
-
#
|
1859
|
-
# @option params [required, String] :view_arn
|
1860
|
-
# The [Amazon resource name (ARN)][1] of the view that you want to
|
1861
|
-
# modify.
|
1862
|
-
#
|
1863
|
-
#
|
1864
|
-
#
|
1865
|
-
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1866
|
-
#
|
1867
2212
|
# @return [Types::UpdateViewOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1868
2213
|
#
|
1869
2214
|
# * {Types::UpdateViewOutput#view #view} => Types::View
|
@@ -1871,26 +2216,26 @@ module Aws::ResourceExplorer2
|
|
1871
2216
|
# @example Request syntax with placeholder values
|
1872
2217
|
#
|
1873
2218
|
# resp = client.update_view({
|
1874
|
-
#
|
1875
|
-
# filter_string: "SearchFilterFilterStringString", # required
|
1876
|
-
# },
|
2219
|
+
# view_arn: "UpdateViewInputViewArnString", # required
|
1877
2220
|
# included_properties: [
|
1878
2221
|
# {
|
1879
2222
|
# name: "IncludedPropertyNameString", # required
|
1880
2223
|
# },
|
1881
2224
|
# ],
|
1882
|
-
#
|
2225
|
+
# filters: {
|
2226
|
+
# filter_string: "SearchFilterFilterStringString", # required
|
2227
|
+
# },
|
1883
2228
|
# })
|
1884
2229
|
#
|
1885
2230
|
# @example Response structure
|
1886
2231
|
#
|
1887
|
-
# resp.view.
|
1888
|
-
# resp.view.included_properties #=> Array
|
1889
|
-
# resp.view.included_properties[0].name #=> String
|
1890
|
-
# resp.view.last_updated_at #=> Time
|
2232
|
+
# resp.view.view_arn #=> String
|
1891
2233
|
# resp.view.owner #=> String
|
2234
|
+
# resp.view.last_updated_at #=> Time
|
1892
2235
|
# resp.view.scope #=> String
|
1893
|
-
# resp.view.
|
2236
|
+
# resp.view.included_properties #=> Array
|
2237
|
+
# resp.view.included_properties[0].name #=> String
|
2238
|
+
# resp.view.filters.filter_string #=> String
|
1894
2239
|
#
|
1895
2240
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateView AWS API Documentation
|
1896
2241
|
#
|
@@ -1919,7 +2264,7 @@ module Aws::ResourceExplorer2
|
|
1919
2264
|
tracer: tracer
|
1920
2265
|
)
|
1921
2266
|
context[:gem_name] = 'aws-sdk-resourceexplorer2'
|
1922
|
-
context[:gem_version] = '1.
|
2267
|
+
context[:gem_version] = '1.42.0'
|
1923
2268
|
Seahorse::Client::Request.new(handlers, context)
|
1924
2269
|
end
|
1925
2270
|
|