BackupSearch / Client / start_search_result_export_job

start_search_result_export_job#

BackupSearch.Client.start_search_result_export_job(**kwargs)#

This operations starts a job to export the results of search job to a designated S3 bucket.

See also: AWS API Documentation

Request Syntax

response = client.start_search_result_export_job(
    SearchJobIdentifier='string',
    ExportSpecification={
        's3ExportSpecification': {
            'DestinationBucket': 'string',
            'DestinationPrefix': 'string'
        }
    },
    ClientToken='string',
    Tags={
        'string': 'string'
    },
    RoleArn='string'
)
Parameters:

  • SearchJobIdentifier (string) –

    [REQUIRED]

    The unique string that specifies the search job.

  • ExportSpecification (dict) –

    [REQUIRED]

    This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: s3ExportSpecification.

    • s3ExportSpecification (dict) –

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

      • DestinationBucket (string) – [REQUIRED]

        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.

  • ClientToken (string) –

    Include this parameter to allow multiple identical calls for idempotency.

    A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

  • Tags (dict) –

    Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

    • (string) –

      • (string) –

  • RoleArn (string) – This parameter specifies the role ARN used to start the search results export jobs.

Return type:

dict

Returns:

Response Syntax

{
    'ExportJobArn': 'string',
    'ExportJobIdentifier': 'string'
}

Response Structure

  • (dict) –

    • ExportJobArn (string) –

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

    • ExportJobIdentifier (string) –

      This is the unique identifier that specifies the new export job.

Exceptions

  • BackupSearch.Client.exceptions.ResourceNotFoundException

  • BackupSearch.Client.exceptions.ThrottlingException

  • BackupSearch.Client.exceptions.AccessDeniedException

  • BackupSearch.Client.exceptions.ValidationException

  • BackupSearch.Client.exceptions.InternalServerException

  • BackupSearch.Client.exceptions.ServiceQuotaExceededException

  • BackupSearch.Client.exceptions.ConflictException