AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . backupsearch ]

start-search-result-export-job

Description

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

See also: AWS API Documentation

Synopsis

  start-search-result-export-job
--search-job-identifier <value>
--export-specification <value>
[--client-token <value>]
[--tags <value>]
[--role-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--search-job-identifier (string)

The unique string that specifies the search job.

--export-specification (tagged union structure)

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 -> (structure)

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.

Shorthand Syntax:

s3ExportSpecification={DestinationBucket=string,DestinationPrefix=string}

JSON Syntax:

{
  "s3ExportSpecification": {
    "DestinationBucket": "string",
    "DestinationPrefix": "string"
  }
}

--client-token (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 (map)

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: + - = . _ : /.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--role-arn (string)

This parameter specifies the role ARN used to start the search results export jobs.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

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.