RecycleBin module#
Index > RecycleBin
Auto-generated documentation for RecycleBin type annotations stubs module mypy-boto3-rbin.
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.86' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
RecycleBin
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 RecycleBin
.
From PyPI with pip#
Install boto3-stubs
for RecycleBin
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[rbin]'
# 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[rbin]'
# standalone installation
python -m pip install mypy-boto3-rbin
How to uninstall#
python -m pip uninstall -y mypy-boto3-rbin
Usage#
Code samples can be found in Examples.
RecycleBinClient#
Type annotations and code completion for boto3.client("rbin")
as RecycleBinClient
boto3 documentation
# RecycleBinClient usage example
from boto3.session import Session
from mypy_boto3_rbin.client import RecycleBinClient
def get_client() -> RecycleBinClient:
return Session().client("rbin")
Paginators#
Type annotations and code completion for paginators
from boto3.client("rbin").get_paginator("...")
.
# ListRulesPaginator usage example
from boto3.session import Session
from mypy_boto3_rbin.paginator import ListRulesPaginator
def get_list_rules_paginator() -> ListRulesPaginator:
return Session().client("rbin").get_paginator("list_rules"))
Literals#
Type annotations for literals used in methods and schema.
# ListRulesPaginatorName usage example
from mypy_boto3_rbin.literals import ListRulesPaginatorName
def get_value() -> ListRulesPaginatorName:
return "list_rules"
- ListRulesPaginatorName
- LockStateType
- ResourceTypeType
- RetentionPeriodUnitType
- RuleStatusType
- UnlockDelayUnitType
- RecycleBinServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ResourceTagTypeDef
- RetentionPeriodTypeDef
- TagTypeDef
- ResponseMetadataTypeDef
- DeleteRuleRequestRequestTypeDef
- GetRuleRequestRequestTypeDef
- PaginatorConfigTypeDef
- ListTagsForResourceRequestRequestTypeDef
- UnlockDelayTypeDef
- UnlockRuleRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- ListRulesRequestRequestTypeDef
- RuleSummaryTypeDef
- UpdateRuleRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- UpdateRuleResponseTypeDef
- ListRulesRequestPaginateTypeDef
- LockConfigurationTypeDef
- ListRulesResponseTypeDef
- CreateRuleRequestRequestTypeDef
- CreateRuleResponseTypeDef
- GetRuleResponseTypeDef
- LockRuleRequestRequestTypeDef
- LockRuleResponseTypeDef
- UnlockRuleResponseTypeDef