Skip to content

ListMigrationsRequest

Source code in docs_src/capo_opensearch/types/list_migrations_request.py 
13
14
15
16
17
18
19
20
21
class ListMigrationsRequest(TypedDict, closed=True):
    application_id: "capo_opensearch.types.application_id.ApplicationId"
    """<p>The unique identifier of the OpenSearch application to list migrations for.</p>"""
    status: NotRequired["capo_opensearch.types.string.String"]
    """<p>Filters the results by migration status. Valid values are <code>PENDING</code>, <code>IN_PROGRESS</code>, <code>SUCCEEDED</code>, and <code>FAILED</code>.</p>"""
    max_results: "capo_opensearch.types.integer.Integer"
    """<p>The maximum number of results to return in a single call.</p>"""
    next_token: NotRequired["capo_opensearch.types.string.String"]
    """<p>The pagination token from a previous call to retrieve the next set of results.</p>"""

application_id instance-attribute 

application_id: ApplicationId

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

max_results instance-attribute 

max_results: Integer

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

next_token instance-attribute 

next_token: NotRequired[String]

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

status instance-attribute 

status: NotRequired[String]

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