AWS CLI Command Reference

[ aws . opensearch ]

list-migrations

Description

Lists migration jobs for an Amazon OpenSearch Service application. You can filter results by migration status. Use pagination to ensure that the operation returns quickly and successfully.

See also: AWS API Documentation

Synopsis

  list-migrations
--application-id <value>
[--status <value>]
[--max-results <value>]
[--next-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 list migrations for.

Constraints:

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

--status (string)

Filters the results by migration status. Valid values are PENDING , IN_PROGRESS , SUCCEEDED , and FAILED .

--max-results (integer)

The maximum number of results to return in a single call.

--next-token (string)

The pagination token from a previous call to retrieve the next set of results.

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

migrations -> (list)

A list of migration job summaries for the specified application.

(structure)

A summary of a migration job, including its status and progress.

migrationId -> (string)

The unique identifier of the migration job.

status -> (string)

The current status of the migration job.

applicationId -> (string)

The unique identifier of the OpenSearch application associated with the migration.

Constraints:

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

source -> (structure)

The source configuration for the migration.

datasourceArn -> (string) [required]

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

Constraints:

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

exportedCount -> (integer)

The number of saved objects exported from the source data source.

importedCount -> (integer)

The number of saved objects successfully imported into the target workspace.

error -> (structure)

Error details if the migration failed or completed with errors.

code -> (string)

The error code identifying the type of failure.

message -> (string)

A human-readable description of the error.

createdAt -> (timestamp)

The date and time when the migration job was created.

updatedAt -> (timestamp)

The date and time when the migration job was last updated.

nextToken -> (string)

The pagination token to use in a subsequent call to retrieve the next set of results.
© Copyright 2026, Amazon Web Services. Created using Sphinx.