Backup / Client / list_backup_plan_templates

list_backup_plan_templates#

Backup.Client.list_backup_plan_templates(**kwargs)#

Lists the backup plan templates.

Request Syntax

response = client.list_backup_plan_templates(
    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 return.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'BackupPlanTemplatesList': [
        {
            'BackupPlanTemplateId': 'string',
            'BackupPlanTemplateName': '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.
- BackupPlanTemplatesList (list) –
  
  An array of template list items containing metadata about your saved templates.
  - (dict) –
    
    An object specifying metadata associated with a backup plan template.
    - BackupPlanTemplateId (string) –
      
      Uniquely identifies a stored backup plan template.
    - BackupPlanTemplateName (string) –
      
      The optional display name of a backup plan template.

Exceptions

Backup.Client.exceptions.InvalidParameterValueException
Backup.Client.exceptions.MissingParameterValueException
Backup.Client.exceptions.ServiceUnavailableException
Backup.Client.exceptions.ResourceNotFoundException