create_workspace_api_key ¶

def create_workspace_api_key(
    self,
    key_name: "capo_grafana.types.api_key_name.ApiKeyName",
    key_role: str,
    seconds_to_live: int,
    workspace_id: "capo_grafana.types.workspace_id.WorkspaceId",
    *,
    config_overrides: Optional[grafanaClientConfig] = None,
) -> "capo_grafana.types.create_workspace_api_key_response.CreateWorkspaceApiKeyResponse":
    """<p>Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See <a href="https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html">https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html</a> for available APIs and example requests.</p> <note> <p>In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.</p> </note>

    Args:
        key_name: <p>Specifies the name of the key. Keynames must be unique to the workspace.</p>
        key_role: <p>Specifies the permission level of the key.</p> <p> Valid values: <code>ADMIN</code>|<code>EDITOR</code>|<code>VIEWER</code> </p>
        seconds_to_live: <p>Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.</p>
        workspace_id: <p>The ID of the workspace to create an API key.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would cause a service quota to be exceeded.</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.create_workspace_api_key_request.CreateWorkspaceApiKeyRequest]",
    ) -> OperationResponse[
        "capo_grafana.types.create_workspace_api_key_response.CreateWorkspaceApiKeyResponse"
    ]:
        import capo_grafana._operations.aws_grafana_control_plane.create_workspace_api_key

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

    def _redact_output(
        output: "capo_grafana.types.create_workspace_api_key_response.CreateWorkspaceApiKeyResponse",
    ) -> dict[str, Any]:
        import capo_grafana.types.create_workspace_api_key_response

        return (
            capo_grafana.types.create_workspace_api_key_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateWorkspaceApiKey", redact_output=_redact_output),
    )
    input_: capo_grafana.types.create_workspace_api_key_request.CreateWorkspaceApiKeyRequest = {
        "key_name": key_name,
        "key_role": key_role,
        "seconds_to_live": seconds_to_live,
        "workspace_id": workspace_id,
    }

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