get_index `async` ¶

get_index(
    domain_name: DomainName,
    index_name: IndexName,
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
) -> GetIndexResponse

Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.

Parameters:

index_name (IndexName) –

The name of the index to retrieve information about.

Raises:

AccessDeniedException –

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

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about 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.
ResourceNotFoundException –

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

The request was denied due to request throttling. Reduce the frequency of your requests and try again.
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 get_index(
    self,
    domain_name: "capo_opensearch.types.domain_name.DomainName",
    index_name: "capo_opensearch.types.index_name.IndexName",
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
) -> "capo_opensearch.types.get_index_response.GetIndexResponse":
    """<p>Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.</p>

    Args:
        index_name: <p>The name of the index to retrieve information about.</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.dependency_failure_exception.DependencyFailureException: <p>An exception for when a failure in one of the dependencies results in the service being unable to fetch details about 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.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Reduce the frequency of your requests and try again.</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.get_index_request.GetIndexRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearch.types.get_index_response.GetIndexResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.get_index

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIndex")
    )
    input_: capo_opensearch.types.get_index_request.GetIndexRequest = {
        "domain_name": domain_name,
        "index_name": index_name,
    }

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

get_index async ¶

get_index `async` ¶