Backup / Paginator / ListLegalHolds

ListLegalHolds

class Backup.Paginator.ListLegalHolds

paginator = client.get_paginator('list_legal_holds')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Backup.Client.list_legal_holds().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'LegalHolds': [
        {
            'Title': 'string',
            'Status': 'CREATING'|'ACTIVE'|'CANCELING'|'CANCELED',
            'Description': 'string',
            'LegalHoldId': 'string',
            'LegalHoldArn': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'CancellationDate': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • LegalHolds (list) –

    This is an array of returned legal holds, both active and previous.

    • (dict) –

      A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.

      • Title (string) –

        The title of a legal hold.

      • Status (string) –

        The status of the legal hold.

      • Description (string) –

        The description of a legal hold.

      • LegalHoldId (string) –

        The ID of the legal hold.

      • LegalHoldArn (string) –

        The Amazon Resource Name (ARN) of the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • CreationDate (datetime) –

        The time when the legal hold was created.

      • CancellationDate (datetime) –

        The time when the legal hold was cancelled.