Skip to content

Typed dictionaries#

Index > DLM > Typed dictionaries

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

RetentionArchiveTierTypeDef#

# RetentionArchiveTierTypeDef usage example

from mypy_boto3_dlm.type_defs import RetentionArchiveTierTypeDef

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

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

CreateLifecyclePolicyResponseTypeDef#

# CreateLifecyclePolicyResponseTypeDef usage example

from mypy_boto3_dlm.type_defs import CreateLifecyclePolicyResponseTypeDef

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

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

CreateRuleTypeDef#

# CreateRuleTypeDef usage example

from mypy_boto3_dlm.type_defs import CreateRuleTypeDef

def get_value() -> CreateRuleTypeDef:
    return {
        "Location": ...,
    }
# CreateRuleTypeDef 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#

# CrossRegionCopyRetainRuleTypeDef usage example

from mypy_boto3_dlm.type_defs import CrossRegionCopyRetainRuleTypeDef

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

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

EncryptionConfigurationTypeDef#

# EncryptionConfigurationTypeDef usage example

from mypy_boto3_dlm.type_defs import EncryptionConfigurationTypeDef

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

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

CrossRegionCopyDeprecateRuleTypeDef#

# CrossRegionCopyDeprecateRuleTypeDef usage example

from mypy_boto3_dlm.type_defs import CrossRegionCopyDeprecateRuleTypeDef

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

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

DeleteLifecyclePolicyRequestRequestTypeDef#

# DeleteLifecyclePolicyRequestRequestTypeDef usage example

from mypy_boto3_dlm.type_defs import DeleteLifecyclePolicyRequestRequestTypeDef

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

class DeleteLifecyclePolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,

DeprecateRuleTypeDef#

# DeprecateRuleTypeDef usage example

from mypy_boto3_dlm.type_defs import DeprecateRuleTypeDef

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

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

EventParametersTypeDef#

# EventParametersTypeDef usage example

from mypy_boto3_dlm.type_defs import EventParametersTypeDef

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

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

FastRestoreRuleTypeDef#

# FastRestoreRuleTypeDef usage example

from mypy_boto3_dlm.type_defs import FastRestoreRuleTypeDef

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

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

GetLifecyclePoliciesRequestRequestTypeDef#

# GetLifecyclePoliciesRequestRequestTypeDef usage example

from mypy_boto3_dlm.type_defs import GetLifecyclePoliciesRequestRequestTypeDef

def get_value() -> GetLifecyclePoliciesRequestRequestTypeDef:
    return {
        "PolicyIds": ...,
    }
# GetLifecyclePoliciesRequestRequestTypeDef 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#

# LifecyclePolicySummaryTypeDef usage example

from mypy_boto3_dlm.type_defs import LifecyclePolicySummaryTypeDef

def get_value() -> LifecyclePolicySummaryTypeDef:
    return {
        "PolicyId": ...,
    }
# LifecyclePolicySummaryTypeDef 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#

# GetLifecyclePolicyRequestRequestTypeDef usage example

from mypy_boto3_dlm.type_defs import GetLifecyclePolicyRequestRequestTypeDef

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

class GetLifecyclePolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_dlm.type_defs import ListTagsForResourceRequestRequestTypeDef

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

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_dlm.type_defs import ListTagsForResourceResponseTypeDef

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

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

TagTypeDef#

# TagTypeDef usage example

from mypy_boto3_dlm.type_defs import TagTypeDef

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

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_dlm.type_defs import ResponseMetadataTypeDef

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

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

RetainRuleTypeDef#

# RetainRuleTypeDef usage example

from mypy_boto3_dlm.type_defs import RetainRuleTypeDef

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

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

ShareRuleTypeDef#

# ShareRuleTypeDef usage example

from mypy_boto3_dlm.type_defs import ShareRuleTypeDef

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

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_dlm.type_defs import TagResourceRequestRequestTypeDef

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

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_dlm.type_defs import UntagResourceRequestRequestTypeDef

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

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

ArchiveRetainRuleTypeDef#

# ArchiveRetainRuleTypeDef usage example

from mypy_boto3_dlm.type_defs import ArchiveRetainRuleTypeDef

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

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

CrossRegionCopyActionTypeDef#

# CrossRegionCopyActionTypeDef usage example

from mypy_boto3_dlm.type_defs import CrossRegionCopyActionTypeDef

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

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

CrossRegionCopyRuleTypeDef#

# CrossRegionCopyRuleTypeDef usage example

from mypy_boto3_dlm.type_defs import CrossRegionCopyRuleTypeDef

def get_value() -> CrossRegionCopyRuleTypeDef:
    return {
        "Encrypted": ...,
    }
# CrossRegionCopyRuleTypeDef 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#

# EventSourceTypeDef usage example

from mypy_boto3_dlm.type_defs import EventSourceTypeDef

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

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

GetLifecyclePoliciesResponseTypeDef#

# GetLifecyclePoliciesResponseTypeDef usage example

from mypy_boto3_dlm.type_defs import GetLifecyclePoliciesResponseTypeDef

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

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

ParametersTypeDef#

# ParametersTypeDef usage example

from mypy_boto3_dlm.type_defs import ParametersTypeDef

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

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

ArchiveRuleTypeDef#

# ArchiveRuleTypeDef usage example

from mypy_boto3_dlm.type_defs import ArchiveRuleTypeDef

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

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

ActionTypeDef#

# ActionTypeDef usage example

from mypy_boto3_dlm.type_defs import ActionTypeDef

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

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

ScheduleTypeDef#

# ScheduleTypeDef usage example

from mypy_boto3_dlm.type_defs import ScheduleTypeDef

def get_value() -> ScheduleTypeDef:
    return {
        "Name": ...,
    }
# ScheduleTypeDef 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#

# PolicyDetailsTypeDef usage example

from mypy_boto3_dlm.type_defs import PolicyDetailsTypeDef

def get_value() -> PolicyDetailsTypeDef:
    return {
        "PolicyType": ...,
    }
# PolicyDetailsTypeDef 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#

# CreateLifecyclePolicyRequestRequestTypeDef usage example

from mypy_boto3_dlm.type_defs import CreateLifecyclePolicyRequestRequestTypeDef

def get_value() -> CreateLifecyclePolicyRequestRequestTypeDef:
    return {
        "ExecutionRoleArn": ...,
        "Description": ...,
        "State": ...,
        "PolicyDetails": ...,
    }
# CreateLifecyclePolicyRequestRequestTypeDef 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#

# LifecyclePolicyTypeDef usage example

from mypy_boto3_dlm.type_defs import LifecyclePolicyTypeDef

def get_value() -> LifecyclePolicyTypeDef:
    return {
        "PolicyId": ...,
    }
# LifecyclePolicyTypeDef 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#

# UpdateLifecyclePolicyRequestRequestTypeDef usage example

from mypy_boto3_dlm.type_defs import UpdateLifecyclePolicyRequestRequestTypeDef

def get_value() -> UpdateLifecyclePolicyRequestRequestTypeDef:
    return {
        "PolicyId": ...,
    }
# UpdateLifecyclePolicyRequestRequestTypeDef 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#

# GetLifecyclePolicyResponseTypeDef usage example

from mypy_boto3_dlm.type_defs import GetLifecyclePolicyResponseTypeDef

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

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