Backup / Client / list_backup_plans

list_backup_plans

Backup.Client.list_backup_plans(**kwargs)

Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

See also: AWS API Documentation

Request Syntax

response = client.list_backup_plans(
    NextToken='string',
    MaxResults=123,
    IncludeDeleted=True|False
)

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.

• IncludeDeleted (boolean) – A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'BackupPlansList': [
        {
            'BackupPlanArn': 'string',
            'BackupPlanId': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'DeletionDate': datetime(2015, 1, 1),
            'VersionId': 'string',
            'BackupPlanName': 'string',
            'CreatorRequestId': 'string',
            'LastExecutionDate': datetime(2015, 1, 1),
            'AdvancedBackupSettings': [
                {
                    'ResourceType': 'string',
                    'BackupOptions': {
                        'string': 'string'
                    }
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

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

  • BackupPlansList (list) –

    An array of backup plan list items containing metadata about your saved backup plans.

    • (dict) –

      Contains metadata about a backup plan.

      • BackupPlanArn (string) –

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • BackupPlanId (string) –

        Uniquely identifies a backup plan.

      • CreationDate (datetime) –

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

      • DeletionDate (datetime) –

        The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • VersionId (string) –

        Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

      • BackupPlanName (string) –

        The display name of a saved backup plan.

      • CreatorRequestId (string) –

        A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

        If used, this parameter must contain 1 to 50 alphanumeric or ‘-_.’ characters.

      • LastExecutionDate (datetime) –

        The last time a job to back up resources was run with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • AdvancedBackupSettings (list) –

        Contains a list of BackupOptions for a resource type.

        • (dict) –

          A list of backup options for each resource type.

          • ResourceType (string) –

            Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

            Valid values: EC2.

          • BackupOptions (dict) –

            Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

            Valid values:

            Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

            Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

            If you specify an invalid option, you get an InvalidParameterValueException exception.

            For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

            • (string) –

              • (string) –

Exceptions

• Backup.Client.exceptions.ResourceNotFoundException

• Backup.Client.exceptions.InvalidParameterValueException

• Backup.Client.exceptions.MissingParameterValueException

• Backup.Client.exceptions.ServiceUnavailableException