Typed dictionaries

Index > DLM > Typed dictionaries

Auto-generated documentation for DLM type annotations stubs module mypy-boto3-dlm.

RetentionArchiveTierTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import RetentionArchiveTierTypeDef

def get_value() -> RetentionArchiveTierTypeDef:
    return {
        "Count": ...,
    }

Definition

class RetentionArchiveTierTypeDef(TypedDict):
    Count: NotRequired[int],
    Interval: NotRequired[int],
    IntervalUnit: NotRequired[RetentionIntervalUnitValuesType],  # (1)

1. See RetentionIntervalUnitValuesType

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_dlm.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,

CreateRuleTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import CreateRuleTypeDef

def get_value() -> CreateRuleTypeDef:
    return {
        "Location": ...,
    }

Definition

class CreateRuleTypeDef(TypedDict):
    Location: NotRequired[LocationValuesType],  # (1)
    Interval: NotRequired[int],
    IntervalUnit: NotRequired[IntervalUnitValuesType],  # (2)
    Times: NotRequired[Sequence[str]],
    CronExpression: NotRequired[str],

1. See LocationValuesType
2. See IntervalUnitValuesType

CrossRegionCopyRetainRuleTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import CrossRegionCopyRetainRuleTypeDef

def get_value() -> CrossRegionCopyRetainRuleTypeDef:
    return {
        "Interval": ...,
    }

Definition

class CrossRegionCopyRetainRuleTypeDef(TypedDict):
    Interval: NotRequired[int],
    IntervalUnit: NotRequired[RetentionIntervalUnitValuesType],  # (1)

1. See RetentionIntervalUnitValuesType

EncryptionConfigurationTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import EncryptionConfigurationTypeDef

def get_value() -> EncryptionConfigurationTypeDef:
    return {
        "Encrypted": ...,
    }

Definition

class EncryptionConfigurationTypeDef(TypedDict):
    Encrypted: bool,
    CmkArn: NotRequired[str],

CrossRegionCopyDeprecateRuleTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import CrossRegionCopyDeprecateRuleTypeDef

def get_value() -> CrossRegionCopyDeprecateRuleTypeDef:
    return {
        "Interval": ...,
    }

Definition

class CrossRegionCopyDeprecateRuleTypeDef(TypedDict):
    Interval: NotRequired[int],
    IntervalUnit: NotRequired[RetentionIntervalUnitValuesType],  # (1)

1. See RetentionIntervalUnitValuesType

DeleteLifecyclePolicyRequestRequestTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import DeleteLifecyclePolicyRequestRequestTypeDef

def get_value() -> DeleteLifecyclePolicyRequestRequestTypeDef:
    return {
        "PolicyId": ...,
    }

Definition

class DeleteLifecyclePolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,

DeprecateRuleTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import DeprecateRuleTypeDef

def get_value() -> DeprecateRuleTypeDef:
    return {
        "Count": ...,
    }

Definition

class DeprecateRuleTypeDef(TypedDict):
    Count: NotRequired[int],
    Interval: NotRequired[int],
    IntervalUnit: NotRequired[RetentionIntervalUnitValuesType],  # (1)

1. See RetentionIntervalUnitValuesType

EventParametersTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import EventParametersTypeDef

def get_value() -> EventParametersTypeDef:
    return {
        "EventType": ...,
        "SnapshotOwner": ...,
        "DescriptionRegex": ...,
    }

Definition

class EventParametersTypeDef(TypedDict):
    EventType: EventTypeValuesType,  # (1)
    SnapshotOwner: Sequence[str],
    DescriptionRegex: str,

1. See EventTypeValuesType

FastRestoreRuleTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import FastRestoreRuleTypeDef

def get_value() -> FastRestoreRuleTypeDef:
    return {
        "AvailabilityZones": ...,
    }

Definition

class FastRestoreRuleTypeDef(TypedDict):
    AvailabilityZones: Sequence[str],
    Count: NotRequired[int],
    Interval: NotRequired[int],
    IntervalUnit: NotRequired[RetentionIntervalUnitValuesType],  # (1)

