Skip to content

MigrationWorkspace

Source code in docs_src/capo_opensearch/types/migration_workspace.py 
12
13
14
15
16
17
18
19
20
class MigrationWorkspace(TypedDict, closed=True):
    workspace_id: NotRequired["capo_opensearch.types.string.String"]
    """<p>The unique identifier of an existing workspace to use as the migration target. Specify either this parameter or <code>createWorkspace</code>.</p>"""
    create_workspace: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Specifies whether to create a new workspace as the migration target. If <code>true</code>, you must also specify <code>name</code>.</p>"""
    name: NotRequired["capo_opensearch.types.string.String"]
    """<p>The name of the new workspace to create. Required when <code>createWorkspace</code> is <code>true</code>.</p>"""
    type: NotRequired["capo_opensearch.types.string.String"]
    """<p>The type of the new workspace to create.</p>"""

create_workspace instance-attribute 

create_workspace: NotRequired[Boolean]

Specifies whether to create a new workspace as the migration target. If true, you must also specify name.

name instance-attribute 

name: NotRequired[String]

The name of the new workspace to create. Required when createWorkspace is true.

type instance-attribute 

type: NotRequired[String]

The type of the new workspace to create.

workspace_id instance-attribute 

workspace_id: NotRequired[String]

The unique identifier of an existing workspace to use as the migration target. Specify either this parameter or createWorkspace.