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

ListMigrations

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.

Request Syntax


GET /2021-01-01/opensearch/app-migrations?applicationId=applicationId&maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

The unique identifier of the OpenSearch application to list migrations for.

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

Required: Yes

maxResults

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

nextToken

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

status

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "migrations": [ 
      { 
         "applicationId": "string",
         "createdAt": number,
         "error": { 
            "code": "string",
            "message": "string"
         },
         "exportedCount": number,
         "importedCount": number,
         "migrationId": "string",
         "source": { 
            "datasourceArn": "string"
         },
         "status": "string",
         "updatedAt": number
      }
   ],
   "nextToken": "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.

migrations

A list of migration job summaries for the specified application.

Type: Array of MigrationSummary objects

nextToken

The pagination token to use in a subsequent call to retrieve the next set of results.

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

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

ValidationException

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

HTTP Status Code: 400