Skip to content

Type definitions#

Index > DLM > Type definitions

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

RetentionArchiveTierTypeDef#

# RetentionArchiveTierTypeDef definition

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

CrossRegionCopyTargetTypeDef#

# CrossRegionCopyTargetTypeDef definition

class CrossRegionCopyTargetTypeDef(TypedDict):
    TargetRegion: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

ScriptTypeDef#

# ScriptTypeDef definition

class ScriptTypeDef(TypedDict):
    ExecutionHandler: str,
    Stages: NotRequired[Sequence[StageValuesType]],  # (1)
    ExecutionHandlerService: NotRequired[ExecutionHandlerServiceValuesType],  # (2)
    ExecuteOperationOnScriptFailure: NotRequired[bool],
    ExecutionTimeout: NotRequired[int],
    MaximumRetryCount: NotRequired[int],
  1. See StageValuesType
  2. See ExecutionHandlerServiceValuesType

CrossRegionCopyRetainRuleTypeDef#

# CrossRegionCopyRetainRuleTypeDef definition

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

EncryptionConfigurationTypeDef#

# EncryptionConfigurationTypeDef definition

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

CrossRegionCopyDeprecateRuleTypeDef#

# CrossRegionCopyDeprecateRuleTypeDef definition

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

DeleteLifecyclePolicyRequestRequestTypeDef#

# DeleteLifecyclePolicyRequestRequestTypeDef definition

class DeleteLifecyclePolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,

DeprecateRuleTypeDef#

# DeprecateRuleTypeDef definition

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

EventParametersTypeDef#

# EventParametersTypeDef definition

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

TagTypeDef#

# TagTypeDef definition

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

FastRestoreRuleTypeDef#

# FastRestoreRuleTypeDef definition

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

GetLifecyclePoliciesRequestRequestTypeDef#

# 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]],
    DefaultPolicyType: NotRequired[DefaultPoliciesTypeValuesType],  # (3)
  1. See GettablePolicyStateValuesType
  2. See ResourceTypeValuesType
  3. See DefaultPoliciesTypeValuesType

LifecyclePolicySummaryTypeDef#

# LifecyclePolicySummaryTypeDef definition

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

GetLifecyclePolicyRequestRequestTypeDef#

# GetLifecyclePolicyRequestRequestTypeDef definition

class GetLifecyclePolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

RetainRuleTypeDef#

# RetainRuleTypeDef definition

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

ShareRuleTypeDef#

# ShareRuleTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

ArchiveRetainRuleTypeDef#

# ArchiveRetainRuleTypeDef definition

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

CreateLifecyclePolicyResponseTypeDef#

# CreateLifecyclePolicyResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

CreateRuleTypeDef#

# CreateRuleTypeDef definition

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

CrossRegionCopyActionTypeDef#

# CrossRegionCopyActionTypeDef definition

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

CrossRegionCopyRuleTypeDef#

# 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 definition

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

ExclusionsTypeDef#

# ExclusionsTypeDef definition

class ExclusionsTypeDef(TypedDict):
    ExcludeBootVolumes: NotRequired[bool],
    ExcludeVolumeTypes: NotRequired[Sequence[str]],
    ExcludeTags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

ParametersTypeDef#

# ParametersTypeDef definition

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

GetLifecyclePoliciesResponseTypeDef#

# GetLifecyclePoliciesResponseTypeDef definition

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

ArchiveRuleTypeDef#

# ArchiveRuleTypeDef definition

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

ActionTypeDef#

# ActionTypeDef definition

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

ScheduleTypeDef#

# 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 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)
    PolicyLanguage: NotRequired[PolicyLanguageValuesType],  # (9)
    ResourceType: NotRequired[ResourceTypeValuesType],  # (10)
    CreateInterval: NotRequired[int],
    RetainInterval: NotRequired[int],
    CopyTags: NotRequired[bool],
    CrossRegionCopyTargets: NotRequired[Sequence[CrossRegionCopyTargetTypeDef]],  # (11)
    ExtendDeletion: NotRequired[bool],
    Exclusions: NotRequired[ExclusionsTypeDef],  # (12)
  1. See PolicyTypeValuesType
  2. See ResourceTypeValuesType
  3. See ResourceLocationValuesType
  4. See TagTypeDef
  5. See ScheduleTypeDef
  6. See ParametersTypeDef
  7. See EventSourceTypeDef
  8. See ActionTypeDef
  9. See PolicyLanguageValuesType
  10. See ResourceTypeValuesType
  11. See CrossRegionCopyTargetTypeDef
  12. See ExclusionsTypeDef

CreateLifecyclePolicyRequestRequestTypeDef#

# CreateLifecyclePolicyRequestRequestTypeDef definition

class CreateLifecyclePolicyRequestRequestTypeDef(TypedDict):
    ExecutionRoleArn: str,
    Description: str,
    State: SettablePolicyStateValuesType,  # (1)
    PolicyDetails: NotRequired[PolicyDetailsTypeDef],  # (2)
    Tags: NotRequired[Mapping[str, str]],
    DefaultPolicy: NotRequired[DefaultPolicyTypeValuesType],  # (3)
    CreateInterval: NotRequired[int],
    RetainInterval: NotRequired[int],
    CopyTags: NotRequired[bool],
    ExtendDeletion: NotRequired[bool],
    CrossRegionCopyTargets: NotRequired[Sequence[CrossRegionCopyTargetTypeDef]],  # (4)
    Exclusions: NotRequired[ExclusionsTypeDef],  # (5)
  1. See SettablePolicyStateValuesType
  2. See PolicyDetailsTypeDef
  3. See DefaultPolicyTypeValuesType
  4. See CrossRegionCopyTargetTypeDef
  5. See ExclusionsTypeDef

LifecyclePolicyTypeDef#

# 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],
    DefaultPolicy: NotRequired[bool],
  1. See GettablePolicyStateValuesType
  2. See PolicyDetailsTypeDef

UpdateLifecyclePolicyRequestRequestTypeDef#

# UpdateLifecyclePolicyRequestRequestTypeDef definition

class UpdateLifecyclePolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,
    ExecutionRoleArn: NotRequired[str],
    State: NotRequired[SettablePolicyStateValuesType],  # (1)
    Description: NotRequired[str],
    PolicyDetails: NotRequired[PolicyDetailsTypeDef],  # (2)
    CreateInterval: NotRequired[int],
    RetainInterval: NotRequired[int],
    CopyTags: NotRequired[bool],
    ExtendDeletion: NotRequired[bool],
    CrossRegionCopyTargets: NotRequired[Sequence[CrossRegionCopyTargetTypeDef]],  # (3)
    Exclusions: NotRequired[ExclusionsTypeDef],  # (4)
  1. See SettablePolicyStateValuesType
  2. See PolicyDetailsTypeDef
  3. See CrossRegionCopyTargetTypeDef
  4. See ExclusionsTypeDef

GetLifecyclePolicyResponseTypeDef#

# GetLifecyclePolicyResponseTypeDef definition

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