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

# ResourceExplorerClient 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.

# Exceptions.exceptions usage example

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

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnauthorizedException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions 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

# associate_default_view method definition

def associate_default_view(
    self,
    *,
    ViewArn: str,
) -> AssociateDefaultViewOutputTypeDef:  # (1)
    ...
  1. See AssociateDefaultViewOutputTypeDef
# associate_default_view method usage example with argument unpacking

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

# batch_get_view method definition

def batch_get_view(
    self,
    *,
    ViewArns: Sequence[str] = ...,
) -> BatchGetViewOutputTypeDef:  # (1)
    ...
  1. See BatchGetViewOutputTypeDef
# batch_get_view method usage example with argument unpacking

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

# can_paginate 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

# close 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

# create_index method definition

def create_index(
    self,
    *,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateIndexOutputTypeDef:  # (1)
    ...
  1. See CreateIndexOutputTypeDef
# create_index method usage example with argument unpacking

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

# create_view method definition

def create_view(
    self,
    *,
    ViewName: str,
    ClientToken: str = ...,
    Filters: SearchFilterTypeDef = ...,  # (1)
    IncludedProperties: Sequence[IncludedPropertyTypeDef] = ...,  # (2)
    Scope: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateViewOutputTypeDef:  # (3)
    ...
  1. See SearchFilterTypeDef
  2. See IncludedPropertyTypeDef
  3. See CreateViewOutputTypeDef
# create_view method usage example with argument unpacking

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

# delete_index method definition

def delete_index(
    self,
    *,
    Arn: str,
) -> DeleteIndexOutputTypeDef:  # (1)
    ...
  1. See DeleteIndexOutputTypeDef
# delete_index method usage example with argument unpacking

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

# delete_view method definition

def delete_view(
    self,
    *,
    ViewArn: str,
) -> DeleteViewOutputTypeDef:  # (1)
    ...
  1. See DeleteViewOutputTypeDef
# delete_view method usage example with argument unpacking

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

# disassociate_default_view 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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_account_level_service_configuration#

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.

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

# get_account_level_service_configuration method definition

def get_account_level_service_configuration(
    self,
) -> GetAccountLevelServiceConfigurationOutputTypeDef:  # (1)
    ...
  1. See GetAccountLevelServiceConfigurationOutputTypeDef

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

# get_default_view 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

# get_index 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

# get_view method definition

def get_view(
    self,
    *,
    ViewArn: str,
) -> GetViewOutputTypeDef:  # (1)
    ...
  1. See GetViewOutputTypeDef
# get_view method usage example with argument unpacking

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

# list_indexes method definition

def list_indexes(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    Regions: Sequence[str] = ...,
    Type: IndexTypeType = ...,  # (1)
) -> ListIndexesOutputTypeDef:  # (2)
    ...
  1. See IndexTypeType
  2. See ListIndexesOutputTypeDef
# list_indexes method usage example with argument unpacking

kwargs: ListIndexesInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

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

list_indexes_for_members#

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.

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