@aws-sdk/client-datazone 3.1153.0 → 3.1155.0

package/dist-types/commands/UpdateDesignationCommand.d.ts

@@ -0,0 +1,106 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateDesignationInput, UpdateDesignationOutput } from "../models/models_2";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link UpdateDesignationCommand}.
+ */
+export interface UpdateDesignationCommandInput extends UpdateDesignationInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateDesignationCommand}.
+ */
+export interface UpdateDesignationCommandOutput extends UpdateDesignationOutput, __MetadataBearer {
+}
+declare const UpdateDesignationCommand_base: {
+    new (input: UpdateDesignationCommandInput): import("@smithy/core/client").CommandImpl<UpdateDesignationCommandInput, UpdateDesignationCommandOutput, import("..").DataZoneClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: UpdateDesignationCommandInput): import("@smithy/core/client").CommandImpl<UpdateDesignationCommandInput, UpdateDesignationCommandOutput, import("..").DataZoneClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Updates an existing designation. Managed designations cannot be modified.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DataZoneClient, UpdateDesignationCommand } from "@aws-sdk/client-datazone"; // ES Modules import
+ * // const { DataZoneClient, UpdateDesignationCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
+ * // import type { DataZoneClientConfig } from "@aws-sdk/client-datazone";
+ * const config = {}; // type is DataZoneClientConfig
+ * const client = new DataZoneClient(config);
+ * const input = { // UpdateDesignationInput
+ *   domainIdentifier: "STRING_VALUE", // required
+ *   identifier: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ *   description: "STRING_VALUE",
+ *   policy: "STRING_VALUE",
+ *   deletionProtection: true || false,
+ * };
+ * const command = new UpdateDesignationCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateDesignationOutput
+ * //   domainId: "STRING_VALUE", // required
+ * //   id: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE", // required
+ * //   description: "STRING_VALUE",
+ * //   designationType: "MANAGED" || "USER_CREATED", // required
+ * //   policy: "STRING_VALUE", // required
+ * //   deletionProtection: true || false, // required
+ * //   createdBy: "STRING_VALUE", // required
+ * //   createdAt: new Date("TIMESTAMP"),
+ * //   lastUpdatedAt: new Date("TIMESTAMP"),
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateDesignationCommandInput - {@link UpdateDesignationCommandInput}
+ * @returns {@link UpdateDesignationCommandOutput}
+ * @see {@link UpdateDesignationCommandInput} for command's `input` shape.
+ * @see {@link UpdateDesignationCommandOutput} for command's `response` shape.
+ * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>There is a conflict while performing this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request has failed because of an unknown error, exception or failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource cannot be found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *  <p>You do not have permission to perform this action.</p>
+ *
+ * @throws {@link DataZoneServiceException}
+ * <p>Base exception class for all service exceptions from DataZone service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateDesignationCommand extends UpdateDesignationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateDesignationInput;
+            output: UpdateDesignationOutput;
+        };
+        sdk: {
+            input: UpdateDesignationCommandInput;
+            output: UpdateDesignationCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateNotebookCommand.d.ts

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { UpdateNotebookInput, UpdateNotebookOutput } from "../models/models_1";
+import type { UpdateNotebookInput, UpdateNotebookOutput } from "../models/models_2";
 /**
  * @public
  */

package/dist-types/commands/index.d.ts

@@ -17,6 +17,7 @@ export * from "./CreateConnectionCommand";
 export * from "./CreateDataProductCommand";
 export * from "./CreateDataProductRevisionCommand";
 export * from "./CreateDataSourceCommand";
+export * from "./CreateDesignationCommand";
 export * from "./CreateDomainCommand";
 export * from "./CreateDomainUnitCommand";
 export * from "./CreateEnvironmentActionCommand";
@@ -45,6 +46,7 @@ export * from "./DeleteConnectionCommand";
 export * from "./DeleteDataExportConfigurationCommand";
 export * from "./DeleteDataProductCommand";
 export * from "./DeleteDataSourceCommand";
+export * from "./DeleteDesignationCommand";
 export * from "./DeleteDomainCommand";
 export * from "./DeleteDomainUnitCommand";
 export * from "./DeleteEnvironmentActionCommand";
@@ -77,6 +79,7 @@ export * from "./GetDataExportConfigurationCommand";
 export * from "./GetDataProductCommand";
 export * from "./GetDataSourceCommand";
 export * from "./GetDataSourceRunCommand";
+export * from "./GetDesignationCommand";
 export * from "./GetDomainCommand";
 export * from "./GetDomainUnitCommand";
 export * from "./GetEnvironmentActionCommand";
@@ -116,6 +119,7 @@ export * from "./ListDataProductRevisionsCommand";
 export * from "./ListDataSourceRunActivitiesCommand";
 export * from "./ListDataSourceRunsCommand";
 export * from "./ListDataSourcesCommand";
+export * from "./ListDesignationsCommand";
 export * from "./ListDomainUnitsForParentCommand";
 export * from "./ListDomainsCommand";
 export * from "./ListEntityOwnersCommand";
@@ -170,6 +174,7 @@ export * from "./UpdateAccountPoolCommand";
 export * from "./UpdateAssetFilterCommand";
 export * from "./UpdateConnectionCommand";
 export * from "./UpdateDataSourceCommand";
+export * from "./UpdateDesignationCommand";
 export * from "./UpdateDomainCommand";
 export * from "./UpdateDomainUnitCommand";
 export * from "./UpdateEnvironmentActionCommand";

package/dist-types/models/enums.d.ts

@@ -114,6 +114,7 @@ export declare const ProjectDesignation: {
     readonly CONTRIBUTOR: "CONTRIBUTOR";
     readonly OWNER: "OWNER";
     readonly PROJECT_CATALOG_STEWARD: "PROJECT_CATALOG_STEWARD";
+    readonly USER_CREATED_DESIGNATION: "USER_CREATED_DESIGNATION";
 };
 /**
  * @public
@@ -617,6 +618,24 @@ export declare const DataSourceStatus: {
  * @public
  */
 export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSourceStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const DesignationType: {
+    /**
+     * System-defined designation that cannot be modified or deleted.
+     */
+    readonly MANAGED: "MANAGED";
+    /**
+     * Created by a user via the CreateDesignation API.
+     */
+    readonly USER_CREATED: "USER_CREATED";
+};
+/**
+ * @public
+ */
+export type DesignationType = (typeof DesignationType)[keyof typeof DesignationType];
 /**
  * @public
  * @enum
@@ -846,6 +865,7 @@ export declare const UserDesignation: {
     readonly PROJECT_CATALOG_VIEWER: "PROJECT_CATALOG_VIEWER";
     readonly PROJECT_CONTRIBUTOR: "PROJECT_CONTRIBUTOR";
     readonly PROJECT_OWNER: "PROJECT_OWNER";
+    readonly USER_CREATED_DESIGNATION: "USER_CREATED_DESIGNATION";
 };
 /**
  * @public

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,4 @@
-import type { AcceptRuleBehavior, AttributeEntityType, AuthenticationType, AuthType, BlueprintCategory, ChangeAction, ComputeEnvironments, ConfigurableActionTypeAuthorization, ConnectionScope, ConnectionStatus, ConnectionType, DataProductItemType, DataProductStatus, DataSourceErrorType, DataSourceRunStatus, DataSourceStatus, DataZoneEntityType, DeploymentMode, DeploymentStatus, DeploymentType, DomainStatus, DomainUnitDesignation, DomainVersion, EnableSetting, EntityType, EnvironmentStatus, FilterExpressionType, FilterStatus, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GlueConnectionType, GovernanceType, GovernedEntityType, GroupProfileStatus, HyperPodOrchestrator, ListingStatus, ManagedPolicyType, NotebookStatus, NotebookType, OAuth2GrantType, OverallDeploymentStatus, PackageManager, ProjectDesignation, ProjectStatus, Protocol, ResolutionStrategy, ResourceTagSource, RuleScopeSelectionMode, S3Permission, Status, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, Timezone, UserAssignment, UserDesignation } from "./enums";
+import type { AcceptRuleBehavior, AttributeEntityType, AuthenticationType, AuthType, BlueprintCategory, ChangeAction, ComputeEnvironments, ConfigurableActionTypeAuthorization, ConnectionScope, ConnectionStatus, ConnectionType, DataProductItemType, DataProductStatus, DataSourceErrorType, DataSourceRunStatus, DataSourceStatus, DataZoneEntityType, DeploymentMode, DeploymentStatus, DeploymentType, DesignationType, DomainStatus, DomainUnitDesignation, DomainVersion, EnableSetting, EntityType, EnvironmentStatus, FilterExpressionType, FilterStatus, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GlueConnectionType, GovernanceType, GovernedEntityType, GroupProfileStatus, HyperPodOrchestrator, ListingStatus, ManagedPolicyType, NotebookStatus, NotebookType, OAuth2GrantType, OverallDeploymentStatus, PackageManager, ProjectDesignation, ProjectStatus, Protocol, ResolutionStrategy, ResourceTagSource, RuleScopeSelectionMode, S3Permission, Status, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, Timezone, UserAssignment, UserDesignation } from "./enums";
 /**
  * <p>Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.</p>
  * @public
@@ -1653,6 +1653,11 @@ export interface ProjectPolicyGrantPrincipal {
      * @public
      */
     projectDesignation: ProjectDesignation | undefined;
+    /**
+     * <p>The ID of the user-created designation granted to the project principal. Required when <code>projectDesignation</code> is <code>USER_CREATED_DESIGNATION</code>; must not be provided otherwise.</p>
+     * @public
+     */
+    userCreatedDesignationId?: string | undefined;
     /**
      * <p>The project ID of the project policy grant principal.</p>
      * @public
@@ -8198,6 +8203,97 @@ export interface CreateDataSourceOutput {
      */
     updatedAt?: Date | undefined;
 }
