ResourceGroups module#
Index > ResourceGroups
Auto-generated documentation for ResourceGroups type annotations stubs module mypy-boto3-resource-groups.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.87' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
ResourceGroups
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and ResourceGroups
.
From PyPI with pip#
Install boto3-stubs
for ResourceGroups
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[resource-groups]'
# 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-groups]'
# standalone installation
python -m pip install mypy-boto3-resource-groups
How to uninstall#
python -m pip uninstall -y mypy-boto3-resource-groups
Usage#
Code samples can be found in Examples.
ResourceGroupsClient#
Type annotations and code completion for boto3.client("resource-groups")
as ResourceGroupsClient
boto3 documentation
# ResourceGroupsClient usage example
from boto3.session import Session
from mypy_boto3_resource_groups.client import ResourceGroupsClient
def get_client() -> ResourceGroupsClient:
return Session().client("resource-groups")
Paginators#
Type annotations and code completion for paginators
from boto3.client("resource-groups").get_paginator("...")
.
# ListGroupResourcesPaginator usage example
from boto3.session import Session
from mypy_boto3_resource_groups.paginator import ListGroupResourcesPaginator
def get_list_group_resources_paginator() -> ListGroupResourcesPaginator:
return Session().client("resource-groups").get_paginator("list_group_resources"))
- ListGroupResourcesPaginator
- ListGroupingStatusesPaginator
- ListGroupsPaginator
- ListTagSyncTasksPaginator
- SearchResourcesPaginator
Literals#
Type annotations for literals used in methods and schema.
# GroupConfigurationStatusType usage example
from mypy_boto3_resource_groups.literals import GroupConfigurationStatusType
def get_value() -> GroupConfigurationStatusType:
return "UPDATE_COMPLETE"
- GroupConfigurationStatusType
- GroupFilterNameType
- GroupLifecycleEventsDesiredStatusType
- GroupLifecycleEventsStatusType
- GroupingStatusType
- GroupingTypeType
- ListGroupResourcesPaginatorName
- ListGroupingStatusesFilterNameType
- ListGroupingStatusesPaginatorName
- ListGroupsPaginatorName
- ListTagSyncTasksPaginatorName
- QueryErrorCodeType
- QueryTypeType
- ResourceFilterNameType
- ResourceStatusValueType
- SearchResourcesPaginatorName
- TagSyncTaskStatusType
- ResourceGroupsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccountSettingsTypeDef
- CancelTagSyncTaskInputRequestTypeDef
- ResourceQueryTypeDef
- GroupTypeDef
- ResponseMetadataTypeDef
- DeleteGroupInputRequestTypeDef
- FailedResourceTypeDef
- GetGroupConfigurationInputRequestTypeDef
- GetGroupInputRequestTypeDef
- GetGroupQueryInputRequestTypeDef
- GetTagSyncTaskInputRequestTypeDef
- GetTagsInputRequestTypeDef
- GroupConfigurationParameterOutputTypeDef
- GroupConfigurationParameterTypeDef
- GroupFilterTypeDef
- GroupIdentifierTypeDef
- GroupResourcesInputRequestTypeDef
- PendingResourceTypeDef
- GroupingStatusesItemTypeDef
- PaginatorConfigTypeDef
- ResourceFilterTypeDef
- ResourceIdentifierTypeDef
- ResourceStatusTypeDef
- QueryErrorTypeDef
- ListGroupingStatusesFilterTypeDef
- ListTagSyncTasksFilterTypeDef
- TagSyncTaskItemTypeDef
- StartTagSyncTaskInputRequestTypeDef
- TagInputRequestTypeDef
- UngroupResourcesInputRequestTypeDef
- UntagInputRequestTypeDef
- UpdateAccountSettingsInputRequestTypeDef
- UpdateGroupInputRequestTypeDef
- GroupQueryTypeDef
- SearchResourcesInputRequestTypeDef
- UpdateGroupQueryInputRequestTypeDef
- DeleteGroupOutputTypeDef
- EmptyResponseMetadataTypeDef
- GetAccountSettingsOutputTypeDef
- GetGroupOutputTypeDef
- GetTagSyncTaskOutputTypeDef
- GetTagsOutputTypeDef
- StartTagSyncTaskOutputTypeDef
- TagOutputTypeDef
- UntagOutputTypeDef
- UpdateAccountSettingsOutputTypeDef
- UpdateGroupOutputTypeDef
- GroupConfigurationItemOutputTypeDef
- GroupConfigurationParameterUnionTypeDef
- ListGroupsInputRequestTypeDef
- ListGroupsOutputTypeDef
- GroupResourcesOutputTypeDef
- UngroupResourcesOutputTypeDef
- ListGroupingStatusesOutputTypeDef
- ListGroupsInputPaginateTypeDef
- SearchResourcesInputPaginateTypeDef
- ListGroupResourcesInputPaginateTypeDef
- ListGroupResourcesInputRequestTypeDef
- ListGroupResourcesItemTypeDef
- SearchResourcesOutputTypeDef
- ListGroupingStatusesInputPaginateTypeDef
- ListGroupingStatusesInputRequestTypeDef
- ListTagSyncTasksInputPaginateTypeDef
- ListTagSyncTasksInputRequestTypeDef
- ListTagSyncTasksOutputTypeDef
- GetGroupQueryOutputTypeDef
- UpdateGroupQueryOutputTypeDef
- GroupConfigurationTypeDef
- GroupConfigurationItemTypeDef
- ListGroupResourcesOutputTypeDef
- CreateGroupOutputTypeDef
- GetGroupConfigurationOutputTypeDef
- GroupConfigurationItemUnionTypeDef
- PutGroupConfigurationInputRequestTypeDef
- CreateGroupInputRequestTypeDef