OpenSearchService / Client / get_migration

get_migration¶

OpenSearchService.Client.get_migration(**kwargs)¶

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

response = client.get_migration(
    migrationId='string'
)

Parameters:

migrationId (string) –

[REQUIRED]

The unique identifier of the migration job to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    '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)
}

Response Structure

(dict) –
- migrationId (string) –
  
  The unique identifier of the migration job.
- status (string) –
  
  The current status of the migration job. Valid values are PENDING, IN_PROGRESS, SUCCEEDED, and FAILED.
- applicationId (string) –
  
  The unique identifier of the OpenSearch application associated with the migration.
- source (dict) –
  
  The source configuration for the migration, including the data source ARN.
  - 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.

Exceptions

OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.AccessDeniedException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.DisabledOperationException