Skip to content

DLMClient

Index > DLM > DLMClient

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

DLMClient

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

Usage example
from boto3.session import Session
from mypy_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.

Usage example
client = boto3.client("dlm")

try:
    do_something(client)
except (
    client.ClientError,
    client.InternalServerException,
    client.InvalidRequestException,
    client.LimitExceededException,
    client.ResourceNotFoundException,
) as e:
    print(e)
Type checking example
from mypy_boto3_dlm.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

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

close

Closes underlying endpoint connections.

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

Method definition
def close(
    self,
) -> None:
    ...

create_lifecycle_policy

Creates a policy to manage the lifecycle of the specified Amazon Web Services resources.

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

Method definition
def create_lifecycle_policy(
    self,
    *,
    ExecutionRoleArn: str,
    Description: str,
    State: SettablePolicyStateValuesType,  # (1)
    PolicyDetails: PolicyDetailsTypeDef,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateLifecyclePolicyResponseTypeDef:  # (3)
    ...
  1. See SettablePolicyStateValuesType
  2. See PolicyDetailsTypeDef
  3. See CreateLifecyclePolicyResponseTypeDef
Usage example with kwargs
kwargs: CreateLifecyclePolicyRequestRequestTypeDef = {  # (1)
    "ExecutionRoleArn": ...,
    "Description": ...,
    "State": ...,
    "PolicyDetails": ...,
}

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

Method definition
def delete_lifecycle_policy(
    self,
    *,
    PolicyId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteLifecyclePolicyRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
}

parent.delete_lifecycle_policy(**kwargs)
  1. See DeleteLifecyclePolicyRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

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

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

Method definition
def get_lifecycle_policies(
    self,
    *,
    PolicyIds: Sequence[str] = ...,
    State: GettablePolicyStateValuesType = ...,  # (1)
    ResourceTypes: Sequence[ResourceTypeValuesType] = ...,  # (2)
    TargetTags: Sequence[str] = ...,
    TagsToAdd: Sequence[str] = ...,
) -> GetLifecyclePoliciesResponseTypeDef:  # (3)
    ...
  1. See GettablePolicyStateValuesType
  2. See ResourceTypeValuesType
  3. See GetLifecyclePoliciesResponseTypeDef
Usage example with kwargs
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

Method definition
def get_lifecycle_policy(
    self,
    *,
    PolicyId: str,
) -> GetLifecyclePolicyResponseTypeDef:  # (1)
    ...
  1. See GetLifecyclePolicyResponseTypeDef
Usage example with kwargs
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

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
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

Method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def update_lifecycle_policy(
    self,
    *,
    PolicyId: str,
    ExecutionRoleArn: str = ...,
    State: SettablePolicyStateValuesType = ...,  # (1)
    Description: str = ...,
    PolicyDetails: PolicyDetailsTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See SettablePolicyStateValuesType
  2. See PolicyDetailsTypeDef
Usage example with kwargs
kwargs: UpdateLifecyclePolicyRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
}

parent.update_lifecycle_policy(**kwargs)
  1. See UpdateLifecyclePolicyRequestRequestTypeDef