Backup / Client / get_legal_hold

get_legal_hold

Backup.Client.get_legal_hold(**kwargs)

This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.

See also: AWS API Documentation

Request Syntax

response = client.get_legal_hold(
    LegalHoldId='string'
)

Parameters:

LegalHoldId (string) –

[REQUIRED]

This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.

Return type:

dict

Returns:

Response Syntax

{
    'Title': 'string',
    'Status': 'CREATING'|'ACTIVE'|'CANCELING'|'CANCELED',
    'Description': 'string',
    'CancelDescription': 'string',
    'LegalHoldId': 'string',
    'LegalHoldArn': 'string',
    'CreationDate': datetime(2015, 1, 1),
    'CancellationDate': datetime(2015, 1, 1),
    'RetainRecordUntil': datetime(2015, 1, 1),
    'RecoveryPointSelection': {
        'VaultNames': [
            'string',
        ],
        'ResourceIdentifiers': [
            'string',
        ],
        'DateRange': {
            'FromDate': datetime(2015, 1, 1),
            'ToDate': datetime(2015, 1, 1)
        }
    }
}

Response Structure

• (dict) –

  • Title (string) –

    This is the string title of the legal hold.

  • Status (string) –

    This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

  • Description (string) –

    This is the returned string description of the legal hold.

  • CancelDescription (string) –

    String describing the reason for removing the legal hold.

  • LegalHoldId (string) –

    This is the returned ID associated with a specified legal hold.

  • LegalHoldArn (string) –

    This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

  • CreationDate (datetime) –

    Time in number format when legal hold was created.

  • CancellationDate (datetime) –

    Time in number when legal hold was cancelled.

  • RetainRecordUntil (datetime) –

    This is the date and time until which the legal hold record will be retained.

  • RecoveryPointSelection (dict) –

    This specifies criteria to assign a set of resources, such as resource types or backup vaults.

    • VaultNames (list) –

      These are the names of the vaults in which the selected recovery points are contained.

      • (string) –

    • ResourceIdentifiers (list) –

      These are the resources included in the resource selection (including type of resources and vaults).

      • (string) –

    • DateRange (dict) –

      This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.

      The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • FromDate (datetime) –

        This value is the beginning date, inclusive.

        The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

      • ToDate (datetime) –

        This value is the end date, inclusive.

        The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

Exceptions

• Backup.Client.exceptions.InvalidParameterValueException

• Backup.Client.exceptions.MissingParameterValueException

• Backup.Client.exceptions.ServiceUnavailableException

• Backup.Client.exceptions.ResourceNotFoundException