Skip to content

Initiates a migration job to migrate saved objects from a data source to an Amazon OpenSearch Service application workspace

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.

Usage

opensearchservice_start_migration(applicationId, migrationOptions,
  clientToken)

Arguments

  • applicationId

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

  • migrationOptions

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

  • clientToken

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.

Value

A list with the following syntax:

list(
  migrationId = "string",
  status = "string"
)

Request syntax

svc$start_migration(
  applicationId = "string",
  migrationOptions = list(
    source = list(
      datasourceArn = "string"
    ),
    workspace = list(
      workspaceId = "string",
      createWorkspace = TRUE|FALSE,
      name = "string",
      type = "string"
    ),
    exportOptions = list(
      types = list(
        "string"
      ),
      objects = list(
        list(
          type = "string",
          id = "string"
        )
      ),
      includeReferencesDeep = TRUE|FALSE
    ),
    conflictResolution = "string"
  ),
  clientToken = "string"
)