S3 / Client / list_legal_holds

list_legal_holds

S3.Client.list_legal_holds(**kwargs)

Returns a list of legal holds on an object

See also: AWS API Documentation

Request Syntax

response = client.list_legal_holds(
    Bucket='string',
    Key='string',
    MirrorDestination='string'
)

Parameters:

• Bucket (string) – [REQUIRED]

• Key (string) – [REQUIRED]

• MirrorDestination (string) – Mirror source for object reads.

Return type:

dict

Returns:

Response Syntax

{
    'CreateTime': datetime(2015, 1, 1),
    'LegalHolds': [
        {
            'Date': datetime(2015, 1, 1),
            'ID': 'string'
        },
    ],
    'RetentionPeriod': 123,
    'RetentionPeriodExpirationDate': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • CreateTime (datetime) –

  • LegalHolds (list) –

    • (dict) –

      • Date (datetime) –

      • ID (string) –

  • RetentionPeriod (integer) – Retention period in seconds.

  • RetentionPeriodExpirationDate (datetime) – Date on which the retention period will expire.