Skip to content

ResourceExplorerClient

Index > ResourceExplorer > ResourceExplorerClient

Auto-generated documentation for ResourceExplorer type annotations stubs module mypy-boto3-resource-explorer-2.

ResourceExplorerClient

Type annotations and code completion for boto3.client("resource-explorer-2"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_resource_explorer_2.client import ResourceExplorerClient

def get_resource-explorer-2_client() -> ResourceExplorerClient:
    return Session().client("resource-explorer-2")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("resource-explorer-2").exceptions structure.

Usage example
client = boto3.client("resource-explorer-2")

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)
Type checking example
from mypy_boto3_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 boto3.client("resource-explorer-2").associate_default_view method. boto3 documentation

Method definition
def associate_default_view(
    self,
    *,
    ViewArn: str,
) -> AssociateDefaultViewOutputTypeDef:  # (1)
    ...
  1. See AssociateDefaultViewOutputTypeDef
Usage example with kwargs
kwargs: AssociateDefaultViewInputRequestTypeDef = {  # (1)
    "ViewArn": ...,
}

parent.associate_default_view(**kwargs)
  1. See AssociateDefaultViewInputRequestTypeDef

batch_get_view

Retrieves details about a list of views.

Type annotations and code completion for boto3.client("resource-explorer-2").batch_get_view method. boto3 documentation

Method definition
def batch_get_view(
    self,
    *,
    ViewArns: Sequence[str] = ...,
) -> BatchGetViewOutputTypeDef:  # (1)
    ...
  1. See BatchGetViewOutputTypeDef
Usage example with kwargs
kwargs: BatchGetViewInputRequestTypeDef = {  # (1)
    "ViewArns": ...,
}

parent.batch_get_view(**kwargs)
  1. See BatchGetViewInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("resource-explorer-2").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("resource-explorer-2").close method. boto3 documentation

Method definition
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 boto3.client("resource-explorer-2").create_index method. boto3 documentation

