OpenSearchService / Client / list_migrations

list_migrations

OpenSearchService.Client.list_migrations(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_migrations(
    applicationId='string',
    status='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

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

• status (string) – Filters the results by migration status. Valid values are PENDING, IN_PROGRESS, SUCCEEDED, and FAILED.

• maxResults (integer) – The maximum number of results to return in a single call.

• nextToken (string) – The pagination token from a previous call to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'migrations': [
        {
            'migrationId': 'string',
            'status': 'string',
            'applicationId': 'string',
            'source': {
                'datasourceArn': 'string'
            },
            'exportedCount': 123,
            'importedCount': 123,
            'error': {
                'code': 'string',
                'message': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • migrations (list) –

    A list of migration job summaries for the specified application.

    • (dict) –

      A summary of a migration job, including its status and progress.

      • migrationId (string) –

        The unique identifier of the migration job.

      • status (string) –

        The current status of the migration job.

      • applicationId (string) –

        The unique identifier of the OpenSearch application associated with the migration.

      • source (dict) –

        The source configuration for the migration.

        • datasourceArn (string) –

          The Amazon Resource Name (ARN) of the data source to migrate saved objects from.

      • exportedCount (integer) –

        The number of saved objects exported from the source data source.

      • importedCount (integer) –

        The number of saved objects successfully imported into the target workspace.

      • error (dict) –

        Error details if the migration failed or completed with errors.

        • code (string) –

          The error code identifying the type of failure.

        • message (string) –

          A human-readable description of the error.

      • createdAt (datetime) –

        The date and time when the migration job was created.

      • updatedAt (datetime) –

        The date and time when the migration job was last updated.

  • nextToken (string) –

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

Exceptions

• OpenSearchService.Client.exceptions.ValidationException

• OpenSearchService.Client.exceptions.AccessDeniedException

• OpenSearchService.Client.exceptions.InternalException

• OpenSearchService.Client.exceptions.DisabledOperationException