GetMigration
Retrieves the current status and progress of a migration job, including the number of exported and imported objects and error details if the migration failed.
Request Syntax
GET /2021-01-01/opensearch/app-migrations/migrationId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- migrationId
-
The unique identifier of the migration job to retrieve.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"applicationId": "string",
"createdAt": number,
"error": {
"code": "string",
"message": "string"
},
"exportedCount": number,
"importedCount": number,
"migrationId": "string",
"source": {
"datasourceArn": "string"
},
"status": "string",
"updatedAt": number
}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.
- applicationId
-
The unique identifier of the OpenSearch application associated with the migration.
Type: String
Pattern:
[a-z0-9]{3,30} - createdAt
-
The date and time when the migration job was created.
Type: Timestamp
- error
-
Error details if the migration failed or completed with errors.
Type: MigrationError object
- exportedCount
-
The number of saved objects exported from the source data source.
Type: Integer
- importedCount
-
The number of saved objects successfully imported into the target workspace.
Type: Integer
- migrationId
-
The unique identifier of the migration job.
Type: String
- source
-
The source configuration for the migration, including the data source ARN.
Type: MigrationSource object
- status
-
The current status of the migration job. Valid values are
PENDING,IN_PROGRESS,SUCCEEDED, andFAILED.Type: String
- updatedAt
-
The date and time when the migration job was last updated.
Type: Timestamp
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: