BackupSearch / Paginator / ListSearchJobBackups

ListSearchJobBackups

class BackupSearch.Paginator.ListSearchJobBackups

paginator = client.get_paginator('list_search_job_backups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from BackupSearch.Client.list_search_job_backups().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• SearchJobIdentifier (string) –

  [REQUIRED]

  The unique string that specifies the search job.

• 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

{
    'Results': [
        {
            'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'FAILED',
            'StatusMessage': 'string',
            'ResourceType': 'S3'|'EBS',
            'BackupResourceArn': 'string',
            'SourceResourceArn': 'string',
            'IndexCreationTime': datetime(2015, 1, 1),
            'BackupCreationTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Results (list) –

    The recovery points returned the results of a search job

    • (dict) –

      This contains the information about recovery points returned in results of a search job.

      • Status (string) –

        This is the status of the search job backup result.

      • StatusMessage (string) –

        This is the status message included with the results.

      • ResourceType (string) –

        This is the resource type of the search.

      • BackupResourceArn (string) –

        The Amazon Resource Name (ARN) that uniquely identifies the backup resources.

      • SourceResourceArn (string) –

        The Amazon Resource Name (ARN) that uniquely identifies the source resources.

      • IndexCreationTime (datetime) –

        This is the creation time of the backup index.

      • BackupCreationTime (datetime) –

        This is the creation time of the backup (recovery point).