1. See RetentionIntervalUnitValuesType

GetLifecyclePoliciesRequestRequestTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import GetLifecyclePoliciesRequestRequestTypeDef

def get_value() -> GetLifecyclePoliciesRequestRequestTypeDef:
    return {
        "PolicyIds": ...,
    }

Definition

class GetLifecyclePoliciesRequestRequestTypeDef(TypedDict):
    PolicyIds: NotRequired[Sequence[str]],
    State: NotRequired[GettablePolicyStateValuesType],  # (1)
    ResourceTypes: NotRequired[Sequence[ResourceTypeValuesType]],  # (2)
    TargetTags: NotRequired[Sequence[str]],
    TagsToAdd: NotRequired[Sequence[str]],

1. See GettablePolicyStateValuesType
2. See ResourceTypeValuesType

LifecyclePolicySummaryTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import LifecyclePolicySummaryTypeDef

def get_value() -> LifecyclePolicySummaryTypeDef:
    return {
        "PolicyId": ...,
    }

Definition

class LifecyclePolicySummaryTypeDef(TypedDict):
    PolicyId: NotRequired[str],
    Description: NotRequired[str],
    State: NotRequired[GettablePolicyStateValuesType],  # (1)
    Tags: NotRequired[Dict[str, str]],
    PolicyType: NotRequired[PolicyTypeValuesType],  # (2)

1. See GettablePolicyStateValuesType
2. See PolicyTypeValuesType

GetLifecyclePolicyRequestRequestTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import GetLifecyclePolicyRequestRequestTypeDef

def get_value() -> GetLifecyclePolicyRequestRequestTypeDef:
    return {
        "PolicyId": ...,
    }

Definition

class GetLifecyclePolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,

ListTagsForResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import ListTagsForResourceRequestRequestTypeDef

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

Definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

TagTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import TagTypeDef

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

Definition

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

RetainRuleTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import RetainRuleTypeDef

def get_value() -> RetainRuleTypeDef:
    return {
        "Count": ...,
    }

Definition

class RetainRuleTypeDef(TypedDict):
    Count: NotRequired[int],
    Interval: NotRequired[int],
    IntervalUnit: NotRequired[RetentionIntervalUnitValuesType],  # (1)

1. See RetentionIntervalUnitValuesType

ShareRuleTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import ShareRuleTypeDef

def get_value() -> ShareRuleTypeDef:
    return {
        "TargetAccounts": ...,
    }

Definition

class ShareRuleTypeDef(TypedDict):
    TargetAccounts: Sequence[str],
    UnshareInterval: NotRequired[int],
    UnshareIntervalUnit: NotRequired[RetentionIntervalUnitValuesType],  # (1)

1. See RetentionIntervalUnitValuesType

TagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import TagResourceRequestRequestTypeDef

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

Definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import UntagResourceRequestRequestTypeDef

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

Definition

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

ArchiveRetainRuleTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import ArchiveRetainRuleTypeDef

def get_value() -> ArchiveRetainRuleTypeDef:
    return {
        "RetentionArchiveTier": ...,
    }

Definition

class ArchiveRetainRuleTypeDef(TypedDict):
    RetentionArchiveTier: RetentionArchiveTierTypeDef,  # (1)

1. See RetentionArchiveTierTypeDef

CreateLifecyclePolicyResponseTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import CreateLifecyclePolicyResponseTypeDef

def get_value() -> CreateLifecyclePolicyResponseTypeDef:
    return {
        "PolicyId": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateLifecyclePolicyResponseTypeDef(TypedDict):
    PolicyId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import ListTagsForResourceResponseTypeDef

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

Definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

CrossRegionCopyActionTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import CrossRegionCopyActionTypeDef

def get_value() -> CrossRegionCopyActionTypeDef:
    return {
        "Target": ...,
        "EncryptionConfiguration": ...,
    }

Definition

class CrossRegionCopyActionTypeDef(TypedDict):
    Target: str,
    EncryptionConfiguration: EncryptionConfigurationTypeDef,  # (1)
    RetainRule: NotRequired[CrossRegionCopyRetainRuleTypeDef],  # (2)

1. See EncryptionConfigurationTypeDef
2. See CrossRegionCopyRetainRuleTypeDef

CrossRegionCopyRuleTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import CrossRegionCopyRuleTypeDef

def get_value() -> CrossRegionCopyRuleTypeDef:
    return {
        "Encrypted": ...,
    }

Definition

class CrossRegionCopyRuleTypeDef(TypedDict):
    Encrypted: bool,
    TargetRegion: NotRequired[str],
    Target: NotRequired[str],
    CmkArn: NotRequired[str],
    CopyTags: NotRequired[bool],
    RetainRule: NotRequired[CrossRegionCopyRetainRuleTypeDef],  # (1)
    DeprecateRule: NotRequired[CrossRegionCopyDeprecateRuleTypeDef],  # (2)

1. See CrossRegionCopyRetainRuleTypeDef
2. See CrossRegionCopyDeprecateRuleTypeDef

EventSourceTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import EventSourceTypeDef

def get_value() -> EventSourceTypeDef:
    return {
        "Type": ...,
    }

Definition

class EventSourceTypeDef(TypedDict):
    Type: EventSourceValuesType,  # (1)
    Parameters: NotRequired[EventParametersTypeDef],  # (2)

1. See EventSourceValuesType
2. See EventParametersTypeDef

GetLifecyclePoliciesResponseTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import GetLifecyclePoliciesResponseTypeDef

def get_value() -> GetLifecyclePoliciesResponseTypeDef:
    return {
        "Policies": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetLifecyclePoliciesResponseTypeDef(TypedDict):
    Policies: List[LifecyclePolicySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LifecyclePolicySummaryTypeDef
2. See ResponseMetadataTypeDef

ParametersTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import ParametersTypeDef

def get_value() -> ParametersTypeDef:
    return {
        "ExcludeBootVolume": ...,
    }

Definition

class ParametersTypeDef(TypedDict):
    ExcludeBootVolume: NotRequired[bool],
    NoReboot: NotRequired[bool],
    ExcludeDataVolumeTags: NotRequired[Sequence[TagTypeDef]],  # (1)

1. See TagTypeDef

ArchiveRuleTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import ArchiveRuleTypeDef

def get_value() -> ArchiveRuleTypeDef:
    return {
        "RetainRule": ...,
    }

Definition

class ArchiveRuleTypeDef(TypedDict):
    RetainRule: ArchiveRetainRuleTypeDef,  # (1)

1. See ArchiveRetainRuleTypeDef

ActionTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import ActionTypeDef

def get_value() -> ActionTypeDef:
    return {
        "Name": ...,
        "CrossRegionCopy": ...,
    }

Definition

class ActionTypeDef(TypedDict):
    Name: str,
    CrossRegionCopy: Sequence[CrossRegionCopyActionTypeDef],  # (1)

1. See CrossRegionCopyActionTypeDef

ScheduleTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import ScheduleTypeDef

def get_value() -> ScheduleTypeDef:
    return {
        "Name": ...,
    }

Definition

class ScheduleTypeDef(TypedDict):
    Name: NotRequired[str],
    CopyTags: NotRequired[bool],
    TagsToAdd: NotRequired[Sequence[TagTypeDef]],  # (1)
    VariableTags: NotRequired[Sequence[TagTypeDef]],  # (1)
    CreateRule: NotRequired[CreateRuleTypeDef],  # (3)
    RetainRule: NotRequired[RetainRuleTypeDef],  # (4)
    FastRestoreRule: NotRequired[FastRestoreRuleTypeDef],  # (5)
    CrossRegionCopyRules: NotRequired[Sequence[CrossRegionCopyRuleTypeDef]],  # (6)
    ShareRules: NotRequired[Sequence[ShareRuleTypeDef]],  # (7)
    DeprecateRule: NotRequired[DeprecateRuleTypeDef],  # (8)
    ArchiveRule: NotRequired[ArchiveRuleTypeDef],  # (9)

1. See TagTypeDef
2. See TagTypeDef
3. See CreateRuleTypeDef
4. See RetainRuleTypeDef
5. See FastRestoreRuleTypeDef
6. See CrossRegionCopyRuleTypeDef
7. See ShareRuleTypeDef
8. See DeprecateRuleTypeDef
9. See ArchiveRuleTypeDef

PolicyDetailsTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import PolicyDetailsTypeDef

def get_value() -> PolicyDetailsTypeDef:
    return {
        "PolicyType": ...,
    }

Definition

class PolicyDetailsTypeDef(TypedDict):
    PolicyType: NotRequired[PolicyTypeValuesType],  # (1)
    ResourceTypes: NotRequired[Sequence[ResourceTypeValuesType]],  # (2)
    ResourceLocations: NotRequired[Sequence[ResourceLocationValuesType]],  # (3)
    TargetTags: NotRequired[Sequence[TagTypeDef]],  # (4)
    Schedules: NotRequired[Sequence[ScheduleTypeDef]],  # (5)
    Parameters: NotRequired[ParametersTypeDef],  # (6)
    EventSource: NotRequired[EventSourceTypeDef],  # (7)
    Actions: NotRequired[Sequence[ActionTypeDef]],  # (8)

1. See PolicyTypeValuesType
2. See ResourceTypeValuesType
3. See ResourceLocationValuesType
4. See TagTypeDef
5. See ScheduleTypeDef
6. See ParametersTypeDef
7. See EventSourceTypeDef
8. See ActionTypeDef

CreateLifecyclePolicyRequestRequestTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import CreateLifecyclePolicyRequestRequestTypeDef

def get_value() -> CreateLifecyclePolicyRequestRequestTypeDef:
    return {
        "ExecutionRoleArn": ...,
        "Description": ...,
        "State": ...,
        "PolicyDetails": ...,
    }

Definition

class CreateLifecyclePolicyRequestRequestTypeDef(TypedDict):
    ExecutionRoleArn: str,
    Description: str,
    State: SettablePolicyStateValuesType,  # (1)
    PolicyDetails: PolicyDetailsTypeDef,  # (2)
    Tags: NotRequired[Mapping[str, str]],

1. See SettablePolicyStateValuesType
2. See PolicyDetailsTypeDef

LifecyclePolicyTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import LifecyclePolicyTypeDef

def get_value() -> LifecyclePolicyTypeDef:
    return {
        "PolicyId": ...,
    }

Definition

class LifecyclePolicyTypeDef(TypedDict):
    PolicyId: NotRequired[str],
    Description: NotRequired[str],
    State: NotRequired[GettablePolicyStateValuesType],  # (1)
    StatusMessage: NotRequired[str],
    ExecutionRoleArn: NotRequired[str],
    DateCreated: NotRequired[datetime],
    DateModified: NotRequired[datetime],
    PolicyDetails: NotRequired[PolicyDetailsTypeDef],  # (2)
    Tags: NotRequired[Dict[str, str]],
    PolicyArn: NotRequired[str],

1. See GettablePolicyStateValuesType
2. See PolicyDetailsTypeDef

UpdateLifecyclePolicyRequestRequestTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import UpdateLifecyclePolicyRequestRequestTypeDef

def get_value() -> UpdateLifecyclePolicyRequestRequestTypeDef:
    return {
        "PolicyId": ...,
    }

Definition

class UpdateLifecyclePolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,
    ExecutionRoleArn: NotRequired[str],
    State: NotRequired[SettablePolicyStateValuesType],  # (1)
    Description: NotRequired[str],
    PolicyDetails: NotRequired[PolicyDetailsTypeDef],  # (2)

1. See SettablePolicyStateValuesType
2. See PolicyDetailsTypeDef

GetLifecyclePolicyResponseTypeDef

Usage Example

from mypy_boto3_dlm.type_defs import GetLifecyclePolicyResponseTypeDef

def get_value() -> GetLifecyclePolicyResponseTypeDef:
    return {
        "Policy": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetLifecyclePolicyResponseTypeDef(TypedDict):
    Policy: LifecyclePolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LifecyclePolicyTypeDef
2. See ResponseMetadataTypeDef