get_index ¶

def get_index(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    index_id: "capo_qbusiness.types.index_id.IndexId",
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
) -> "capo_qbusiness.types.get_index_response.GetIndexResponse":
    """<p>Gets information about an existing Amazon Q Business index.</p>

    Args:
        application_id: <p>The identifier of the Amazon Q Business application connected to the index.</p>
        index_id: <p>The identifier of the Amazon Q Business index you want information on.</p>

    Raises:
        capo_qbusiness.errors.access_denied_exception.AccessDeniedException: <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
        capo_qbusiness.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_qbusiness.errors.resource_not_found_exception.ResourceNotFoundException: <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
        capo_qbusiness.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
        capo_qbusiness.errors.validation_exception.ValidationException: <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
        capo_qbusiness.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_qbusiness.types.get_index_request.GetIndexRequest]",
    ) -> OperationResponse[
        "capo_qbusiness.types.get_index_response.GetIndexResponse"
    ]:
        import capo_qbusiness._operations.expert_q.get_index

        output, http_response = (
            capo_qbusiness._operations.expert_q.get_index.get_index(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIndex")
    )
    input_: capo_qbusiness.types.get_index_request.GetIndexRequest = {
        "application_id": application_id,
        "index_id": index_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output