2018/11/08 - Amazon Data Lifecycle Manager - 3 updated api methods
Changes Amazon Data Lifecycle Manager adds support for copying EBS volume tags to EBS snapshots. AWS resource tags allow customers to add metadata and apply access policies to your Amazon Elastic Block Store (Amazon EBS) resources. Starting today, customers can use Amazon Data Lifecycle Manager (DLM) to copy tags on EBS volumes to EBS snapshots. This allows customers to easily set snapshot metadata, such as access policies, to match the parent volume. Customers can enable this functionality on new or existing lifecycle policies. They can also choose to disable it at a future date.
{'PolicyDetails': {'Schedules': {'CopyTags': 'boolean'}}}
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
client.create_lifecycle_policy(
ExecutionRoleArn='string',
Description='string',
State='ENABLED'|'DISABLED',
PolicyDetails={
'ResourceTypes': [
'VOLUME',
],
'TargetTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Schedules': [
{
'Name': 'string',
'CopyTags': True|False,
'TagsToAdd': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreateRule': {
'Interval': 123,
'IntervalUnit': 'HOURS',
'Times': [
'string',
]
},
'RetainRule': {
'Count': 123
}
},
]
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
string
[REQUIRED]
A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
string
[REQUIRED]
The desired activation state of the lifecycle policy after creation.
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.
CopyTags (boolean) --
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.
dict
Response Syntax
{
'PolicyId': 'string'
}
Response Structure
(dict) --
PolicyId (string) --
The identifier of the lifecycle policy.
{'Policy': {'PolicyDetails': {'Schedules': {'CopyTags': 'boolean'}}}}
Gets detailed information about the specified lifecycle policy.
See also: AWS API Documentation
Request Syntax
client.get_lifecycle_policy(
PolicyId='string'
)
string
[REQUIRED]
The identifier of the lifecycle policy.
dict
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',
'CopyTags': True|False,
'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.
CopyTags (boolean) --
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.
{'PolicyDetails': {'Schedules': {'CopyTags': 'boolean'}}}
Updates the specified lifecycle policy.
See also: AWS API Documentation
Request Syntax
client.update_lifecycle_policy(
PolicyId='string',
ExecutionRoleArn='string',
State='ENABLED'|'DISABLED',
Description='string',
PolicyDetails={
'ResourceTypes': [
'VOLUME',
],
'TargetTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Schedules': [
{
'Name': 'string',
'CopyTags': True|False,
'TagsToAdd': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreateRule': {
'Interval': 123,
'IntervalUnit': 'HOURS',
'Times': [
'string',
]
},
'RetainRule': {
'Count': 123
}
},
]
}
)
string
[REQUIRED]
The identifier of the lifecycle policy.
string
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
string
The desired activation state of the lifecycle policy after creation.
string
A description of the lifecycle policy.
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.
CopyTags (boolean) --
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.
dict
Response Syntax
{}
Response Structure
(dict) --