DLM

Client

class DLM.Client

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

client = session.create_client('dlm')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

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

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

See also: AWS API Documentation

Request Syntax

response = client.create_lifecycle_policy(
    ExecutionRoleArn='string',
    Description='string',
    State='ENABLED'|'DISABLED',
    PolicyDetails={
        'PolicyType': 'EBS_SNAPSHOT_MANAGEMENT',
        'ResourceTypes': [
            'VOLUME'|'INSTANCE',
        ],
        'TargetTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Schedules': [
            {
                'Name': 'string',
                'CopyTags': True|False,
                'TagsToAdd': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'VariableTags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'CreateRule': {
                    'Interval': 123,
                    'IntervalUnit': 'HOURS',
                    'Times': [
                        'string',
                    ],
                    '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',
                        'Encrypted': True|False,
                        'CmkArn': 'string',
                        'CopyTags': True|False,
                        'RetainRule': {
                            'Interval': 123,
                            'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
                        }
                    },
                ]
            },
        ],
        'Parameters': {
            'ExcludeBootVolume': True|False
        }
    },
    Tags={
        'string': 'string'
    }
)
Parameters
  • ExecutionRoleArn (string) --

    [REQUIRED]

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

  • Description (string) --

    [REQUIRED]

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

  • State (string) --

    [REQUIRED]

    The desired activation state of the lifecycle policy after creation.

  • PolicyDetails (dict) --

    [REQUIRED]

    The configuration details of the lifecycle policy.

    • PolicyType (string) --

      The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT.

    • ResourceTypes (list) --

      The resource type. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

      • (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 backup schedule.

        • Name (string) --

          The name of the schedule.

        • CopyTags (boolean) --

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

        • 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.

        • VariableTags (list) --

          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.

          • (dict) --

            Specifies a tag for a resource.

            • Key (string) -- [REQUIRED]

              The tag key.

            • Value (string) -- [REQUIRED]

              The tag value.

        • CreateRule (dict) --

          The creation rule.

          • Interval (integer) --

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

          • IntervalUnit (string) --

            The interval unit.

          • Times (list) --

            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.

            • (string) --
          • CronExpression (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 .

        • RetainRule (dict) --

          The retention rule.

          • Count (integer) --

            The number of snapshots to retain for each volume, up to a maximum of 1000.

          • Interval (integer) --

            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 (string) --

            The unit of time for time-based retention.

        • FastRestoreRule (dict) --

          The rule for enabling fast snapshot restore.

          • Count (integer) --

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

          • Interval (integer) --

            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 (string) --

            The unit of time for enabling fast snapshot restore.

          • AvailabilityZones (list) -- [REQUIRED]

            The Availability Zones in which to enable fast snapshot restore.

            • (string) --
        • CrossRegionCopyRules (list) --

          The rule for cross-Region snapshot copies.

          • (dict) --

            Specifies a rule for cross-Region snapshot copies.

            • TargetRegion (string) -- [REQUIRED]

              The target Region.

            • Encrypted (boolean) -- [REQUIRED]

              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.

            • CmkArn (string) --

              The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.

            • CopyTags (boolean) --

              Copy all user-defined tags from the source snapshot to the copied snapshot.

            • RetainRule (dict) --

              The retention rule.

              • Interval (integer) --

                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 (string) --

                The unit of time for time-based retention.

    • Parameters (dict) --

      A set of optional parameters for the policy.

      • ExcludeBootVolume (boolean) --

        [EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots . The default is false.

  • Tags (dict) --

    The tags to apply to the lifecycle policy during creation.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'PolicyId': 'string'
}

Response Structure

  • (dict) --

    • PolicyId (string) --

      The identifier of the lifecycle policy.

Exceptions

delete_lifecycle_policy(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The identifier of the lifecycle policy.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

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

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

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

The presigned url

get_lifecycle_policies(**kwargs)

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

To get complete information about a policy, use GetLifecyclePolicy .

See also: AWS API Documentation

Request Syntax

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

    The identifiers of the data lifecycle policies.

    • (string) --
  • State (string) -- The activation state.
  • ResourceTypes (list) --

    The resource type.

    • (string) --
  • TargetTags (list) --

    The target tag for a policy.

    Tags are strings in the format key=value .

    • (string) --
  • TagsToAdd (list) --

    The tags to add to objects created by the policy.

    Tags are strings in the format key=value .

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

    • (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • Policies (list) --

      Summary information about the lifecycle policies.

      • (dict) --

        Summary information about a lifecycle policy.

        • PolicyId (string) --

          The identifier of the lifecycle policy.

        • Description (string) --

          The description of the lifecycle policy.

        • State (string) --

          The activation state of the lifecycle policy.

        • Tags (dict) --

          The tags.

          • (string) --
            • (string) --

Exceptions

get_lifecycle_policy(**kwargs)

Gets detailed information about the specified lifecycle policy.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The identifier of the lifecycle policy.

Return type
dict
Returns
Response Syntax
{
    'Policy': {
        'PolicyId': 'string',
        'Description': 'string',
        'State': 'ENABLED'|'DISABLED'|'ERROR',
        'StatusMessage': 'string',
        'ExecutionRoleArn': 'string',
        'DateCreated': datetime(2015, 1, 1),
        'DateModified': datetime(2015, 1, 1),
        'PolicyDetails': {
            'PolicyType': 'EBS_SNAPSHOT_MANAGEMENT',
            'ResourceTypes': [
                'VOLUME'|'INSTANCE',
            ],
            'TargetTags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Schedules': [
                {
                    'Name': 'string',
                    'CopyTags': True|False,
                    'TagsToAdd': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'VariableTags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'CreateRule': {
                        'Interval': 123,
                        'IntervalUnit': 'HOURS',
                        'Times': [
                            'string',
                        ],
                        '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',
                            'Encrypted': True|False,
                            'CmkArn': 'string',
                            'CopyTags': True|False,
                            'RetainRule': {
                                'Interval': 123,
                                'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
                            }
                        },
                    ]
                },
            ],
            'Parameters': {
                'ExcludeBootVolume': True|False
            }
        },
        'Tags': {
            'string': 'string'
        },
        'PolicyArn': 'string'
    }
}

Response Structure

  • (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.

      • StatusMessage (string) --

        The description of the status.

      • 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

        • PolicyType (string) --

          The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT.

        • ResourceTypes (list) --

          The resource type. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

          • (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 backup schedule.

            • Name (string) --

              The name of the schedule.

            • CopyTags (boolean) --

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

            • 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.

            • VariableTags (list) --

              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.

              • (dict) --

                Specifies a tag for a resource.

                • Key (string) --

                  The tag key.

                • Value (string) --

                  The tag value.

            • CreateRule (dict) --

              The creation rule.

              • Interval (integer) --

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

              • IntervalUnit (string) --

                The interval unit.

              • Times (list) --

                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.

                • (string) --
              • CronExpression (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 .

            • RetainRule (dict) --

              The retention rule.

              • Count (integer) --

                The number of snapshots to retain for each volume, up to a maximum of 1000.

              • Interval (integer) --

                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 (string) --

                The unit of time for time-based retention.

            • FastRestoreRule (dict) --

              The rule for enabling fast snapshot restore.

              • Count (integer) --

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

              • Interval (integer) --

                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 (string) --

                The unit of time for enabling fast snapshot restore.

              • AvailabilityZones (list) --

                The Availability Zones in which to enable fast snapshot restore.

                • (string) --
            • CrossRegionCopyRules (list) --

              The rule for cross-Region snapshot copies.

              • (dict) --

                Specifies a rule for cross-Region snapshot copies.

                • TargetRegion (string) --

                  The target Region.

                • Encrypted (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.

                • CmkArn (string) --

                  The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.

                • CopyTags (boolean) --

                  Copy all user-defined tags from the source snapshot to the copied snapshot.

                • RetainRule (dict) --

                  The retention rule.

                  • Interval (integer) --

                    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 (string) --

                    The unit of time for time-based retention.

        • Parameters (dict) --

          A set of optional parameters for the policy.

          • ExcludeBootVolume (boolean) --

            [EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots . The default is false.

      • Tags (dict) --

        The tags.

        • (string) --
          • (string) --
      • PolicyArn (string) --

        The Amazon Resource Name (ARN) of the policy.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

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

Returns an object that can wait for some condition.

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

Lists the tags for the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      Information about the tags.

      • (string) --
        • (string) --

Exceptions

tag_resource(**kwargs)

Adds the specified tags to the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • Tags (dict) --

    [REQUIRED]

    One or more tags.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes the specified tags from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • TagKeys (list) --

    [REQUIRED]

    The tag keys.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_lifecycle_policy(**kwargs)

Updates the specified lifecycle policy.

See also: AWS API Documentation

Request Syntax

response = client.update_lifecycle_policy(
    PolicyId='string',
    ExecutionRoleArn='string',
    State='ENABLED'|'DISABLED',
    Description='string',
    PolicyDetails={
        'PolicyType': 'EBS_SNAPSHOT_MANAGEMENT',
        'ResourceTypes': [
            'VOLUME'|'INSTANCE',
        ],
        'TargetTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Schedules': [
            {
                'Name': 'string',
                'CopyTags': True|False,
                'TagsToAdd': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'VariableTags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'CreateRule': {
                    'Interval': 123,
                    'IntervalUnit': 'HOURS',
                    'Times': [
                        'string',
                    ],
                    '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',
                        'Encrypted': True|False,
                        'CmkArn': 'string',
                        'CopyTags': True|False,
                        'RetainRule': {
                            'Interval': 123,
                            'IntervalUnit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
                        }
                    },
                ]
            },
        ],
        'Parameters': {
            'ExcludeBootVolume': True|False
        }
    }
)
Parameters
  • PolicyId (string) --

    [REQUIRED]

    The identifier of the lifecycle policy.

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

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

    • PolicyType (string) --

      The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT.

    • ResourceTypes (list) --

      The resource type. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

      • (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 backup schedule.

        • Name (string) --

          The name of the schedule.

        • CopyTags (boolean) --

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

        • 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.

        • VariableTags (list) --

          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.

          • (dict) --

            Specifies a tag for a resource.

            • Key (string) -- [REQUIRED]

              The tag key.

            • Value (string) -- [REQUIRED]

              The tag value.

        • CreateRule (dict) --

          The creation rule.

          • Interval (integer) --

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

          • IntervalUnit (string) --

            The interval unit.

          • Times (list) --

            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.

            • (string) --
          • CronExpression (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 .

        • RetainRule (dict) --

          The retention rule.

          • Count (integer) --

            The number of snapshots to retain for each volume, up to a maximum of 1000.

          • Interval (integer) --

            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 (string) --

            The unit of time for time-based retention.

        • FastRestoreRule (dict) --

          The rule for enabling fast snapshot restore.

          • Count (integer) --

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

          • Interval (integer) --

            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 (string) --

            The unit of time for enabling fast snapshot restore.

          • AvailabilityZones (list) -- [REQUIRED]

            The Availability Zones in which to enable fast snapshot restore.

            • (string) --
        • CrossRegionCopyRules (list) --

          The rule for cross-Region snapshot copies.

          • (dict) --

            Specifies a rule for cross-Region snapshot copies.

            • TargetRegion (string) -- [REQUIRED]

              The target Region.

            • Encrypted (boolean) -- [REQUIRED]

              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.

            • CmkArn (string) --

              The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.

            • CopyTags (boolean) --

              Copy all user-defined tags from the source snapshot to the copied snapshot.

            • RetainRule (dict) --

              The retention rule.

              • Interval (integer) --

                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 (string) --

                The unit of time for time-based retention.

    • Parameters (dict) --

      A set of optional parameters for the policy.

      • ExcludeBootVolume (boolean) --

        [EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots . The default is false.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class DLM.Client.exceptions.InternalServerException

The service failed in an unexpected way.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Code': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service failed in an unexpected way.

    • Message (string) --
    • Code (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class DLM.Client.exceptions.InvalidRequestException

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

Example

try:
  ...
except client.exceptions.InvalidRequestException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Code': 'string',
    'RequiredParameters': [
        'string',
    ],
    'MutuallyExclusiveParameters': [
        'string',
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --

    • Code (string) --

    • RequiredParameters (list) --

      The request omitted one or more required parameters.

      • (string) --
    • MutuallyExclusiveParameters (list) --

      The request included parameters that cannot be provided together.

      • (string) --
    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class DLM.Client.exceptions.LimitExceededException

The request failed because a limit was exceeded.

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Code': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request failed because a limit was exceeded.

    • Message (string) --

    • Code (string) --

    • ResourceType (string) --

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

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class DLM.Client.exceptions.ResourceNotFoundException

A requested resource was not found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Code': 'string',
    'ResourceType': 'string',
    'ResourceIds': [
        'string',
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A requested resource was not found.

    • Message (string) --

    • Code (string) --

    • ResourceType (string) --

      Value is the type of resource that was not found.

    • ResourceIds (list) --

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

      • (string) --
    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: