DLMClient

Index > DLM > DLMClient

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

DLMClient

Type annotations and code completion for boto3.client("dlm"). boto3 documentation

# DLMClient usage example

from boto3.session import Session
from types_boto3_dlm.client import DLMClient

def get_dlm_client() -> DLMClient:
    return Session().client("dlm")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("dlm").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("dlm")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidRequestException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceNotFoundException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_dlm.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("dlm").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("dlm").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_lifecycle_policy

Creates an Amazon Data Lifecycle Manager lifecycle policy.

Type annotations and code completion for boto3.client("dlm").create_lifecycle_policy method. boto3 documentation

# create_lifecycle_policy method definition

def create_lifecycle_policy(
    self,
    *,
    ExecutionRoleArn: str,
    Description: str,
    State: SettablePolicyStateValuesType,  # (1)
    PolicyDetails: PolicyDetailsTypeDef = ...,  # (2)
    Tags: Mapping[str, str] = ...,
    DefaultPolicy: DefaultPolicyTypeValuesType = ...,  # (3)
    CreateInterval: int = ...,
    RetainInterval: int = ...,
    CopyTags: bool = ...,
    ExtendDeletion: bool = ...,
    CrossRegionCopyTargets: Sequence[CrossRegionCopyTargetTypeDef] = ...,  # (4)
    Exclusions: ExclusionsTypeDef = ...,  # (5)
) -> CreateLifecyclePolicyResponseTypeDef:  # (6)
    ...

1. See SettablePolicyStateValuesType
2. See PolicyDetailsTypeDef
3. See DefaultPolicyTypeValuesType
4. See CrossRegionCopyTargetTypeDef
5. See ExclusionsTypeDef
6. See CreateLifecyclePolicyResponseTypeDef

# create_lifecycle_policy method usage example with argument unpacking

kwargs: CreateLifecyclePolicyRequestRequestTypeDef = {  # (1)
    "ExecutionRoleArn": ...,
    "Description": ...,
    "State": ...,
}

parent.create_lifecycle_policy(**kwargs)

1. See CreateLifecyclePolicyRequestRequestTypeDef

delete_lifecycle_policy

Deletes the specified lifecycle policy and halts the automated operations that the policy specified.

Type annotations and code completion for boto3.client("dlm").delete_lifecycle_policy method. boto3 documentation

# delete_lifecycle_policy method definition

def delete_lifecycle_policy(
    self,
    *,
    PolicyId: str,
) -> dict[str, Any]:
    ...

# delete_lifecycle_policy method usage example with argument unpacking

kwargs: DeleteLifecyclePolicyRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
}

parent.delete_lifecycle_policy(**kwargs)

1. See DeleteLifecyclePolicyRequestRequestTypeDef

get_lifecycle_policies

Gets summary information about all or the specified data lifecycle policies.

Type annotations and code completion for boto3.client("dlm").get_lifecycle_policies method. boto3 documentation

# get_lifecycle_policies method definition

def get_lifecycle_policies(
    self,
    *,
    PolicyIds: Sequence[str] = ...,
    State: GettablePolicyStateValuesType = ...,  # (1)
    ResourceTypes: Sequence[ResourceTypeValuesType] = ...,  # (2)
    TargetTags: Sequence[str] = ...,
    TagsToAdd: Sequence[str] = ...,
    DefaultPolicyType: DefaultPoliciesTypeValuesType = ...,  # (3)
) -> GetLifecyclePoliciesResponseTypeDef:  # (4)
    ...

1. See GettablePolicyStateValuesType
2. See ResourceTypeValuesType
3. See DefaultPoliciesTypeValuesType
4. See GetLifecyclePoliciesResponseTypeDef

# get_lifecycle_policies method usage example with argument unpacking

kwargs: GetLifecyclePoliciesRequestRequestTypeDef = {  # (1)
    "PolicyIds": ...,
}

parent.get_lifecycle_policies(**kwargs)

1. See GetLifecyclePoliciesRequestRequestTypeDef

get_lifecycle_policy

Gets detailed information about the specified lifecycle policy.

Type annotations and code completion for boto3.client("dlm").get_lifecycle_policy method. boto3 documentation

# get_lifecycle_policy method definition

def get_lifecycle_policy(
    self,
    *,
    PolicyId: str,
) -> GetLifecyclePolicyResponseTypeDef:  # (1)
    ...

1. See GetLifecyclePolicyResponseTypeDef

# get_lifecycle_policy method usage example with argument unpacking

kwargs: GetLifecyclePolicyRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
}

parent.get_lifecycle_policy(**kwargs)

1. See GetLifecyclePolicyRequestRequestTypeDef

list_tags_for_resource

Lists the tags for the specified resource.

Type annotations and code completion for boto3.client("dlm").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

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

tag_resource

Adds the specified tags to the specified resource.

Type annotations and code completion for boto3.client("dlm").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the specified tags from the specified resource.

Type annotations and code completion for boto3.client("dlm").untag_resource method. boto3 documentation

# untag_resource method definition

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_lifecycle_policy

Updates the specified lifecycle policy.

Type annotations and code completion for boto3.client("dlm").update_lifecycle_policy method. boto3 documentation

# update_lifecycle_policy method definition

def update_lifecycle_policy(
    self,
    *,
    PolicyId: str,
    ExecutionRoleArn: str = ...,
    State: SettablePolicyStateValuesType = ...,  # (1)
    Description: str = ...,
    PolicyDetails: PolicyDetailsTypeDef = ...,  # (2)
    CreateInterval: int = ...,
    RetainInterval: int = ...,
    CopyTags: bool = ...,
    ExtendDeletion: bool = ...,
    CrossRegionCopyTargets: Sequence[CrossRegionCopyTargetTypeDef] = ...,  # (3)
    Exclusions: ExclusionsTypeDef = ...,  # (4)
) -> dict[str, Any]:
    ...

1. See SettablePolicyStateValuesType
2. See PolicyDetailsTypeDef
3. See CrossRegionCopyTargetTypeDef
4. See ExclusionsTypeDef

# update_lifecycle_policy method usage example with argument unpacking

kwargs: UpdateLifecyclePolicyRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
}

parent.update_lifecycle_policy(**kwargs)

1. See UpdateLifecyclePolicyRequestRequestTypeDef