Skip to content

RecycleBinClient#

Index > RecycleBin > RecycleBinClient

Auto-generated documentation for RecycleBin type annotations stubs module types-aiobotocore-rbin.

RecycleBinClient#

Type annotations and code completion for session.create_client("rbin") boto3 documentation

RecycleBinClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_rbin.client import RecycleBinClient

session = get_session()
async with session.create_client("rbin") as client:
    client: RecycleBinClient

Exceptions#

aiobotocore client exceptions are generated in runtime. This class provides code completion for session.create_client("rbin").exceptions structure.

RecycleBinClient.exceptions usage example

async with session.create_client("rbin") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.ConflictException,
        client.InternalServerException,
        client.ResourceNotFoundException,
        client.ServiceQuotaExceededException,
        client.ValidationException,
    ) as e:
        print(e)
RecycleBinClient usage type checking example

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.create_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 session.create_client("rbin").close method. boto3 documentation

# close method definition

await def close(
    self,
) -> None:
    ...

create_rule#

Creates a Recycle Bin retention rule.

Type annotations and code completion for session.create_client("rbin").create_rule method. boto3 documentation

# create_rule method definition

await 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)
    ...
  1. See RetentionPeriodTypeDef
  2. See ResourceTypeType
  3. See TagTypeDef
  4. See ResourceTagTypeDef
  5. See LockConfigurationTypeDef
  6. See CreateRuleResponseTypeDef 
# create_rule method usage example with argument unpacking

kwargs: CreateRuleRequestRequestTypeDef = {  # (1)
    "RetentionPeriod": ...,
    "ResourceType": ...,
}

parent.create_rule(**kwargs)
  1. See CreateRuleRequestRequestTypeDef

delete_rule#

Deletes a Recycle Bin retention rule.

Type annotations and code completion for session.create_client("rbin").delete_rule method. boto3 documentation

# delete_rule method definition

await 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)
  1. See DeleteRuleRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for session.create_client("rbin").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

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.create_client("rbin").get_rule method. boto3 documentation

# get_rule method definition

await def get_rule(
    self,
    *,
    Identifier: str,
) -> GetRuleResponseTypeDef:  # (1)
    ...
  1. See GetRuleResponseTypeDef 
# get_rule method usage example with argument unpacking

kwargs: GetRuleRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_rule(**kwargs)
  1. See GetRuleRequestRequestTypeDef

list_rules#

Lists the Recycle Bin retention rules in the Region.

Type annotations and code completion for session.create_client("rbin").list_rules method. boto3 documentation

# list_rules method definition

await def list_rules(
    self,
    *,
    ResourceType: ResourceTypeType,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
    ResourceTags: Sequence[ResourceTagTypeDef] = ...,  # (2)
    LockState: LockStateType = ...,  # (3)
) -> ListRulesResponseTypeDef:  # (4)
    ...
  1. See ResourceTypeType
  2. See ResourceTagTypeDef
  3. See LockStateType
  4. See ListRulesResponseTypeDef 
# list_rules method usage example with argument unpacking

kwargs: ListRulesRequestRequestTypeDef = {  # (1)
    "ResourceType": ...,
}

parent.list_rules(**kwargs)
  1. See ListRulesRequestRequestTypeDef

list_tags_for_resource#

Lists the tags assigned to a retention rule.

Type annotations and code completion for session.create_client("rbin").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

await def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

lock_rule#

Locks a retention rule.

Type annotations and code completion for session.create_client("rbin").lock_rule method. boto3 documentation

# lock_rule method definition

await def lock_rule(
    self,
    *,
    Identifier: str,
    LockConfiguration: LockConfigurationTypeDef,  # (1)
) -> LockRuleResponseTypeDef:  # (2)
    ...
  1. See LockConfigurationTypeDef
  2. See LockRuleResponseTypeDef 
# lock_rule method usage example with argument unpacking

kwargs: LockRuleRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "LockConfiguration": ...,
}

parent.lock_rule(**kwargs)
  1. See LockRuleRequestRequestTypeDef

tag_resource#

Assigns tags to the specified retention rule.

Type annotations and code completion for session.create_client("rbin").tag_resource method. boto3 documentation

# tag_resource method definition

await def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

unlock_rule#

Unlocks a retention rule.

Type annotations and code completion for session.create_client("rbin").unlock_rule method. boto3 documentation

# unlock_rule method definition

await def unlock_rule(
    self,
    *,
    Identifier: str,
) -> UnlockRuleResponseTypeDef:  # (1)
    ...
  1. See UnlockRuleResponseTypeDef 
# unlock_rule method usage example with argument unpacking

kwargs: UnlockRuleRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.unlock_rule(**kwargs)
  1. See UnlockRuleRequestRequestTypeDef

untag_resource#

Unassigns a tag from a retention rule.

Type annotations and code completion for session.create_client("rbin").untag_resource method. boto3 documentation

# untag_resource method definition

await def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_rule#

Updates an existing Recycle Bin retention rule.

Type annotations and code completion for session.create_client("rbin").update_rule method. boto3 documentation

# update_rule method definition

await def update_rule(
    self,
    *,
    Identifier: str,
    RetentionPeriod: RetentionPeriodTypeDef = ...,  # (1)
    Description: str = ...,
    ResourceType: ResourceTypeType = ...,  # (2)
    ResourceTags: Sequence[ResourceTagTypeDef] = ...,  # (3)
) -> UpdateRuleResponseTypeDef:  # (4)
    ...
  1. See RetentionPeriodTypeDef
  2. See ResourceTypeType
  3. See ResourceTagTypeDef
  4. See UpdateRuleResponseTypeDef 
# update_rule method usage example with argument unpacking

kwargs: UpdateRuleRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.update_rule(**kwargs)
  1. See UpdateRuleRequestRequestTypeDef

__aenter__#

Type annotations and code completion for session.create_client("rbin").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> RecycleBinClient:
    ...

__aexit__#

Type annotations and code completion for session.create_client("rbin").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator#

Type annotations and code completion for session.create_client("rbin").get_paginator method with overloads.