Backup / Client / list_protected_resources

list_protected_resources#

Backup.Client.list_protected_resources(**kwargs)#

Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

See also: AWS API Documentation

Request Syntax

response = client.list_protected_resources(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

  • MaxResults (integer) – The maximum number of items to be returned.

Return type:

dict

Returns:

Response Syntax

{
    'Results': [
        {
            'ResourceArn': 'string',
            'ResourceType': 'string',
            'LastBackupTime': datetime(2015, 1, 1),
            'ResourceName': 'string',
            'LastBackupVaultArn': 'string',
            'LastRecoveryPointArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Results (list) –

      An array of resources successfully backed up by Backup including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

      • (dict) –

        A structure that contains information about a backed-up resource.

        • ResourceArn (string) –

          An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • ResourceType (string) –

          The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

        • LastBackupTime (datetime) –

          The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • ResourceName (string) –

          This is the non-unique name of the resource that belongs to the specified backup.

        • LastBackupVaultArn (string) –

          This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.

        • LastRecoveryPointArn (string) –

          This is the ARN (Amazon Resource Name) of the most recent recovery point.

    • NextToken (string) –

      The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Exceptions

  • Backup.Client.exceptions.InvalidParameterValueException

  • Backup.Client.exceptions.ServiceUnavailableException