BackupSearch / Client / list_search_result_export_jobs

list_search_result_export_jobs

BackupSearch.Client.list_search_result_export_jobs(**kwargs)

This operation exports search results of a search job to a specified destination S3 bucket.

See also: AWS API Documentation

Request Syntax

response = client.list_search_result_export_jobs(
    Status='RUNNING'|'FAILED'|'COMPLETED',
    SearchJobIdentifier='string',
    NextToken='string',
    MaxResults=123
)
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.

  • NextToken (string) –

    The next item following a partial list of returned backups included in a search job.

    For example, if a request is made to return MaxResults number of backups, 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 resource list items to be returned.

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'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      The next item following a partial list of returned backups included in a search job.

      For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Exceptions