Method definition
def create_index(
    self,
    *,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateIndexOutputTypeDef:  # (1)
    ...
  1. See CreateIndexOutputTypeDef
Usage example with kwargs
kwargs: CreateIndexInputRequestTypeDef = {  # (1)
    "ClientToken": ...,
}

parent.create_index(**kwargs)
  1. See CreateIndexInputRequestTypeDef

create_view

Creates a view that users can query by using the Search operation.

Type annotations and code completion for boto3.client("resource-explorer-2").create_view method. boto3 documentation

Method definition
def create_view(
    self,
    *,
    ViewName: str,
    ClientToken: str = ...,
    Filters: SearchFilterTypeDef = ...,  # (1)
    IncludedProperties: Sequence[IncludedPropertyTypeDef] = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateViewOutputTypeDef:  # (3)
    ...
  1. See SearchFilterTypeDef
  2. See IncludedPropertyTypeDef
  3. See CreateViewOutputTypeDef
Usage example with kwargs
kwargs: CreateViewInputRequestTypeDef = {  # (1)
    "ViewName": ...,
}

parent.create_view(**kwargs)
  1. See CreateViewInputRequestTypeDef

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 boto3.client("resource-explorer-2").delete_index method. boto3 documentation

Method definition
def delete_index(
    self,
    *,
    Arn: str,
) -> DeleteIndexOutputTypeDef:  # (1)
    ...
  1. See DeleteIndexOutputTypeDef
Usage example with kwargs
kwargs: DeleteIndexInputRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.delete_index(**kwargs)
  1. See DeleteIndexInputRequestTypeDef

delete_view

Deletes the specified view.

Type annotations and code completion for boto3.client("resource-explorer-2").delete_view method. boto3 documentation

Method definition
def delete_view(
    self,
    *,
    ViewArn: str,
) -> DeleteViewOutputTypeDef:  # (1)
    ...
  1. See DeleteViewOutputTypeDef
Usage example with kwargs
kwargs: DeleteViewInputRequestTypeDef = {  # (1)
    "ViewArn": ...,
}

parent.delete_view(**kwargs)
  1. See DeleteViewInputRequestTypeDef

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 boto3.client("resource-explorer-2").disassociate_default_view method. boto3 documentation

Method definition
def disassociate_default_view(
    self,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("resource-explorer-2").generate_presigned_url method. boto3 documentation

Method definition
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 boto3.client("resource-explorer-2").get_default_view method. boto3 documentation

Method definition
def get_default_view(
    self,
) -> GetDefaultViewOutputTypeDef:  # (1)
    ...
  1. See GetDefaultViewOutputTypeDef

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 boto3.client("resource-explorer-2").get_index method. boto3 documentation

Method definition
def get_index(
    self,
) -> GetIndexOutputTypeDef:  # (1)
    ...
  1. See GetIndexOutputTypeDef

get_view

Retrieves details of the specified view.

Type annotations and code completion for boto3.client("resource-explorer-2").get_view method. boto3 documentation

Method definition
def get_view(
    self,
    *,
    ViewArn: str,
) -> GetViewOutputTypeDef:  # (1)
    ...
  1. See GetViewOutputTypeDef
Usage example with kwargs
kwargs: GetViewInputRequestTypeDef = {  # (1)
    "ViewArn": ...,
}

parent.get_view(**kwargs)
  1. See GetViewInputRequestTypeDef

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 boto3.client("resource-explorer-2").list_indexes method. boto3 documentation

Method definition
def list_indexes(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    Regions: Sequence[str] = ...,
    Type: IndexTypeType = ...,  # (1)
) -> ListIndexesOutputTypeDef:  # (2)
    ...
  1. See IndexTypeType
  2. See ListIndexesOutputTypeDef
Usage example with kwargs
kwargs: ListIndexesInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_indexes(**kwargs)
  1. See ListIndexesInputRequestTypeDef

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 boto3.client("resource-explorer-2").list_supported_resource_types method. boto3 documentation

Method definition
def list_supported_resource_types(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSupportedResourceTypesOutputTypeDef:  # (1)
    ...
  1. See ListSupportedResourceTypesOutputTypeDef
Usage example with kwargs
kwargs: ListSupportedResourceTypesInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_supported_resource_types(**kwargs)
  1. See ListSupportedResourceTypesInputRequestTypeDef

list_tags_for_resource

Lists the tags that are attached to the specified resource.

Type annotations and code completion for boto3.client("resource-explorer-2").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

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 boto3.client("resource-explorer-2").list_views method. boto3 documentation

Method definition
def list_views(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListViewsOutputTypeDef:  # (1)
    ...
  1. See ListViewsOutputTypeDef
Usage example with kwargs
kwargs: ListViewsInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_views(**kwargs)
  1. See ListViewsInputRequestTypeDef

Searches for resources and displays details about all resources that match the specified criteria.

Type annotations and code completion for boto3.client("resource-explorer-2").search method. boto3 documentation

Method definition
def search(
    self,
    *,
    QueryString: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    ViewArn: str = ...,
) -> SearchOutputTypeDef:  # (1)
    ...
  1. See SearchOutputTypeDef
Usage example with kwargs
kwargs: SearchInputRequestTypeDef = {  # (1)
    "QueryString": ...,
}

parent.search(**kwargs)
  1. See SearchInputRequestTypeDef

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 boto3.client("resource-explorer-2").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    Tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputRequestTypeDef

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 boto3.client("resource-explorer-2").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputRequestTypeDef

update_index_type

Changes the type of the index from one of the following types to the other.

Type annotations and code completion for boto3.client("resource-explorer-2").update_index_type method. boto3 documentation

Method definition
def update_index_type(
    self,
    *,
    Arn: str,
    Type: IndexTypeType,  # (1)
) -> UpdateIndexTypeOutputTypeDef:  # (2)
    ...
  1. See IndexTypeType
  2. See UpdateIndexTypeOutputTypeDef
Usage example with kwargs
kwargs: UpdateIndexTypeInputRequestTypeDef = {  # (1)
    "Arn": ...,
    "Type": ...,
}

parent.update_index_type(**kwargs)
  1. See UpdateIndexTypeInputRequestTypeDef

update_view

Modifies some of the details of a view.

Type annotations and code completion for boto3.client("resource-explorer-2").update_view method. boto3 documentation

Method definition
def update_view(
    self,
    *,
    ViewArn: str,
    Filters: SearchFilterTypeDef = ...,  # (1)
    IncludedProperties: Sequence[IncludedPropertyTypeDef] = ...,  # (2)
) -> UpdateViewOutputTypeDef:  # (3)
    ...
  1. See SearchFilterTypeDef
  2. See IncludedPropertyTypeDef
  3. See UpdateViewOutputTypeDef
Usage example with kwargs
kwargs: UpdateViewInputRequestTypeDef = {  # (1)
    "ViewArn": ...,
}

parent.update_view(**kwargs)
  1. See UpdateViewInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("resource-explorer-2").get_paginator method with overloads.