create_retriever ¶

def create_retriever(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    type: "capo_qbusiness.types.retriever_type.RetrieverType",
    display_name: "capo_qbusiness.types.retriever_name.RetrieverName",
    configuration: "capo_qbusiness.types.retriever_configuration.RetrieverConfiguration",
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    role_arn: Optional["capo_qbusiness.types.role_arn.RoleArn"] = None,
    client_token: Optional["capo_qbusiness.types.client_token.ClientToken"] = None,
    tags: Optional["capo_qbusiness.types.tags.Tags"] = None,
) -> "capo_qbusiness.types.create_retriever_response.CreateRetrieverResponse":
    """<p>Adds a retriever to your Amazon Q Business application.</p>

    Args:
        application_id: <p>The identifier of your Amazon Q Business application.</p>
        type: <p>The type of retriever you are using.</p>
        display_name: <p>The name of your retriever.</p>
        role_arn: <p>The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.</p>
        client_token: <p>A token that you provide to identify the request to create your Amazon Q Business application retriever.</p>
        tags: <p>A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</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.conflict_exception.ConflictException: <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources 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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have exceeded the set limits for your Amazon Q Business service. </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.create_retriever_request.CreateRetrieverRequest]",
    ) -> OperationResponse[
        "capo_qbusiness.types.create_retriever_response.CreateRetrieverResponse"
    ]:
        import capo_qbusiness._operations.expert_q.create_retriever

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRetriever")
    )
    input_: capo_qbusiness.types.create_retriever_request.CreateRetrieverRequest = {
        "application_id": application_id,
        "type": type,
        "display_name": display_name,
        "configuration": configuration,
    }
    if role_arn is not None:
        input_["role_arn"] = role_arn
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

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