ResourceExplorerClient#
Index > ResourceExplorer > ResourceExplorerClient
Auto-generated documentation for ResourceExplorer type annotations stubs module types-aiobotocore-resource-explorer-2.
ResourceExplorerClient#
Type annotations and code completion for session.create_client("resource-explorer-2")
boto3 documentation
ResourceExplorerClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_resource_explorer_2.client import ResourceExplorerClient
session = get_session()
async with session.create_client("resource-explorer-2") as client:
client: ResourceExplorerClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("resource-explorer-2").exceptions
structure.
ResourceExplorerClient.exceptions usage example
async with session.create_client("resource-explorer-2") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.UnauthorizedException,
client.ValidationException,
) as e:
print(e)
ResourceExplorerClient usage type checking example
from types_aiobotocore_resource_explorer_2.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
associate_default_view#
Sets the specified view as the default for the Amazon Web Services Region in which you call this operation.
Type annotations and code completion for session.create_client("resource-explorer-2").associate_default_view
method.
boto3 documentation
# associate_default_view method definition
await def associate_default_view(
self,
*,
ViewArn: str,
) -> AssociateDefaultViewOutputTypeDef: # (1)
...
# associate_default_view method usage example with argument unpacking
kwargs: AssociateDefaultViewInputRequestTypeDef = { # (1)
"ViewArn": ...,
}
parent.associate_default_view(**kwargs)
batch_get_view#
Retrieves details about a list of views.
Type annotations and code completion for session.create_client("resource-explorer-2").batch_get_view
method.
boto3 documentation
# batch_get_view method definition
await def batch_get_view(
self,
*,
ViewArns: Sequence[str] = ...,
) -> BatchGetViewOutputTypeDef: # (1)
...
# batch_get_view method usage example with argument unpacking
kwargs: BatchGetViewInputRequestTypeDef = { # (1)
"ViewArns": ...,
}
parent.batch_get_view(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_client("resource-explorer-2").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("resource-explorer-2").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_index#
Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index.
Type annotations and code completion for session.create_client("resource-explorer-2").create_index
method.
boto3 documentation
# create_index method definition
await def create_index(
self,
*,
ClientToken: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateIndexOutputTypeDef: # (1)
...
# create_index method usage example with argument unpacking
kwargs: CreateIndexInputRequestTypeDef = { # (1)
"ClientToken": ...,
}
parent.create_index(**kwargs)
create_view#
Creates a view that users can query by using the Search operation.
Type annotations and code completion for session.create_client("resource-explorer-2").create_view
method.
boto3 documentation
# create_view method definition
await def create_view(
self,
*,
ViewName: str,
ClientToken: str = ...,
Filters: SearchFilterTypeDef = ..., # (1)
IncludedProperties: Sequence[IncludedPropertyTypeDef] = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreateViewOutputTypeDef: # (3)
...
# create_view method usage example with argument unpacking
kwargs: CreateViewInputRequestTypeDef = { # (1)
"ViewName": ...,
}
parent.create_view(**kwargs)
delete_index#
Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.
Type annotations and code completion for session.create_client("resource-explorer-2").delete_index
method.
boto3 documentation
# delete_index method definition
await def delete_index(
self,
*,
Arn: str,
) -> DeleteIndexOutputTypeDef: # (1)
...
# delete_index method usage example with argument unpacking
kwargs: DeleteIndexInputRequestTypeDef = { # (1)
"Arn": ...,
}
parent.delete_index(**kwargs)
delete_view#
Deletes the specified view.
Type annotations and code completion for session.create_client("resource-explorer-2").delete_view
method.
boto3 documentation
# delete_view method definition
await def delete_view(
self,
*,
ViewArn: str,
) -> DeleteViewOutputTypeDef: # (1)
...
# delete_view method usage example with argument unpacking
kwargs: DeleteViewInputRequestTypeDef = { # (1)
"ViewArn": ...,
}
parent.delete_view(**kwargs)
disassociate_default_view#
After you call this operation, the affected Amazon Web Services Region no longer has a default view.
Type annotations and code completion for session.create_client("resource-explorer-2").disassociate_default_view
method.
boto3 documentation
# disassociate_default_view method definition
await def disassociate_default_view(
self,
) -> EmptyResponseMetadataTypeDef: # (1)
...
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("resource-explorer-2").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_default_view#
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.
Type annotations and code completion for session.create_client("resource-explorer-2").get_default_view
method.
boto3 documentation
# get_default_view method definition
await def get_default_view(
self,
) -> GetDefaultViewOutputTypeDef: # (1)
...
get_index#
Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
Type annotations and code completion for session.create_client("resource-explorer-2").get_index
method.
boto3 documentation
# get_index method definition
await def get_index(
self,
) -> GetIndexOutputTypeDef: # (1)
...
get_view#
Retrieves details of the specified view.
Type annotations and code completion for session.create_client("resource-explorer-2").get_view
method.
boto3 documentation
# get_view method definition
await def get_view(
self,
*,
ViewArn: str,
) -> GetViewOutputTypeDef: # (1)
...
# get_view method usage example with argument unpacking
kwargs: GetViewInputRequestTypeDef = { # (1)
"ViewArn": ...,
}
parent.get_view(**kwargs)
list_indexes#
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.
Type annotations and code completion for session.create_client("resource-explorer-2").list_indexes
method.
boto3 documentation
# list_indexes method definition
await def list_indexes(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
Regions: Sequence[str] = ...,
Type: IndexTypeType = ..., # (1)
) -> ListIndexesOutputTypeDef: # (2)
...
# list_indexes method usage example with argument unpacking
kwargs: ListIndexesInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_indexes(**kwargs)
list_supported_resource_types#
Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
Type annotations and code completion for session.create_client("resource-explorer-2").list_supported_resource_types
method.
boto3 documentation
# list_supported_resource_types method definition
await def list_supported_resource_types(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListSupportedResourceTypesOutputTypeDef: # (1)
...
# list_supported_resource_types method usage example with argument unpacking
kwargs: ListSupportedResourceTypesInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_supported_resource_types(**kwargs)
list_tags_for_resource#
Lists the tags that are attached to the specified resource.
Type annotations and code completion for session.create_client("resource-explorer-2").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_views#
Lists the Amazon resource names (ARNs)_ of the views available in the Amazon Web Services Region in which you call this operation.
Type annotations and code completion for session.create_client("resource-explorer-2").list_views
method.
boto3 documentation
# list_views method definition
await def list_views(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListViewsOutputTypeDef: # (1)
...
# list_views method usage example with argument unpacking
kwargs: ListViewsInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_views(**kwargs)
search#
Searches for resources and displays details about all resources that match the specified criteria.
Type annotations and code completion for session.create_client("resource-explorer-2").search
method.
boto3 documentation
# search method definition
await def search(
self,
*,
QueryString: str,
MaxResults: int = ...,
NextToken: str = ...,
ViewArn: str = ...,
) -> SearchOutputTypeDef: # (1)
...
# search method usage example with argument unpacking
kwargs: SearchInputRequestTypeDef = { # (1)
"QueryString": ...,
}
parent.search(**kwargs)
tag_resource#
Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
Type annotations and code completion for session.create_client("resource-explorer-2").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
resourceArn: str,
Tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
Type annotations and code completion for session.create_client("resource-explorer-2").untag_resource
method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_index_type#
Changes the type of the index from one of the following types to the other.
Type annotations and code completion for session.create_client("resource-explorer-2").update_index_type
method.
boto3 documentation
# update_index_type method definition
await def update_index_type(
self,
*,
Arn: str,
Type: IndexTypeType, # (1)
) -> UpdateIndexTypeOutputTypeDef: # (2)
...
# update_index_type method usage example with argument unpacking
kwargs: UpdateIndexTypeInputRequestTypeDef = { # (1)
"Arn": ...,
"Type": ...,
}
parent.update_index_type(**kwargs)
update_view#
Modifies some of the details of a view.
Type annotations and code completion for session.create_client("resource-explorer-2").update_view
method.
boto3 documentation
# update_view method definition
await def update_view(
self,
*,
ViewArn: str,
Filters: SearchFilterTypeDef = ..., # (1)
IncludedProperties: Sequence[IncludedPropertyTypeDef] = ..., # (2)
) -> UpdateViewOutputTypeDef: # (3)
...
# update_view method usage example with argument unpacking
kwargs: UpdateViewInputRequestTypeDef = { # (1)
"ViewArn": ...,
}
parent.update_view(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("resource-explorer-2").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> ResourceExplorerClient:
...
__aexit__#
Type annotations and code completion for session.create_client("resource-explorer-2").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("resource-explorer-2").get_paginator
method with overloads.
client.get_paginator("list_indexes")
-> ListIndexesPaginatorclient.get_paginator("list_supported_resource_types")
-> ListSupportedResourceTypesPaginatorclient.get_paginator("list_views")
-> ListViewsPaginatorclient.get_paginator("search")
-> SearchPaginator