Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartMigration

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.

Request Syntax


POST /2021-01-01/opensearch/app-migrations HTTP/1.1
Content-type: application/json

{
   "applicationId": "string",
   "clientToken": "string",
   "migrationOptions": { 
      "conflictResolution": "string",
      "exportOptions": { 
         "includeReferencesDeep": boolean,
         "objects": [ 
            { 
               "id": "string",
               "type": "string"
            }
         ],
         "types": [ "string" ]
      },
      "source": { 
         "datasourceArn": "string"
      },
      "workspace": { 
         "createWorkspace": boolean,
         "name": "string",
         "type": "string",
         "workspaceId": "string"
      }
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

applicationId

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

Type: String

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

Required: Yes

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

migrationOptions

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

Type: MigrationOptions object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "migrationId": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

migrationId

The unique identifier of the migration job.

Type: String

status

The initial status of the migration job. The status is PENDING when a migration is first created.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

An error occurred because you don't have permissions to access the resource.

HTTP Status Code: 403

ConflictException

An error occurred because the client attempts to remove a resource that is currently in use.

HTTP Status Code: 409

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400