update_plugin ¶

def update_plugin(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    plugin_id: "capo_qbusiness.types.plugin_id.PluginId",
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    display_name: Optional["capo_qbusiness.types.plugin_name.PluginName"] = None,
    state: Optional["capo_qbusiness.types.plugin_state.PluginState"] = None,
    server_url: Optional["capo_qbusiness.types.url.Url"] = None,
    custom_plugin_configuration: Optional[
        "capo_qbusiness.types.custom_plugin_configuration.CustomPluginConfiguration"
    ] = None,
    auth_configuration: Optional[
        "capo_qbusiness.types.plugin_auth_configuration.PluginAuthConfiguration"
    ] = None,
) -> "capo_qbusiness.types.update_plugin_response.UpdatePluginResponse":
    """<p>Updates an Amazon Q Business plugin.</p>

    Args:
        application_id: <p>The identifier of the application the plugin is attached to.</p>
        plugin_id: <p>The identifier of the plugin.</p>
        display_name: <p>The name of the plugin.</p>
        state: <p>The status of the plugin. </p>
        server_url: <p>The source URL used for plugin configuration.</p>
        custom_plugin_configuration: <p>The configuration for a custom plugin.</p>
        auth_configuration: <p>The authentication configuration the plugin is using.</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.update_plugin_request.UpdatePluginRequest]",
    ) -> OperationResponse[
        "capo_qbusiness.types.update_plugin_response.UpdatePluginResponse"
    ]:
        import capo_qbusiness._operations.expert_q.update_plugin

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

    def _redact_input(
        input_: "capo_qbusiness.types.update_plugin_request.UpdatePluginRequest",
    ) -> dict[str, Any]:
        import capo_qbusiness.types.update_plugin_request

        return capo_qbusiness.types.update_plugin_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdatePlugin", redact_input=_redact_input),
    )
    input_: capo_qbusiness.types.update_plugin_request.UpdatePluginRequest = {
        "application_id": application_id,
        "plugin_id": plugin_id,
    }
    if display_name is not None:
        input_["display_name"] = display_name
    if state is not None:
        input_["state"] = state
    if server_url is not None:
        input_["server_url"] = server_url
    if custom_plugin_configuration is not None:
        input_["custom_plugin_configuration"] = custom_plugin_configuration
    if auth_configuration is not None:
        input_["auth_configuration"] = auth_configuration

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