describe_index `async` ¶

describe_index(
    id: IndexId, *, config_overrides: Optional[AsynckendraClientConfig] = None
) -> DescribeIndexResponse

Gets information about an Amazon Kendra index.

Parameters:

id (IndexId) –

The identifier of the index you want to get information on.

Raises:

AccessDeniedException –

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
InternalServerException –

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
ResourceNotFoundException –

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
ThrottlingException –

The request was denied due to request throttling. Please reduce the number of requests and try again.
ValidationException –

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
UnknownServiceError –

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

Source code in docs_src/capo_kendra/_services/async_kendra.py

async def describe_index(
    self,
    id: "capo_kendra.types.index_id.IndexId",
    *,
    config_overrides: Optional[AsynckendraClientConfig] = None,
) -> "capo_kendra.types.describe_index_response.DescribeIndexResponse":
    """<p>Gets information about an Amazon Kendra index.</p>

    Args:
        id: <p>The identifier of the index you want to get information on.</p>

    Raises:
        capo_kendra.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
        capo_kendra.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_kendra.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.</p>
        capo_kendra.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
        capo_kendra.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.</p>
        capo_kendra.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kendra.types.describe_index_request.DescribeIndexRequest]",
    ) -> AsyncOperationResponse[
        "capo_kendra.types.describe_index_response.DescribeIndexResponse"
    ]:
        import capo_kendra._operations.aws_kendra_frontend_service.describe_index

        (
            output,
            http_response,
        ) = await capo_kendra._operations.aws_kendra_frontend_service.describe_index.async_describe_index(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_kendra.types.describe_index_response.DescribeIndexResponse",
    ) -> dict[str, Any]:
        import capo_kendra.types.describe_index_response

        return capo_kendra.types.describe_index_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeIndex", redact_output=_redact_output),
    )
    input_: capo_kendra.types.describe_index_request.DescribeIndexRequest = {
        "id": id
    }

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

describe_index async ¶

describe_index `async` ¶