ResourceGroups module

Index > ResourceGroups

Auto-generated documentation for ResourceGroups type annotations stubs module mypy-boto3-resource-groups.

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

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("...").

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"))

Literals

Type annotations for literals used in methods and schemas.

Usage example

from mypy_boto3_resource_groups.literals import GroupConfigurationStatusType

def get_value() -> GroupConfigurationStatusType:
    return "UPDATE_COMPLETE"

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example

from mypy_boto3_resource_groups.type_defs import AccountSettingsTypeDef

def get_value() -> AccountSettingsTypeDef:
    return {
        "GroupLifecycleEventsDesiredStatus": ...,
    }