Class: Aws::ResourceExplorer2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ResourceExplorer2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb
Overview
An API client for ResourceExplorer2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ResourceExplorer2::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_default_view(params = {}) ⇒ Types::AssociateDefaultViewOutput
Sets the specified view as the default for the Amazon Web Services Region in which you call this operation.
-
#batch_get_view(params = {}) ⇒ Types::BatchGetViewOutput
Retrieves details about a list of views.
-
#create_index(params = {}) ⇒ Types::CreateIndexOutput
Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index.
-
#create_view(params = {}) ⇒ Types::CreateViewOutput
Creates a view that users can query by using the Search operation.
-
#delete_index(params = {}) ⇒ Types::DeleteIndexOutput
Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.
-
#delete_view(params = {}) ⇒ Types::DeleteViewOutput
Deletes the specified view.
-
#disassociate_default_view(params = {}) ⇒ Struct
After you call this operation, the affected Amazon Web Services Region no longer has a default view.
-
#get_account_level_service_configuration(params = {}) ⇒ Types::GetAccountLevelServiceConfigurationOutput
Retrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature.
-
#get_default_view(params = {}) ⇒ Types::GetDefaultViewOutput
Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation.
-
#get_index(params = {}) ⇒ Types::GetIndexOutput
Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
-
#get_view(params = {}) ⇒ Types::GetViewOutput
Retrieves details of the specified view.
-
#list_indexes(params = {}) ⇒ Types::ListIndexesOutput
Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.
-
#list_indexes_for_members(params = {}) ⇒ Types::ListIndexesForMembersOutput
Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.
-
#list_supported_resource_types(params = {}) ⇒ Types::ListSupportedResourceTypesOutput
Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags that are attached to the specified resource.
-
#list_views(params = {}) ⇒ Types::ListViewsOutput
Lists the [Amazon resource names (ARNs)][1] of the views available in the Amazon Web Services Region in which you call this operation.
-
#search(params = {}) ⇒ Types::SearchOutput
Searches for resources and displays details about all resources that match the specified criteria.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
-
#update_index_type(params = {}) ⇒ Types::UpdateIndexTypeOutput
Changes the type of the index from one of the following types to the other.
-
#update_view(params = {}) ⇒ Types::UpdateViewOutput
Modifies some of the details of a view.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
434 435 436 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 434 def initialize(*args) super end |
Instance Method Details
#associate_default_view(params = {}) ⇒ Types::AssociateDefaultViewOutput
Sets the specified view as the default for the Amazon Web Services Region in which you call this operation. When a user performs a Search that doesn't explicitly specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for searches performed in this Amazon Web Services Region.
If an Amazon Web Services Region doesn't have a default view
configured, then users must explicitly specify a view with every
Search
operation performed in that Region.
478 479 480 481 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 478 def associate_default_view(params = {}, = {}) req = build_request(:associate_default_view, params) req.send_request() end |
#batch_get_view(params = {}) ⇒ Types::BatchGetViewOutput
Retrieves details about a list of views.
522 523 524 525 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 522 def batch_get_view(params = {}, = {}) req = build_request(:batch_get_view, params) req.send_request() end |
#create_index(params = {}) ⇒ Types::CreateIndexOutput
Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.
For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Web Services Resource Explorer User Guide.
If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.
Action:
resource-explorer-2:CreateIndex
Resource: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (
*
) at the end of the string to match the eventual UUID. For example, the followingResource
element restricts the role or user to creating an index in only theus-east-2
Region of the specified account."Resource": "arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*"
Alternatively, you can use
"Resource": "*"
to allow the role or user to create an index in any Region.Action:
iam:CreateServiceLinkedRole
Resource: No specific resource (*).
This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the service-linked role needed to index the resources in your account. Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.
630 631 632 633 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 630 def create_index(params = {}, = {}) req = build_request(:create_index, params) req.send_request() end |
#create_view(params = {}) ⇒ Types::CreateViewOutput
Creates a view that users can query by using the Search operation.
Results from queries that you make using this view include only
resources that match the view's Filters
. For more information about
Amazon Web Services Resource Explorer views, see Managing views
in the Amazon Web Services Resource Explorer User Guide.
Only the principals with an IAM identity-based policy that grants
Allow
to the Search
action on a Resource
with the Amazon
resource name (ARN) of this view can Search using views you create
with this operation.
747 748 749 750 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 747 def create_view(params = {}, = {}) req = build_request(:create_view, params) req.send_request() end |
#delete_index(params = {}) ⇒ Types::DeleteIndexOutput
Deletes the specified index and turns off Amazon Web Services Resource
Explorer in the specified Amazon Web Services Region. When you delete
an index, Resource Explorer stops discovering and indexing resources
in that Region. Resource Explorer also deletes all views in that
Region. These actions occur as asynchronous background tasks. You can
check to see when the actions are complete by using the GetIndex
operation and checking the Status
response value.
798 799 800 801 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 798 def delete_index(params = {}, = {}) req = build_request(:delete_index, params) req.send_request() end |
#delete_view(params = {}) ⇒ Types::DeleteViewOutput
Deletes the specified view.
If the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use until you configure a new default by calling the AssociateDefaultView operation.
836 837 838 839 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 836 def delete_view(params = {}, = {}) req = build_request(:delete_view, params) req.send_request() end |
#disassociate_default_view(params = {}) ⇒ Struct
After you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation.
If an Amazon Web Services Region doesn't have a default view
configured, then users must explicitly specify a view with every
Search
operation performed in that Region.
856 857 858 859 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 856 def disassociate_default_view(params = {}, = {}) req = build_request(:disassociate_default_view, params) req.send_request() end |
#get_account_level_service_configuration(params = {}) ⇒ Types::GetAccountLevelServiceConfigurationOutput
Retrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature. Only the management account or a delegated administrator with service access enabled can invoke this API call.
880 881 882 883 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 880 def get_account_level_service_configuration(params = {}, = {}) req = build_request(:get_account_level_service_configuration, params) req.send_request() end |
#get_default_view(params = {}) ⇒ Types::GetDefaultViewOutput
Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation. You can then call GetView to retrieve the details of that view.
902 903 904 905 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 902 def get_default_view(params = {}, = {}) req = build_request(:get_default_view, params) req.send_request() end |
#get_index(params = {}) ⇒ Types::GetIndexOutput
Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
940 941 942 943 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 940 def get_index(params = {}, = {}) req = build_request(:get_index, params) req.send_request() end |
#get_view(params = {}) ⇒ Types::GetViewOutput
Retrieves details of the specified view.
982 983 984 985 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 982 def get_view(params = {}, = {}) req = build_request(:get_view, params) req.send_request() end |
#list_indexes(params = {}) ⇒ Types::ListIndexesOutput
Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1052 1053 1054 1055 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 1052 def list_indexes(params = {}, = {}) req = build_request(:list_indexes, params) req.send_request() end |
#list_indexes_for_members(params = {}) ⇒ Types::ListIndexesForMembersOutput
Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer. Only the management account or a delegated administrator with service access enabled can invoke this API call.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1118 1119 1120 1121 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 1118 def list_indexes_for_members(params = {}, = {}) req = build_request(:list_indexes_for_members, params) req.send_request() end |
#list_supported_resource_types(params = {}) ⇒ Types::ListSupportedResourceTypesOutput
Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 1174 def list_supported_resource_types(params = {}, = {}) req = build_request(:list_supported_resource_types, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags that are attached to the specified resource.
1208 1209 1210 1211 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 1208 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_views(params = {}) ⇒ Types::ListViewsOutput
Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.
NextToken
response parameter for a null
value
when calling a paginated operation. These operations can occasionally
return an empty set of results even when there are more results
available. The NextToken
response parameter value is null
only
when there are no more results to display.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1275 1276 1277 1278 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 1275 def list_views(params = {}, = {}) req = build_request(:list_views, params) req.send_request() end |
#search(params = {}) ⇒ Types::SearchOutput
Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.
All search queries must use a view. If you don't explicitly specify a
view, then Amazon Web Services Resource Explorer uses the default view
for the Amazon Web Services Region in which you call this operation.
The results are the logical intersection of the results that match
both the QueryString
parameter supplied to this operation and the
SearchFilter
parameter attached to the view.
For the complete syntax supported by the QueryString
parameter, see
Search query syntax reference for Resource Explorer.
If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 1397 def search(params = {}, = {}) req = build_request(:search, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 1428 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
1457 1458 1459 1460 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 1457 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_index_type(params = {}) ⇒ Types::UpdateIndexTypeOutput
Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
AGGREGATOR
index typeThe index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index.
When you change the index type to
AGGREGATOR
, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, theStatus
response of that operation changes fromUPDATING
toACTIVE
. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type
LOCAL
.LOCAL
index typeThe index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.
When you change the index type to
LOCAL
, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in theUPDATING
state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, theStatus
response of that operation changes fromUPDATING
toACTIVE
. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.
1565 1566 1567 1568 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 1565 def update_index_type(params = {}, = {}) req = build_request(:update_index_type, params) req.send_request() end |
#update_view(params = {}) ⇒ Types::UpdateViewOutput
Modifies some of the details of a view. You can change the filter string and the list of included properties. You can't change the name of the view.
1645 1646 1647 1648 |
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/client.rb', line 1645 def update_view(params = {}, = {}) req = build_request(:update_view, params) req.send_request() end |