RecycleBinClient
Index > RecycleBin > RecycleBinClient
Auto-generated documentation for RecycleBin type annotations stubs module types-aiobotocore-rbin.
RecycleBinClient
Type annotations and code completion for session.client("rbin")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_rbin.client import RecycleBinClient
session = Session()
async with session.client("rbin") as client:
client: RecycleBinClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("rbin").exceptions
structure.
async with session.client("rbin") as client:
try:
do_something(client)
except (
client.ClientError,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ValidationException,
) as e:
print(e)
from types_aiobotocore_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 session.client("rbin").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("rbin").close
method.
boto3 documentation
create_rule
Creates a Recycle Bin retention rule.
Type annotations and code completion for session.client("rbin").create_rule
method.
boto3 documentation
await def create_rule(
self,
*,
RetentionPeriod: RetentionPeriodTypeDef, # (1)
ResourceType: ResourceTypeType, # (2)
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (3)
ResourceTags: Sequence[ResourceTagTypeDef] = ..., # (4)
) -> CreateRuleResponseTypeDef: # (5)
...
- See RetentionPeriodTypeDef
- See ResourceTypeType
- See TagTypeDef
- See ResourceTagTypeDef
- See CreateRuleResponseTypeDef
kwargs: CreateRuleRequestRequestTypeDef = { # (1)
"RetentionPeriod": ...,
"ResourceType": ...,
}
parent.create_rule(**kwargs)
delete_rule
Deletes a Recycle Bin retention rule.
Type annotations and code completion for session.client("rbin").delete_rule
method.
boto3 documentation
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 session.client("rbin").generate_presigned_url
method.
boto3 documentation
await 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 session.client("rbin").get_rule
method.
boto3 documentation
await def get_rule(
self,
*,
Identifier: str,
) -> GetRuleResponseTypeDef: # (1)
...
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 session.client("rbin").list_rules
method.
boto3 documentation
await def list_rules(
self,
*,
ResourceType: ResourceTypeType, # (1)
MaxResults: int = ...,
NextToken: str = ...,
ResourceTags: Sequence[ResourceTagTypeDef] = ..., # (2)
) -> ListRulesResponseTypeDef: # (3)
...
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 session.client("rbin").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
tag_resource
Assigns tags to the specified retention rule.
Type annotations and code completion for session.client("rbin").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Unassigns a tag from a retention rule.
Type annotations and code completion for session.client("rbin").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_rule
Updates an existing Recycle Bin retention rule.
Type annotations and code completion for session.client("rbin").update_rule
method.
boto3 documentation
await def update_rule(
self,
*,
Identifier: str,
RetentionPeriod: RetentionPeriodTypeDef = ..., # (1)
Description: str = ...,
ResourceType: ResourceTypeType = ..., # (2)
ResourceTags: Sequence[ResourceTagTypeDef] = ..., # (3)
) -> UpdateRuleResponseTypeDef: # (4)
...
- See RetentionPeriodTypeDef
- See ResourceTypeType
- See ResourceTagTypeDef
- See UpdateRuleResponseTypeDef
kwargs: UpdateRuleRequestRequestTypeDef = { # (1)
"Identifier": ...,
}
parent.update_rule(**kwargs)
__aenter__
Type annotations and code completion for session.client("rbin").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("rbin").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("rbin").get_paginator
method with overloads.
client.get_paginator("list_rules")
-> ListRulesPaginator