list_migrations `async` ¶

list_migrations(
    application_id: ApplicationId,
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    status: Optional[String] = None,
    max_results: Optional[Integer] = None,
    next_token: Optional[String] = None,
) -> ListMigrationsResponse

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.

Parameters:

application_id (ApplicationId) –

The unique identifier of the OpenSearch application to list migrations for.
status (Optional[String], default: None ) –

Filters the results by migration status. Valid values are PENDING, IN_PROGRESS, SUCCEEDED, and FAILED.
max_results (Optional[Integer], default: None ) –

The maximum number of results to return in a single call.
next_token (Optional[String], default: None ) –

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

Raises:

AccessDeniedException –

An error occurred because you don't have permissions to access the resource.
DisabledOperationException –

An error occured because the client wanted to access an unsupported operation.
InternalException –

Request processing failed because of an unknown error, exception, or internal failure.
ValidationException –

An exception for accessing or deleting a resource that doesn't exist.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_opensearch/_services/async_open_search.py

async def list_migrations(
    self,
    application_id: "capo_opensearch.types.application_id.ApplicationId",
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    status: Optional["capo_opensearch.types.string.String"] = None,
    max_results: Optional["capo_opensearch.types.integer.Integer"] = None,
    next_token: Optional["capo_opensearch.types.string.String"] = None,
) -> "capo_opensearch.types.list_migrations_response.ListMigrationsResponse":
    """<p>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.</p>

    Args:
        application_id: <p>The unique identifier of the OpenSearch application to list migrations for.</p>
        status: <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: <p>The maximum number of results to return in a single call.</p>
        next_token: <p>The pagination token from a previous call to retrieve the next set of results.</p>

    Raises:
        capo_opensearch.errors.access_denied_exception.AccessDeniedException: <p>An error occurred because you don't have permissions to access the resource.</p>
        capo_opensearch.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access an unsupported operation.</p>
        capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
        capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_opensearch.types.list_migrations_request.ListMigrationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearch.types.list_migrations_response.ListMigrationsResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.list_migrations

        (
            output,
            http_response,
        ) = await capo_opensearch._operations.amazon_open_search_service.list_migrations.async_list_migrations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMigrations")
    )
    input_: capo_opensearch.types.list_migrations_request.ListMigrationsRequest = {
        "application_id": application_id
    }
    if status is not None:
        input_["status"] = status
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_migrations async ¶

list_migrations `async` ¶