BackupSearch / Paginator / ListSearchResultExportJobs

ListSearchResultExportJobs

class BackupSearch.Paginator.ListSearchResultExportJobs

paginator = client.get_paginator('list_search_result_export_jobs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• Status (string) – The search jobs to be included in the export job can be filtered by including this parameter.

• SearchJobIdentifier (string) – 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

{
    'ExportJobs': [
        {
            'ExportJobIdentifier': 'string',
            'ExportJobArn': 'string',
            'Status': 'RUNNING'|'FAILED'|'COMPLETED',
            'CreationTime': datetime(2015, 1, 1),
            'CompletionTime': datetime(2015, 1, 1),
            'StatusMessage': 'string',
            'SearchJobArn': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • ExportJobs (list) –

    The operation returns the included export jobs.

    • (dict) –

      This is the summary of an export job.

      • ExportJobIdentifier (string) –

        This is the unique string that identifies a specific export job.

      • ExportJobArn (string) –

        This is the unique ARN (Amazon Resource Name) that belongs to the new export job.

      • Status (string) –

        The status of the export job is one of the following:

        CREATED; RUNNING; FAILED; or COMPLETED.

      • CreationTime (datetime) –

        This is a timestamp of the time the export job was created.

      • CompletionTime (datetime) –

        This is a timestamp of the time the export job compeleted.

      • StatusMessage (string) –

        A status message is a string that is returned for an export job.

        A status message is included for any status other than COMPLETED without issues.

      • SearchJobArn (string) –

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