Backup / Paginator / ListBackupSelections

ListBackupSelections

class Backup.Paginator.ListBackupSelections

paginator = client.get_paginator('list_backup_selections')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Backup.Client.list_backup_selections().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    BackupPlanId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• BackupPlanId (string) –

  [REQUIRED]

  Uniquely identifies a backup plan.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'BackupSelectionsList': [
        {
            'SelectionId': 'string',
            'SelectionName': 'string',
            'BackupPlanId': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'CreatorRequestId': 'string',
            'IamRoleArn': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • BackupSelectionsList (list) –

    An array of backup selection list items containing metadata about each resource in the list.

    • (dict) –

      Contains metadata about a BackupSelection object.

      • SelectionId (string) –

        Uniquely identifies a request to assign a set of resources to a backup plan.

      • SelectionName (string) –

        The display name of a resource selection document.

      • BackupPlanId (string) –

        Uniquely identifies a backup plan.

      • CreationDate (datetime) –

        The date and time a 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.

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

      • IamRoleArn (string) –

        Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.