Table of Contents
A low-level client representing Amazon Data Lifecycle Manager (DLM):
import boto3
client = boto3.client('dlm')
These are the available methods:
Check if an operation can be paginated.
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={
'PolicyType': 'EBS_SNAPSHOT_MANAGEMENT',
'ResourceTypes': [
'VOLUME'|'INSTANCE',
],
'TargetTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Schedules': [
{
'Name': 'string',
'CopyTags': True|False,
'TagsToAdd': [
{
'Key': 'string',
'Value': 'string'
},
],
'VariableTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreateRule': {
'Interval': 123,
'IntervalUnit': 'HOURS',
'Times': [
'string',
]
},
'RetainRule': {
'Count': 123,
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
},
'FastRestoreRule': {
'Count': 123,
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS',
'AvailabilityZones': [
'string',
]
},
'CrossRegionCopyRules': [
{
'TargetRegion': 'string',
'Encrypted': True|False,
'CmkArn': 'string',
'CopyTags': True|False,
'RetainRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
]
},
],
'Parameters': {
'ExcludeBootVolume': True|False
}
},
Tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
[REQUIRED]
A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
[REQUIRED]
The desired activation state of the lifecycle policy after creation.
[REQUIRED]
The configuration details of the lifecycle policy.
The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT.
The resource type.
The single tag that identifies targeted resources for this policy.
Specifies a tag for a resource.
The tag key.
The tag value.
The schedule of policy-defined actions.
Specifies a backup schedule.
The name of the schedule.
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
Specifies a tag for a resource.
The tag key.
The tag value.
A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp) . Variable tags are only valid for EBS Snapshot Management – Instance policies.
Specifies a tag for a resource.
The tag key.
The tag value.
The creation rule.
The interval between snapshots. The supported values are 2, 3, 4, 6, 8, 12, and 24.
The interval unit.
The time, in UTC, to start the operation. The supported format is hh:mm.
The operation occurs within a one-hour window following the specified time.
The retention rule.
The number of snapshots to retain for each volume, up to a maximum of 1000.
The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
The unit of time for time-based retention.
The rule for enabling fast snapshot restore.
The number of snapshots to be enabled with fast snapshot restore.
The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
The unit of time for enabling fast snapshot restore.
The Availability Zones in which to enable fast snapshot restore.
The rule for cross-Region snapshot copies.
Specifies a rule for cross-Region snapshot copies.
The target Region.
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.
The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.
Copy all user-defined tags from the source snapshot to the copied snapshot.
The retention rule.
The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
The unit of time for time-based retention.
A set of optional parameters for the policy.
[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots . The default is false.
The tags to apply to the lifecycle policy during creation.
dict
Response Syntax
{
'PolicyId': 'string'
}
Response Structure
(dict) --
PolicyId (string) --
The identifier of the lifecycle policy.
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'
)
[REQUIRED]
The identifier of the lifecycle policy.
{}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
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'|'INSTANCE',
],
TargetTags=[
'string',
],
TagsToAdd=[
'string',
]
)
The identifiers of the data lifecycle policies.
The resource type.
The target tag for a policy.
Tags are strings in the format key=value .
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.
dict
Response Syntax
{
'Policies': [
{
'PolicyId': 'string',
'Description': 'string',
'State': 'ENABLED'|'DISABLED'|'ERROR',
'Tags': {
'string': 'string'
}
},
]
}
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.
Tags (dict) --
The tags.
Gets detailed information about the specified lifecycle policy.
See also: AWS API Documentation
Request Syntax
response = client.get_lifecycle_policy(
PolicyId='string'
)
[REQUIRED]
The identifier of the lifecycle policy.
{
'Policy': {
'PolicyId': 'string',
'Description': 'string',
'State': 'ENABLED'|'DISABLED'|'ERROR',
'StatusMessage': 'string',
'ExecutionRoleArn': 'string',
'DateCreated': datetime(2015, 1, 1),
'DateModified': datetime(2015, 1, 1),
'PolicyDetails': {
'PolicyType': 'EBS_SNAPSHOT_MANAGEMENT',
'ResourceTypes': [
'VOLUME'|'INSTANCE',
],
'TargetTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Schedules': [
{
'Name': 'string',
'CopyTags': True|False,
'TagsToAdd': [
{
'Key': 'string',
'Value': 'string'
},
],
'VariableTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreateRule': {
'Interval': 123,
'IntervalUnit': 'HOURS',
'Times': [
'string',
]
},
'RetainRule': {
'Count': 123,
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
},
'FastRestoreRule': {
'Count': 123,
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS',
'AvailabilityZones': [
'string',
]
},
'CrossRegionCopyRules': [
{
'TargetRegion': 'string',
'Encrypted': True|False,
'CmkArn': 'string',
'CopyTags': True|False,
'RetainRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
]
},
],
'Parameters': {
'ExcludeBootVolume': True|False
}
},
'Tags': {
'string': 'string'
},
'PolicyArn': 'string'
}
}
Response Structure
Detailed information about the lifecycle policy.
The identifier of the lifecycle policy.
The description of the lifecycle policy.
The activation state of the lifecycle policy.
The description of the status.
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
The local date and time when the lifecycle policy was created.
The local date and time when the lifecycle policy was last modified.
The configuration of the lifecycle policy
The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT.
The resource type.
The single tag that identifies targeted resources for this policy.
Specifies a tag for a resource.
The tag key.
The tag value.
The schedule of policy-defined actions.
Specifies a backup schedule.
The name of the schedule.
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
Specifies a tag for a resource.
The tag key.
The tag value.
A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp) . Variable tags are only valid for EBS Snapshot Management – Instance policies.
Specifies a tag for a resource.
The tag key.
The tag value.
The creation rule.
The interval between snapshots. The supported values are 2, 3, 4, 6, 8, 12, and 24.
The interval unit.
The time, in UTC, to start the operation. The supported format is hh:mm.
The operation occurs within a one-hour window following the specified time.
The retention rule.
The number of snapshots to retain for each volume, up to a maximum of 1000.
The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
The unit of time for time-based retention.
The rule for enabling fast snapshot restore.
The number of snapshots to be enabled with fast snapshot restore.
The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
The unit of time for enabling fast snapshot restore.
The Availability Zones in which to enable fast snapshot restore.
The rule for cross-Region snapshot copies.
Specifies a rule for cross-Region snapshot copies.
The target Region.
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.
The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.
Copy all user-defined tags from the source snapshot to the copied snapshot.
The retention rule.
The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
The unit of time for time-based retention.
A set of optional parameters for the policy.
[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots . The default is false.
The tags.
The Amazon Resource Name (ARN) of the policy.
Create a paginator for an operation.
Returns an object that can wait for some condition.
Lists the tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
{
'Tags': {
'string': 'string'
}
}
Response Structure
Information about the tags.
Adds the specified tags to the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
One or more tags.
dict
Response Syntax
{}
Response Structure
Removes the specified tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tag keys.
dict
Response Syntax
{}
Response Structure
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={
'PolicyType': 'EBS_SNAPSHOT_MANAGEMENT',
'ResourceTypes': [
'VOLUME'|'INSTANCE',
],
'TargetTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Schedules': [
{
'Name': 'string',
'CopyTags': True|False,
'TagsToAdd': [
{
'Key': 'string',
'Value': 'string'
},
],
'VariableTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreateRule': {
'Interval': 123,
'IntervalUnit': 'HOURS',
'Times': [
'string',
]
},
'RetainRule': {
'Count': 123,
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
},
'FastRestoreRule': {
'Count': 123,
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS',
'AvailabilityZones': [
'string',
]
},
'CrossRegionCopyRules': [
{
'TargetRegion': 'string',
'Encrypted': True|False,
'CmkArn': 'string',
'CopyTags': True|False,
'RetainRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
]
},
],
'Parameters': {
'ExcludeBootVolume': True|False
}
}
)
[REQUIRED]
The identifier of the lifecycle policy.
The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT.
The resource type.
The single tag that identifies targeted resources for this policy.
Specifies a tag for a resource.
The tag key.
The tag value.
The schedule of policy-defined actions.
Specifies a backup schedule.
The name of the schedule.
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
Specifies a tag for a resource.
The tag key.
The tag value.
A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp) . Variable tags are only valid for EBS Snapshot Management – Instance policies.
Specifies a tag for a resource.
The tag key.
The tag value.
The creation rule.
The interval between snapshots. The supported values are 2, 3, 4, 6, 8, 12, and 24.
The interval unit.
The time, in UTC, to start the operation. The supported format is hh:mm.
The operation occurs within a one-hour window following the specified time.
The retention rule.
The number of snapshots to retain for each volume, up to a maximum of 1000.
The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
The unit of time for time-based retention.
The rule for enabling fast snapshot restore.
The number of snapshots to be enabled with fast snapshot restore.
The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
The unit of time for enabling fast snapshot restore.
The Availability Zones in which to enable fast snapshot restore.
The rule for cross-Region snapshot copies.
Specifies a rule for cross-Region snapshot copies.
The target Region.
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.
The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.
Copy all user-defined tags from the source snapshot to the copied snapshot.
The retention rule.
The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
The unit of time for time-based retention.
A set of optional parameters for the policy.
[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots . The default is false.
dict
Response Syntax
{}
Response Structure
The available paginators are: