DLM ¶

Table of Contents

DLM
- Client
- Paginators

Client ¶

class DLM.Client¶

A low-level client representing Amazon Data Lifecycle Manager (DLM):

client = session.create_client('dlm')

These are the available methods:

can_paginate()
create_lifecycle_policy()
delete_lifecycle_policy()
generate_presigned_url()
get_lifecycle_policies()
get_lifecycle_policy()
get_paginator()
get_waiter()
update_lifecycle_policy()

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

create_lifecycle_policy(**kwargs)¶

Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.

See also: AWS API Documentation

Request Syntax

response = client.create_lifecycle_policy(
    ExecutionRoleArn='string',
    Description='string',
    State='ENABLED'|'DISABLED',
    PolicyDetails={
        'ResourceTypes': [
            'VOLUME',
        ],
        'TargetTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Schedules': [
            {
                'Name': 'string',
                'TagsToAdd': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'CreateRule': {
                    'Interval': 123,
                    'IntervalUnit': 'HOURS',
                    'Times': [
                        'string',
                    ]
                },
                'RetainRule': {
                    'Count': 123
                }
            },
        ]
    }
)

Parameters

ExecutionRoleArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
Description (string) --
[REQUIRED]

A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
State (string) --
[REQUIRED]

The desired activation state of the lifecycle policy after creation.
PolicyDetails (dict) --
[REQUIRED]

The configuration details of the lifecycle policy.

Target tags cannot be re-used across lifecycle policies.
- ResourceTypes (list) --
  The resource type.
  - (string) --
- TargetTags (list) --
  The single tag that identifies targeted resources for this policy.
  - (dict) --
    Specifies a tag for a resource.
    - Key (string) -- [REQUIRED]
      The tag key.
    - Value (string) -- [REQUIRED]
      The tag value.
- Schedules (list) --
  The schedule of policy-defined actions.
  - (dict) --
    Specifies a schedule.
    - Name (string) --
      The name of the schedule.
    - TagsToAdd (list) --
      The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
      - (dict) --
        Specifies a tag for a resource.
        
        Key (string) -- [REQUIRED]
        The tag key.
        
        Value (string) -- [REQUIRED]
        The tag value.
    - CreateRule (dict) --
      The create rule.
      - Interval (integer) -- [REQUIRED]
        The interval. The supported values are 12 and 24.
      - IntervalUnit (string) -- [REQUIRED]
        The interval unit.
      - Times (list) --
        The time, in UTC, to start the operation.
        
        The operation occurs within a one-hour window following the specified time.
        
        (string) --
    - RetainRule (dict) --
      The retain rule.
      - Count (integer) -- [REQUIRED]
        The number of snapshots to keep for each volume, up to a maximum of 1000.

Return type

dict

Returns

Response Syntax

{
    'PolicyId': 'string'
}

Response Structure

(dict) --
- PolicyId (string) --
  
  The identifier of the lifecycle policy.

delete_lifecycle_policy(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.delete_lifecycle_policy(
    PolicyId='string'
)

Parameters

PolicyId (string) --

[REQUIRED]

The identifier of the lifecycle policy.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

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

Parameters

ClientMethod (string) -- The client method to presign for
Params (dict) -- The parameters normally passed to ClientMethod.
ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.

Returns

The presigned url

get_lifecycle_policies(**kwargs)¶

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

To get complete information about a policy, use GetLifecyclePolicy .

See also: AWS API Documentation

Request Syntax

response = client.get_lifecycle_policies(
    PolicyIds=[
        'string',
    ],
    State='ENABLED'|'DISABLED'|'ERROR',
    ResourceTypes=[
        'VOLUME',
    ],
    TargetTags=[
        'string',
    ],
    TagsToAdd=[
        'string',
    ]
)

Parameters

PolicyIds (list) --
The identifiers of the data lifecycle policies.
- (string) --
State (string) -- The activation state.
ResourceTypes (list) --
The resource type.
- (string) --
TargetTags (list) --
The target tag for a policy.

Tags are strings in the format key=value .
- (string) --
TagsToAdd (list) --
The tags to add to objects created by the policy.

Tags are strings in the format key=value .

These user-defined tags are added in addition to the AWS-added lifecycle tags.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'Policies': [
        {
            'PolicyId': 'string',
            'Description': 'string',
            'State': 'ENABLED'|'DISABLED'|'ERROR'
        },
    ]
}

Response Structure

(dict) --
- Policies (list) --
  
  Summary information about the lifecycle policies.
  - (dict) --
    
    Summary information about a lifecycle policy.
    - PolicyId (string) --
      
      The identifier of the lifecycle policy.
    - Description (string) --
      
      The description of the lifecycle policy.
    - State (string) --
      
      The activation state of the lifecycle policy.

get_lifecycle_policy(**kwargs)¶

Gets detailed information about the specified lifecycle policy.

See also: AWS API Documentation

Request Syntax

response = client.get_lifecycle_policy(
    PolicyId='string'
)

Parameters

PolicyId (string) --

[REQUIRED]

The identifier of the lifecycle policy.

