BackupSearch / Client / get_search_result_export_job

get_search_result_export_job#

BackupSearch.Client.get_search_result_export_job(**kwargs)#

This operation retrieves the metadata of an export job.

An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.

An export job allows you to retain results of a search beyond the search job’s scheduled retention of 7 days.

See also: AWS API Documentation

Request Syntax

response = client.get_search_result_export_job(
    ExportJobIdentifier='string'
)
Parameters:

ExportJobIdentifier (string) –

[REQUIRED]

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

Required for this operation.

Return type:

dict

Returns:

Response Syntax

{
    'ExportJobIdentifier': 'string',
    'ExportJobArn': 'string',
    'Status': 'RUNNING'|'FAILED'|'COMPLETED',
    'CreationTime': datetime(2015, 1, 1),
    'CompletionTime': datetime(2015, 1, 1),
    'StatusMessage': 'string',
    'ExportSpecification': {
        's3ExportSpecification': {
            'DestinationBucket': 'string',
            'DestinationPrefix': 'string'
        }
    },
    'SearchJobArn': 'string'
}

Response Structure

  • (dict) –

    • ExportJobIdentifier (string) –

      This is the unique string that identifies the specified export job.

    • ExportJobArn (string) –

      The unique Amazon Resource Name (ARN) that uniquely identifies the export job.

    • Status (string) –

      This is the current status of the export job.

    • CreationTime (datetime) –

      The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • CompletionTime (datetime) –

      The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • StatusMessage (string) –

      A status message is a string that is returned for search job with a status of FAILED, along with steps to remedy and retry the operation.

    • ExportSpecification (dict) –

      The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: s3ExportSpecification. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • s3ExportSpecification (dict) –

        This specifies the destination Amazon S3 bucket for the export job. And, if included, it also specifies the destination prefix.

        • DestinationBucket (string) –

          This specifies the destination Amazon S3 bucket for the export job.

        • DestinationPrefix (string) –

          This specifies the prefix for the destination Amazon S3 bucket for the export job.

    • SearchJobArn (string) –

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

Exceptions

  • BackupSearch.Client.exceptions.ResourceNotFoundException

  • BackupSearch.Client.exceptions.ThrottlingException

  • BackupSearch.Client.exceptions.AccessDeniedException

  • BackupSearch.Client.exceptions.ValidationException

  • BackupSearch.Client.exceptions.InternalServerException