+/**
+ * @public
+ */
+export interface CreateDesignationInput {
+    /**
+     * <p>The identifier of the Amazon DataZone domain in which the designation is created.</p>
+     * @public
+     */
+    domainIdentifier: string | undefined;
+    /**
+     * <p>The name of the designation. The name must be unique within the domain.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>A human-readable description of the designation and its intended use.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * The Cedar permit policy that defines what actions holders of this
+     * designation are allowed to perform.
+     * @public
+     */
+    policy: string | undefined;
+    /**
+     * Whether deletion protection is enabled for this designation. Defaults to true when omitted.
+     * @public
+     */
+    deletionProtection?: boolean | undefined;
+}
+/**
+ * A designation defines a named role with a Cedar permit policy that controls
+ * what actions members holding this designation can perform within a project.
+ * @public
+ */
+export interface CreateDesignationOutput {
+    /**
+     * <p>The identifier of the Amazon DataZone domain in which the designation was created.</p>
+     * @public
+     */
+    domainId: string | undefined;
+    /**
+     * <p>The unique ID of the designation.</p>
+     * @public
+     */
+    id: string | undefined;
+    /**
+     * <p>The name of the designation. The name is unique within the domain.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>A human-readable description of the designation and its intended use.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * The classification of this designation. MANAGED designations are
+     * system-defined and cannot be modified or deleted.
+     * @public
+     */
+    designationType: DesignationType | undefined;
+    /**
+     * The Cedar permit policy that governs what actions holders of this
+     * designation are allowed to perform.
+     * @public
+     */
+    policy: string | undefined;
+    /**
+     * Whether deletion protection is enabled for this designation. When true,
+     * DeleteDesignation is rejected until protection is disabled via UpdateDesignation.
+     * @public
+     */
+    deletionProtection: boolean | undefined;
+    /**
+     * <p>The identifier of the Amazon DataZone user who created the designation.</p>
+     * @public
+     */
+    createdBy: string | undefined;
+    /**
+     * <p>The date and time when the designation was created.</p>
+     * @public
+     */
+    createdAt?: Date | undefined;
+    /**
+     * <p>The date and time when the designation was last updated.</p>
+     * @public
+     */
+    lastUpdatedAt?: Date | undefined;
+}
 /**
  * <p>The single sign-on details in Amazon DataZone.</p>
  * @public
@@ -9843,6 +9939,11 @@ export interface ProjectMembershipAssignment {
      * @public
      */
     designation: UserDesignation | undefined;
+    /**
+     * <p>The ID of the user-created designation to assign to this member when creating the project. Required when <code>designation</code> is <code>USER_CREATED_DESIGNATION</code>; must not be provided otherwise.</p>
+     * @public
+     */
+    userCreatedDesignationId?: string | undefined;
 }
 /**
  * <p>Specifies the account/Region that is to be used during project creation for a particular blueprint.</p>
@@ -10113,6 +10214,11 @@ export interface CreateProjectMembershipInput {
      * @public
      */
     designation: UserDesignation | undefined;
+    /**
+     * <p>The ID of the user-created designation to assign to the project member. Required when <code>designation</code> is <code>USER_CREATED_DESIGNATION</code>; must not be provided otherwise.</p>
+     * @public
+     */
+    userCreatedDesignationId?: string | undefined;
 }
 /**
  * @public
@@ -10333,84 +10439,3 @@ export interface CreateProjectProfileInput {
      */
     domainUnitIdentifier?: string | undefined;
 }
-/**
- * @public
- */
-export interface CreateProjectProfileOutput {
-    /**
-     * <p>The ID of the domain where a project profile is created.</p>
-     * @public
-     */
-    domainId: string | undefined;
-    /**
-     * <p>Project profile ID.</p>
-     * @public
-     */
-    id: string | undefined;
-    /**
-     * <p>Project profile name.</p>
-     * @public
-     */
-    name: string | undefined;
-    /**
-     * <p>A project profile description.</p>
-     * @public
-     */
-    description?: string | undefined;
-    /**
-     * <p>Project profile status.</p>
-     * @public
-     */
-    status?: Status | undefined;
-    /**
-     * <p>The resource tags of the project profile.</p>
-     * @public
-     */
-    projectResourceTags?: ResourceTagParameter[] | undefined;
-    /**
-     * <p>Specifies whether custom project resource tags are supported.</p>
-     * @public
-     */
-    allowCustomProjectResourceTags?: boolean | undefined;
-    /**
-     * <p>Field viewable through the UI that provides a project user with the allowed resource tag specifications.</p>
-     * @public
-     */
-    projectResourceTagsDescription?: string | undefined;
-    /**
-     * <p>Environment configurations of a project profile.</p>
-     * @public
-     */
-    environmentConfigurations?: EnvironmentConfiguration[] | undefined;
-    /**
-     * <p>A user who created a project profile.</p>
-     * @public
-     */
-    createdBy: string | undefined;
-    /**
-     * <p>A timestamp at which a project profile is created.</p>
-     * @public
-     */
-    createdAt?: Date | undefined;
-    /**
-     * <p>A timestamp when a project profile was last updated.</p>
-     * @public
-     */
-    lastUpdatedAt?: Date | undefined;
-    /**
-     * <p>The ID of the domain unit where a project profile is created.</p>
-     * @public
-     */
-    domainUnitId?: string | undefined;
-}
-/**
- * <p>The enforcement details of a glossary term.</p>
- * @public
- */
-export interface GlossaryTermEnforcementDetail {
-    /**
-     * <p>The ID of the required glossary term.</p>
-     * @public
-     */
-    requiredGlossaryTermIds?: string[] | undefined;
-}