Table of Contents
A low-level client representing Amazon Data Lifecycle Manager (DLM)
With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create lifecycle policies, which are used to automate operations on the specified resources.
Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see Automating the Amazon EBS Snapshot Lifecycle in the Amazon EC2 User Guide .
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 Amazon Web Services 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'|'IMAGE_MANAGEMENT'|'EVENT_BASED_POLICY',
'ResourceTypes': [
'VOLUME'|'INSTANCE',
],
'ResourceLocations': [
'CLOUD'|'OUTPOST',
],
'TargetTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Schedules': [
{
'Name': 'string',
'CopyTags': True|False,
'TagsToAdd': [
{
'Key': 'string',
'Value': 'string'
},
],
'VariableTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreateRule': {
'Location': 'CLOUD'|'OUTPOST_LOCAL',
'Interval': 123,
'IntervalUnit': 'HOURS',
'Times': [
'string',
],
'CronExpression': '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',
'Target': 'string',
'Encrypted': True|False,
'CmkArn': 'string',
'CopyTags': True|False,
'RetainRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
},
'DeprecateRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
],
'ShareRules': [
{
'TargetAccounts': [
'string',
],
'UnshareInterval': 123,
'UnshareIntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
},
],
'DeprecateRule': {
'Count': 123,
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
],
'Parameters': {
'ExcludeBootVolume': True|False,
'NoReboot': True|False
},
'EventSource': {
'Type': 'MANAGED_CWE',
'Parameters': {
'EventType': 'shareSnapshot',
'SnapshotOwner': [
'string',
],
'DescriptionRegex': 'string'
}
},
'Actions': [
{
'Name': 'string',
'CrossRegionCopy': [
{
'Target': 'string',
'EncryptionConfiguration': {
'Encrypted': True|False,
'CmkArn': 'string'
},
'RetainRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
]
},
]
},
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. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.
The default is EBS_SNAPSHOT_MANAGEMENT .
The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD . If the source resources are located on an Outpost in your account, specify OUTPOST .
If you specify OUTPOST , Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.
The single tag that identifies targeted resources for this policy.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
Specifies a tag for a resource.
The tag key.
The tag value.
The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
Specifies a backup schedule for a snapshot or AMI lifecycle policy.
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 Amazon Web Services-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.
Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD . To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL . If you omit this parameter, CLOUD is used by default.
If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource.
If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.
The interval between snapshots. The supported values are 1, 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. If you do not specify a time, Amazon DLM selects a time within the next 24 hours.
The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see Cron expressions in the Amazon CloudWatch User Guide .
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.
You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
Specifies a rule for cross-Region snapshot copies.
Avoid using this parameter when creating new policies. Instead, use Target to specify a target Region or a target Outpost for snapshot copies.
For policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.
The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
Use this parameter instead of TargetRegion . Do not specify both.
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 KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
Indicates whether to copy all user-defined tags from the source snapshot to the cross-Region snapshot copy.
The retention rule that indicates how long snapshot copies are to be retained in the destination Region.
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 AMI deprecation rule for cross-Region AMI copies created by the rule.
The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
The unit of time in which to measure the Interval .
The rule for sharing snapshots with other Amazon Web Services accounts.
Specifies a rule for sharing snapshots across Amazon Web Services accounts.
The IDs of the Amazon Web Services accounts with which to share the snapshots.
The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.
The unit of time for the automatic unsharing interval.
The AMI deprecation rule for the schedule.
If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
The unit of time in which to measure the Interval .
A set of optional parameters for snapshot and AMI lifecycle policies.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots . The default is false.
Applies to AMI lifecycle policies only. Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
The event that triggers the event-based policy.
This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
The source of the event. Currently only managed CloudWatch Events rules are supported.
Information about the event.
The type of event. Currently, only snapshot sharing events are supported.
The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.
The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.
For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.
The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
Specifies an action for an event-based policy.
A descriptive name for the action.
The rule for copying shared snapshots across Regions.
Specifies a rule for copying shared snapshots across Regions.
The target Region.
The encryption settings for the copied snapshot.
To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
Specifies the retention rule for cross-Region snapshot copies.
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 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.
Exceptions
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
Exceptions
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 Amazon Web Services-added lifecycle tags.
dict
Response Syntax
{
'Policies': [
{
'PolicyId': 'string',
'Description': 'string',
'State': 'ENABLED'|'DISABLED'|'ERROR',
'Tags': {
'string': 'string'
},
'PolicyType': 'EBS_SNAPSHOT_MANAGEMENT'|'IMAGE_MANAGEMENT'|'EVENT_BASED_POLICY'
},
]
}
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.
PolicyType (string) --
The type of policy. EBS_SNAPSHOT_MANAGEMENT indicates that the policy manages the lifecycle of Amazon EBS snapshots. IMAGE_MANAGEMENT indicates that the policy manages the lifecycle of EBS-backed AMIs.
Exceptions
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'|'IMAGE_MANAGEMENT'|'EVENT_BASED_POLICY',
'ResourceTypes': [
'VOLUME'|'INSTANCE',
],
'ResourceLocations': [
'CLOUD'|'OUTPOST',
],
'TargetTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Schedules': [
{
'Name': 'string',
'CopyTags': True|False,
'TagsToAdd': [
{
'Key': 'string',
'Value': 'string'
},
],
'VariableTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreateRule': {
'Location': 'CLOUD'|'OUTPOST_LOCAL',
'Interval': 123,
'IntervalUnit': 'HOURS',
'Times': [
'string',
],
'CronExpression': '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',
'Target': 'string',
'Encrypted': True|False,
'CmkArn': 'string',
'CopyTags': True|False,
'RetainRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
},
'DeprecateRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
],
'ShareRules': [
{
'TargetAccounts': [
'string',
],
'UnshareInterval': 123,
'UnshareIntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
},
],
'DeprecateRule': {
'Count': 123,
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
],
'Parameters': {
'ExcludeBootVolume': True|False,
'NoReboot': True|False
},
'EventSource': {
'Type': 'MANAGED_CWE',
'Parameters': {
'EventType': 'shareSnapshot',
'SnapshotOwner': [
'string',
],
'DescriptionRegex': 'string'
}
},
'Actions': [
{
'Name': 'string',
'CrossRegionCopy': [
{
'Target': 'string',
'EncryptionConfiguration': {
'Encrypted': True|False,
'CmkArn': 'string'
},
'RetainRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
]
},
]
},
'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. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.
The default is EBS_SNAPSHOT_MANAGEMENT .
The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD . If the source resources are located on an Outpost in your account, specify OUTPOST .
If you specify OUTPOST , Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.
The single tag that identifies targeted resources for this policy.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
Specifies a tag for a resource.
The tag key.
The tag value.
The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
Specifies a backup schedule for a snapshot or AMI lifecycle policy.
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 Amazon Web Services-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.
Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD . To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL . If you omit this parameter, CLOUD is used by default.
If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource.
If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.
The interval between snapshots. The supported values are 1, 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. If you do not specify a time, Amazon DLM selects a time within the next 24 hours.
The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see Cron expressions in the Amazon CloudWatch User Guide .
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.
You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
Specifies a rule for cross-Region snapshot copies.
Avoid using this parameter when creating new policies. Instead, use Target to specify a target Region or a target Outpost for snapshot copies.
For policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.
The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
Use this parameter instead of TargetRegion . Do not specify both.
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 KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
Indicates whether to copy all user-defined tags from the source snapshot to the cross-Region snapshot copy.
The retention rule that indicates how long snapshot copies are to be retained in the destination Region.
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 AMI deprecation rule for cross-Region AMI copies created by the rule.
The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
The unit of time in which to measure the Interval .
The rule for sharing snapshots with other Amazon Web Services accounts.
Specifies a rule for sharing snapshots across Amazon Web Services accounts.
The IDs of the Amazon Web Services accounts with which to share the snapshots.
The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.
The unit of time for the automatic unsharing interval.
The AMI deprecation rule for the schedule.
If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
The unit of time in which to measure the Interval .
A set of optional parameters for snapshot and AMI lifecycle policies.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots . The default is false.
Applies to AMI lifecycle policies only. Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
The event that triggers the event-based policy.
This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
The source of the event. Currently only managed CloudWatch Events rules are supported.
Information about the event.
The type of event. Currently, only snapshot sharing events are supported.
The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.
The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.
For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.
The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
Specifies an action for an event-based policy.
A descriptive name for the action.
The rule for copying shared snapshots across Regions.
Specifies a rule for copying shared snapshots across Regions.
The target Region.
The encryption settings for the copied snapshot.
To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
Specifies the retention rule for cross-Region snapshot copies.
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 tags.
The Amazon Resource Name (ARN) of the policy.
Exceptions
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.
Exceptions
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
Exceptions
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
Exceptions
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'|'IMAGE_MANAGEMENT'|'EVENT_BASED_POLICY',
'ResourceTypes': [
'VOLUME'|'INSTANCE',
],
'ResourceLocations': [
'CLOUD'|'OUTPOST',
],
'TargetTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Schedules': [
{
'Name': 'string',
'CopyTags': True|False,
'TagsToAdd': [
{
'Key': 'string',
'Value': 'string'
},
],
'VariableTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreateRule': {
'Location': 'CLOUD'|'OUTPOST_LOCAL',
'Interval': 123,
'IntervalUnit': 'HOURS',
'Times': [
'string',
],
'CronExpression': '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',
'Target': 'string',
'Encrypted': True|False,
'CmkArn': 'string',
'CopyTags': True|False,
'RetainRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
},
'DeprecateRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
],
'ShareRules': [
{
'TargetAccounts': [
'string',
],
'UnshareInterval': 123,
'UnshareIntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
},
],
'DeprecateRule': {
'Count': 123,
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
],
'Parameters': {
'ExcludeBootVolume': True|False,
'NoReboot': True|False
},
'EventSource': {
'Type': 'MANAGED_CWE',
'Parameters': {
'EventType': 'shareSnapshot',
'SnapshotOwner': [
'string',
],
'DescriptionRegex': 'string'
}
},
'Actions': [
{
'Name': 'string',
'CrossRegionCopy': [
{
'Target': 'string',
'EncryptionConfiguration': {
'Encrypted': True|False,
'CmkArn': 'string'
},
'RetainRule': {
'Interval': 123,
'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
}
},
]
},
]
}
)
[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. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.
The default is EBS_SNAPSHOT_MANAGEMENT .
The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD . If the source resources are located on an Outpost in your account, specify OUTPOST .
If you specify OUTPOST , Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.
The single tag that identifies targeted resources for this policy.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
Specifies a tag for a resource.
The tag key.
The tag value.
The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
Specifies a backup schedule for a snapshot or AMI lifecycle policy.
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 Amazon Web Services-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.
Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD . To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL . If you omit this parameter, CLOUD is used by default.
If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource.
If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.
The interval between snapshots. The supported values are 1, 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. If you do not specify a time, Amazon DLM selects a time within the next 24 hours.
The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see Cron expressions in the Amazon CloudWatch User Guide .
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.
You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
Specifies a rule for cross-Region snapshot copies.
Avoid using this parameter when creating new policies. Instead, use Target to specify a target Region or a target Outpost for snapshot copies.
For policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.
The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
Use this parameter instead of TargetRegion . Do not specify both.
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 KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
Indicates whether to copy all user-defined tags from the source snapshot to the cross-Region snapshot copy.
The retention rule that indicates how long snapshot copies are to be retained in the destination Region.
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 AMI deprecation rule for cross-Region AMI copies created by the rule.
The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
The unit of time in which to measure the Interval .
The rule for sharing snapshots with other Amazon Web Services accounts.
Specifies a rule for sharing snapshots across Amazon Web Services accounts.
The IDs of the Amazon Web Services accounts with which to share the snapshots.
The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.
The unit of time for the automatic unsharing interval.
The AMI deprecation rule for the schedule.
If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
The unit of time in which to measure the Interval .
A set of optional parameters for snapshot and AMI lifecycle policies.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots . The default is false.
Applies to AMI lifecycle policies only. Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
The event that triggers the event-based policy.
This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
The source of the event. Currently only managed CloudWatch Events rules are supported.
Information about the event.
The type of event. Currently, only snapshot sharing events are supported.
The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.
The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.
For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.
The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
Specifies an action for an event-based policy.
A descriptive name for the action.
The rule for copying shared snapshots across Regions.
Specifies a rule for copying shared snapshots across Regions.
The target Region.
The encryption settings for the copied snapshot.
To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
Specifies the retention rule for cross-Region snapshot copies.
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.
dict
Response Syntax
{}
Response Structure
Exceptions
The available paginators are: