update_workspace_configuration ¶

def update_workspace_configuration(
    self,
    configuration: "capo_grafana.types.overridable_configuration_json.OverridableConfigurationJson",
    workspace_id: "capo_grafana.types.workspace_id.WorkspaceId",
    *,
    config_overrides: Optional[grafanaClientConfig] = None,
    grafana_version: Optional[
        "capo_grafana.types.grafana_version.GrafanaVersion"
    ] = None,
) -> "capo_grafana.types.update_workspace_configuration_response.UpdateWorkspaceConfigurationResponse":
    """<p>Updates the configuration string for the given workspace</p>

    Args:
        configuration: <p>The new configuration string for the workspace. For more information about the format and configuration options available, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html">Working in your Grafana workspace</a>.</p>
        workspace_id: <p>The ID of the workspace to update.</p>
        grafana_version: <p>Specifies the version of Grafana to support in the workspace. If not specified, keeps the current version of the workspace.</p> <p>Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4).</p> <p>To know what versions are available to upgrade to for a specific workspace, see the <a href="https://docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html">ListVersions</a> operation.</p>

    Raises:
        capo_grafana.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action. </p>
        capo_grafana.errors.conflict_exception.ConflictException: <p>A resource was in an inconsistent state during an update or a deletion.</p>
        capo_grafana.errors.internal_server_exception.InternalServerException: <p>Unexpected error while processing the request. Retry the request.</p>
        capo_grafana.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist.</p>
        capo_grafana.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling. Retry the request.</p>
        capo_grafana.errors.validation_exception.ValidationException: <p>The value of a parameter in the request caused an error.</p>
        capo_grafana.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_grafana.types.update_workspace_configuration_request.UpdateWorkspaceConfigurationRequest]",
    ) -> OperationResponse[
        "capo_grafana.types.update_workspace_configuration_response.UpdateWorkspaceConfigurationResponse"
    ]:
        import capo_grafana._operations.aws_grafana_control_plane.update_workspace_configuration

        output, http_response = (
            capo_grafana._operations.aws_grafana_control_plane.update_workspace_configuration.update_workspace_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateWorkspaceConfiguration")
    )
    input_: capo_grafana.types.update_workspace_configuration_request.UpdateWorkspaceConfigurationRequest = {
        "configuration": configuration,
        "workspace_id": workspace_id,
    }
    if grafana_version is not None:
        input_["grafana_version"] = grafana_version

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