Skip to content

list_applications async

list_applications(
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    next_token: Optional[NextToken] = None,
    statuses: Optional[ApplicationStatuses] = None,
    max_results: Optional[MaxResults] = None,
) -> ListApplicationsResponse

Lists all OpenSearch applications under your account.

Parameters:

  • statuses (Optional[ApplicationStatuses], default: None ) –

    Filters the list of OpenSearch applications by status. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

Raises:

Source code in docs_src/capo_opensearch/_services/async_open_search.py
async def list_applications(
    self,
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    next_token: Optional["capo_opensearch.types.next_token.NextToken"] = None,
    statuses: Optional[
        "capo_opensearch.types.application_statuses.ApplicationStatuses"
    ] = None,
    max_results: Optional["capo_opensearch.types.max_results.MaxResults"] = None,
) -> "capo_opensearch.types.list_applications_response.ListApplicationsResponse":
    """<p>Lists all OpenSearch applications under your account.</p>

    Args:
        statuses: <p>Filters the list of OpenSearch applications by status. Possible values: <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</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.base_exception.BaseException: <p>An error occurred while processing the request.</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.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</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_applications_request.ListApplicationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearch.types.list_applications_response.ListApplicationsResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.list_applications

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListApplications")
    )
    input_: capo_opensearch.types.list_applications_request.ListApplicationsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if statuses is not None:
        input_["statuses"] = statuses
    if max_results is not None:
        input_["max_results"] = max_results

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