ResourceExplorer module#
Index > ResourceExplorer
Auto-generated documentation for ResourceExplorer type annotations stubs module mypy-boto3-resource-explorer-2.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and ResourceExplorer
.
From PyPI with pip#
Install boto3-stubs
for ResourceExplorer
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[resource-explorer-2]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[resource-explorer-2]'
# standalone installation
python -m pip install mypy-boto3-resource-explorer-2
How to uninstall#
python -m pip uninstall -y mypy-boto3-resource-explorer-2
Usage#
Code samples can be found in Examples.
ResourceExplorerClient#
Type annotations and code completion for boto3.client("resource-explorer-2")
as ResourceExplorerClient
boto3 documentation
# ResourceExplorerClient usage example
from boto3.session import Session
from mypy_boto3_resource_explorer_2.client import ResourceExplorerClient
def get_client() -> ResourceExplorerClient:
return Session().client("resource-explorer-2")
Paginators#
Type annotations and code completion for paginators
from boto3.client("resource-explorer-2").get_paginator("...")
.
# ListIndexesPaginator usage example
from boto3.session import Session
from mypy_boto3_resource_explorer_2.paginator import ListIndexesPaginator
def get_list_indexes_paginator() -> ListIndexesPaginator:
return Session().client("resource-explorer-2").get_paginator("list_indexes"))
Literals#
Type annotations for literals used in methods and schemas.
# IndexStateType usage example
from mypy_boto3_resource_explorer_2.literals import IndexStateType
def get_value() -> IndexStateType:
return "ACTIVE"
- IndexStateType
- IndexTypeType
- ListIndexesPaginatorName
- ListSupportedResourceTypesPaginatorName
- ListViewsPaginatorName
- SearchPaginatorName
- ResourceExplorerServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AssociateDefaultViewInputRequestTypeDef usage example
from mypy_boto3_resource_explorer_2.type_defs import AssociateDefaultViewInputRequestTypeDef
def get_value() -> AssociateDefaultViewInputRequestTypeDef:
return {
"ViewArn": ...,
}
- AssociateDefaultViewInputRequestTypeDef
- AssociateDefaultViewOutputTypeDef
- BatchGetViewErrorTypeDef
- BatchGetViewInputRequestTypeDef
- CreateIndexInputRequestTypeDef
- CreateIndexOutputTypeDef
- IncludedPropertyTypeDef
- SearchFilterTypeDef
- DeleteIndexInputRequestTypeDef
- DeleteIndexOutputTypeDef
- DeleteViewInputRequestTypeDef
- DeleteViewOutputTypeDef
- EmptyResponseMetadataTypeDef
- GetDefaultViewOutputTypeDef
- GetIndexOutputTypeDef
- GetViewInputRequestTypeDef
- IndexTypeDef
- ListIndexesInputListIndexesPaginateTypeDef
- ListIndexesInputRequestTypeDef
- ListSupportedResourceTypesInputListSupportedResourceTypesPaginateTypeDef
- ListSupportedResourceTypesInputRequestTypeDef
- SupportedResourceTypeTypeDef
- ListTagsForResourceInputRequestTypeDef
- ListTagsForResourceOutputTypeDef
- ListViewsInputListViewsPaginateTypeDef
- ListViewsInputRequestTypeDef
- ListViewsOutputTypeDef
- PaginatorConfigTypeDef
- ResourceCountTypeDef
- ResourcePropertyTypeDef
- ResponseMetadataTypeDef
- SearchInputRequestTypeDef
- SearchInputSearchPaginateTypeDef
- TagResourceInputRequestTypeDef
- UntagResourceInputRequestTypeDef
- UpdateIndexTypeInputRequestTypeDef
- UpdateIndexTypeOutputTypeDef
- CreateViewInputRequestTypeDef
- UpdateViewInputRequestTypeDef
- ViewTypeDef
- ListIndexesOutputTypeDef
- ListSupportedResourceTypesOutputTypeDef
- ResourceTypeDef
- BatchGetViewOutputTypeDef
- CreateViewOutputTypeDef
- GetViewOutputTypeDef
- UpdateViewOutputTypeDef
- SearchOutputTypeDef