AWS CLI Command Reference

[ aws . opensearch ]

start-migration

Description

Initiates a migration job to migrate saved objects from a data source to an Amazon OpenSearch Service application workspace. Saved objects include dashboards, visualizations, index patterns, and searches. You can specify export filters to control the scope of the migration and a conflict resolution strategy for handling existing objects in the target workspace.

See also: AWS API Documentation

Synopsis

  start-migration
--application-id <value>
--migration-options <value>
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--application-id (string) [required]

The unique identifier of the OpenSearch application to migrate saved objects into.

Constraints:

  • pattern: [a-z0-9]{3,30}

--migration-options (structure) [required]

The configuration options for the migration, including the source data source, target workspace, export filters, and conflict resolution strategy.

source -> (structure) [required]

The data source from which to export saved objects.

datasourceArn -> (string) [required]

The Amazon Resource Name (ARN) of the data source to migrate saved objects from.

Constraints:

  • min: 20
  • max: 2048
  • pattern: .*

workspace -> (structure) [required]

The target workspace configuration for importing saved objects. You can specify an existing workspace or request creation of a new workspace.

workspaceId -> (string)

The unique identifier of an existing workspace to use as the migration target. Specify either this parameter or createWorkspace .

createWorkspace -> (boolean)

Specifies whether to create a new workspace as the migration target. If true , you must also specify name .

name -> (string)

The name of the new workspace to create. Required when createWorkspace is true .

type -> (string)

The type of the new workspace to create.

exportOptions -> (structure)

Options to filter the scope of saved objects to export from the source.

types -> (list)

A list of saved object types to include in the migration. Valid values include dashboard , visualization , index-pattern , search , and query .

(string)

objects -> (list)

A list of specific saved objects to include in the migration, identified by type and ID.

(structure)

Identifies a specific saved object by its type and unique identifier.

type -> (string) [required]

The type of the saved object, such as dashboard , visualization , index-pattern , search , or query .

id -> (string) [required]

The unique identifier of the saved object.

includeReferencesDeep -> (boolean)

Specifies whether to include all objects referenced by the exported objects, recursively.

conflictResolution -> (string)

The strategy for resolving conflicts when saved objects already exist in the target workspace. Valid values are CREATE_NEW_COPIES , which creates new objects with unique IDs, and overwrite , which replaces existing objects.

JSON Syntax:

{
  "source": {
    "datasourceArn": "string"
  },
  "workspace": {
    "workspaceId": "string",
    "createWorkspace": true|false,
    "name": "string",
    "type": "string"
  },
  "exportOptions": {
    "types": ["string", ...],
    "objects": [
      {
        "type": "string",
        "id": "string"
      }
      ...
    ],
    "includeReferencesDeep": true|false
  },
  "conflictResolution": "string"
}

--client-token (string)

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon OpenSearch Service ignores the request but does not return an error.

Constraints:

  • min: 1
  • max: 64

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream
  • off

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

migrationId -> (string)

The unique identifier of the migration job.

status -> (string)

The initial status of the migration job. The status is PENDING when a migration is first created.
© Copyright 2026, Amazon Web Services. Created using Sphinx.