AWS SDK for PHP 3.x

Service ID: dlm

Version: 2018-01-12

This page describes the parameters and results for the operations of the Amazon Data Lifecycle Manager (2018-01-12), and shows how to use the Aws\DLM\DLMClient object to call the described operations. This documentation is specific to the 2018-01-12 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateLifecyclePolicy ( array $params = [] )
Creates a policy to manage the lifecycle of the specified Amazon Web Services resources.
DeleteLifecyclePolicy ( array $params = [] )
Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
GetLifecyclePolicies ( array $params = [] )
Gets summary information about all or the specified data lifecycle policies.
GetLifecyclePolicy ( array $params = [] )
Gets detailed information about the specified lifecycle policy.
ListTagsForResource ( array $params = [] )
Lists the tags for the specified resource.
TagResource ( array $params = [] )
Adds the specified tags to the specified resource.
UntagResource ( array $params = [] )
Removes the specified tags from the specified resource.
UpdateLifecyclePolicy ( array $params = [] )
Updates the specified lifecycle policy.

Operations

CreateLifecyclePolicy

$result = $client->createLifecyclePolicy([/* ... */]);
$promise = $client->createLifecyclePolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createLifecyclePolicy([
    'Description' => '<string>', // REQUIRED
    'ExecutionRoleArn' => '<string>', // REQUIRED
    'PolicyDetails' => [ // REQUIRED
        'Actions' => [
            [
                'CrossRegionCopy' => [ // REQUIRED
                    [
                        'EncryptionConfiguration' => [ // REQUIRED
                            'CmkArn' => '<string>',
                            'Encrypted' => true || false, // REQUIRED
                        ],
                        'RetainRule' => [
                            'Interval' => <integer>,
                            'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                        ],
                        'Target' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'Name' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'EventSource' => [
            'Parameters' => [
                'DescriptionRegex' => '<string>', // REQUIRED
                'EventType' => 'shareSnapshot', // REQUIRED
                'SnapshotOwner' => ['<string>', ...], // REQUIRED
            ],
            'Type' => 'MANAGED_CWE', // REQUIRED
        ],
        'Parameters' => [
            'ExcludeBootVolume' => true || false,
            'ExcludeDataVolumeTags' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'NoReboot' => true || false,
        ],
        'PolicyType' => 'EBS_SNAPSHOT_MANAGEMENT|IMAGE_MANAGEMENT|EVENT_BASED_POLICY',
        'ResourceLocations' => ['<string>', ...],
        'ResourceTypes' => ['<string>', ...],
        'Schedules' => [
            [
                'ArchiveRule' => [
                    'RetainRule' => [ // REQUIRED
                        'RetentionArchiveTier' => [ // REQUIRED
                            'Count' => <integer>,
                            'Interval' => <integer>,
                            'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                        ],
                    ],
                ],
                'CopyTags' => true || false,
                'CreateRule' => [
                    'CronExpression' => '<string>',
                    'Interval' => <integer>,
                    'IntervalUnit' => 'HOURS',
                    'Location' => 'CLOUD|OUTPOST_LOCAL',
                    'Times' => ['<string>', ...],
                ],
                'CrossRegionCopyRules' => [
                    [
                        'CmkArn' => '<string>',
                        'CopyTags' => true || false,
                        'DeprecateRule' => [
                            'Interval' => <integer>,
                            'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                        ],
                        'Encrypted' => true || false, // REQUIRED
                        'RetainRule' => [
                            'Interval' => <integer>,
                            'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                        ],
                        'Target' => '<string>',
                        'TargetRegion' => '<string>',
                    ],
                    // ...
                ],
                'DeprecateRule' => [
                    'Count' => <integer>,
                    'Interval' => <integer>,
                    'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                ],
                'FastRestoreRule' => [
                    'AvailabilityZones' => ['<string>', ...], // REQUIRED
                    'Count' => <integer>,
                    'Interval' => <integer>,
                    'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                ],
                'Name' => '<string>',
                'RetainRule' => [
                    'Count' => <integer>,
                    'Interval' => <integer>,
                    'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                ],
                'ShareRules' => [
                    [
                        'TargetAccounts' => ['<string>', ...], // REQUIRED
                        'UnshareInterval' => <integer>,
                        'UnshareIntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                    ],
                    // ...
                ],
                'TagsToAdd' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'VariableTags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'TargetTags' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'State' => 'ENABLED|DISABLED', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

Description

Required: Yes
Type: string

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

ExecutionRoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

PolicyDetails

Required: Yes
Type: PolicyDetails structure

The configuration details of the lifecycle policy.

State

Required: Yes
Type: string

The desired activation state of the lifecycle policy after creation.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags to apply to the lifecycle policy during creation.

Result Syntax

[
    'PolicyId' => '<string>',
]

Result Details

Members

PolicyId

Type: string

The identifier of the lifecycle policy.

Errors

InvalidRequestException:
Bad request. The request is missing required parameters or has invalid parameters.
LimitExceededException:
The request failed because a limit was exceeded.
InternalServerException:
The service failed in an unexpected way.

DeleteLifecyclePolicy

$result = $client->deleteLifecyclePolicy([/* ... */]);
$promise = $client->deleteLifecyclePolicyAsync([/* ... */]);

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

For more information about deleting a policy, see Delete lifecycle policies.

Parameter Syntax

$result = $client->deleteLifecyclePolicy([
    'PolicyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

PolicyId

Required: Yes
Type: string

The identifier of the lifecycle policy.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A requested resource was not found.
InternalServerException:
The service failed in an unexpected way.
LimitExceededException:
The request failed because a limit was exceeded.

GetLifecyclePolicies

$result = $client->getLifecyclePolicies([/* ... */]);
$promise = $client->getLifecyclePoliciesAsync([/* ... */]);

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

To get complete information about a policy, use GetLifecyclePolicy.

Parameter Syntax

$result = $client->getLifecyclePolicies([
    'PolicyIds' => ['<string>', ...],
    'ResourceTypes' => ['<string>', ...],
    'State' => 'ENABLED|DISABLED|ERROR',
    'TagsToAdd' => ['<string>', ...],
    'TargetTags' => ['<string>', ...],
]);

Parameter Details

Members

PolicyIds

Type: Array of strings

The identifiers of the data lifecycle policies.

ResourceTypes

Type: Array of strings

The resource type.

State

Type: string

The activation state.

TagsToAdd

Type: Array of strings

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.

TargetTags

Type: Array of strings

The target tag for a policy.

Tags are strings in the format key=value.

Result Syntax

[
    'Policies' => [
        [
            'Description' => '<string>',
            'PolicyId' => '<string>',
            'PolicyType' => 'EBS_SNAPSHOT_MANAGEMENT|IMAGE_MANAGEMENT|EVENT_BASED_POLICY',
            'State' => 'ENABLED|DISABLED|ERROR',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

Policies

Type: Array of LifecyclePolicySummary structures

Summary information about the lifecycle policies.

Errors

ResourceNotFoundException:
A requested resource was not found.
InvalidRequestException:
Bad request. The request is missing required parameters or has invalid parameters.
InternalServerException:
The service failed in an unexpected way.
LimitExceededException:
The request failed because a limit was exceeded.

GetLifecyclePolicy

$result = $client->getLifecyclePolicy([/* ... */]);
$promise = $client->getLifecyclePolicyAsync([/* ... */]);

Gets detailed information about the specified lifecycle policy.

Parameter Syntax

$result = $client->getLifecyclePolicy([
    'PolicyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

PolicyId

Required: Yes
Type: string

The identifier of the lifecycle policy.

Result Syntax

[
    'Policy' => [
        'DateCreated' => <DateTime>,
        'DateModified' => <DateTime>,
        'Description' => '<string>',
        'ExecutionRoleArn' => '<string>',
        'PolicyArn' => '<string>',
        'PolicyDetails' => [
            'Actions' => [
                [
                    'CrossRegionCopy' => [
                        [
                            'EncryptionConfiguration' => [
                                'CmkArn' => '<string>',
                                'Encrypted' => true || false,
                            ],
                            'RetainRule' => [
                                'Interval' => <integer>,
                                'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                            ],
                            'Target' => '<string>',
                        ],
                        // ...
                    ],
                    'Name' => '<string>',
                ],
                // ...
            ],
            'EventSource' => [
                'Parameters' => [
                    'DescriptionRegex' => '<string>',
                    'EventType' => 'shareSnapshot',
                    'SnapshotOwner' => ['<string>', ...],
                ],
                'Type' => 'MANAGED_CWE',
            ],
            'Parameters' => [
                'ExcludeBootVolume' => true || false,
                'ExcludeDataVolumeTags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'NoReboot' => true || false,
            ],
            'PolicyType' => 'EBS_SNAPSHOT_MANAGEMENT|IMAGE_MANAGEMENT|EVENT_BASED_POLICY',
            'ResourceLocations' => ['<string>', ...],
            'ResourceTypes' => ['<string>', ...],
            'Schedules' => [
                [
                    'ArchiveRule' => [
                        'RetainRule' => [
                            'RetentionArchiveTier' => [
                                'Count' => <integer>,
                                'Interval' => <integer>,
                                'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                            ],
                        ],
                    ],
                    'CopyTags' => true || false,
                    'CreateRule' => [
                        'CronExpression' => '<string>',
                        'Interval' => <integer>,
                        'IntervalUnit' => 'HOURS',
                        'Location' => 'CLOUD|OUTPOST_LOCAL',
                        'Times' => ['<string>', ...],
                    ],
                    'CrossRegionCopyRules' => [
                        [
                            'CmkArn' => '<string>',
                            'CopyTags' => true || false,
                            'DeprecateRule' => [
                                'Interval' => <integer>,
                                'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                            ],
                            'Encrypted' => true || false,
                            'RetainRule' => [
                                'Interval' => <integer>,
                                'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                            ],
                            'Target' => '<string>',
                            'TargetRegion' => '<string>',
                        ],
                        // ...
                    ],
                    'DeprecateRule' => [
                        'Count' => <integer>,
                        'Interval' => <integer>,
                        'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                    ],
                    'FastRestoreRule' => [
                        'AvailabilityZones' => ['<string>', ...],
                        'Count' => <integer>,
                        'Interval' => <integer>,
                        'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                    ],
                    'Name' => '<string>',
                    'RetainRule' => [
                        'Count' => <integer>,
                        'Interval' => <integer>,
                        'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                    ],
                    'ShareRules' => [
                        [
                            'TargetAccounts' => ['<string>', ...],
                            'UnshareInterval' => <integer>,
                            'UnshareIntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                        ],
                        // ...
                    ],
                    'TagsToAdd' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VariableTags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'TargetTags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'PolicyId' => '<string>',
        'State' => 'ENABLED|DISABLED|ERROR',
        'StatusMessage' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members

Policy

Type: LifecyclePolicy structure

Detailed information about the lifecycle policy.

Errors

ResourceNotFoundException:
A requested resource was not found.
InternalServerException:
The service failed in an unexpected way.
LimitExceededException:
The request failed because a limit was exceeded.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags for the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Information about the tags.

Errors

InternalServerException:
The service failed in an unexpected way.
InvalidRequestException:
Bad request. The request is missing required parameters or has invalid parameters.
ResourceNotFoundException:
A requested resource was not found.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds the specified tags to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

One or more tags.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
The service failed in an unexpected way.
InvalidRequestException:
Bad request. The request is missing required parameters or has invalid parameters.
ResourceNotFoundException:
A requested resource was not found.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

TagKeys

Required: Yes
Type: Array of strings

The tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
The service failed in an unexpected way.
InvalidRequestException:
Bad request. The request is missing required parameters or has invalid parameters.
ResourceNotFoundException:
A requested resource was not found.

UpdateLifecyclePolicy

$result = $client->updateLifecyclePolicy([/* ... */]);
$promise = $client->updateLifecyclePolicyAsync([/* ... */]);

Updates the specified lifecycle policy.

For more information about updating a policy, see Modify lifecycle policies.

Parameter Syntax

$result = $client->updateLifecyclePolicy([
    'Description' => '<string>',
    'ExecutionRoleArn' => '<string>',
    'PolicyDetails' => [
        'Actions' => [
            [
                'CrossRegionCopy' => [ // REQUIRED
                    [
                        'EncryptionConfiguration' => [ // REQUIRED
                            'CmkArn' => '<string>',
                            'Encrypted' => true || false, // REQUIRED
                        ],
                        'RetainRule' => [
                            'Interval' => <integer>,
                            'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                        ],
                        'Target' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'Name' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'EventSource' => [
            'Parameters' => [
                'DescriptionRegex' => '<string>', // REQUIRED
                'EventType' => 'shareSnapshot', // REQUIRED
                'SnapshotOwner' => ['<string>', ...], // REQUIRED
            ],
            'Type' => 'MANAGED_CWE', // REQUIRED
        ],
        'Parameters' => [
            'ExcludeBootVolume' => true || false,
            'ExcludeDataVolumeTags' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'NoReboot' => true || false,
        ],
        'PolicyType' => 'EBS_SNAPSHOT_MANAGEMENT|IMAGE_MANAGEMENT|EVENT_BASED_POLICY',
        'ResourceLocations' => ['<string>', ...],
        'ResourceTypes' => ['<string>', ...],
        'Schedules' => [
            [
                'ArchiveRule' => [
                    'RetainRule' => [ // REQUIRED
                        'RetentionArchiveTier' => [ // REQUIRED
                            'Count' => <integer>,
                            'Interval' => <integer>,
                            'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                        ],
                    ],
                ],
                'CopyTags' => true || false,
                'CreateRule' => [
                    'CronExpression' => '<string>',
                    'Interval' => <integer>,
                    'IntervalUnit' => 'HOURS',
                    'Location' => 'CLOUD|OUTPOST_LOCAL',
                    'Times' => ['<string>', ...],
                ],
                'CrossRegionCopyRules' => [
                    [
                        'CmkArn' => '<string>',
                        'CopyTags' => true || false,
                        'DeprecateRule' => [
                            'Interval' => <integer>,
                            'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                        ],
                        'Encrypted' => true || false, // REQUIRED
                        'RetainRule' => [
                            'Interval' => <integer>,
                            'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                        ],
                        'Target' => '<string>',
                        'TargetRegion' => '<string>',
                    ],
                    // ...
                ],
                'DeprecateRule' => [
                    'Count' => <integer>,
                    'Interval' => <integer>,
                    'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                ],
                'FastRestoreRule' => [
                    'AvailabilityZones' => ['<string>', ...], // REQUIRED
                    'Count' => <integer>,
                    'Interval' => <integer>,
                    'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                ],
                'Name' => '<string>',
                'RetainRule' => [
                    'Count' => <integer>,
                    'Interval' => <integer>,
                    'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                ],
                'ShareRules' => [
                    [
                        'TargetAccounts' => ['<string>', ...], // REQUIRED
                        'UnshareInterval' => <integer>,
                        'UnshareIntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
                    ],
                    // ...
                ],
                'TagsToAdd' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'VariableTags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'TargetTags' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'PolicyId' => '<string>', // REQUIRED
    'State' => 'ENABLED|DISABLED',
]);

Parameter Details

Members

Description

Type: string

A description of the lifecycle policy.

ExecutionRoleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

PolicyDetails

Type: PolicyDetails structure

The configuration of the lifecycle policy. You cannot update the policy type or the resource type.

PolicyId

Required: Yes
Type: string

The identifier of the lifecycle policy.

State

Type: string

The desired activation state of the lifecycle policy after creation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
A requested resource was not found.
InvalidRequestException:
Bad request. The request is missing required parameters or has invalid parameters.
InternalServerException:
The service failed in an unexpected way.
LimitExceededException:
The request failed because a limit was exceeded.

Shapes

Action

Description

[Event-based policies only] Specifies an action for an event-based policy.

Members

CrossRegionCopy

Required: Yes
Type: Array of CrossRegionCopyAction structures

The rule for copying shared snapshots across Regions.

Name

Required: Yes
Type: string

A descriptive name for the action.

ArchiveRetainRule

Description

[Snapshot policies only] Specifies information about the archive storage tier retention period.

Members

RetentionArchiveTier

Required: Yes
Type: RetentionArchiveTier structure

Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots.

ArchiveRule

Description

[Snapshot policies only] Specifies a snapshot archiving rule for a schedule.

Members

RetainRule

Required: Yes
Type: ArchiveRetainRule structure

Information about the retention period for the snapshot archiving rule.

CreateRule

Description

[Snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.

You must specify either CronExpression, or Interval, IntervalUnit, and Times.
If you need to specify an ArchiveRule for the schedule, then you must specify a creation frequency of at least 28 days.

Members

CronExpression

Type: string

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.

Interval

Type: int

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

IntervalUnit

Type: string

The interval unit.

Location

Type: string

[Snapshot policies only] 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.

Times

Type: Array of strings

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 Data Lifecycle Manager selects a time within the next 24 hours.

CrossRegionCopyAction

Description

[Event-based policies only] Specifies a cross-Region copy action for event-based policies.

To specify a cross-Region copy rule for snapshot and AMI policies, use CrossRegionCopyRule.

Members

EncryptionConfiguration

Required: Yes
Type: EncryptionConfiguration structure

The encryption settings for the copied snapshot.

RetainRule

Type: CrossRegionCopyRetainRule structure

Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.

Target

Required: Yes
Type: string

The target Region.

CrossRegionCopyDeprecateRule

Description

[AMI policies only] Specifies an AMI deprecation rule for cross-Region AMI copies created by an AMI policy.

Members

Interval

Type: int

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.

IntervalUnit

Type: string

The unit of time in which to measure the Interval. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.

CrossRegionCopyRetainRule

Description

Members

Interval

Type: int

The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

IntervalUnit

Type: string

The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.

CrossRegionCopyRule

Description

[Snapshot and AMI policies only] Specifies a cross-Region copy rule for snapshot and AMI policies.

To specify a cross-Region copy action for event-based polices, use CrossRegionCopyAction.

Members

CmkArn

Type: string

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.

CopyTags

Type: boolean

Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.

DeprecateRule

Type: CrossRegionCopyDeprecateRule structure

[AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.

Encrypted

Required: Yes
Type: boolean

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.

RetainRule

Type: CrossRegionCopyRetainRule structure

The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.

Target

Type: string

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.

TargetRegion

Type: string

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.

DeprecateRule

Description

[AMI policies only] Specifies an AMI deprecation rule for AMIs created by an AMI lifecycle policy.

For age-based schedules, you must specify Interval and IntervalUnit. For count-based schedules, you must specify Count.

Members

Count

Type: int

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.

Interval

Type: int

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.

IntervalUnit

Type: string

The unit of time in which to measure the Interval.

EncryptionConfiguration

Description

[Event-based policies only] Specifies the encryption settings for cross-Region snapshot copies created by event-based policies.

Members

CmkArn

Type: string

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.

Encrypted

Required: Yes
Type: boolean

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.

EventParameters

Description

[Event-based policies only] Specifies an event that activates an event-based policy.

Members

DescriptionRegex

Required: Yes
Type: string

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.

EventType

Required: Yes
Type: string

The type of event. Currently, only snapshot sharing events are supported.

SnapshotOwner

Required: Yes
Type: Array of strings

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.

EventSource

Description

[Event-based policies only] Specifies an event that activates an event-based policy.

Members

Parameters

Type: EventParameters structure

Information about the event.

Type

Required: Yes
Type: string

The source of the event. Currently only managed CloudWatch Events rules are supported.

FastRestoreRule

Description

[Snapshot policies only] Specifies a rule for enabling fast snapshot restore for snapshots created by snapshot policies. You can enable fast snapshot restore based on either a count or a time interval.

Members

AvailabilityZones

Required: Yes
Type: Array of strings

The Availability Zones in which to enable fast snapshot restore.

Count

Type: int

The number of snapshots to be enabled with fast snapshot restore.

Interval

Type: int

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.

IntervalUnit

Type: string

The unit of time for enabling fast snapshot restore.

InternalServerException

Description

The service failed in an unexpected way.

Members

Code

Type: string

Message

Type: string

InvalidRequestException

Description

Bad request. The request is missing required parameters or has invalid parameters.

Members

Code

Type: string

Message

Type: string

MutuallyExclusiveParameters

Type: Array of strings

The request included parameters that cannot be provided together.

RequiredParameters

Type: Array of strings

The request omitted one or more required parameters.

LifecyclePolicy

Description

[All policy types] Detailed information about a snapshot, AMI, or event-based lifecycle policy.

Members

DateCreated

Type: timestamp (string|DateTime or anything parsable by strtotime)

The local date and time when the lifecycle policy was created.

DateModified

Type: timestamp (string|DateTime or anything parsable by strtotime)

The local date and time when the lifecycle policy was last modified.

Description

Type: string

The description of the lifecycle policy.

ExecutionRoleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

PolicyArn

Type: string

The Amazon Resource Name (ARN) of the policy.

PolicyDetails

Type: PolicyDetails structure

The configuration of the lifecycle policy

PolicyId

Type: string

The identifier of the lifecycle policy.

State

Type: string

The activation state of the lifecycle policy.

StatusMessage

Type: string

The description of the status.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags.

LifecyclePolicySummary

Description

Summary information about a lifecycle policy.

Members

Description

Type: string

The description of the lifecycle policy.

PolicyId

Type: string

The identifier of the lifecycle policy.

PolicyType

Type: 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. EVENT_BASED_POLICY indicates that the policy automates cross-account snapshot copies for snapshots that are shared with your account.

State

Type: string

The activation state of the lifecycle policy.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags.

LimitExceededException

Description

The request failed because a limit was exceeded.

Members

Code

Type: string

Message

Type: string

ResourceType

Type: string

Value is the type of resource for which a limit was exceeded.

Parameters

Description

[Snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The set of valid parameters depends on the combination of policy type and target resource type.

If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create any snapshots for the affected instance, and it will emit a SnapshotsCreateFailed Amazon CloudWatch metric. For more information, see Monitor your policies using Amazon CloudWatch.

Members

ExcludeBootVolume

Type: boolean

[Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.

ExcludeDataVolumeTags

Type: Array of Tag structures

[Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.

If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.

NoReboot

Type: boolean

[AMI 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).

PolicyDetails

Description

[All policy types] Specifies the configuration of a lifecycle policy.

Members

Actions

Type: Array of Action structures

[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

EventSource

Type: EventSource structure

[Event-based policies only] The event that activates the event-based policy.

Parameters

Type: Parameters structure

[Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

PolicyType

Type: string

[All policy types] 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.

ResourceLocations

Type: Array of strings

[Snapshot and AMI policies only] 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.

ResourceTypes

Type: Array of strings

[Snapshot policies only] 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.

Schedules

Type: Array of Schedule structures

[Snapshot and AMI policies only] 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.

TargetTags

Type: Array of Tag structures

[Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

ResourceNotFoundException

Description

A requested resource was not found.

Members

Code

Type: string

Message

Type: string

ResourceIds

Type: Array of strings

Value is a list of resource IDs that were not found.

ResourceType

Type: string

Value is the type of resource that was not found.

RetainRule

Description

[Snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies, or for AMIs created by AMI policies.

For snapshot policies that have an ArchiveRule, this retention rule applies to standard tier retention. When the retention threshold is met, snapshots are moved from the standard to the archive tier.

For snapshot policies that do not have an ArchiveRule, snapshots are permanently deleted when this retention threshold is met.

You can retain snapshots based on either a count or a time interval.

Count-based retention

You must specify Count. If you specify an ArchiveRule for the schedule, then you can specify a retention count of 0 to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention count of 1 or more.
Age-based retention

You must specify Interval and IntervalUnit. If you specify an ArchiveRule for the schedule, then you can specify a retention interval of 0 days to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention interval of 1 day or more.

Members

Count

Type: int

The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.

Interval

Type: int

The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

IntervalUnit

Type: string

The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.

RetentionArchiveTier

Description

[Snapshot policies only] Describes the retention rule for archived snapshots. Once the archive retention threshold is met, the snapshots are permanently deleted from the archive tier.

The archive retention rule must retain snapshots in the archive tier for a minimum of 90 days.

For count-based schedules, you must specify Count. For age-based schedules, you must specify Interval and IntervalUnit.

For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.

Members

Count

Type: int

The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.

Interval

Type: int

Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.

IntervalUnit

Type: string

The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.

Schedule

Description

[Snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.

Members

ArchiveRule

Type: ArchiveRule structure

[Snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.

CopyTags

Type: boolean

Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.

CreateRule

Type: CreateRule structure

The creation rule.

CrossRegionCopyRules

Type: Array of CrossRegionCopyRule structures

Specifies a rule for copying snapshots or AMIs across regions.

You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

DeprecateRule

Type: DeprecateRule structure

[AMI policies only] The AMI deprecation rule for the schedule.

FastRestoreRule

Type: FastRestoreRule structure

[Snapshot policies only] The rule for enabling fast snapshot restore.

Name

Type: string

The name of the schedule.

RetainRule

Type: RetainRule structure

The retention rule for snapshots or AMIs created by the policy.

ShareRules

Type: Array of ShareRule structures

[Snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.

TagsToAdd

Type: Array of Tag structures

The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.

VariableTags

Type: Array of Tag structures

[AMI policies and snapshot policies that target instances only] 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.

ShareRule

Description

[Snapshot policies only] Specifies a rule for sharing snapshots across Amazon Web Services accounts.

Members

TargetAccounts

Required: Yes
Type: Array of strings

The IDs of the Amazon Web Services accounts with which to share the snapshots.

UnshareInterval

Type: int

The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.

UnshareIntervalUnit

Type: string

The unit of time for the automatic unsharing interval.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Data Lifecycle Manager 2018-01-12

Operation Summary

Operations

CreateLifecyclePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteLifecyclePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetLifecyclePolicies

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetLifecyclePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

TagResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

UntagResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

UpdateLifecyclePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

Shapes

Action

Description

Members

ArchiveRetainRule

Description

Members

ArchiveRule

Description

Members

CreateRule