Return type

dict

Returns

Response Syntax

{
    'Policy': {
        'PolicyId': 'string',
        'Description': 'string',
        'State': 'ENABLED'|'DISABLED'|'ERROR',
        'ExecutionRoleArn': 'string',
        'DateCreated': datetime(2015, 1, 1),
        'DateModified': datetime(2015, 1, 1),
        'PolicyDetails': {
            'ResourceTypes': [
                'VOLUME',
            ],
            'TargetTags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Schedules': [
                {
                    'Name': 'string',
                    'TagsToAdd': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'CreateRule': {
                        'Interval': 123,
                        'IntervalUnit': 'HOURS',
                        'Times': [
                            'string',
                        ]
                    },
                    'RetainRule': {
                        'Count': 123
                    }
                },
            ]
        }
    }
}

Response Structure

(dict) --
- Policy (dict) --
  Detailed information about the lifecycle policy.
  - PolicyId (string) --
    The identifier of the lifecycle policy.
  - Description (string) --
    The description of the lifecycle policy.
  - State (string) --
    The activation state of the lifecycle policy.
  - ExecutionRoleArn (string) --
    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
  - DateCreated (datetime) --
    The local date and time when the lifecycle policy was created.
  - DateModified (datetime) --
    The local date and time when the lifecycle policy was last modified.
  - PolicyDetails (dict) --
    The configuration of the lifecycle policy
    - ResourceTypes (list) --
      The resource type.
      - (string) --
    - TargetTags (list) --
      The single tag that identifies targeted resources for this policy.
      - (dict) --
        Specifies a tag for a resource.
        
        Key (string) --
        The tag key.
        
        Value (string) --
        The tag value.
    - Schedules (list) --
      The schedule of policy-defined actions.
      - (dict) --
        Specifies a schedule.
        
        Name (string) --
        The name of the schedule.
        
        TagsToAdd (list) --
        The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
        
        (dict) --
        Specifies a tag for a resource.
        
        Key (string) --
        The tag key.
        
        Value (string) --
        The tag value.
        
        CreateRule (dict) --
        The create rule.
        
        Interval (integer) --
        The interval. The supported values are 12 and 24.
        
        IntervalUnit (string) --
        The interval unit.
        
        Times (list) --
        The time, in UTC, to start the operation.
        
        The operation occurs within a one-hour window following the specified time.
        
        (string) --
        
        RetainRule (dict) --
        The retain rule.
        
        Count (integer) --
        The number of snapshots to keep for each volume, up to a maximum of 1000.

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

update_lifecycle_policy(**kwargs)¶

Updates the specified lifecycle policy.

See also: AWS API Documentation

Request Syntax

response = client.update_lifecycle_policy(
    PolicyId='string',
    ExecutionRoleArn='string',
    State='ENABLED'|'DISABLED',
    Description='string',
    PolicyDetails={
        'ResourceTypes': [
            'VOLUME',
        ],
        'TargetTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Schedules': [
            {
                'Name': 'string',
                'TagsToAdd': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'CreateRule': {
                    'Interval': 123,
                    'IntervalUnit': 'HOURS',
                    'Times': [
                        'string',
                    ]
                },
                'RetainRule': {
                    'Count': 123
                }
            },
        ]
    }
)

Parameters

PolicyId (string) --
[REQUIRED]

The identifier of the lifecycle policy.
ExecutionRoleArn (string) -- The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
State (string) -- The desired activation state of the lifecycle policy after creation.
Description (string) -- A description of the lifecycle policy.
PolicyDetails (dict) --
The configuration of the lifecycle policy.

Target tags cannot be re-used across policies.
- ResourceTypes (list) --
  The resource type.
  - (string) --
- TargetTags (list) --
  The single tag that identifies targeted resources for this policy.
  - (dict) --
    Specifies a tag for a resource.
    - Key (string) -- [REQUIRED]
      The tag key.
    - Value (string) -- [REQUIRED]
      The tag value.
- Schedules (list) --
  The schedule of policy-defined actions.
  - (dict) --
    Specifies a schedule.
    - Name (string) --
      The name of the schedule.
    - TagsToAdd (list) --
      The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
      - (dict) --
        Specifies a tag for a resource.
        
        Key (string) -- [REQUIRED]
        The tag key.
        
        Value (string) -- [REQUIRED]
        The tag value.
    - CreateRule (dict) --
      The create rule.
      - Interval (integer) -- [REQUIRED]
        The interval. The supported values are 12 and 24.
      - IntervalUnit (string) -- [REQUIRED]
        The interval unit.
      - Times (list) --
        The time, in UTC, to start the operation.
        
        The operation occurs within a one-hour window following the specified time.
        
        (string) --
    - RetainRule (dict) --
      The retain rule.
      - Count (integer) -- [REQUIRED]
        The number of snapshots to keep for each volume, up to a maximum of 1000.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Paginators ¶

The available paginators are:

Navigation

Table Of Contents

Contents

DLM¶

Client¶

Paginators¶

Navigation

DLM ¶

Client ¶

Paginators ¶