Skip to content

update_permissions

update_permissions(
    update_instruction_batch: UpdateInstructionBatch,
    workspace_id: WorkspaceId,
    *,
    config_overrides: Optional[grafanaClientConfig] = None,
) -> UpdatePermissionsResponse

Updates which users in a workspace have the Grafana Admin or Editor roles.

Parameters:

  • update_instruction_batch (UpdateInstructionBatch) –

    An array of structures that contain the permission updates to make.

  • workspace_id (WorkspaceId) –

    The ID of the workspace to update.

Raises:

Source code in docs_src/capo_grafana/_services/grafana.py
def update_permissions(
    self,
    update_instruction_batch: "capo_grafana.types.update_instruction_batch.UpdateInstructionBatch",
    workspace_id: "capo_grafana.types.workspace_id.WorkspaceId",
    *,
    config_overrides: Optional[grafanaClientConfig] = None,
) -> "capo_grafana.types.update_permissions_response.UpdatePermissionsResponse":
    """<p>Updates which users in a workspace have the Grafana <code>Admin</code> or <code>Editor</code> roles.</p>

    Args:
        update_instruction_batch: <p>An array of structures that contain the permission updates to make.</p>
        workspace_id: <p>The ID of the workspace to update.</p>

    Raises:
        capo_grafana.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action. </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_permissions_request.UpdatePermissionsRequest]",
    ) -> OperationResponse[
        "capo_grafana.types.update_permissions_response.UpdatePermissionsResponse"
    ]:
        import capo_grafana._operations.aws_grafana_control_plane.update_permissions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePermissions")
    )
    input_: capo_grafana.types.update_permissions_request.UpdatePermissionsRequest = {
        "update_instruction_batch": update_instruction_batch,
        "workspace_id": workspace_id,
    }

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