BackupSearch / Paginator / ListSearchJobs

ListSearchJobs

class BackupSearch.Paginator.ListSearchJobs

paginator = client.get_paginator('list_search_jobs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ByStatus='RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ByStatus (string) – Include this parameter to filter list by search job status.

• 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

{
    'SearchJobs': [
        {
            'SearchJobIdentifier': 'string',
            'SearchJobArn': 'string',
            'Name': 'string',
            'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'FAILED',
            'CreationTime': datetime(2015, 1, 1),
            'CompletionTime': datetime(2015, 1, 1),
            'SearchScopeSummary': {
                'TotalRecoveryPointsToScanCount': 123,
                'TotalItemsToScanCount': 123
            },
            'StatusMessage': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • SearchJobs (list) –

    The search jobs among the list, with details of the returned search jobs.

    • (dict) –

      This is information pertaining to a search job.

      • SearchJobIdentifier (string) –

        The unique string that specifies the search job.

      • SearchJobArn (string) –

        The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

      • Name (string) –

        This is the name of the search job.

      • Status (string) –

        This is the status of the search job.

      • CreationTime (datetime) –

        This is the creation time of the search job.

      • CompletionTime (datetime) –

        This is the completion time of the search job.

      • SearchScopeSummary (dict) –

        Returned summary of the specified search job scope, including:

        • TotalBackupsToScanCount, the number of recovery points returned by the search.

        • TotalItemsToScanCount, the number of items returned by the search.

        • TotalRecoveryPointsToScanCount (integer) –

          This is the count of the total number of backups that will be scanned in a search.

        • TotalItemsToScanCount (integer) –

          This is the count of the total number of items that will be scanned in a search.

      • StatusMessage (string) –

        A status message will be returned for either a earch job with a status of ERRORED or a status of COMPLETED jobs with issues.

        For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.