RecycleBinClient#
Index > RecycleBin > RecycleBinClient
Auto-generated documentation for RecycleBin type annotations stubs module mypy-boto3-rbin.
RecycleBinClient#
Type annotations and code completion for boto3.client("rbin")
.
boto3 documentation
# RecycleBinClient usage example
from boto3.session import Session
from mypy_boto3_rbin.client import RecycleBinClient
def get_rbin_client() -> RecycleBinClient:
return Session().client("rbin")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("rbin").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("rbin")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_rbin.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("rbin").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("rbin").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_rule#
Creates a Recycle Bin retention rule.
Type annotations and code completion for boto3.client("rbin").create_rule
method.
boto3 documentation
# create_rule method definition
def create_rule(
self,
*,
RetentionPeriod: RetentionPeriodTypeDef, # (1)
ResourceType: ResourceTypeType, # (2)
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (3)
ResourceTags: Sequence[ResourceTagTypeDef] = ..., # (4)
LockConfiguration: LockConfigurationTypeDef = ..., # (5)
) -> CreateRuleResponseTypeDef: # (6)
...
- See RetentionPeriodTypeDef
- See ResourceTypeType
- See TagTypeDef
- See ResourceTagTypeDef
- See LockConfigurationTypeDef
- See CreateRuleResponseTypeDef
# create_rule method usage example with argument unpacking
kwargs: CreateRuleRequestRequestTypeDef = { # (1)
"RetentionPeriod": ...,
"ResourceType": ...,
}
parent.create_rule(**kwargs)
delete_rule#
Deletes a Recycle Bin retention rule.
Type annotations and code completion for boto3.client("rbin").delete_rule
method.
boto3 documentation
# delete_rule method definition
def delete_rule(
self,
*,
Identifier: str,
) -> Dict[str, Any]:
...
# delete_rule method usage example with argument unpacking
kwargs: DeleteRuleRequestRequestTypeDef = { # (1)
"Identifier": ...,
}
parent.delete_rule(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("rbin").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_rule#
Gets information about a Recycle Bin retention rule.
Type annotations and code completion for boto3.client("rbin").get_rule
method.
boto3 documentation
# get_rule method definition
def get_rule(
self,
*,
Identifier: str,
) -> GetRuleResponseTypeDef: # (1)
...
# get_rule method usage example with argument unpacking
kwargs: GetRuleRequestRequestTypeDef = { # (1)
"Identifier": ...,
}
parent.get_rule(**kwargs)
list_rules#
Lists the Recycle Bin retention rules in the Region.
Type annotations and code completion for boto3.client("rbin").list_rules
method.
boto3 documentation
# list_rules method definition
def list_rules(
self,
*,
ResourceType: ResourceTypeType, # (1)
MaxResults: int = ...,
NextToken: str = ...,
ResourceTags: Sequence[ResourceTagTypeDef] = ..., # (2)
LockState: LockStateType = ..., # (3)
) -> ListRulesResponseTypeDef: # (4)
...
- See ResourceTypeType
- See ResourceTagTypeDef
- See LockStateType
- See ListRulesResponseTypeDef
# list_rules method usage example with argument unpacking
kwargs: ListRulesRequestRequestTypeDef = { # (1)
"ResourceType": ...,
}
parent.list_rules(**kwargs)
list_tags_for_resource#
Lists the tags assigned to a retention rule.
Type annotations and code completion for boto3.client("rbin").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
lock_rule#
Locks a retention rule.
Type annotations and code completion for boto3.client("rbin").lock_rule
method.