@alicloud/dataworks-public20240518 9.9.3 → 9.10.0

package/dist/client.d.ts

@@ -464,6 +464,27 @@ export default class Client extends OpenApi {
      * @returns CreateBusinessResponse
      */
     createBusiness(request: $_model.CreateBusinessRequest): Promise<$_model.CreateBusinessResponse>;
+    /**
+     * Creates a scheduling calendar.
+     *
+     * @remarks
+     * You must purchase DataWorks Enterprise Edition to use this feature.
+     *
+     * @param tmpReq - CreateCalendarRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateCalendarResponse
+     */
+    createCalendarWithOptions(tmpReq: $_model.CreateCalendarRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateCalendarResponse>;
+    /**
+     * Creates a scheduling calendar.
+     *
+     * @remarks
+     * You must purchase DataWorks Enterprise Edition to use this feature.
+     *
+     * @param request - CreateCalendarRequest
+     * @returns CreateCalendarResponse
+     */
+    createCalendar(request: $_model.CreateCalendarRequest): Promise<$_model.CreateCalendarResponse>;
     /**
      * Creates a component.
      *
@@ -1512,10 +1533,10 @@ export default class Client extends OpenApi {
      */
     createWorkflowDefinition(request: $_model.CreateWorkflowDefinitionRequest): Promise<$_model.CreateWorkflowDefinitionResponse>;
     /**
-     * Creates a workflow instance based on the specified configurations, such as a data backfill workflow instance.
+     * Creates a workflow instance based on configurations, such as a data backfill workflow instance.
      *
      * @remarks
-     * DataWorks Basic Edition or later is required.
+     * You must purchase DataWorks Basic Edition or a later edition to use this feature.
      *
      * @param tmpReq - CreateWorkflowInstancesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1523,10 +1544,10 @@ export default class Client extends OpenApi {
      */
     createWorkflowInstancesWithOptions(tmpReq: $_model.CreateWorkflowInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateWorkflowInstancesResponse>;
     /**
-     * Creates a workflow instance based on the specified configurations, such as a data backfill workflow instance.
+     * Creates a workflow instance based on configurations, such as a data backfill workflow instance.
      *
      * @remarks
-     * DataWorks Basic Edition or later is required.
+     * You must purchase DataWorks Basic Edition or a later edition to use this feature.
      *
      * @param request - CreateWorkflowInstancesRequest
      * @returns CreateWorkflowInstancesResponse
@@ -1585,6 +1606,29 @@ export default class Client extends OpenApi {
      * @returns DeleteBusinessResponse
      */
     deleteBusiness(request: $_model.DeleteBusinessRequest): Promise<$_model.DeleteBusinessResponse>;
+    /**
+     * Deletes a scheduling calendar.
+     *
+     * @remarks
+     * DataWorks Enterprise Edition is required.
+     * You cannot delete a scheduling calendar that is referenced by nodes. Remove the node references first.
+     *
+     * @param request - DeleteCalendarRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteCalendarResponse
+     */
+    deleteCalendarWithOptions(request: $_model.DeleteCalendarRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteCalendarResponse>;
+    /**
+     * Deletes a scheduling calendar.
+     *
+     * @remarks
+     * DataWorks Enterprise Edition is required.
+     * You cannot delete a scheduling calendar that is referenced by nodes. Remove the node references first.
+     *
+     * @param request - DeleteCalendarRequest
+     * @returns DeleteCalendarResponse
+     */
+    deleteCalendar(request: $_model.DeleteCalendarRequest): Promise<$_model.DeleteCalendarResponse>;
     /**
      * Deletes a certificate file.
      *
@@ -2846,11 +2890,11 @@ export default class Client extends OpenApi {
      */
     executeAdhocWorkflowInstance(request: $_model.ExecuteAdhocWorkflowInstanceRequest): Promise<$_model.ExecuteAdhocWorkflowInstanceResponse>;
     /**
-     * Find the security policy that best matches the given conditions.
+     * Queries the best-matching security policy based on specified conditions.
      *
      * @remarks
-     * ## Request Description
-     * This API is used to find the most suitable security policy based on the provided control module, sub-module, and workspace ID. If a workspace ID is provided, the policy at the specified workspace level is matched first; otherwise, the tenant-level policy is returned. Note that system policies cannot be deleted or modified.
+     * ## Operation description
+     * This API operation queries the most suitable security policy based on the provided control module, submodule, and workspace ID. If a workspace ID is provided, the system preferentially matches policies at the specified workspace level. Otherwise, tenant-level policies are returned. Note that system policies cannot be deleted or modified.
      *
      * @param request - FindBestMatchSecurityStrategyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2858,11 +2902,11 @@ export default class Client extends OpenApi {
      */
     findBestMatchSecurityStrategyWithOptions(request: $_model.FindBestMatchSecurityStrategyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.FindBestMatchSecurityStrategyResponse>;
     /**
-     * Find the security policy that best matches the given conditions.
+     * Queries the best-matching security policy based on specified conditions.
      *
      * @remarks
-     * ## Request Description
-     * This API is used to find the most suitable security policy based on the provided control module, sub-module, and workspace ID. If a workspace ID is provided, the policy at the specified workspace level is matched first; otherwise, the tenant-level policy is returned. Note that system policies cannot be deleted or modified.
+     * ## Operation description
+     * This API operation queries the most suitable security policy based on the provided control module, submodule, and workspace ID. If a workspace ID is provided, the system preferentially matches policies at the specified workspace level. Otherwise, tenant-level policies are returned. Note that system policies cannot be deleted or modified.
      *
      * @param request - FindBestMatchSecurityStrategyRequest
      * @returns FindBestMatchSecurityStrategyResponse
@@ -3013,6 +3057,27 @@ export default class Client extends OpenApi {
      * @returns GetBusinessResponse
      */
     getBusiness(request: $_model.GetBusinessRequest): Promise<$_model.GetBusinessResponse>;
+    /**
+     * Retrieves the current configuration of a specified scheduling calendar.
+     *
+     * @remarks
+     * DataWorks Enterprise Edition is required to use this API.
+     *
+     * @param request - GetCalendarRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetCalendarResponse
+     */
+    getCalendarWithOptions(request: $_model.GetCalendarRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetCalendarResponse>;
+    /**
+     * Retrieves the current configuration of a specified scheduling calendar.
+     *
+     * @remarks
+     * DataWorks Enterprise Edition is required to use this API.
+     *
+     * @param request - GetCalendarRequest
+     * @returns GetCalendarResponse
+     */
+    getCalendar(request: $_model.GetCalendarRequest): Promise<$_model.GetCalendarResponse>;
     /**
      * Retrieves the details of a specified data catalog in DataWorks Data Map. Currently, DLF and StarRocks catalog types are supported.
      *
@@ -4163,14 +4228,14 @@ export default class Client extends OpenApi {
      */
     getSchema(request: $_model.GetSchemaRequest): Promise<$_model.GetSchemaResponse>;
     /**
-     * Retrieves the details of a security policy by its ID. This operation requires both DataWorks tenant administrator and security administrator permissions.
+     * Retrieves the details of a security policy based on the provided security policy ID.
      *
      * @remarks
-     * ## Request
-     * - This API retrieves the complete configuration information for a security policy by its ID.
-     * - The API returns an error message if the provided `Id` is invalid or does not exist.
-     * - The response includes basic policy information, such as its name and description, and policy details, such as control items and their settings.
-     * - Note: Some fields in a system default policy cannot be modified or deleted.
+     * ## Request description
+     * - This API retrieves all configuration information of a specific security policy by using the specified security policy ID.
+     * - Ensure that the provided `Id` parameter value is valid and exists. Otherwise, an error message is returned.
+     * - The returned data structure includes the basic information of the policy, such as the name and description, and the detailed policy content, such as control items and their settings.
+     * - Note: Some fields of system default policies may be protected from modification or deletion.
      *
      * @param request - GetSecurityStrategyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -4178,14 +4243,14 @@ export default class Client extends OpenApi {
      */
     getSecurityStrategyWithOptions(request: $_model.GetSecurityStrategyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetSecurityStrategyResponse>;
     /**
-     * Retrieves the details of a security policy by its ID. This operation requires both DataWorks tenant administrator and security administrator permissions.
+     * Retrieves the details of a security policy based on the provided security policy ID.
      *
      * @remarks
-     * ## Request
-     * - This API retrieves the complete configuration information for a security policy by its ID.
-     * - The API returns an error message if the provided `Id` is invalid or does not exist.
-     * - The response includes basic policy information, such as its name and description, and policy details, such as control items and their settings.
-     * - Note: Some fields in a system default policy cannot be modified or deleted.
+     * ## Request description
+     * - This API retrieves all configuration information of a specific security policy by using the specified security policy ID.
+     * - Ensure that the provided `Id` parameter value is valid and exists. Otherwise, an error message is returned.
+     * - The returned data structure includes the basic information of the policy, such as the name and description, and the detailed policy content, such as control items and their settings.
+     * - Note: Some fields of system default policies may be protected from modification or deletion.
      *
      * @param request - GetSecurityStrategyRequest
      * @returns GetSecurityStrategyResponse
@@ -4704,6 +4769,48 @@ export default class Client extends OpenApi {
      * @returns ListBusinessResponse
      */
     listBusiness(request: $_model.ListBusinessRequest): Promise<$_model.ListBusinessResponse>;
+    /**
+     * Queries the versions of a specified scheduling calendar.
+     *
+     * @remarks
+     * DataWorks Enterprise Edition is required.
+     *
+     * @param request - ListCalendarVersionsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListCalendarVersionsResponse
+     */
+    listCalendarVersionsWithOptions(request: $_model.ListCalendarVersionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCalendarVersionsResponse>;
+    /**
+     * Queries the versions of a specified scheduling calendar.
+     *
+     * @remarks
+     * DataWorks Enterprise Edition is required.
+     *
+     * @param request - ListCalendarVersionsRequest
+     * @returns ListCalendarVersionsResponse
+     */
+    listCalendarVersions(request: $_model.ListCalendarVersionsRequest): Promise<$_model.ListCalendarVersionsResponse>;
+    /**
+     * Queries a list of scheduling calendars.
+     *
+     * @remarks
+     * DataWorks Enterprise Edition is required.
+     *
+     * @param request - ListCalendarsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListCalendarsResponse
+     */
+    listCalendarsWithOptions(request: $_model.ListCalendarsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCalendarsResponse>;
+    /**
+     * Queries a list of scheduling calendars.
+     *
+     * @remarks
+     * DataWorks Enterprise Edition is required.
+     *
+     * @param request - ListCalendarsRequest
+     * @returns ListCalendarsResponse
+     */
+    listCalendars(request: $_model.ListCalendarsRequest): Promise<$_model.ListCalendarsResponse>;
     /**
      * Queries a list of catalogs in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks metadata crawler types are supported. For the DLF metadata crawler type, all supported data catalogs are returned. For the StarRocks metadata crawler type, data catalogs in a specific instance are returned.
      *
@@ -6167,10 +6274,10 @@ export default class Client extends OpenApi {
      */
     listProjectMembers(request: $_model.ListProjectMembersRequest): Promise<$_model.ListProjectMembersResponse>;
     /**
-     * Queries the details of workspace roles with pagination.
+     * Queries the details of workspace roles by paging.
      *
      * @remarks
-     * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
+     * You must purchase DataWorks Basic Edition or later to use this operation.
      *
      * @param tmpReq - ListProjectRolesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -6178,10 +6285,10 @@ export default class Client extends OpenApi {
      */
     listProjectRolesWithOptions(tmpReq: $_model.ListProjectRolesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListProjectRolesResponse>;
     /**
-     * Queries the details of workspace roles with pagination.
+     * Queries the details of workspace roles by paging.
      *
      * @remarks
-     * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
+     * You must purchase DataWorks Basic Edition or later to use this operation.
      *
      * @param request - ListProjectRolesRequest
      * @returns ListProjectRolesResponse
@@ -6339,14 +6446,14 @@ export default class Client extends OpenApi {
      */
     listSchemas(request: $_model.ListSchemasRequest): Promise<$_model.ListSchemasResponse>;
     /**
-     * Retrieves a paginated list of security policies based on specified conditions. This operation requires DataWorks tenant administrator or security administrator permissions.
+     * Retrieves a paginated list of security policies in the system based on specified conditions. This operation requires DataWorks tenant administrator and security administrator permissions.
      *
      * @remarks
-     * ## Request
-     * - This API retrieves a paginated list of configured security policies.
-     * - The `ControlModule` and `ControlSubModule` parameters filter policies by a specific module or submodule.
-     * - The `PageNum` and `PageSize` parameters control pagination. `PageNum` specifies the page number to retrieve (default: 1), and `PageSize` specifies the number of policies to return per page (default: 20).
-     * - Use the `MaxResults` and `NextToken` private parameters for advanced pagination.
+     * ## Request description
+     * - This operation retrieves the configured security policies in the system in pages.
+     * - You can use the `ControlModule` and `ControlSubModule` parameters to filter policies under specific modules or submodules.
+     * - The pagination parameters include `PageNum` and `PageSize`, which indicate the page number and the number of entries per page. The default values are 1 and 20.
+     * - If you need further pagination control, you can use the `MaxResults` and `NextToken` parameters (private parameters).
      *
      * @param request - ListSecurityStrategiesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -6354,14 +6461,14 @@ export default class Client extends OpenApi {
      */
     listSecurityStrategiesWithOptions(request: $_model.ListSecurityStrategiesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListSecurityStrategiesResponse>;
     /**
-     * Retrieves a paginated list of security policies based on specified conditions. This operation requires DataWorks tenant administrator or security administrator permissions.
+     * Retrieves a paginated list of security policies in the system based on specified conditions. This operation requires DataWorks tenant administrator and security administrator permissions.
      *
      * @remarks
-     * ## Request
-     * - This API retrieves a paginated list of configured security policies.
-     * - The `ControlModule` and `ControlSubModule` parameters filter policies by a specific module or submodule.
-     * - The `PageNum` and `PageSize` parameters control pagination. `PageNum` specifies the page number to retrieve (default: 1), and `PageSize` specifies the number of policies to return per page (default: 20).
-     * - Use the `MaxResults` and `NextToken` private parameters for advanced pagination.
+     * ## Request description
+     * - This operation retrieves the configured security policies in the system in pages.
+     * - You can use the `ControlModule` and `ControlSubModule` parameters to filter policies under specific modules or submodules.
+     * - The pagination parameters include `PageNum` and `PageSize`, which indicate the page number and the number of entries per page. The default values are 1 and 20.
+     * - If you need further pagination control, you can use the `MaxResults` and `NextToken` parameters (private parameters).
      *
      * @param request - ListSecurityStrategiesRequest
      * @returns ListSecurityStrategiesResponse
@@ -6547,10 +6654,10 @@ export default class Client extends OpenApi {
      */
     listSnapshots(request: $_model.ListSnapshotsRequest): Promise<$_model.ListSnapshotsResponse>;
     /**
-     * Queries the list of data tables in DataWorks Data Map. For types that do not support the schema level, you can query data tables under a specified database. For types that support the schema level, you can query data tables under a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical metadata or business metadata.
+     * Queries the tables in Data Map. For types that do not support the schema level, this operation queries the tables in a specified database. For types that support the schema level, this operation queries the tables in a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical or business metadata. For non-MaxCompute types, the response is not real-time and may be delayed by up to 1 hour compared to the metadata collection results.
      *
      * @remarks
-     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
+     * 1. You must purchase DataWorks Basic Edition or later to use this API.
      *
      * @param tmpReq - ListTablesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -6558,10 +6665,10 @@ export default class Client extends OpenApi {
      */
     listTablesWithOptions(tmpReq: $_model.ListTablesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListTablesResponse>;
     /**
-     * Queries the list of data tables in DataWorks Data Map. For types that do not support the schema level, you can query data tables under a specified database. For types that support the schema level, you can query data tables under a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical metadata or business metadata.
+     * Queries the tables in Data Map. For types that do not support the schema level, this operation queries the tables in a specified database. For types that support the schema level, this operation queries the tables in a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical or business metadata. For non-MaxCompute types, the response is not real-time and may be delayed by up to 1 hour compared to the metadata collection results.
      *
      * @remarks
-     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
+     * 1. You must purchase DataWorks Basic Edition or later to use this API.
      *
      * @param request - ListTablesRequest
      * @returns ListTablesResponse
@@ -7716,6 +7823,29 @@ export default class Client extends OpenApi {
      * @returns UpdateBusinessResponse
      */
     updateBusiness(request: $_model.UpdateBusinessRequest): Promise<$_model.UpdateBusinessResponse>;
+    /**
+     * Updates a scheduling calendar. This is a full update that requires you to submit the complete editable configuration.
+     *
+     * @remarks
+     * You must purchase DataWorks Enterprise Edition to use this feature.
+     * The calendar name cannot be modified. Unsubmitted dates are not retained.
+     *
+     * @param tmpReq - UpdateCalendarRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns UpdateCalendarResponse
+     */
+    updateCalendarWithOptions(tmpReq: $_model.UpdateCalendarRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateCalendarResponse>;
+    /**
+     * Updates a scheduling calendar. This is a full update that requires you to submit the complete editable configuration.
+     *
+     * @remarks
+     * You must purchase DataWorks Enterprise Edition to use this feature.
+     * The calendar name cannot be modified. Unsubmitted dates are not retained.
+     *
+     * @param request - UpdateCalendarRequest
+     * @returns UpdateCalendarResponse
+     */
+    updateCalendar(request: $_model.UpdateCalendarRequest): Promise<$_model.UpdateCalendarResponse>;
     /**
      * Updates the business metadata for a column in a data map. This operation can only update the business description and custom attributes.
      *