@alicloud/emr-serverless-spark20230808 2.1.0 → 2.2.0

package/dist/client.d.ts

@@ -243,7 +243,7 @@ export default class Client extends OpenApi {
      */
     createRayCluster(workspaceId: string, request: $_model.CreateRayClusterRequest): Promise<$_model.CreateRayClusterResponse>;
     /**
-     * Creates a session cluster.
+     * Creates a session.
      *
      * @param request - CreateSessionClusterRequest
      * @param headers - map
@@ -254,14 +254,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSessionClusterResponse>;
     /**
-     * Creates a session cluster.
+     * Creates a session.
      *
      * @param request - CreateSessionClusterRequest
      * @returns CreateSessionClusterResponse
      */
     createSessionCluster(workspaceId: string, request: $_model.CreateSessionClusterRequest): Promise<$_model.CreateSessionClusterResponse>;
     /**
-     * Creates an SQL statement.
+     * Creates an SQL query.
      *
      * @param request - CreateSqlStatementRequest
      * @param headers - map
@@ -272,7 +272,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSqlStatementResponse>;
     /**
-     * Creates an SQL statement.
+     * Creates an SQL query.
      *
      * @param request - CreateSqlStatementRequest
      * @returns CreateSqlStatementResponse
@@ -453,7 +453,7 @@ export default class Client extends OpenApi {
      */
     generateTaskCodes(bizId: string, request: $_model.GenerateTaskCodesRequest): Promise<$_model.GenerateTaskCodesResponse>;
     /**
-     * Gets the state of an AI center.
+     * Retrieves the status of AI Hub.
      *
      * @param request - GetAICenterStateRequest
      * @param headers - map
@@ -464,7 +464,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetAICenterStateResponse>;
     /**
-     * Gets the state of an AI center.
+     * Retrieves the status of AI Hub.
      *
      * @param request - GetAICenterStateRequest
      * @returns GetAICenterStateResponse
@@ -507,7 +507,7 @@ export default class Client extends OpenApi {
      */
     getCuHours(workspaceId: string, queue: string, request: $_model.GetCuHoursRequest): Promise<$_model.GetCuHoursResponse>;
     /**
-     * Obtains job analysis information on E-MapReduce (EMR) Doctor.
+     * Retrieves the diagnostic information for a Serverless Spark job.
      *
      * @param request - GetDoctorApplicationRequest
      * @param headers - map
@@ -518,14 +518,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetDoctorApplicationResponse>;
     /**
-     * Obtains job analysis information on E-MapReduce (EMR) Doctor.
+     * Retrieves the diagnostic information for a Serverless Spark job.
      *
      * @param request - GetDoctorApplicationRequest
      * @returns GetDoctorApplicationResponse
      */
     getDoctorApplication(workspaceId: string, runId: string, request: $_model.GetDoctorApplicationRequest): Promise<$_model.GetDoctorApplicationResponse>;
     /**
-     * Retrieves the details of a job run by calling GetJobRun.
+     * Retrieves the details of a Spark job run by calling GetJobRun.
      *
      * @param request - GetJobRunRequest
      * @param headers - map
@@ -536,14 +536,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobRunResponse>;
     /**
-     * Retrieves the details of a job run by calling GetJobRun.
+     * Retrieves the details of a Spark job run by calling GetJobRun.
      *
      * @param request - GetJobRunRequest
      * @returns GetJobRunResponse
      */
     getJobRun(workspaceId: string, jobRunId: string, request: $_model.GetJobRunRequest): Promise<$_model.GetJobRunResponse>;
     /**
-     * Retrieves the details of a Kyuubi Gateway.
+     * Retrieves a Kyuubi Gateway.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -553,12 +553,12 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetKyuubiServiceResponse>;
     /**
-     * Retrieves the details of a Kyuubi Gateway.
+     * Retrieves a Kyuubi Gateway.
      * @returns GetKyuubiServiceResponse
      */
     getKyuubiService(workspaceId: string, kyuubiServiceId: string): Promise<$_model.GetKyuubiServiceResponse>;
     /**
-     * Obtains an authentication token for Kyuubi Gateway.
+     * Retrieves the Kyuubi Gateway authentication token.
      *
      * @param request - GetKyuubiTokenRequest
      * @param headers - map
@@ -569,14 +569,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetKyuubiTokenResponse>;
     /**
-     * Obtains an authentication token for Kyuubi Gateway.
+     * Retrieves the Kyuubi Gateway authentication token.
      *
      * @param request - GetKyuubiTokenRequest
      * @returns GetKyuubiTokenResponse
      */
     getKyuubiToken(workspaceId: string, kyuubiServiceId: string, tokenId: string, request: $_model.GetKyuubiTokenRequest): Promise<$_model.GetKyuubiTokenResponse>;
     /**
-     * Retrieves information about a Livy Gateway.
+     * Retrieves the Livy Gateway information.
      *
      * @param request - GetLivyComputeRequest
      * @param headers - map
@@ -587,14 +587,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetLivyComputeResponse>;
     /**
-     * Retrieves information about a Livy Gateway.
+     * Retrieves the Livy Gateway information.
      *
      * @param request - GetLivyComputeRequest
      * @returns GetLivyComputeResponse
      */
     getLivyCompute(workspaceBizId: string, livyComputeId: string, request: $_model.GetLivyComputeRequest): Promise<$_model.GetLivyComputeResponse>;
     /**
-     * Retrieves a token for a Livy Gateway.
+     * Retrieves the token for a Livy Gateway.
      *
      * @param request - GetLivyComputeTokenRequest
      * @param headers - map
@@ -605,7 +605,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetLivyComputeTokenResponse>;
     /**
-     * Retrieves a token for a Livy Gateway.
+     * Retrieves the token for a Livy Gateway.
      *
      * @param request - GetLivyComputeTokenRequest
      * @returns GetLivyComputeTokenResponse
@@ -681,7 +681,7 @@ export default class Client extends OpenApi {
      */
     getRunConfiguration(workspaceId: string, runId: string, request: $_model.GetRunConfigurationRequest): Promise<$_model.GetRunConfigurationResponse>;
     /**
-     * Retrieves session details.
+     * Retrieves the details of a session.
      *
      * @param request - GetSessionClusterRequest
      * @param headers - map
@@ -692,7 +692,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetSessionClusterResponse>;
     /**
-     * Retrieves session details.
+     * Retrieves the details of a session.
      *
      * @param request - GetSessionClusterRequest
      * @returns GetSessionClusterResponse
@@ -734,6 +734,24 @@ export default class Client extends OpenApi {
      * @returns GetTemplateResponse
      */
     getTemplate(workspaceBizId: string, request: $_model.GetTemplateRequest): Promise<$_model.GetTemplateResponse>;
+    /**
+     * Retrieves the details of a workspace.
+     *
+     * @param request - GetWorkspaceRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetWorkspaceResponse
+     */
+    getWorkspaceWithOptions(workspaceId: string, request: $_model.GetWorkspaceRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.GetWorkspaceResponse>;
+    /**
+     * Retrieves the details of a workspace.
+     *
+     * @param request - GetWorkspaceRequest
+     * @returns GetWorkspaceResponse
+     */
+    getWorkspace(workspaceId: string, request: $_model.GetWorkspaceRequest): Promise<$_model.GetWorkspaceResponse>;
     /**
      * Assigns a specified role to users.
      *
@@ -771,7 +789,7 @@ export default class Client extends OpenApi {
      */
     listCatalogs(workspaceId: string, request: $_model.ListCatalogsRequest): Promise<$_model.ListCatalogsResponse>;
     /**
-     * Lists the log files for a job executor.
+     * Lists the log files of a job executor.
      *
      * @param request - ListExecutorLogsRequest
      * @param headers - map
@@ -782,7 +800,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListExecutorLogsResponse>;
     /**
-     * Lists the log files for a job executor.
+     * Lists the log files of a job executor.
      *
      * @param request - ListExecutorLogsRequest
      * @returns ListExecutorLogsResponse
@@ -807,7 +825,7 @@ export default class Client extends OpenApi {
      */
     listJobExecutors(workspaceId: string, jobRunId: string, request: $_model.ListJobExecutorsRequest): Promise<$_model.ListJobExecutorsResponse>;
     /**
-     * Queries a list of Spark jobs.
+     * Lists Spark job runs.
      *
      * @param tmpReq - ListJobRunsRequest
      * @param headers - map
@@ -818,7 +836,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListJobRunsResponse>;
     /**
-     * Queries a list of Spark jobs.
+     * Lists Spark job runs.
      *
      * @param request - ListJobRunsRequest
      * @returns ListJobRunsResponse
@@ -843,7 +861,7 @@ export default class Client extends OpenApi {
      */
     listKyuubiServices(workspaceId: string, request: $_model.ListKyuubiServicesRequest): Promise<$_model.ListKyuubiServicesResponse>;
     /**
-     * Lists Kyuubi Spark applications.
+     * Queries the Spark applications submitted by Kyuubi.
      *
      * @param tmpReq - ListKyuubiSparkApplicationsRequest
      * @param headers - map
@@ -854,14 +872,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListKyuubiSparkApplicationsResponse>;
     /**
-     * Lists Kyuubi Spark applications.
+     * Queries the Spark applications submitted by Kyuubi.
      *
      * @param request - ListKyuubiSparkApplicationsRequest
      * @returns ListKyuubiSparkApplicationsResponse
      */
     listKyuubiSparkApplications(workspaceId: string, kyuubiServiceId: string, request: $_model.ListKyuubiSparkApplicationsRequest): Promise<$_model.ListKyuubiSparkApplicationsResponse>;
     /**
-     * Lists KyuubiServer authentication tokens.
+     * Lists the Kyuubi Server authentication tokens.
      *
      * @param request - ListKyuubiTokenRequest
      * @param headers - map
@@ -872,14 +890,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListKyuubiTokenResponse>;
     /**
-     * Lists KyuubiServer authentication tokens.
+     * Lists the Kyuubi Server authentication tokens.
      *
      * @param request - ListKyuubiTokenRequest
      * @returns ListKyuubiTokenResponse
      */
     listKyuubiToken(workspaceId: string, kyuubiServiceId: string, request: $_model.ListKyuubiTokenRequest): Promise<$_model.ListKyuubiTokenResponse>;
     /**
-     * Lists Livy Gateways.
+     * Lists Livy gateways.
      *
      * @param request - ListLivyComputeRequest
      * @param headers - map
@@ -890,14 +908,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListLivyComputeResponse>;
     /**
-     * Lists Livy Gateways.
+     * Lists Livy gateways.
      *
      * @param request - ListLivyComputeRequest
      * @returns ListLivyComputeResponse
      */
     listLivyCompute(workspaceBizId: string, request: $_model.ListLivyComputeRequest): Promise<$_model.ListLivyComputeResponse>;
     /**
-     * Lists the historical sessions for a Livy Gateway.
+     * Retrieves the historical sessions of a Livy Gateway.
      *
      * @param request - ListLivyComputeSessionsRequest
      * @param headers - map
@@ -908,14 +926,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListLivyComputeSessionsResponse>;
     /**
-     * Lists the historical sessions for a Livy Gateway.
+     * Retrieves the historical sessions of a Livy Gateway.
      *
      * @param request - ListLivyComputeSessionsRequest
      * @returns ListLivyComputeSessionsResponse
      */
     listLivyComputeSessions(workspaceId: string, livyComputeId: string, request: $_model.ListLivyComputeSessionsRequest): Promise<$_model.ListLivyComputeSessionsResponse>;
     /**
-     * Lists the tokens of a Livy Gateway.
+     * Lists the tokens of a Livy gateway.
      *
      * @param request - ListLivyComputeTokenRequest
      * @param headers - map
@@ -926,7 +944,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListLivyComputeTokenResponse>;
     /**
-     * Lists the tokens of a Livy Gateway.
+     * Lists the tokens of a Livy gateway.
      *
      * @param request - ListLivyComputeTokenRequest
      * @returns ListLivyComputeTokenResponse
@@ -951,7 +969,7 @@ export default class Client extends OpenApi {
      */
     listLogContents(workspaceId: string, request: $_model.ListLogContentsRequest): Promise<$_model.ListLogContentsResponse>;
     /**
-     * Retrieves the list of members in the workspace.
+     * Queries the list of members in a workspace.
      *
      * @param request - ListMembersRequest
      * @param headers - map
@@ -962,7 +980,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListMembersResponse>;
     /**
-     * Retrieves the list of members in the workspace.
+     * Queries the list of members in a workspace.
      *
      * @param request - ListMembersRequest
      * @returns ListMembersResponse
@@ -986,6 +1004,24 @@ export default class Client extends OpenApi {
      * @returns ListNetworkServicesResponse
      */
     listNetworkServices(workspaceId: string, request: $_model.ListNetworkServicesRequest): Promise<$_model.ListNetworkServicesResponse>;
+    /**
+     * Queries the jobs with the highest CU usage in a queue.
+     *
+     * @param request - ListQueueTopJobsRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListQueueTopJobsResponse
+     */
+    listQueueTopJobsWithOptions(workspaceId: string, queueName: string, request: $_model.ListQueueTopJobsRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.ListQueueTopJobsResponse>;
+    /**
+     * Queries the jobs with the highest CU usage in a queue.
+     *
+     * @param request - ListQueueTopJobsRequest
+     * @returns ListQueueTopJobsResponse
+     */
+    listQueueTopJobs(workspaceId: string, queueName: string, request: $_model.ListQueueTopJobsRequest): Promise<$_model.ListQueueTopJobsResponse>;
     /**
      * Lists Ray clusters.
      *
@@ -1005,7 +1041,7 @@ export default class Client extends OpenApi {
      */
     listRayCluster(workspaceId: string, request: $_model.ListRayClusterRequest): Promise<$_model.ListRayClusterResponse>;
     /**
-     * Lists Ray Job information.
+     * Lists Ray job information.
      *
      * @param tmpReq - ListRayJobRequest
      * @param headers - map
@@ -1016,7 +1052,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListRayJobResponse>;
     /**
-     * Lists Ray Job information.
+     * Lists Ray job information.
      *
      * @param request - ListRayJobRequest
      * @returns ListRayJobResponse
@@ -1059,7 +1095,7 @@ export default class Client extends OpenApi {
      */
     listReleaseVersions(request: $_model.ListReleaseVersionsRequest): Promise<$_model.ListReleaseVersionsResponse>;
     /**
-     * Retrieves a list of session clusters.
+     * Retrieves a list of sessions.
      *
      * @param request - ListSessionClustersRequest
      * @param headers - map
@@ -1070,7 +1106,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListSessionClustersResponse>;
     /**
-     * Retrieves a list of session clusters.
+     * Retrieves a list of sessions.
      *
      * @param request - ListSessionClustersRequest
      * @returns ListSessionClustersResponse
@@ -1113,7 +1149,7 @@ export default class Client extends OpenApi {
      */
     listTemplate(workspaceBizId: string, request: $_model.ListTemplateRequest): Promise<$_model.ListTemplateResponse>;
     /**
-     * Queries the list of queues in a workspace.
+     * Queries the queues in a workspace.
      *
      * @param request - ListWorkspaceQueuesRequest
      * @param headers - map
@@ -1124,14 +1160,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListWorkspaceQueuesResponse>;
     /**
-     * Queries the list of queues in a workspace.
+     * Queries the queues in a workspace.
      *
      * @param request - ListWorkspaceQueuesRequest
      * @returns ListWorkspaceQueuesResponse
      */
     listWorkspaceQueues(workspaceId: string, request: $_model.ListWorkspaceQueuesRequest): Promise<$_model.ListWorkspaceQueuesResponse>;
     /**
-     * Queries a list of workspaces.
+     * Retrieves a list of workspaces.
      *
      * @param tmpReq - ListWorkspacesRequest
      * @param headers - map
@@ -1142,7 +1178,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListWorkspacesResponse>;
     /**
-     * Queries a list of workspaces.
+     * Retrieves a list of workspaces.
      *
      * @param request - ListWorkspacesRequest
      * @returns ListWorkspacesResponse
@@ -1485,7 +1521,7 @@ export default class Client extends OpenApi {
      */
     updateLivyCompute(workspaceBizId: string, livyComputeId: string, request: $_model.UpdateLivyComputeRequest): Promise<$_model.UpdateLivyComputeResponse>;
     /**
-     * Updates a workflow definition and its timed scheduling.
+     * Updates the workflow definition and timed scheduling.
      *
      * @param tmpReq - UpdateProcessDefinitionWithScheduleRequest
      * @param headers - map
@@ -1496,7 +1532,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateProcessDefinitionWithScheduleResponse>;
     /**
-     * Updates a workflow definition and its timed scheduling.
+     * Updates the workflow definition and timed scheduling.
      *
      * @param request - UpdateProcessDefinitionWithScheduleRequest
      * @returns UpdateProcessDefinitionWithScheduleResponse
@@ -1521,7 +1557,7 @@ export default class Client extends OpenApi {
      */
     updateRayCluster(workspaceId: string, clusterId: string, request: $_model.UpdateRayClusterRequest): Promise<$_model.UpdateRayClusterResponse>;
     /**
-     * Updates the properties of a workspace.
+     * Updates the attributes of a workspace.
      *
      * @param request - UpdateWorkspaceRequest
      * @param headers - map
@@ -1532,7 +1568,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateWorkspaceResponse>;
     /**
-     * Updates the properties of a workspace.
+     * Updates the attributes of a workspace.
      *
      * @param request - UpdateWorkspaceRequest
      * @returns UpdateWorkspaceResponse