Typed dictionaries

Index > RecycleBin > Typed dictionaries

Auto-generated documentation for RecycleBin type annotations stubs module mypy-boto3-rbin.

ResourceTagTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import ResourceTagTypeDef

def get_value() -> ResourceTagTypeDef:
    return {
        "ResourceTagKey": ...,
    }

Definition

class ResourceTagTypeDef(TypedDict):
    ResourceTagKey: str,
    ResourceTagValue: NotRequired[str],

RetentionPeriodTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import RetentionPeriodTypeDef

def get_value() -> RetentionPeriodTypeDef:
    return {
        "RetentionPeriodValue": ...,
        "RetentionPeriodUnit": ...,
    }

Definition

class RetentionPeriodTypeDef(TypedDict):
    RetentionPeriodValue: int,
    RetentionPeriodUnit: RetentionPeriodUnitType,  # (1)

1. See RetentionPeriodUnitType

TagTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }

Definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DeleteRuleRequestRequestTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import DeleteRuleRequestRequestTypeDef

def get_value() -> DeleteRuleRequestRequestTypeDef:
    return {
        "Identifier": ...,
    }

Definition

class DeleteRuleRequestRequestTypeDef(TypedDict):
    Identifier: str,

GetRuleRequestRequestTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import GetRuleRequestRequestTypeDef

def get_value() -> GetRuleRequestRequestTypeDef:
    return {
        "Identifier": ...,
    }

Definition

class GetRuleRequestRequestTypeDef(TypedDict):
    Identifier: str,

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

Definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

Definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

UnlockDelayTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import UnlockDelayTypeDef

def get_value() -> UnlockDelayTypeDef:
    return {
        "UnlockDelayValue": ...,
        "UnlockDelayUnit": ...,
    }

Definition

class UnlockDelayTypeDef(TypedDict):
    UnlockDelayValue: int,
    UnlockDelayUnit: UnlockDelayUnitType,  # (1)

1. See UnlockDelayUnitType

UnlockRuleRequestRequestTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import UnlockRuleRequestRequestTypeDef

def get_value() -> UnlockRuleRequestRequestTypeDef:
    return {
        "Identifier": ...,
    }

Definition

class UnlockRuleRequestRequestTypeDef(TypedDict):
    Identifier: str,

UntagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }

Definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

ListRulesRequestRequestTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import ListRulesRequestRequestTypeDef

def get_value() -> ListRulesRequestRequestTypeDef:
    return {
        "ResourceType": ...,
    }

Definition

class ListRulesRequestRequestTypeDef(TypedDict):
    ResourceType: ResourceTypeType,  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    ResourceTags: NotRequired[Sequence[ResourceTagTypeDef]],  # (2)
    LockState: NotRequired[LockStateType],  # (3)

1. See ResourceTypeType
2. See ResourceTagTypeDef
3. See LockStateType

RuleSummaryTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import RuleSummaryTypeDef

def get_value() -> RuleSummaryTypeDef:
    return {
        "Identifier": ...,
    }

Definition

class RuleSummaryTypeDef(TypedDict):
    Identifier: NotRequired[str],
    Description: NotRequired[str],
    RetentionPeriod: NotRequired[RetentionPeriodTypeDef],  # (1)
    LockState: NotRequired[LockStateType],  # (2)

1. See RetentionPeriodTypeDef
2. See LockStateType

UpdateRuleRequestRequestTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import UpdateRuleRequestRequestTypeDef

def get_value() -> UpdateRuleRequestRequestTypeDef:
    return {
        "Identifier": ...,
    }

Definition

class UpdateRuleRequestRequestTypeDef(TypedDict):
    Identifier: str,
    RetentionPeriod: NotRequired[RetentionPeriodTypeDef],  # (1)
    Description: NotRequired[str],
    ResourceType: NotRequired[ResourceTypeType],  # (2)
    ResourceTags: NotRequired[Sequence[ResourceTagTypeDef]],  # (3)

1. See RetentionPeriodTypeDef
2. See ResourceTypeType
3. See ResourceTagTypeDef

TagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }

Definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)

1. See TagTypeDef

ListTagsForResourceResponseTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TagTypeDef
2. See ResponseMetadataTypeDef

UpdateRuleResponseTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import UpdateRuleResponseTypeDef

def get_value() -> UpdateRuleResponseTypeDef:
    return {
        "Identifier": ...,
        "RetentionPeriod": ...,
        "Description": ...,
        "ResourceType": ...,
        "ResourceTags": ...,
        "Status": ...,
        "LockState": ...,
        "LockEndTime": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateRuleResponseTypeDef(TypedDict):
    Identifier: str,
    RetentionPeriod: RetentionPeriodTypeDef,  # (1)
    Description: str,
    ResourceType: ResourceTypeType,  # (2)
    ResourceTags: List[ResourceTagTypeDef],  # (3)
    Status: RuleStatusType,  # (4)
    LockState: LockStateType,  # (5)
    LockEndTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

1. See RetentionPeriodTypeDef
2. See ResourceTypeType
3. See ResourceTagTypeDef
4. See RuleStatusType
5. See LockStateType
6. See ResponseMetadataTypeDef

ListRulesRequestListRulesPaginateTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import ListRulesRequestListRulesPaginateTypeDef

def get_value() -> ListRulesRequestListRulesPaginateTypeDef:
    return {
        "ResourceType": ...,
    }

Definition

class ListRulesRequestListRulesPaginateTypeDef(TypedDict):
    ResourceType: ResourceTypeType,  # (1)
    ResourceTags: NotRequired[Sequence[ResourceTagTypeDef]],  # (2)
    LockState: NotRequired[LockStateType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)

1. See ResourceTypeType
2. See ResourceTagTypeDef
3. See LockStateType
4. See PaginatorConfigTypeDef

LockConfigurationTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import LockConfigurationTypeDef

def get_value() -> LockConfigurationTypeDef:
    return {
        "UnlockDelay": ...,
    }

Definition

class LockConfigurationTypeDef(TypedDict):
    UnlockDelay: UnlockDelayTypeDef,  # (1)

1. See UnlockDelayTypeDef

ListRulesResponseTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import ListRulesResponseTypeDef

def get_value() -> ListRulesResponseTypeDef:
    return {
        "Rules": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListRulesResponseTypeDef(TypedDict):
    Rules: List[RuleSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RuleSummaryTypeDef
2. See ResponseMetadataTypeDef

CreateRuleRequestRequestTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import CreateRuleRequestRequestTypeDef

def get_value() -> CreateRuleRequestRequestTypeDef:
    return {
        "RetentionPeriod": ...,
        "ResourceType": ...,
    }

Definition

class CreateRuleRequestRequestTypeDef(TypedDict):
    RetentionPeriod: RetentionPeriodTypeDef,  # (1)
    ResourceType: ResourceTypeType,  # (2)
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    ResourceTags: NotRequired[Sequence[ResourceTagTypeDef]],  # (4)
    LockConfiguration: NotRequired[LockConfigurationTypeDef],  # (5)

1. See RetentionPeriodTypeDef
2. See ResourceTypeType
3. See TagTypeDef
4. See ResourceTagTypeDef
5. See LockConfigurationTypeDef

CreateRuleResponseTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import CreateRuleResponseTypeDef

def get_value() -> CreateRuleResponseTypeDef:
    return {
        "Identifier": ...,
        "RetentionPeriod": ...,
        "Description": ...,
        "Tags": ...,
        "ResourceType": ...,
        "ResourceTags": ...,
        "Status": ...,
        "LockConfiguration": ...,
        "LockState": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateRuleResponseTypeDef(TypedDict):
    Identifier: str,
    RetentionPeriod: RetentionPeriodTypeDef,  # (1)
    Description: str,
    Tags: List[TagTypeDef],  # (2)
    ResourceType: ResourceTypeType,  # (3)
    ResourceTags: List[ResourceTagTypeDef],  # (4)
    Status: RuleStatusType,  # (5)
    LockConfiguration: LockConfigurationTypeDef,  # (6)
    LockState: LockStateType,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)

1. See RetentionPeriodTypeDef
2. See TagTypeDef
3. See ResourceTypeType
4. See ResourceTagTypeDef
5. See RuleStatusType
6. See LockConfigurationTypeDef
7. See LockStateType
8. See ResponseMetadataTypeDef

GetRuleResponseTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import GetRuleResponseTypeDef

def get_value() -> GetRuleResponseTypeDef:
    return {
        "Identifier": ...,
        "Description": ...,
        "ResourceType": ...,
        "RetentionPeriod": ...,
        "ResourceTags": ...,
        "Status": ...,
        "LockConfiguration": ...,
        "LockState": ...,
        "LockEndTime": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetRuleResponseTypeDef(TypedDict):
    Identifier: str,
    Description: str,
    ResourceType: ResourceTypeType,  # (1)
    RetentionPeriod: RetentionPeriodTypeDef,  # (2)
    ResourceTags: List[ResourceTagTypeDef],  # (3)
    Status: RuleStatusType,  # (4)
    LockConfiguration: LockConfigurationTypeDef,  # (5)
    LockState: LockStateType,  # (6)
    LockEndTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)

1. See ResourceTypeType
2. See RetentionPeriodTypeDef
3. See ResourceTagTypeDef
4. See RuleStatusType
5. See LockConfigurationTypeDef
6. See LockStateType
7. See ResponseMetadataTypeDef

LockRuleRequestRequestTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import LockRuleRequestRequestTypeDef

def get_value() -> LockRuleRequestRequestTypeDef:
    return {
        "Identifier": ...,
        "LockConfiguration": ...,
    }

Definition

class LockRuleRequestRequestTypeDef(TypedDict):
    Identifier: str,
    LockConfiguration: LockConfigurationTypeDef,  # (1)

1. See LockConfigurationTypeDef

LockRuleResponseTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import LockRuleResponseTypeDef

def get_value() -> LockRuleResponseTypeDef:
    return {
        "Identifier": ...,
        "Description": ...,
        "ResourceType": ...,
        "RetentionPeriod": ...,
        "ResourceTags": ...,
        "Status": ...,
        "LockConfiguration": ...,
        "LockState": ...,
        "ResponseMetadata": ...,
    }

Definition

class LockRuleResponseTypeDef(TypedDict):
    Identifier: str,
    Description: str,
    ResourceType: ResourceTypeType,  # (1)
    RetentionPeriod: RetentionPeriodTypeDef,  # (2)
    ResourceTags: List[ResourceTagTypeDef],  # (3)
    Status: RuleStatusType,  # (4)
    LockConfiguration: LockConfigurationTypeDef,  # (5)
    LockState: LockStateType,  # (6)
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)

1. See ResourceTypeType
2. See RetentionPeriodTypeDef
3. See ResourceTagTypeDef
4. See RuleStatusType
5. See LockConfigurationTypeDef
6. See LockStateType
7. See ResponseMetadataTypeDef

UnlockRuleResponseTypeDef

Usage Example

from mypy_boto3_rbin.type_defs import UnlockRuleResponseTypeDef

def get_value() -> UnlockRuleResponseTypeDef:
    return {
        "Identifier": ...,
        "Description": ...,
        "ResourceType": ...,
        "RetentionPeriod": ...,
        "ResourceTags": ...,
        "Status": ...,
        "LockConfiguration": ...,
        "LockState": ...,
        "LockEndTime": ...,
        "ResponseMetadata": ...,
    }

Definition

class UnlockRuleResponseTypeDef(TypedDict):
    Identifier: str,
    Description: str,
    ResourceType: ResourceTypeType,  # (1)
    RetentionPeriod: RetentionPeriodTypeDef,  # (2)
    ResourceTags: List[ResourceTagTypeDef],  # (3)
    Status: RuleStatusType,  # (4)
    LockConfiguration: LockConfigurationTypeDef,  # (5)
    LockState: LockStateType,  # (6)
    LockEndTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)

1. See ResourceTypeType
2. See RetentionPeriodTypeDef
3. See ResourceTagTypeDef
4. See RuleStatusType
5. See LockConfigurationTypeDef
6. See LockStateType
7. See ResponseMetadataTypeDef