Skip to content

Lists migration jobs for an Amazon OpenSearch Service application

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.

Usage

opensearchservice_list_migrations(applicationId, status, maxResults,
  nextToken)

Arguments

  • applicationId

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

  • status

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

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

Value

A list with the following syntax:

list(
  migrations = list(
    list(
      migrationId = "string",
      status = "string",
      applicationId = "string",
      source = list(
        datasourceArn = "string"
      ),
      exportedCount = 123,
      importedCount = 123,
      error = list(
        code = "string",
        message = "string"
      ),
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_migrations(
  applicationId = "string",
  status = "string",
  maxResults = 123,
  nextToken = "string"
)