Creates a rule in Amazon DataZone. A rule is a formal agreement that enforces specific + * requirements across user workflows (e.g., publishing assets to the catalog, requesting + * subscriptions, creating projects) within the Amazon DataZone data portal. These rules help + * maintain consistency, ensure compliance, and uphold governance standards in data management + * processes. For instance, a metadata enforcement rule can specify the required information + * for creating a subscription request or publishing a data asset to the catalog, ensuring + * alignment with organizational standards.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, CreateRuleCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, CreateRuleCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // CreateRuleInput + * domainIdentifier: "STRING_VALUE", // required + * name: "STRING_VALUE", // required + * target: { // RuleTarget Union: only one key present + * domainUnitTarget: { // DomainUnitTarget + * domainUnitId: "STRING_VALUE", // required + * includeChildDomainUnits: true || false, + * }, + * }, + * action: "CREATE_SUBSCRIPTION_REQUEST", // required + * scope: { // RuleScope + * assetType: { // AssetTypesForRule + * selectionMode: "ALL" || "SPECIFIC", // required + * specificAssetTypes: [ // RuleAssetTypeList + * "STRING_VALUE", + * ], + * }, + * dataProduct: true || false, + * project: { // ProjectsForRule + * selectionMode: "ALL" || "SPECIFIC", // required + * specificProjects: [ // RuleProjectIdentifierList + * "STRING_VALUE", + * ], + * }, + * }, + * detail: { // RuleDetail Union: only one key present + * metadataFormEnforcementDetail: { // MetadataFormEnforcementDetail + * requiredMetadataForms: [ // RequiredMetadataFormList + * { // MetadataFormReference + * typeIdentifier: "STRING_VALUE", // required + * typeRevision: "STRING_VALUE", // required + * }, + * ], + * }, + * }, + * description: "STRING_VALUE", + * clientToken: "STRING_VALUE", + * }; + * const command = new CreateRuleCommand(input); + * const response = await client.send(command); + * // { // CreateRuleOutput + * // identifier: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // ruleType: "METADATA_FORM_ENFORCEMENT", // required + * // target: { // RuleTarget Union: only one key present + * // domainUnitTarget: { // DomainUnitTarget + * // domainUnitId: "STRING_VALUE", // required + * // includeChildDomainUnits: true || false, + * // }, + * // }, + * // action: "CREATE_SUBSCRIPTION_REQUEST", // required + * // scope: { // RuleScope + * // assetType: { // AssetTypesForRule + * // selectionMode: "ALL" || "SPECIFIC", // required + * // specificAssetTypes: [ // RuleAssetTypeList + * // "STRING_VALUE", + * // ], + * // }, + * // dataProduct: true || false, + * // project: { // ProjectsForRule + * // selectionMode: "ALL" || "SPECIFIC", // required + * // specificProjects: [ // RuleProjectIdentifierList + * // "STRING_VALUE", + * // ], + * // }, + * // }, + * // detail: { // RuleDetail Union: only one key present + * // metadataFormEnforcementDetail: { // MetadataFormEnforcementDetail + * // requiredMetadataForms: [ // RequiredMetadataFormList + * // { // MetadataFormReference + * // typeIdentifier: "STRING_VALUE", // required + * // typeRevision: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // }, + * // targetType: "DOMAIN_UNIT", + * // description: "STRING_VALUE", + * // createdAt: new Date("TIMESTAMP"), // required + * // createdBy: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param CreateRuleCommandInput - {@link CreateRuleCommandInput} + * @returns {@link CreateRuleCommandOutput} + * @see {@link CreateRuleCommandInput} for command's `input` shape. + * @see {@link CreateRuleCommandOutput} for command's `response` shape. + * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *There is a conflict while performing this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource cannot be found.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request has exceeded the specified service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by the Amazon Web Services service.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You do not have permission to perform this action.
+ * + * @throws {@link DataZoneServiceException} + *Base exception class for all service exceptions from DataZone service.
+ * + * @public + */ +export class CreateRuleCommand extends $Command + .classBuilder< + CreateRuleCommandInput, + CreateRuleCommandOutput, + DataZoneClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DataZoneClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DataZone", "CreateRule", {}) + .n("DataZoneClient", "CreateRuleCommand") + .f(CreateRuleInputFilterSensitiveLog, CreateRuleOutputFilterSensitiveLog) + .ser(se_CreateRuleCommand) + .de(de_CreateRuleCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateRuleInput; + output: CreateRuleOutput; + }; + sdk: { + input: CreateRuleCommandInput; + output: CreateRuleCommandOutput; + }; + }; +} diff --git a/clients/client-datazone/src/commands/CreateSubscriptionRequestCommand.ts b/clients/client-datazone/src/commands/CreateSubscriptionRequestCommand.ts index cf35cbbc4285..8ad4f8f2d326 100644 --- a/clients/client-datazone/src/commands/CreateSubscriptionRequestCommand.ts +++ b/clients/client-datazone/src/commands/CreateSubscriptionRequestCommand.ts @@ -56,6 +56,14 @@ export interface CreateSubscriptionRequestCommandOutput extends CreateSubscripti * ], * requestReason: "STRING_VALUE", // required * clientToken: "STRING_VALUE", + * metadataForms: [ // MetadataFormInputs + * { // FormInput + * formName: "STRING_VALUE", // required + * typeIdentifier: "STRING_VALUE", + * typeRevision: "STRING_VALUE", + * content: "STRING_VALUE", + * }, + * ], * }; * const command = new CreateSubscriptionRequestCommand(input); * const response = await client.send(command); @@ -129,6 +137,15 @@ export interface CreateSubscriptionRequestCommandOutput extends CreateSubscripti * // ], * // reviewerId: "STRING_VALUE", * // decisionComment: "STRING_VALUE", + * // existingSubscriptionId: "STRING_VALUE", + * // metadataForms: [ // MetadataForms + * // { // FormOutput + * // formName: "STRING_VALUE", // required + * // typeName: "STRING_VALUE", + * // typeRevision: "STRING_VALUE", + * // content: "STRING_VALUE", + * // }, + * // ], * // }; * * ``` diff --git a/clients/client-datazone/src/commands/DeleteDomainUnitCommand.ts b/clients/client-datazone/src/commands/DeleteDomainUnitCommand.ts index a5558118f49d..c91c0f94fad2 100644 --- a/clients/client-datazone/src/commands/DeleteDomainUnitCommand.ts +++ b/clients/client-datazone/src/commands/DeleteDomainUnitCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteDomainUnitInput, DeleteDomainUnitOutput } from "../models/models_0"; +import { DeleteDomainUnitInput, DeleteDomainUnitOutput } from "../models/models_1"; import { de_DeleteDomainUnitCommand, se_DeleteDomainUnitCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/DeleteEnvironmentBlueprintConfigurationCommand.ts b/clients/client-datazone/src/commands/DeleteEnvironmentBlueprintConfigurationCommand.ts index 8cb364a150cc..5d796b5bd961 100644 --- a/clients/client-datazone/src/commands/DeleteEnvironmentBlueprintConfigurationCommand.ts +++ b/clients/client-datazone/src/commands/DeleteEnvironmentBlueprintConfigurationCommand.ts @@ -6,8 +6,10 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteEnvironmentBlueprintConfigurationInput } from "../models/models_0"; -import { DeleteEnvironmentBlueprintConfigurationOutput } from "../models/models_1"; +import { + DeleteEnvironmentBlueprintConfigurationInput, + DeleteEnvironmentBlueprintConfigurationOutput, +} from "../models/models_1"; import { de_DeleteEnvironmentBlueprintConfigurationCommand, se_DeleteEnvironmentBlueprintConfigurationCommand, diff --git a/clients/client-datazone/src/commands/DeleteRuleCommand.ts b/clients/client-datazone/src/commands/DeleteRuleCommand.ts new file mode 100644 index 000000000000..a017235f7fa8 --- /dev/null +++ b/clients/client-datazone/src/commands/DeleteRuleCommand.ts @@ -0,0 +1,118 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteRuleInput, DeleteRuleOutput } from "../models/models_1"; +import { de_DeleteRuleCommand, se_DeleteRuleCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteRuleCommand}. + */ +export interface DeleteRuleCommandInput extends DeleteRuleInput {} +/** + * @public + * + * The output of {@link DeleteRuleCommand}. + */ +export interface DeleteRuleCommandOutput extends DeleteRuleOutput, __MetadataBearer {} + +/** + *Deletes a rule in Amazon DataZone. A rule is a formal agreement that enforces specific + * requirements across user workflows (e.g., publishing assets to the catalog, requesting + * subscriptions, creating projects) within the Amazon DataZone data portal. These rules help + * maintain consistency, ensure compliance, and uphold governance standards in data management + * processes. For instance, a metadata enforcement rule can specify the required information + * for creating a subscription request or publishing a data asset to the catalog, ensuring + * alignment with organizational standards.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, DeleteRuleCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, DeleteRuleCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // DeleteRuleInput + * domainIdentifier: "STRING_VALUE", // required + * identifier: "STRING_VALUE", // required + * }; + * const command = new DeleteRuleCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteRuleCommandInput - {@link DeleteRuleCommandInput} + * @returns {@link DeleteRuleCommandOutput} + * @see {@link DeleteRuleCommandInput} for command's `input` shape. + * @see {@link DeleteRuleCommandOutput} for command's `response` shape. + * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *There is a conflict while performing this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource cannot be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by the Amazon Web Services service.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You do not have permission to perform this action.
+ * + * @throws {@link DataZoneServiceException} + *Base exception class for all service exceptions from DataZone service.
+ * + * @public + */ +export class DeleteRuleCommand extends $Command + .classBuilder< + DeleteRuleCommandInput, + DeleteRuleCommandOutput, + DataZoneClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DataZoneClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DataZone", "DeleteRule", {}) + .n("DataZoneClient", "DeleteRuleCommand") + .f(void 0, void 0) + .ser(se_DeleteRuleCommand) + .de(de_DeleteRuleCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteRuleInput; + output: {}; + }; + sdk: { + input: DeleteRuleCommandInput; + output: DeleteRuleCommandOutput; + }; + }; +} diff --git a/clients/client-datazone/src/commands/GetDomainUnitCommand.ts b/clients/client-datazone/src/commands/GetDomainUnitCommand.ts index 6294f106d79d..b7c1e15691e9 100644 --- a/clients/client-datazone/src/commands/GetDomainUnitCommand.ts +++ b/clients/client-datazone/src/commands/GetDomainUnitCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetDomainUnitInput, GetDomainUnitOutput, GetDomainUnitOutputFilterSensitiveLog } from "../models/models_0"; +import { GetDomainUnitInput, GetDomainUnitOutput, GetDomainUnitOutputFilterSensitiveLog } from "../models/models_1"; import { de_GetDomainUnitCommand, se_GetDomainUnitCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetRuleCommand.ts b/clients/client-datazone/src/commands/GetRuleCommand.ts new file mode 100644 index 000000000000..fc75a129f92f --- /dev/null +++ b/clients/client-datazone/src/commands/GetRuleCommand.ts @@ -0,0 +1,159 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetRuleInput, GetRuleOutput, GetRuleOutputFilterSensitiveLog } from "../models/models_1"; +import { de_GetRuleCommand, se_GetRuleCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetRuleCommand}. + */ +export interface GetRuleCommandInput extends GetRuleInput {} +/** + * @public + * + * The output of {@link GetRuleCommand}. + */ +export interface GetRuleCommandOutput extends GetRuleOutput, __MetadataBearer {} + +/** + *Gets the details of a rule in Amazon DataZone. A rule is a formal agreement that + * enforces specific requirements across user workflows (e.g., publishing assets to the + * catalog, requesting subscriptions, creating projects) within the Amazon DataZone data + * portal. These rules help maintain consistency, ensure compliance, and uphold governance + * standards in data management processes. For instance, a metadata enforcement rule can + * specify the required information for creating a subscription request or publishing a data + * asset to the catalog, ensuring alignment with organizational standards.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, GetRuleCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, GetRuleCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // GetRuleInput + * domainIdentifier: "STRING_VALUE", // required + * identifier: "STRING_VALUE", // required + * revision: "STRING_VALUE", + * }; + * const command = new GetRuleCommand(input); + * const response = await client.send(command); + * // { // GetRuleOutput + * // identifier: "STRING_VALUE", // required + * // revision: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // ruleType: "METADATA_FORM_ENFORCEMENT", // required + * // target: { // RuleTarget Union: only one key present + * // domainUnitTarget: { // DomainUnitTarget + * // domainUnitId: "STRING_VALUE", // required + * // includeChildDomainUnits: true || false, + * // }, + * // }, + * // action: "CREATE_SUBSCRIPTION_REQUEST", // required + * // scope: { // RuleScope + * // assetType: { // AssetTypesForRule + * // selectionMode: "ALL" || "SPECIFIC", // required + * // specificAssetTypes: [ // RuleAssetTypeList + * // "STRING_VALUE", + * // ], + * // }, + * // dataProduct: true || false, + * // project: { // ProjectsForRule + * // selectionMode: "ALL" || "SPECIFIC", // required + * // specificProjects: [ // RuleProjectIdentifierList + * // "STRING_VALUE", + * // ], + * // }, + * // }, + * // detail: { // RuleDetail Union: only one key present + * // metadataFormEnforcementDetail: { // MetadataFormEnforcementDetail + * // requiredMetadataForms: [ // RequiredMetadataFormList + * // { // MetadataFormReference + * // typeIdentifier: "STRING_VALUE", // required + * // typeRevision: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // }, + * // targetType: "DOMAIN_UNIT", + * // description: "STRING_VALUE", + * // createdAt: new Date("TIMESTAMP"), // required + * // updatedAt: new Date("TIMESTAMP"), // required + * // createdBy: "STRING_VALUE", // required + * // lastUpdatedBy: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param GetRuleCommandInput - {@link GetRuleCommandInput} + * @returns {@link GetRuleCommandOutput} + * @see {@link GetRuleCommandInput} for command's `input` shape. + * @see {@link GetRuleCommandOutput} for command's `response` shape. + * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource cannot be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by the Amazon Web Services service.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You do not have permission to perform this action.
+ * + * @throws {@link DataZoneServiceException} + *Base exception class for all service exceptions from DataZone service.
+ * + * @public + */ +export class GetRuleCommand extends $Command + .classBuilder< + GetRuleCommandInput, + GetRuleCommandOutput, + DataZoneClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DataZoneClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DataZone", "GetRule", {}) + .n("DataZoneClient", "GetRuleCommand") + .f(void 0, GetRuleOutputFilterSensitiveLog) + .ser(se_GetRuleCommand) + .de(de_GetRuleCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetRuleInput; + output: GetRuleOutput; + }; + sdk: { + input: GetRuleCommandInput; + output: GetRuleCommandOutput; + }; + }; +} diff --git a/clients/client-datazone/src/commands/GetSubscriptionRequestDetailsCommand.ts b/clients/client-datazone/src/commands/GetSubscriptionRequestDetailsCommand.ts index 7f441d7d9326..3b7409ed0345 100644 --- a/clients/client-datazone/src/commands/GetSubscriptionRequestDetailsCommand.ts +++ b/clients/client-datazone/src/commands/GetSubscriptionRequestDetailsCommand.ts @@ -120,6 +120,15 @@ export interface GetSubscriptionRequestDetailsCommandOutput * // ], * // reviewerId: "STRING_VALUE", * // decisionComment: "STRING_VALUE", + * // existingSubscriptionId: "STRING_VALUE", + * // metadataForms: [ // MetadataForms + * // { // FormOutput + * // formName: "STRING_VALUE", // required + * // typeName: "STRING_VALUE", + * // typeRevision: "STRING_VALUE", + * // content: "STRING_VALUE", + * // }, + * // ], * // }; * * ``` diff --git a/clients/client-datazone/src/commands/ListDomainUnitsForParentCommand.ts b/clients/client-datazone/src/commands/ListDomainUnitsForParentCommand.ts index 724e845f97fc..2774dac941f4 100644 --- a/clients/client-datazone/src/commands/ListDomainUnitsForParentCommand.ts +++ b/clients/client-datazone/src/commands/ListDomainUnitsForParentCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListDomainUnitsForParentInput, ListDomainUnitsForParentOutput } from "../models/models_0"; +import { ListDomainUnitsForParentInput, ListDomainUnitsForParentOutput } from "../models/models_1"; import { de_ListDomainUnitsForParentCommand, se_ListDomainUnitsForParentCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/ListDomainsCommand.ts b/clients/client-datazone/src/commands/ListDomainsCommand.ts index d33c0827be31..4297c22ce62c 100644 --- a/clients/client-datazone/src/commands/ListDomainsCommand.ts +++ b/clients/client-datazone/src/commands/ListDomainsCommand.ts @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListDomainsInput, ListDomainsOutput, ListDomainsOutputFilterSensitiveLog } from "../models/models_0"; +import { ListDomainsInput } from "../models/models_0"; +import { ListDomainsOutput, ListDomainsOutputFilterSensitiveLog } from "../models/models_1"; import { de_ListDomainsCommand, se_ListDomainsCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/ListRulesCommand.ts b/clients/client-datazone/src/commands/ListRulesCommand.ts new file mode 100644 index 000000000000..94c0f84910d7 --- /dev/null +++ b/clients/client-datazone/src/commands/ListRulesCommand.ts @@ -0,0 +1,163 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListRulesInput, ListRulesOutput, ListRulesOutputFilterSensitiveLog } from "../models/models_1"; +import { de_ListRulesCommand, se_ListRulesCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListRulesCommand}. + */ +export interface ListRulesCommandInput extends ListRulesInput {} +/** + * @public + * + * The output of {@link ListRulesCommand}. + */ +export interface ListRulesCommandOutput extends ListRulesOutput, __MetadataBearer {} + +/** + *Lists existing rules. In Amazon DataZone, a rule is a formal agreement that enforces + * specific requirements across user workflows (e.g., publishing assets to the catalog, + * requesting subscriptions, creating projects) within the Amazon DataZone data portal. These + * rules help maintain consistency, ensure compliance, and uphold governance standards in data + * management processes. For instance, a metadata enforcement rule can specify the required + * information for creating a subscription request or publishing a data asset to the catalog, + * ensuring alignment with organizational standards.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, ListRulesCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, ListRulesCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // ListRulesInput + * domainIdentifier: "STRING_VALUE", // required + * targetType: "DOMAIN_UNIT", // required + * targetIdentifier: "STRING_VALUE", // required + * ruleType: "METADATA_FORM_ENFORCEMENT", + * action: "CREATE_SUBSCRIPTION_REQUEST", + * projectIds: [ // ProjectIds + * "STRING_VALUE", + * ], + * assetTypes: [ // AssetTypeIdentifiers + * "STRING_VALUE", + * ], + * dataProduct: true || false, + * includeCascaded: true || false, + * maxResults: Number("int"), + * nextToken: "STRING_VALUE", + * }; + * const command = new ListRulesCommand(input); + * const response = await client.send(command); + * // { // ListRulesOutput + * // items: [ // RuleSummaries // required + * // { // RuleSummary + * // identifier: "STRING_VALUE", + * // revision: "STRING_VALUE", + * // ruleType: "METADATA_FORM_ENFORCEMENT", + * // name: "STRING_VALUE", + * // targetType: "DOMAIN_UNIT", + * // target: { // RuleTarget Union: only one key present + * // domainUnitTarget: { // DomainUnitTarget + * // domainUnitId: "STRING_VALUE", // required + * // includeChildDomainUnits: true || false, + * // }, + * // }, + * // action: "CREATE_SUBSCRIPTION_REQUEST", + * // scope: { // RuleScope + * // assetType: { // AssetTypesForRule + * // selectionMode: "ALL" || "SPECIFIC", // required + * // specificAssetTypes: [ // RuleAssetTypeList + * // "STRING_VALUE", + * // ], + * // }, + * // dataProduct: true || false, + * // project: { // ProjectsForRule + * // selectionMode: "ALL" || "SPECIFIC", // required + * // specificProjects: [ // RuleProjectIdentifierList + * // "STRING_VALUE", + * // ], + * // }, + * // }, + * // updatedAt: new Date("TIMESTAMP"), + * // lastUpdatedBy: "STRING_VALUE", + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListRulesCommandInput - {@link ListRulesCommandInput} + * @returns {@link ListRulesCommandOutput} + * @see {@link ListRulesCommandInput} for command's `input` shape. + * @see {@link ListRulesCommandOutput} for command's `response` shape. + * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource cannot be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by the Amazon Web Services service.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You do not have permission to perform this action.
+ * + * @throws {@link DataZoneServiceException} + *Base exception class for all service exceptions from DataZone service.
+ * + * @public + */ +export class ListRulesCommand extends $Command + .classBuilder< + ListRulesCommandInput, + ListRulesCommandOutput, + DataZoneClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DataZoneClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DataZone", "ListRules", {}) + .n("DataZoneClient", "ListRulesCommand") + .f(void 0, ListRulesOutputFilterSensitiveLog) + .ser(se_ListRulesCommand) + .de(de_ListRulesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListRulesInput; + output: ListRulesOutput; + }; + sdk: { + input: ListRulesCommandInput; + output: ListRulesCommandOutput; + }; + }; +} diff --git a/clients/client-datazone/src/commands/ListSubscriptionRequestsCommand.ts b/clients/client-datazone/src/commands/ListSubscriptionRequestsCommand.ts index 98557a249460..310c14507c3c 100644 --- a/clients/client-datazone/src/commands/ListSubscriptionRequestsCommand.ts +++ b/clients/client-datazone/src/commands/ListSubscriptionRequestsCommand.ts @@ -124,6 +124,14 @@ export interface ListSubscriptionRequestsCommandOutput extends ListSubscriptionR * // ], * // reviewerId: "STRING_VALUE", * // decisionComment: "STRING_VALUE", + * // existingSubscriptionId: "STRING_VALUE", + * // metadataFormsSummary: [ // MetadataFormsSummary + * // { // MetadataFormSummary + * // formName: "STRING_VALUE", + * // typeName: "STRING_VALUE", // required + * // typeRevision: "STRING_VALUE", // required + * // }, + * // ], * // }, * // ], * // nextToken: "STRING_VALUE", diff --git a/clients/client-datazone/src/commands/RejectSubscriptionRequestCommand.ts b/clients/client-datazone/src/commands/RejectSubscriptionRequestCommand.ts index 1fec168f911b..97eb8233811c 100644 --- a/clients/client-datazone/src/commands/RejectSubscriptionRequestCommand.ts +++ b/clients/client-datazone/src/commands/RejectSubscriptionRequestCommand.ts @@ -117,6 +117,15 @@ export interface RejectSubscriptionRequestCommandOutput extends RejectSubscripti * // ], * // reviewerId: "STRING_VALUE", * // decisionComment: "STRING_VALUE", + * // existingSubscriptionId: "STRING_VALUE", + * // metadataForms: [ // MetadataForms + * // { // FormOutput + * // formName: "STRING_VALUE", // required + * // typeName: "STRING_VALUE", + * // typeRevision: "STRING_VALUE", + * // content: "STRING_VALUE", + * // }, + * // ], * // }; * * ``` diff --git a/clients/client-datazone/src/commands/UpdateDomainCommand.ts b/clients/client-datazone/src/commands/UpdateDomainCommand.ts index 94ba39e63e50..dd3d7ef1d350 100644 --- a/clients/client-datazone/src/commands/UpdateDomainCommand.ts +++ b/clients/client-datazone/src/commands/UpdateDomainCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateDomainInput, UpdateDomainOutput } from "../models/models_0"; +import { UpdateDomainInput, UpdateDomainOutput } from "../models/models_1"; import { de_UpdateDomainCommand, se_UpdateDomainCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/UpdateDomainUnitCommand.ts b/clients/client-datazone/src/commands/UpdateDomainUnitCommand.ts index 2180551f6242..bac74f257c80 100644 --- a/clients/client-datazone/src/commands/UpdateDomainUnitCommand.ts +++ b/clients/client-datazone/src/commands/UpdateDomainUnitCommand.ts @@ -11,7 +11,7 @@ import { UpdateDomainUnitInputFilterSensitiveLog, UpdateDomainUnitOutput, UpdateDomainUnitOutputFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_UpdateDomainUnitCommand, se_UpdateDomainUnitCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/UpdateRuleCommand.ts b/clients/client-datazone/src/commands/UpdateRuleCommand.ts new file mode 100644 index 000000000000..176c6cac06c6 --- /dev/null +++ b/clients/client-datazone/src/commands/UpdateRuleCommand.ts @@ -0,0 +1,196 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + UpdateRuleInput, + UpdateRuleInputFilterSensitiveLog, + UpdateRuleOutput, + UpdateRuleOutputFilterSensitiveLog, +} from "../models/models_1"; +import { de_UpdateRuleCommand, se_UpdateRuleCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateRuleCommand}. + */ +export interface UpdateRuleCommandInput extends UpdateRuleInput {} +/** + * @public + * + * The output of {@link UpdateRuleCommand}. + */ +export interface UpdateRuleCommandOutput extends UpdateRuleOutput, __MetadataBearer {} + +/** + *Updates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific + * requirements across user workflows (e.g., publishing assets to the catalog, requesting + * subscriptions, creating projects) within the Amazon DataZone data portal. These rules help + * maintain consistency, ensure compliance, and uphold governance standards in data management + * processes. For instance, a metadata enforcement rule can specify the required information + * for creating a subscription request or publishing a data asset to the catalog, ensuring + * alignment with organizational standards.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, UpdateRuleCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, UpdateRuleCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // UpdateRuleInput + * domainIdentifier: "STRING_VALUE", // required + * identifier: "STRING_VALUE", // required + * name: "STRING_VALUE", + * description: "STRING_VALUE", + * scope: { // RuleScope + * assetType: { // AssetTypesForRule + * selectionMode: "ALL" || "SPECIFIC", // required + * specificAssetTypes: [ // RuleAssetTypeList + * "STRING_VALUE", + * ], + * }, + * dataProduct: true || false, + * project: { // ProjectsForRule + * selectionMode: "ALL" || "SPECIFIC", // required + * specificProjects: [ // RuleProjectIdentifierList + * "STRING_VALUE", + * ], + * }, + * }, + * detail: { // RuleDetail Union: only one key present + * metadataFormEnforcementDetail: { // MetadataFormEnforcementDetail + * requiredMetadataForms: [ // RequiredMetadataFormList + * { // MetadataFormReference + * typeIdentifier: "STRING_VALUE", // required + * typeRevision: "STRING_VALUE", // required + * }, + * ], + * }, + * }, + * includeChildDomainUnits: true || false, + * }; + * const command = new UpdateRuleCommand(input); + * const response = await client.send(command); + * // { // UpdateRuleOutput + * // identifier: "STRING_VALUE", // required + * // revision: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // ruleType: "METADATA_FORM_ENFORCEMENT", // required + * // target: { // RuleTarget Union: only one key present + * // domainUnitTarget: { // DomainUnitTarget + * // domainUnitId: "STRING_VALUE", // required + * // includeChildDomainUnits: true || false, + * // }, + * // }, + * // action: "CREATE_SUBSCRIPTION_REQUEST", // required + * // scope: { // RuleScope + * // assetType: { // AssetTypesForRule + * // selectionMode: "ALL" || "SPECIFIC", // required + * // specificAssetTypes: [ // RuleAssetTypeList + * // "STRING_VALUE", + * // ], + * // }, + * // dataProduct: true || false, + * // project: { // ProjectsForRule + * // selectionMode: "ALL" || "SPECIFIC", // required + * // specificProjects: [ // RuleProjectIdentifierList + * // "STRING_VALUE", + * // ], + * // }, + * // }, + * // detail: { // RuleDetail Union: only one key present + * // metadataFormEnforcementDetail: { // MetadataFormEnforcementDetail + * // requiredMetadataForms: [ // RequiredMetadataFormList + * // { // MetadataFormReference + * // typeIdentifier: "STRING_VALUE", // required + * // typeRevision: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // }, + * // description: "STRING_VALUE", + * // createdAt: new Date("TIMESTAMP"), // required + * // updatedAt: new Date("TIMESTAMP"), // required + * // createdBy: "STRING_VALUE", // required + * // lastUpdatedBy: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param UpdateRuleCommandInput - {@link UpdateRuleCommandInput} + * @returns {@link UpdateRuleCommandOutput} + * @see {@link UpdateRuleCommandInput} for command's `input` shape. + * @see {@link UpdateRuleCommandOutput} for command's `response` shape. + * @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *There is a conflict while performing this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource cannot be found.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request has exceeded the specified service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by the Amazon Web Services service.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You do not have permission to perform this action.
+ * + * @throws {@link DataZoneServiceException} + *Base exception class for all service exceptions from DataZone service.
+ * + * @public + */ +export class UpdateRuleCommand extends $Command + .classBuilder< + UpdateRuleCommandInput, + UpdateRuleCommandOutput, + DataZoneClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DataZoneClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DataZone", "UpdateRule", {}) + .n("DataZoneClient", "UpdateRuleCommand") + .f(UpdateRuleInputFilterSensitiveLog, UpdateRuleOutputFilterSensitiveLog) + .ser(se_UpdateRuleCommand) + .de(de_UpdateRuleCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateRuleInput; + output: UpdateRuleOutput; + }; + sdk: { + input: UpdateRuleCommandInput; + output: UpdateRuleCommandOutput; + }; + }; +} diff --git a/clients/client-datazone/src/commands/UpdateSubscriptionRequestCommand.ts b/clients/client-datazone/src/commands/UpdateSubscriptionRequestCommand.ts index 8c199576b05c..e031b7b9bf47 100644 --- a/clients/client-datazone/src/commands/UpdateSubscriptionRequestCommand.ts +++ b/clients/client-datazone/src/commands/UpdateSubscriptionRequestCommand.ts @@ -117,6 +117,15 @@ export interface UpdateSubscriptionRequestCommandOutput extends UpdateSubscripti * // ], * // reviewerId: "STRING_VALUE", * // decisionComment: "STRING_VALUE", + * // existingSubscriptionId: "STRING_VALUE", + * // metadataForms: [ // MetadataForms + * // { // FormOutput + * // formName: "STRING_VALUE", // required + * // typeName: "STRING_VALUE", + * // typeRevision: "STRING_VALUE", + * // content: "STRING_VALUE", + * // }, + * // ], * // }; * * ``` diff --git a/clients/client-datazone/src/commands/index.ts b/clients/client-datazone/src/commands/index.ts index f43099e72829..5c44186e1b4c 100644 --- a/clients/client-datazone/src/commands/index.ts +++ b/clients/client-datazone/src/commands/index.ts @@ -25,6 +25,7 @@ export * from "./CreateGroupProfileCommand"; export * from "./CreateListingChangeSetCommand"; export * from "./CreateProjectCommand"; export * from "./CreateProjectMembershipCommand"; +export * from "./CreateRuleCommand"; export * from "./CreateSubscriptionGrantCommand"; export * from "./CreateSubscriptionRequestCommand"; export * from "./CreateSubscriptionTargetCommand"; @@ -46,6 +47,7 @@ export * from "./DeleteGlossaryTermCommand"; export * from "./DeleteListingCommand"; export * from "./DeleteProjectCommand"; export * from "./DeleteProjectMembershipCommand"; +export * from "./DeleteRuleCommand"; export * from "./DeleteSubscriptionGrantCommand"; export * from "./DeleteSubscriptionRequestCommand"; export * from "./DeleteSubscriptionTargetCommand"; @@ -74,6 +76,7 @@ export * from "./GetLineageNodeCommand"; export * from "./GetListingCommand"; export * from "./GetMetadataGenerationRunCommand"; export * from "./GetProjectCommand"; +export * from "./GetRuleCommand"; export * from "./GetSubscriptionCommand"; export * from "./GetSubscriptionGrantCommand"; export * from "./GetSubscriptionRequestDetailsCommand"; @@ -100,6 +103,7 @@ export * from "./ListNotificationsCommand"; export * from "./ListPolicyGrantsCommand"; export * from "./ListProjectMembershipsCommand"; export * from "./ListProjectsCommand"; +export * from "./ListRulesCommand"; export * from "./ListSubscriptionGrantsCommand"; export * from "./ListSubscriptionRequestsCommand"; export * from "./ListSubscriptionTargetsCommand"; @@ -134,6 +138,7 @@ export * from "./UpdateGlossaryCommand"; export * from "./UpdateGlossaryTermCommand"; export * from "./UpdateGroupProfileCommand"; export * from "./UpdateProjectCommand"; +export * from "./UpdateRuleCommand"; export * from "./UpdateSubscriptionGrantStatusCommand"; export * from "./UpdateSubscriptionRequestCommand"; export * from "./UpdateSubscriptionTargetCommand"; diff --git a/clients/client-datazone/src/models/models_0.ts b/clients/client-datazone/src/models/models_0.ts index acbe68ebb9df..852bc3eb35c9 100644 --- a/clients/client-datazone/src/models/models_0.ts +++ b/clients/client-datazone/src/models/models_0.ts @@ -319,6 +319,36 @@ export interface AcceptSubscriptionRequestInput { assetScopes?: AcceptedAssetScope[] | undefined; } +/** + *The details of a metadata form.
+ * @public + */ +export interface FormOutput { + /** + *The name of the metadata form.
+ * @public + */ + formName: string | undefined; + + /** + *The name of the metadata form type.
+ * @public + */ + typeName?: string | undefined; + + /** + *The revision of the metadata form type.
+ * @public + */ + typeRevision?: string | undefined; + + /** + *The content of the metadata form.
+ * @public + */ + content?: string | undefined; +} + /** * @public * @enum @@ -733,6 +763,18 @@ export interface AcceptSubscriptionRequestOutput { * @public */ decisionComment?: string | undefined; + + /** + *The ID of the existing subscription.
+ * @public + */ + existingSubscriptionId?: string | undefined; + + /** + *The metadata form in the subscription request.
+ * @public + */ + metadataForms?: FormOutput[] | undefined; } /** @@ -1955,36 +1997,6 @@ export interface CreateAssetInput { clientToken?: string | undefined; } -/** - *The details of a metadata form.
- * @public - */ -export interface FormOutput { - /** - *The name of the metadata form.
- * @public - */ - formName: string | undefined; - - /** - *The name of the metadata form type.
- * @public - */ - typeName?: string | undefined; - - /** - *The revision of the metadata form type.
- * @public - */ - typeRevision?: string | undefined; - - /** - *The content of the metadata form.
- * @public - */ - content?: string | undefined; -} - /** *The summary of the time series data points form.
* @public @@ -3788,6 +3800,38 @@ export interface AssetTypeItem { updatedBy?: string | undefined; } +/** + * @public + * @enum + */ +export const RuleScopeSelectionMode = { + ALL: "ALL", + SPECIFIC: "SPECIFIC", +} as const; + +/** + * @public + */ +export type RuleScopeSelectionMode = (typeof RuleScopeSelectionMode)[keyof typeof RuleScopeSelectionMode]; + +/** + *The asset type for the rule details.
+ * @public + */ +export interface AssetTypesForRule { + /** + *The selection mode for the rule.
+ * @public + */ + selectionMode: RuleScopeSelectionMode | undefined; + + /** + *The specific asset types that are included in the rule.
+ * @public + */ + specificAssetTypes?: string[] | undefined; +} + /** * @public */ @@ -7013,41 +7057,64 @@ export interface CreateProjectMembershipInput { export interface CreateProjectMembershipOutput {} /** - *A revision to be made to an asset published in a Amazon DataZone catalog.
* @public + * @enum */ -export interface ListingRevisionInput { +export const RuleAction = { + CREATE_SUBSCRIPTION_REQUEST: "CREATE_SUBSCRIPTION_REQUEST", +} as const; + +/** + * @public + */ +export type RuleAction = (typeof RuleAction)[keyof typeof RuleAction]; + +/** + *The reference of a metadata form.
+ * @public + */ +export interface MetadataFormReference { /** - *An identifier of revision to be made to an asset published in a Amazon DataZone - * catalog.
+ *The type ID of the metadata form reference.
* @public */ - identifier: string | undefined; + typeIdentifier: string | undefined; /** - *The details of a revision to be made to an asset published in a Amazon DataZone - * catalog.
+ *The type revision of the metadata form reference.
* @public */ - revision: string | undefined; + typeRevision: string | undefined; } /** - *The details of a listing for which a subscription is to be granted.
+ *The enforcement details of a metadata form.
* @public */ -export type GrantedEntityInput = GrantedEntityInput.ListingMember | GrantedEntityInput.$UnknownMember; +export interface MetadataFormEnforcementDetail { + /** + *The required metadata forms.
+ * @public + */ + requiredMetadataForms?: MetadataFormReference[] | undefined; +} /** + *The details of a rule.
* @public */ -export namespace GrantedEntityInput { +export type RuleDetail = RuleDetail.MetadataFormEnforcementDetailMember | RuleDetail.$UnknownMember; + +/** + * @public + */ +export namespace RuleDetail { /** - *The listing for which a subscription is to be granted.
+ *The enforcement detail of the metadata form.
* @public */ - export interface ListingMember { - listing: ListingRevisionInput; + export interface MetadataFormEnforcementDetailMember { + metadataFormEnforcementDetail: MetadataFormEnforcementDetail; $unknown?: never; } @@ -7055,342 +7122,307 @@ export namespace GrantedEntityInput { * @public */ export interface $UnknownMember { - listing?: never; + metadataFormEnforcementDetail?: never; $unknown: [string, any]; } export interface VisitorSpecifies projects in which the rule is created.
* @public */ -export interface CreateSubscriptionGrantInput { - /** - *The ID of the Amazon DataZone domain in which the subscription grant is created.
- * @public - */ - domainIdentifier: string | undefined; - +export interface ProjectsForRule { /** - *The ID of the environment in which the subscription grant is created.
+ *The selection mode of the rule.
* @public */ - environmentIdentifier: string | undefined; + selectionMode: RuleScopeSelectionMode | undefined; /** - *The ID of the subscription target for which the subscription grant is created.
+ *The specific projects in which the rule is created.
* @public */ - subscriptionTargetIdentifier: string | undefined; + specificProjects?: string[] | undefined; +} +/** + *The scope of a rule.
+ * @public + */ +export interface RuleScope { /** - *The entity to which the subscription is to be granted.
+ *The asset type included in the rule scope.
* @public */ - grantedEntity: GrantedEntityInput | undefined; + assetType?: AssetTypesForRule | undefined; /** - *The names of the assets for which the subscription grant is created.
+ *The data product included in the rule scope.
* @public */ - assetTargetNames?: AssetTargetNameMap[] | undefined; + dataProduct?: boolean | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The project included in the rule scope.
* @public */ - clientToken?: string | undefined; + project?: ProjectsForRule | undefined; } /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The target for the domain unit.
* @public */ -export interface FailureCause { +export interface DomainUnitTarget { /** - *The description of the error message.
+ *The ID of the domain unit.
* @public */ - message?: string | undefined; + domainUnitId: string | undefined; + + /** + *Specifies whether to apply a rule to the child domain units.
+ * @public + */ + includeChildDomainUnits?: boolean | undefined; } /** + *The target of the rule.
* @public - * @enum */ -export const SubscriptionGrantStatus = { - GRANTED: "GRANTED", - GRANT_FAILED: "GRANT_FAILED", - GRANT_IN_PROGRESS: "GRANT_IN_PROGRESS", - GRANT_PENDING: "GRANT_PENDING", - REVOKED: "REVOKED", - REVOKE_FAILED: "REVOKE_FAILED", - REVOKE_IN_PROGRESS: "REVOKE_IN_PROGRESS", - REVOKE_PENDING: "REVOKE_PENDING", -} as const; +export type RuleTarget = RuleTarget.DomainUnitTargetMember | RuleTarget.$UnknownMember; /** * @public */ -export type SubscriptionGrantStatus = (typeof SubscriptionGrantStatus)[keyof typeof SubscriptionGrantStatus]; +export namespace RuleTarget { + /** + *The ID of the domain unit.
+ * @public + */ + export interface DomainUnitTargetMember { + domainUnitTarget: DomainUnitTarget; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + domainUnitTarget?: never; + $unknown: [string, any]; + } + + export interface VisitorThe details of the asset for which the subscription grant is created.
* @public */ -export interface SubscribedAsset { +export interface CreateRuleInput { /** - *The identifier of the asset for which the subscription grant is created.
+ *The ID of the domain where the rule is created.
* @public */ - assetId: string | undefined; + domainIdentifier: string | undefined; /** - *The revision of the asset for which the subscription grant is created.
+ *The name of the rule.
* @public */ - assetRevision: string | undefined; + name: string | undefined; /** - *The status of the asset for which the subscription grant is created.
+ *The target of the rule.
* @public */ - status: SubscriptionGrantStatus | undefined; + target: RuleTarget | undefined; /** - *The target name of the asset for which the subscription grant is created.
+ *The action of the rule.
* @public */ - targetName?: string | undefined; + action: RuleAction | undefined; /** - *The failure cause included in the details of the asset for which the subscription grant - * is created.
+ *The scope of the rule.
* @public */ - failureCause?: FailureCause | undefined; + scope: RuleScope | undefined; /** - *The timestamp of when the subscription grant to the asset is created.
+ *The detail of the rule.
* @public */ - grantedTimestamp?: Date | undefined; + detail: RuleDetail | undefined; /** - *The failure timestamp included in the details of the asset for which the subscription - * grant is created.
+ *The description of the rule.
* @public */ - failureTimestamp?: Date | undefined; + description?: string | undefined; /** - *The asset scope of the subscribed asset.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - assetScope?: AssetScope | undefined; + clientToken?: string | undefined; } /** - *A revision of an asset published in a Amazon DataZone catalog.
* @public + * @enum */ -export interface ListingRevision { - /** - *An identifier of a revision of an asset published in a Amazon DataZone catalog.
- * @public - */ - id: string | undefined; +export const RuleType = { + METADATA_FORM_ENFORCEMENT: "METADATA_FORM_ENFORCEMENT", +} as const; - /** - *The details of a revision of an asset published in a Amazon DataZone catalog.
- * @public - */ - revision: string | undefined; -} +/** + * @public + */ +export type RuleType = (typeof RuleType)[keyof typeof RuleType]; /** - *The details of a listing for which a subscription is granted.
* @public + * @enum */ -export type GrantedEntity = GrantedEntity.ListingMember | GrantedEntity.$UnknownMember; +export const RuleTargetType = { + DOMAIN_UNIT: "DOMAIN_UNIT", +} as const; /** * @public */ -export namespace GrantedEntity { +export type RuleTargetType = (typeof RuleTargetType)[keyof typeof RuleTargetType]; + +/** + * @public + */ +export interface CreateRuleOutput { /** - *The listing for which a subscription is granted.
+ *The ID of the rule.
* @public */ - export interface ListingMember { - listing: ListingRevision; - $unknown?: never; - } + identifier: string | undefined; /** + *The name of the rule.
* @public */ - export interface $UnknownMember { - listing?: never; - $unknown: [string, any]; - } - - export interface VisitorThe ID of the subscription grant.
- * @public - */ - id: string | undefined; - - /** - *The Amazon DataZone user who created the subscription grant.
- * @public - */ - createdBy: string | undefined; + name: string | undefined; /** - *The Amazon DataZone user who updated the subscription grant.
+ *The type of the rule.
* @public */ - updatedBy?: string | undefined; + ruleType: RuleType | undefined; /** - *The ID of the Amazon DataZone domain in which the subscription grant is created.
+ *The target of the rule.
* @public */ - domainId: string | undefined; + target: RuleTarget | undefined; /** - *A timestamp of when the subscription grant is created.
+ *The action of the rule.
* @public */ - createdAt: Date | undefined; + action: RuleAction | undefined; /** - *A timestamp of when the subscription grant was updated.
+ *The scope of the rule.
* @public */ - updatedAt: Date | undefined; + scope: RuleScope | undefined; /** - *The ID of the subscription target for which the subscription grant is created.
+ *The detail of the rule.
* @public */ - subscriptionTargetId: string | undefined; + detail: RuleDetail | undefined; /** - *The entity to which the subscription is granted.
+ *The target type of the rule.
* @public */ - grantedEntity: GrantedEntity | undefined; + targetType?: RuleTargetType | undefined; /** - *The status of the subscription grant.
+ *The description of the rule.
* @public */ - status: SubscriptionGrantOverallStatus | undefined; + description?: string | undefined; /** - *The assets for which the subscription grant is created.
+ *The timestamp at which the rule is created.
* @public */ - assets?: SubscribedAsset[] | undefined; + createdAt: Date | undefined; /** - * @deprecated - * - *The identifier of the subscription grant.
+ *The user who creates the rule.
* @public */ - subscriptionId?: string | undefined; + createdBy: string | undefined; } /** - *The published asset for which the subscription grant is to be created.
+ *A revision to be made to an asset published in a Amazon DataZone catalog.
* @public */ -export interface SubscribedListingInput { +export interface ListingRevisionInput { /** - *The identifier of the published asset for which the subscription grant is to be - * created.
+ *An identifier of revision to be made to an asset published in a Amazon DataZone + * catalog.
* @public */ identifier: string | undefined; -} -/** - *The project that is to be given a subscription grant.
- * @public - */ -export interface SubscribedProjectInput { /** - *The identifier of the project that is to be given a subscription grant.
+ *The details of a revision to be made to an asset published in a Amazon DataZone + * catalog.
* @public */ - identifier?: string | undefined; + revision: string | undefined; } /** - *The principal that is to be given a subscriptiong grant.
+ *The details of a listing for which a subscription is to be granted.
* @public */ -export type SubscribedPrincipalInput = SubscribedPrincipalInput.ProjectMember | SubscribedPrincipalInput.$UnknownMember; +export type GrantedEntityInput = GrantedEntityInput.ListingMember | GrantedEntityInput.$UnknownMember; /** * @public */ -export namespace SubscribedPrincipalInput { +export namespace GrantedEntityInput { /** - *The project that is to be given a subscription grant.
+ *The listing for which a subscription is to be granted.
* @public */ - export interface ProjectMember { - project: SubscribedProjectInput; + export interface ListingMember { + listing: ListingRevisionInput; $unknown?: never; } @@ -7398,17 +7430,17 @@ export namespace SubscribedPrincipalInput { * @public */ export interface $UnknownMember { - project?: never; + listing?: never; $unknown: [string, any]; } export interface VisitorThe ID of the Amazon DataZone domain in which the subscription request is created.
+ *The ID of the Amazon DataZone domain in which the subscription grant is created.
* @public */ domainIdentifier: string | undefined; /** - *The Amazon DataZone principals for whom the subscription request is created.
+ *The ID of the environment in which the subscription grant is created.
* @public */ - subscribedPrincipals: SubscribedPrincipalInput[] | undefined; + environmentIdentifier: string | undefined; /** - *The published asset for which the subscription grant is to be created.
+ *The ID of the subscription target for which the subscription grant is created.
* @public */ - subscribedListings: SubscribedListingInput[] | undefined; + subscriptionTargetIdentifier: string | undefined; /** - *The reason for the subscription request.
+ *The entity to which the subscription is to be granted.
* @public */ - requestReason: string | undefined; + grantedEntity: GrantedEntityInput | undefined; + + /** + *The names of the assets for which the subscription grant is created.
+ * @public + */ + assetTargetNames?: AssetTargetNameMap[] | undefined; /** *A unique, case-sensitive identifier that is provided to ensure the idempotency of the @@ -7450,1729 +7488,1693 @@ export interface CreateSubscriptionRequestInput { } /** + *
Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ -export interface CreateSubscriptionRequestOutput { - /** - *The ID of the subscription request.
- * @public - */ - id: string | undefined; - +export interface FailureCause { /** - *The Amazon DataZone user who created the subscription request.
+ *The description of the error message.
* @public */ - createdBy: string | undefined; + message?: string | undefined; +} - /** - *The Amazon DataZone user who updated the subscription request.
- * @public - */ - updatedBy?: string | undefined; +/** + * @public + * @enum + */ +export const SubscriptionGrantStatus = { + GRANTED: "GRANTED", + GRANT_FAILED: "GRANT_FAILED", + GRANT_IN_PROGRESS: "GRANT_IN_PROGRESS", + GRANT_PENDING: "GRANT_PENDING", + REVOKED: "REVOKED", + REVOKE_FAILED: "REVOKE_FAILED", + REVOKE_IN_PROGRESS: "REVOKE_IN_PROGRESS", + REVOKE_PENDING: "REVOKE_PENDING", +} as const; - /** - *The ID of the Amazon DataZone domain in whcih the subscription request is created.
- * @public - */ - domainId: string | undefined; +/** + * @public + */ +export type SubscriptionGrantStatus = (typeof SubscriptionGrantStatus)[keyof typeof SubscriptionGrantStatus]; +/** + *The details of the asset for which the subscription grant is created.
+ * @public + */ +export interface SubscribedAsset { /** - *The status of the subscription request.
+ *The identifier of the asset for which the subscription grant is created.
* @public */ - status: SubscriptionRequestStatus | undefined; + assetId: string | undefined; /** - *A timestamp of when the subscription request is created.
+ *The revision of the asset for which the subscription grant is created.
* @public */ - createdAt: Date | undefined; + assetRevision: string | undefined; /** - *The timestamp of when the subscription request was updated.
+ *The status of the asset for which the subscription grant is created.
* @public */ - updatedAt: Date | undefined; + status: SubscriptionGrantStatus | undefined; /** - *The reason for the subscription request.
+ *The target name of the asset for which the subscription grant is created.
* @public */ - requestReason: string | undefined; + targetName?: string | undefined; /** - *The subscribed principals of the subscription request.
+ *The failure cause included in the details of the asset for which the subscription grant + * is created.
* @public */ - subscribedPrincipals: SubscribedPrincipal[] | undefined; + failureCause?: FailureCause | undefined; /** - *The published asset for which the subscription grant is to be created.
+ *The timestamp of when the subscription grant to the asset is created.
* @public */ - subscribedListings: SubscribedListing[] | undefined; + grantedTimestamp?: Date | undefined; /** - *The ID of the reviewer of the subscription request.
+ *The failure timestamp included in the details of the asset for which the subscription + * grant is created.
* @public */ - reviewerId?: string | undefined; + failureTimestamp?: Date | undefined; /** - *The decision comment of the subscription request.
+ *The asset scope of the subscribed asset.
* @public */ - decisionComment?: string | undefined; + assetScope?: AssetScope | undefined; } /** - *The details of the subscription target configuration.
+ *A revision of an asset published in a Amazon DataZone catalog.
* @public */ -export interface SubscriptionTargetForm { +export interface ListingRevision { /** - *The form name included in the subscription target configuration.
+ *An identifier of a revision of an asset published in a Amazon DataZone catalog.
* @public */ - formName: string | undefined; + id: string | undefined; /** - *The content of the subscription target configuration.
+ *The details of a revision of an asset published in a Amazon DataZone catalog.
* @public */ - content: string | undefined; + revision: string | undefined; } /** + *The details of a listing for which a subscription is granted.
* @public */ -export interface CreateSubscriptionTargetInput { - /** - *The ID of the Amazon DataZone domain in which subscription target is created.
- * @public - */ - domainIdentifier: string | undefined; +export type GrantedEntity = GrantedEntity.ListingMember | GrantedEntity.$UnknownMember; +/** + * @public + */ +export namespace GrantedEntity { /** - *The ID of the environment in which subscription target is created.
+ *The listing for which a subscription is granted.
* @public */ - environmentIdentifier: string | undefined; + export interface ListingMember { + listing: ListingRevision; + $unknown?: never; + } /** - *The name of the subscription target.
* @public */ - name: string | undefined; + export interface $UnknownMember { + listing?: never; + $unknown: [string, any]; + } - /** - *The type of the subscription target.
- * @public - */ - type: string | undefined; + export interface VisitorThe configuration of the subscription target.
+ *The ID of the subscription grant.
* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + id: string | undefined; /** - *The authorized principals of the subscription target.
+ *The Amazon DataZone user who created the subscription grant.
* @public */ - authorizedPrincipals: string[] | undefined; + createdBy: string | undefined; /** - *The manage access role that is used to create the subscription target.
+ *The Amazon DataZone user who updated the subscription grant.
* @public */ - manageAccessRole: string | undefined; + updatedBy?: string | undefined; /** - *The asset types that can be included in the subscription target.
+ *The ID of the Amazon DataZone domain in which the subscription grant is created.
* @public */ - applicableAssetTypes: string[] | undefined; + domainId: string | undefined; /** - *The provider of the subscription target.
+ *A timestamp of when the subscription grant is created.
* @public */ - provider?: string | undefined; + createdAt: Date | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *A timestamp of when the subscription grant was updated.
* @public */ - clientToken?: string | undefined; -} + updatedAt: Date | undefined; -/** - * @public - */ -export interface CreateSubscriptionTargetOutput { /** - *The ID of the subscription target.
+ *The ID of the subscription target for which the subscription grant is created.
* @public */ - id: string | undefined; + subscriptionTargetId: string | undefined; /** - *The authorised principals of the subscription target.
+ *The entity to which the subscription is granted.
* @public */ - authorizedPrincipals: string[] | undefined; + grantedEntity: GrantedEntity | undefined; /** - *The ID of the Amazon DataZone domain in which the subscription target was created.
+ *The status of the subscription grant.
* @public */ - domainId: string | undefined; + status: SubscriptionGrantOverallStatus | undefined; /** - *???
+ *The assets for which the subscription grant is created.
* @public */ - projectId: string | undefined; + assets?: SubscribedAsset[] | undefined; /** - *The ID of the environment in which the subscription target was created.
+ * @deprecated + * + *The identifier of the subscription grant.
* @public */ - environmentId: string | undefined; + subscriptionId?: string | undefined; +} +/** + *The published asset for which the subscription grant is to be created.
+ * @public + */ +export interface SubscribedListingInput { /** - *The name of the subscription target.
+ *The identifier of the published asset for which the subscription grant is to be + * created.
* @public */ - name: string | undefined; + identifier: string | undefined; +} +/** + *The project that is to be given a subscription grant.
+ * @public + */ +export interface SubscribedProjectInput { /** - *The type of the subscription target.
+ *The identifier of the project that is to be given a subscription grant.
* @public */ - type: string | undefined; + identifier?: string | undefined; +} + +/** + *The principal that is to be given a subscriptiong grant.
+ * @public + */ +export type SubscribedPrincipalInput = SubscribedPrincipalInput.ProjectMember | SubscribedPrincipalInput.$UnknownMember; +/** + * @public + */ +export namespace SubscribedPrincipalInput { /** - *The Amazon DataZone user who created the subscription target.
+ *The project that is to be given a subscription grant.
* @public */ - createdBy: string | undefined; + export interface ProjectMember { + project: SubscribedProjectInput; + $unknown?: never; + } /** - *The Amazon DataZone user who updated the subscription target.
* @public */ - updatedBy?: string | undefined; + export interface $UnknownMember { + project?: never; + $unknown: [string, any]; + } + + export interface VisitorThe timestamp of when the subscription target was created.
+ *The ID of the Amazon DataZone domain in which the subscription request is created.
* @public */ - createdAt: Date | undefined; + domainIdentifier: string | undefined; /** - *The timestamp of when the subscription target was updated.
+ *The Amazon DataZone principals for whom the subscription request is created.
* @public */ - updatedAt?: Date | undefined; + subscribedPrincipals: SubscribedPrincipalInput[] | undefined; /** - *The manage access role with which the subscription target was created.
+ *The published asset for which the subscription grant is to be created.
* @public */ - manageAccessRole: string | undefined; + subscribedListings: SubscribedListingInput[] | undefined; /** - *The asset types that can be included in the subscription target.
+ *The reason for the subscription request.
* @public */ - applicableAssetTypes: string[] | undefined; + requestReason: string | undefined; /** - *The configuration of the subscription target.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + clientToken?: string | undefined; /** - *The provider of the subscription target.
+ *The metadata form included in the subscription request.
* @public */ - provider: string | undefined; + metadataForms?: FormInput[] | undefined; } -/** - * @public - * @enum - */ -export const UserType = { - IAM_ROLE: "IAM_ROLE", - IAM_USER: "IAM_USER", - SSO_USER: "SSO_USER", -} as const; - -/** - * @public - */ -export type UserType = (typeof UserType)[keyof typeof UserType]; - /** * @public */ -export interface CreateUserProfileInput { +export interface CreateSubscriptionRequestOutput { /** - *The identifier of the Amazon DataZone domain in which a user profile is created.
+ *The ID of the subscription request.
* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *The identifier of the user for which the user profile is created.
+ *The Amazon DataZone user who created the subscription request.
* @public */ - userIdentifier: string | undefined; + createdBy: string | undefined; /** - *The user type of the user for which the user profile is created.
+ *The Amazon DataZone user who updated the subscription request.
* @public */ - userType?: UserType | undefined; + updatedBy?: string | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The ID of the Amazon DataZone domain in whcih the subscription request is created.
* @public */ - clientToken?: string | undefined; -} + domainId: string | undefined; -/** - *The details of an IAM user profile in Amazon DataZone.
- * @public - */ -export interface IamUserProfileDetails { /** - *The ARN of an IAM user profile in Amazon DataZone.
+ *The status of the subscription request.
* @public */ - arn?: string | undefined; -} + status: SubscriptionRequestStatus | undefined; -/** - *The single sign-on details of the user profile.
- * @public - */ -export interface SsoUserProfileDetails { /** - *The username included in the single sign-on details of the user profile.
+ *A timestamp of when the subscription request is created.
* @public */ - username?: string | undefined; + createdAt: Date | undefined; /** - *The first name included in the single sign-on details of the user profile.
+ *The timestamp of when the subscription request was updated.
* @public */ - firstName?: string | undefined; + updatedAt: Date | undefined; /** - *The last name included in the single sign-on details of the user profile.
+ *The reason for the subscription request.
* @public */ - lastName?: string | undefined; -} - -/** - *The details of the user profile in Amazon DataZone.
- * @public - */ -export type UserProfileDetails = - | UserProfileDetails.IamMember - | UserProfileDetails.SsoMember - | UserProfileDetails.$UnknownMember; + requestReason: string | undefined; -/** - * @public - */ -export namespace UserProfileDetails { /** - *The IAM details included in the user profile details.
+ *The subscribed principals of the subscription request.
* @public */ - export interface IamMember { - iam: IamUserProfileDetails; - sso?: never; - $unknown?: never; - } + subscribedPrincipals: SubscribedPrincipal[] | undefined; /** - *The single sign-on details included in the user profile details.
- * @public - */ - export interface SsoMember { - iam?: never; - sso: SsoUserProfileDetails; - $unknown?: never; - } - - /** - * @public - */ - export interface $UnknownMember { - iam?: never; - sso?: never; - $unknown: [string, any]; - } - - export interface VisitorThe identifier of the Amazon DataZone domain in which a user profile is created.
+ *The published asset for which the subscription grant is to be created.
* @public */ - domainId?: string | undefined; + subscribedListings: SubscribedListing[] | undefined; /** - *The identifier of the user profile.
+ *The ID of the reviewer of the subscription request.
* @public */ - id?: string | undefined; + reviewerId?: string | undefined; /** - *The type of the user profile.
+ *The decision comment of the subscription request.
* @public */ - type?: UserProfileType | undefined; + decisionComment?: string | undefined; /** - *The status of the user profile.
+ *The ID of the existing subscription.
* @public */ - status?: UserProfileStatus | undefined; + existingSubscriptionId?: string | undefined; /** - *The details of the user profile in Amazon DataZone.
+ *The metadata form included in the subscription request.
* @public */ - details?: UserProfileDetails | undefined; + metadataForms?: FormOutput[] | undefined; } /** - * @public - * @enum - */ -export const DataAssetActivityStatus = { - FAILED: "FAILED", - PUBLISHING_FAILED: "PUBLISHING_FAILED", - SKIPPED_ALREADY_IMPORTED: "SKIPPED_ALREADY_IMPORTED", - SKIPPED_ARCHIVED: "SKIPPED_ARCHIVED", - SKIPPED_NO_ACCESS: "SKIPPED_NO_ACCESS", - SUCCEEDED_CREATED: "SUCCEEDED_CREATED", - SUCCEEDED_UPDATED: "SUCCEEDED_UPDATED", - UNCHANGED: "UNCHANGED", -} as const; - -/** - * @public - */ -export type DataAssetActivityStatus = (typeof DataAssetActivityStatus)[keyof typeof DataAssetActivityStatus]; - -/** + *The details of the subscription target configuration.
* @public */ -export interface DeleteDataProductInput { +export interface SubscriptionTargetForm { /** - *The ID of the Amazon DataZone domain in which the data product is deleted.
+ *The form name included in the subscription target configuration.
* @public */ - domainIdentifier: string | undefined; + formName: string | undefined; /** - *The identifier of the data product that is deleted.
+ *The content of the subscription target configuration.
* @public */ - identifier: string | undefined; + content: string | undefined; } /** * @public */ -export interface DeleteDataProductOutput {} - -/** - * @public - */ -export interface GetDataProductInput { +export interface CreateSubscriptionTargetInput { /** - *The ID of the domain where the data product lives.
+ *The ID of the Amazon DataZone domain in which subscription target is created.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the data product.
- * @public - */ - identifier: string | undefined; - - /** - *The revision of the data product.
- * @public - */ - revision?: string | undefined; -} - -/** - * @public - */ -export interface GetDataProductOutput { - /** - *The ID of the domain where the data product lives.
+ *The ID of the environment in which subscription target is created.
* @public */ - domainId: string | undefined; + environmentIdentifier: string | undefined; /** - *The ID of the data product.
+ *The name of the subscription target.
* @public */ - id: string | undefined; + name: string | undefined; /** - *The revision of the data product.
+ *The type of the subscription target.
* @public */ - revision: string | undefined; + type: string | undefined; /** - *The ID of the owning project of the data product.
+ *The configuration of the subscription target.
* @public */ - owningProjectId: string | undefined; + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; /** - *The name of the data product.
+ *The authorized principals of the subscription target.
* @public */ - name: string | undefined; + authorizedPrincipals: string[] | undefined; /** - *The status of the data product.
+ *The manage access role that is used to create the subscription target.
* @public */ - status: DataProductStatus | undefined; + manageAccessRole: string | undefined; /** - *The description of the data product.
+ *The asset types that can be included in the subscription target.
* @public */ - description?: string | undefined; + applicableAssetTypes: string[] | undefined; /** - *The glossary terms of the data product.
+ *The provider of the subscription target.
* @public */ - glossaryTerms?: string[] | undefined; + provider?: string | undefined; /** - *The data assets of the data product.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - items?: DataProductItem[] | undefined; + clientToken?: string | undefined; +} +/** + * @public + */ +export interface CreateSubscriptionTargetOutput { /** - *The metadata forms of the data product.
+ *The ID of the subscription target.
* @public */ - formsOutput?: FormOutput[] | undefined; + id: string | undefined; /** - *The timestamp at which the data product is created.
+ *The authorised principals of the subscription target.
* @public */ - createdAt?: Date | undefined; + authorizedPrincipals: string[] | undefined; /** - *The user who created the data product.
+ *The ID of the Amazon DataZone domain in which the subscription target was created.
* @public */ - createdBy?: string | undefined; + domainId: string | undefined; /** - *The timestamp at which the first revision of the data product is created.
+ *???
* @public */ - firstRevisionCreatedAt?: Date | undefined; + projectId: string | undefined; /** - *The user who created the first revision of the data product.
+ *The ID of the environment in which the subscription target was created.
* @public */ - firstRevisionCreatedBy?: string | undefined; -} + environmentId: string | undefined; -/** - *The summary of the listing of the data product.
- * @public - */ -export interface ListingSummary { /** - *The ID of the data product listing.
+ *The name of the subscription target.
* @public */ - listingId?: string | undefined; + name: string | undefined; /** - *The revision of the data product listing.
+ *The type of the subscription target.
* @public */ - listingRevision?: string | undefined; + type: string | undefined; /** - *The glossary terms of the data product.
+ *The Amazon DataZone user who created the subscription target.
* @public */ - glossaryTerms?: DetailedGlossaryTerm[] | undefined; -} + createdBy: string | undefined; -/** - *The data product listing.
- * @public - */ -export interface DataProductListing { /** - *The ID of the data product listing.
+ *The Amazon DataZone user who updated the subscription target.
* @public */ - dataProductId?: string | undefined; + updatedBy?: string | undefined; /** - *The revision of the data product listing.
+ *The timestamp of when the subscription target was created.
* @public */ - dataProductRevision?: string | undefined; + createdAt: Date | undefined; /** - *The timestamp at which the data product listing was created.
+ *The timestamp of when the subscription target was updated.
* @public */ - createdAt?: Date | undefined; + updatedAt?: Date | undefined; /** - *The metadata forms of the data product listing.
+ *The manage access role with which the subscription target was created.
* @public */ - forms?: string | undefined; + manageAccessRole: string | undefined; /** - *The glossary terms of the data product listing.
+ *The asset types that can be included in the subscription target.
* @public */ - glossaryTerms?: DetailedGlossaryTerm[] | undefined; + applicableAssetTypes: string[] | undefined; /** - *The ID of the owning project of the data product listing.
+ *The configuration of the subscription target.
* @public */ - owningProjectId?: string | undefined; + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; /** - *The data assets of the data product listing.
+ *The provider of the subscription target.
* @public */ - items?: ListingSummary[] | undefined; + provider: string | undefined; } /** - *The additional attributes of the asset of the data product.
* @public + * @enum */ -export interface DataProductListingItemAdditionalAttributes { - /** - *The metadata forms of the asset of the data product.
- * @public - */ - forms?: string | undefined; -} +export const UserType = { + IAM_ROLE: "IAM_ROLE", + IAM_USER: "IAM_USER", + SSO_USER: "SSO_USER", +} as const; /** - *The results of the data product summary.
* @public */ -export interface ListingSummaryItem { - /** - *The ID of the data product listing.
- * @public - */ - listingId?: string | undefined; - - /** - *The revision of the data product listing.
- * @public - */ - listingRevision?: string | undefined; - - /** - *The glossary terms of the data product listing.
- * @public - */ - glossaryTerms?: DetailedGlossaryTerm[] | undefined; -} +export type UserType = (typeof UserType)[keyof typeof UserType]; /** - *The asset of the data product listing.
* @public */ -export interface DataProductListingItem { - /** - *The ID of the listing.
- * @public - */ - listingId?: string | undefined; - - /** - *The revision of the listing.
- * @public - */ - listingRevision?: string | undefined; - - /** - *The name of the asset of the data product.
- * @public - */ - name?: string | undefined; - - /** - *The entity ID of the asset of the asset of the data product.
- * @public - */ - entityId?: string | undefined; - - /** - *The revision of the asset of the asset of the data product.
- * @public - */ - entityRevision?: string | undefined; - +export interface CreateUserProfileInput { /** - *The description of the asset of the asset of the data product.
+ *The identifier of the Amazon DataZone domain in which a user profile is created.
* @public */ - description?: string | undefined; + domainIdentifier: string | undefined; /** - *The timestamp at which the asset of the data product listing was created.
+ *The identifier of the user for which the user profile is created.
* @public */ - createdAt?: Date | undefined; + userIdentifier: string | undefined; /** - *The timestamp at which the listing was created.
+ *The user type of the user for which the user profile is created.
* @public */ - listingCreatedBy?: string | undefined; + userType?: UserType | undefined; /** - *The user who updated the listing.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - listingUpdatedBy?: string | undefined; + clientToken?: string | undefined; +} +/** + *The details of an IAM user profile in Amazon DataZone.
+ * @public + */ +export interface IamUserProfileDetails { /** - *The glossary terms of the asset of the asset of the data product.
+ *The ARN of an IAM user profile in Amazon DataZone.
* @public */ - glossaryTerms?: DetailedGlossaryTerm[] | undefined; + arn?: string | undefined; +} +/** + *The single sign-on details of the user profile.
+ * @public + */ +export interface SsoUserProfileDetails { /** - *The ID of the owning project of the asset of the data product.
+ *The username included in the single sign-on details of the user profile.
* @public */ - owningProjectId?: string | undefined; + username?: string | undefined; /** - *The additional attributes of the asset of the data product.
+ *The first name included in the single sign-on details of the user profile.
* @public */ - additionalAttributes?: DataProductListingItemAdditionalAttributes | undefined; + firstName?: string | undefined; /** - *The data of the asset of the data product.
+ *The last name included in the single sign-on details of the user profile.
* @public */ - items?: ListingSummaryItem[] | undefined; + lastName?: string | undefined; } /** - *The data product.
+ *The details of the user profile in Amazon DataZone.
* @public */ -export interface DataProductResultItem { - /** - *The ID of the domain where the data product lives.
- * @public - */ - domainId: string | undefined; +export type UserProfileDetails = + | UserProfileDetails.IamMember + | UserProfileDetails.SsoMember + | UserProfileDetails.$UnknownMember; +/** + * @public + */ +export namespace UserProfileDetails { /** - *The ID of the data product.
+ *The IAM details included in the user profile details.
* @public */ - id: string | undefined; + export interface IamMember { + iam: IamUserProfileDetails; + sso?: never; + $unknown?: never; + } /** - *The name of the data product.
+ *The single sign-on details included in the user profile details.
* @public */ - name: string | undefined; + export interface SsoMember { + iam?: never; + sso: SsoUserProfileDetails; + $unknown?: never; + } /** - *The ID of the owning project of the data product.
* @public */ - owningProjectId: string | undefined; + export interface $UnknownMember { + iam?: never; + sso?: never; + $unknown: [string, any]; + } - /** - *The description of the data product.
- * @public - */ - description?: string | undefined; + export interface VisitorThe glossary terms of the data product.
- * @public - */ - glossaryTerms?: string[] | undefined; + export const visit =The timestamp at which the data product was created.
- * @public - */ - createdAt?: Date | undefined; +/** + * @public + * @enum + */ +export const UserProfileStatus = { + ACTIVATED: "ACTIVATED", + ASSIGNED: "ASSIGNED", + DEACTIVATED: "DEACTIVATED", + NOT_ASSIGNED: "NOT_ASSIGNED", +} as const; - /** - *The user who created the data product.
- * @public - */ - createdBy?: string | undefined; +/** + * @public + */ +export type UserProfileStatus = (typeof UserProfileStatus)[keyof typeof UserProfileStatus]; - /** - *The timestamp at which first revision of the data product was created.
- * @public - */ - firstRevisionCreatedAt?: Date | undefined; +/** + * @public + * @enum + */ +export const UserProfileType = { + IAM: "IAM", + SSO: "SSO", +} as const; - /** - *The user who created the first revision of the data product.
- * @public - */ - firstRevisionCreatedBy?: string | undefined; -} +/** + * @public + */ +export type UserProfileType = (typeof UserProfileType)[keyof typeof UserProfileType]; /** - *The data product revision.
* @public */ -export interface DataProductRevision { +export interface CreateUserProfileOutput { /** - *The ID of the domain where the data product revision lives.
+ *The identifier of the Amazon DataZone domain in which a user profile is created.
* @public */ domainId?: string | undefined; /** - *The ID of the data product revision.
+ *The identifier of the user profile.
* @public */ id?: string | undefined; /** - *The data product revision.
- * @public - */ - revision?: string | undefined; - - /** - *The timestamp at which the data product revision was created.
- * @public - */ - createdAt?: Date | undefined; - - /** - *The user who created the data product revision.
- * @public - */ - createdBy?: string | undefined; -} - -/** - * @public - */ -export interface DeleteDataSourceInput { - /** - *The ID of the Amazon DataZone domain in which the data source is deleted.
- * @public - */ - domainIdentifier: string | undefined; - - /** - *The identifier of the data source that is deleted.
+ *The type of the user profile.
* @public */ - identifier: string | undefined; + type?: UserProfileType | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The status of the user profile.
* @public */ - clientToken?: string | undefined; + status?: UserProfileStatus | undefined; /** - *Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.
+ *The details of the user profile in Amazon DataZone.
* @public */ - retainPermissionsOnRevokeFailure?: boolean | undefined; + details?: UserProfileDetails | undefined; } /** * @public * @enum */ -export const SelfGrantStatus = { - GRANTED: "GRANTED", - GRANT_FAILED: "GRANT_FAILED", - GRANT_IN_PROGRESS: "GRANT_IN_PROGRESS", - GRANT_PENDING: "GRANT_PENDING", - REVOKE_FAILED: "REVOKE_FAILED", - REVOKE_IN_PROGRESS: "REVOKE_IN_PROGRESS", - REVOKE_PENDING: "REVOKE_PENDING", +export const DataAssetActivityStatus = { + FAILED: "FAILED", + PUBLISHING_FAILED: "PUBLISHING_FAILED", + SKIPPED_ALREADY_IMPORTED: "SKIPPED_ALREADY_IMPORTED", + SKIPPED_ARCHIVED: "SKIPPED_ARCHIVED", + SKIPPED_NO_ACCESS: "SKIPPED_NO_ACCESS", + SUCCEEDED_CREATED: "SUCCEEDED_CREATED", + SUCCEEDED_UPDATED: "SUCCEEDED_UPDATED", + UNCHANGED: "UNCHANGED", } as const; /** * @public */ -export type SelfGrantStatus = (typeof SelfGrantStatus)[keyof typeof SelfGrantStatus]; +export type DataAssetActivityStatus = (typeof DataAssetActivityStatus)[keyof typeof DataAssetActivityStatus]; /** - *The details for the self granting status.
* @public */ -export interface SelfGrantStatusDetail { - /** - *The name of the database used for the data source.
- * @public - */ - databaseName: string | undefined; - - /** - *The name of the schema used in the data source.
- * @public - */ - schemaName?: string | undefined; - +export interface DeleteDataProductInput { /** - *The self granting status of the data source.
+ *The ID of the Amazon DataZone domain in which the data product is deleted.
* @public */ - status: SelfGrantStatus | undefined; + domainIdentifier: string | undefined; /** - *The reason for why the operation failed.
+ *The identifier of the data product that is deleted.
* @public */ - failureCause?: string | undefined; + identifier: string | undefined; } /** - *The details of the self granting status.
* @public */ -export interface GlueSelfGrantStatusOutput { - /** - *The details for the self granting status for a Glue data source.
- * @public - */ - selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; -} +export interface DeleteDataProductOutput {} /** - *The details for the self granting status for an Amazon Redshift data source.
* @public */ -export interface RedshiftSelfGrantStatusOutput { +export interface GetDataProductInput { /** - *The details for the self granting status for an Amazon Redshift data source.
+ *The ID of the domain where the data product lives.
* @public */ - selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; -} - -/** - *The details for the self granting status for a data source.
- * @public - */ -export type SelfGrantStatusOutput = - | SelfGrantStatusOutput.GlueSelfGrantStatusMember - | SelfGrantStatusOutput.RedshiftSelfGrantStatusMember - | SelfGrantStatusOutput.$UnknownMember; + domainIdentifier: string | undefined; -/** - * @public - */ -export namespace SelfGrantStatusOutput { /** - *The details for the self granting status for a Glue data source.
+ *The ID of the data product.
* @public */ - export interface GlueSelfGrantStatusMember { - glueSelfGrantStatus: GlueSelfGrantStatusOutput; - redshiftSelfGrantStatus?: never; - $unknown?: never; - } + identifier: string | undefined; /** - *The details for the self granting status for an Amazon Redshift data source.
+ *The revision of the data product.
* @public */ - export interface RedshiftSelfGrantStatusMember { - glueSelfGrantStatus?: never; - redshiftSelfGrantStatus: RedshiftSelfGrantStatusOutput; - $unknown?: never; - } + revision?: string | undefined; +} +/** + * @public + */ +export interface GetDataProductOutput { /** - * @public - */ - export interface $UnknownMember { - glueSelfGrantStatus?: never; - redshiftSelfGrantStatus?: never; - $unknown: [string, any]; - } - - export interface VisitorThe ID of the domain where the data product lives.
+ * @public + */ + domainId: string | undefined; -/** - * @public - */ -export interface DeleteDataSourceOutput { /** - *The ID of the data source that is deleted.
+ *The ID of the data product.
* @public */ id: string | undefined; /** - *The status of this data source.
+ *The revision of the data product.
* @public */ - status?: DataSourceStatus | undefined; + revision: string | undefined; /** - *The type of this data source.
+ *The ID of the owning project of the data product.
* @public */ - type?: string | undefined; + owningProjectId: string | undefined; /** - *The name of the data source that is deleted.
+ *The name of the data product.
* @public */ name: string | undefined; /** - *The description of the data source that is deleted.
+ *The status of the data product.
+ * @public + */ + status: DataProductStatus | undefined; + + /** + *The description of the data product.
* @public */ description?: string | undefined; /** - *The ID of the Amazon DataZone domain in which the data source is deleted.
+ *The glossary terms of the data product.
* @public */ - domainId: string | undefined; + glossaryTerms?: string[] | undefined; /** - *The ID of the project in which this data source exists and from which it's - * deleted.
+ *The data assets of the data product.
* @public */ - projectId: string | undefined; + items?: DataProductItem[] | undefined; /** - *The ID of the environemnt associated with this data source.
+ *The metadata forms of the data product.
* @public */ - environmentId: string | undefined; + formsOutput?: FormOutput[] | undefined; /** - *The configuration of the data source that is deleted.
+ *The timestamp at which the data product is created.
* @public */ - configuration?: DataSourceConfigurationOutput | undefined; + createdAt?: Date | undefined; /** - *The enable setting of the data source that specifies whether the data source is enabled - * or disabled.
+ *The user who created the data product.
* @public */ - enableSetting?: EnableSetting | undefined; + createdBy?: string | undefined; /** - *Specifies whether the assets that this data source creates in the inventory are to be - * also automatically published to the catalog.
+ *The timestamp at which the first revision of the data product is created.
* @public */ - publishOnImport?: boolean | undefined; + firstRevisionCreatedAt?: Date | undefined; /** - *The asset data forms associated with this data source.
+ *The user who created the first revision of the data product.
* @public */ - assetFormsOutput?: FormOutput[] | undefined; + firstRevisionCreatedBy?: string | undefined; +} +/** + *The summary of the listing of the data product.
+ * @public + */ +export interface ListingSummary { /** - *The schedule of runs for this data source.
+ *The ID of the data product listing.
* @public */ - schedule?: ScheduleConfiguration | undefined; + listingId?: string | undefined; /** - *The status of the last run of this data source.
+ *The revision of the data product listing.
* @public */ - lastRunStatus?: DataSourceRunStatus | undefined; + listingRevision?: string | undefined; /** - *The timestamp of when the data source was last run.
+ *The glossary terms of the data product.
* @public */ - lastRunAt?: Date | undefined; + glossaryTerms?: DetailedGlossaryTerm[] | undefined; +} +/** + *The data product listing.
+ * @public + */ +export interface DataProductListing { /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The ID of the data product listing.
* @public */ - lastRunErrorMessage?: DataSourceErrorMessage | undefined; + dataProductId?: string | undefined; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The revision of the data product listing.
* @public */ - errorMessage?: DataSourceErrorMessage | undefined; + dataProductRevision?: string | undefined; /** - *The timestamp of when this data source was created.
+ *The timestamp at which the data product listing was created.
* @public */ createdAt?: Date | undefined; /** - *The timestamp of when this data source was updated.
+ *The metadata forms of the data product listing.
* @public */ - updatedAt?: Date | undefined; + forms?: string | undefined; /** - *Specifies the status of the self-granting functionality.
+ *The glossary terms of the data product listing.
* @public */ - selfGrantStatus?: SelfGrantStatusOutput | undefined; + glossaryTerms?: DetailedGlossaryTerm[] | undefined; /** - *Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.
+ *The ID of the owning project of the data product listing.
* @public */ - retainPermissionsOnRevokeFailure?: boolean | undefined; + owningProjectId?: string | undefined; + + /** + *The data assets of the data product listing.
+ * @public + */ + items?: ListingSummary[] | undefined; } /** + *The additional attributes of the asset of the data product.
* @public */ -export interface GetDataSourceInput { +export interface DataProductListingItemAdditionalAttributes { /** - *The ID of the Amazon DataZone domain in which the data source exists.
+ *The metadata forms of the asset of the data product.
* @public */ - domainIdentifier: string | undefined; + forms?: string | undefined; +} +/** + *The results of the data product summary.
+ * @public + */ +export interface ListingSummaryItem { /** - *The ID of the Amazon DataZone data source.
+ *The ID of the data product listing.
* @public */ - identifier: string | undefined; + listingId?: string | undefined; + + /** + *The revision of the data product listing.
+ * @public + */ + listingRevision?: string | undefined; + + /** + *The glossary terms of the data product listing.
+ * @public + */ + glossaryTerms?: DetailedGlossaryTerm[] | undefined; } /** + *The asset of the data product listing.
* @public */ -export interface GetDataSourceOutput { +export interface DataProductListingItem { /** - *The ID of the data source.
+ *The ID of the listing.
* @public */ - id: string | undefined; + listingId?: string | undefined; /** - *The status of the data source.
+ *The revision of the listing.
* @public */ - status?: DataSourceStatus | undefined; + listingRevision?: string | undefined; /** - *The type of the data source.
+ *The name of the asset of the data product.
* @public */ - type?: string | undefined; + name?: string | undefined; /** - *The name of the data source.
+ *The entity ID of the asset of the asset of the data product.
* @public */ - name: string | undefined; + entityId?: string | undefined; /** - *The description of the data source.
+ *The revision of the asset of the asset of the data product.
+ * @public + */ + entityRevision?: string | undefined; + + /** + *The description of the asset of the asset of the data product.
* @public */ description?: string | undefined; /** - *The ID of the Amazon DataZone domain in which the data source exists.
+ *The timestamp at which the asset of the data product listing was created.
* @public */ - domainId: string | undefined; + createdAt?: Date | undefined; /** - *The ID of the project where the data source creates and publishes assets.
+ *The timestamp at which the listing was created.
* @public */ - projectId: string | undefined; + listingCreatedBy?: string | undefined; /** - *The ID of the environment where this data source creates and publishes assets,
+ *The user who updated the listing.
* @public */ - environmentId: string | undefined; + listingUpdatedBy?: string | undefined; /** - *The configuration of the data source.
+ *The glossary terms of the asset of the asset of the data product.
* @public */ - configuration?: DataSourceConfigurationOutput | undefined; + glossaryTerms?: DetailedGlossaryTerm[] | undefined; /** - *The recommendation configuration of the data source.
+ *The ID of the owning project of the asset of the data product.
* @public */ - recommendation?: RecommendationConfiguration | undefined; + owningProjectId?: string | undefined; /** - *Specifies whether this data source is enabled or not.
+ *The additional attributes of the asset of the data product.
* @public */ - enableSetting?: EnableSetting | undefined; + additionalAttributes?: DataProductListingItemAdditionalAttributes | undefined; /** - *Specifies whether the assets that this data source creates in the inventory are to be - * also automatically published to the catalog.
+ *The data of the asset of the data product.
* @public */ - publishOnImport?: boolean | undefined; + items?: ListingSummaryItem[] | undefined; +} +/** + *The data product.
+ * @public + */ +export interface DataProductResultItem { /** - *The metadata forms attached to the assets created by this data source.
+ *The ID of the domain where the data product lives.
* @public */ - assetFormsOutput?: FormOutput[] | undefined; + domainId: string | undefined; /** - *The schedule of the data source runs.
+ *The ID of the data product.
* @public */ - schedule?: ScheduleConfiguration | undefined; + id: string | undefined; /** - *The status of the last run of the data source.
+ *The name of the data product.
* @public */ - lastRunStatus?: DataSourceRunStatus | undefined; + name: string | undefined; /** - *The timestamp of the last run of the data source.
+ *The ID of the owning project of the data product.
* @public */ - lastRunAt?: Date | undefined; + owningProjectId: string | undefined; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The description of the data product.
* @public */ - lastRunErrorMessage?: DataSourceErrorMessage | undefined; + description?: string | undefined; + + /** + *The glossary terms of the data product.
+ * @public + */ + glossaryTerms?: string[] | undefined; + + /** + *The timestamp at which the data product was created.
+ * @public + */ + createdAt?: Date | undefined; + + /** + *The user who created the data product.
+ * @public + */ + createdBy?: string | undefined; + + /** + *The timestamp at which first revision of the data product was created.
+ * @public + */ + firstRevisionCreatedAt?: Date | undefined; + + /** + *The user who created the first revision of the data product.
+ * @public + */ + firstRevisionCreatedBy?: string | undefined; +} +/** + *The data product revision.
+ * @public + */ +export interface DataProductRevision { /** - *The number of assets created by the data source during its last run.
+ *The ID of the domain where the data product revision lives.
* @public */ - lastRunAssetCount?: number | undefined; + domainId?: string | undefined; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The ID of the data product revision.
* @public */ - errorMessage?: DataSourceErrorMessage | undefined; + id?: string | undefined; /** - *The timestamp of when the data source was created.
+ *The data product revision.
* @public */ - createdAt?: Date | undefined; + revision?: string | undefined; /** - *The timestamp of when the data source was updated.
+ *The timestamp at which the data product revision was created.
* @public */ - updatedAt?: Date | undefined; + createdAt?: Date | undefined; /** - *Specifies the status of the self-granting functionality.
+ *The user who created the data product revision.
* @public */ - selfGrantStatus?: SelfGrantStatusOutput | undefined; + createdBy?: string | undefined; } /** * @public */ -export interface ListDataSourcesInput { +export interface DeleteDataSourceInput { /** - *The identifier of the Amazon DataZone domain in which to list the data sources.
+ *The ID of the Amazon DataZone domain in which the data source is deleted.
* @public */ domainIdentifier: string | undefined; /** - *The identifier of the project in which to list data sources.
+ *The identifier of the data source that is deleted.
* @public */ - projectIdentifier: string | undefined; + identifier: string | undefined; /** - *The identifier of the environment in which to list the data sources.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - environmentIdentifier?: string | undefined; + clientToken?: string | undefined; /** - *The type of the data source.
+ *Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.
* @public */ - type?: string | undefined; + retainPermissionsOnRevokeFailure?: boolean | undefined; +} + +/** + * @public + * @enum + */ +export const SelfGrantStatus = { + GRANTED: "GRANTED", + GRANT_FAILED: "GRANT_FAILED", + GRANT_IN_PROGRESS: "GRANT_IN_PROGRESS", + GRANT_PENDING: "GRANT_PENDING", + REVOKE_FAILED: "REVOKE_FAILED", + REVOKE_IN_PROGRESS: "REVOKE_IN_PROGRESS", + REVOKE_PENDING: "REVOKE_PENDING", +} as const; + +/** + * @public + */ +export type SelfGrantStatus = (typeof SelfGrantStatus)[keyof typeof SelfGrantStatus]; +/** + *The details for the self granting status.
+ * @public + */ +export interface SelfGrantStatusDetail { /** - *The status of the data source.
+ *The name of the database used for the data source.
* @public */ - status?: DataSourceStatus | undefined; + databaseName: string | undefined; /** - *The name of the data source.
+ *The name of the schema used in the data source.
* @public */ - name?: string | undefined; + schemaName?: string | undefined; /** - *When the number of data sources is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of data sources, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListDataSources to
- * list the next set of data sources.
The self granting status of the data source.
* @public */ - nextToken?: string | undefined; + status: SelfGrantStatus | undefined; /** - *The maximum number of data sources to return in a single call to
- * ListDataSources. When the number of data sources to be listed is greater
- * than the value of MaxResults, the response contains a NextToken
- * value that you can use in a subsequent call to ListDataSources to list the
- * next set of data sources.
The reason for why the operation failed.
* @public */ - maxResults?: number | undefined; + failureCause?: string | undefined; } /** - *The details of the data source.
+ *The details of the self granting status.
* @public */ -export interface DataSourceSummary { +export interface GlueSelfGrantStatusOutput { /** - *The ID of the Amazon DataZone domain in which the data source exists.
+ *The details for the self granting status for a Glue data source.
* @public */ - domainId: string | undefined; + selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; +} +/** + *The details for the self granting status for an Amazon Redshift data source.
+ * @public + */ +export interface RedshiftSelfGrantStatusOutput { /** - *The ID of the environment in which the data source exists.
+ *The details for the self granting status for an Amazon Redshift data source.
* @public */ - environmentId: string | undefined; + selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; +} + +/** + *The details for the self granting status for a data source.
+ * @public + */ +export type SelfGrantStatusOutput = + | SelfGrantStatusOutput.GlueSelfGrantStatusMember + | SelfGrantStatusOutput.RedshiftSelfGrantStatusMember + | SelfGrantStatusOutput.$UnknownMember; +/** + * @public + */ +export namespace SelfGrantStatusOutput { /** - *The ID of the data source.
+ *The details for the self granting status for a Glue data source.
* @public */ - dataSourceId: string | undefined; + export interface GlueSelfGrantStatusMember { + glueSelfGrantStatus: GlueSelfGrantStatusOutput; + redshiftSelfGrantStatus?: never; + $unknown?: never; + } /** - *The name of the data source.
+ *The details for the self granting status for an Amazon Redshift data source.
* @public */ - name: string | undefined; + export interface RedshiftSelfGrantStatusMember { + glueSelfGrantStatus?: never; + redshiftSelfGrantStatus: RedshiftSelfGrantStatusOutput; + $unknown?: never; + } /** - *The type of the data source.
* @public */ - type: string | undefined; + export interface $UnknownMember { + glueSelfGrantStatus?: never; + redshiftSelfGrantStatus?: never; + $unknown: [string, any]; + } + + export interface VisitorThe status of the data source.
+ *The ID of the data source that is deleted.
* @public */ - status: DataSourceStatus | undefined; + id: string | undefined; /** - *Specifies whether the data source is enabled.
+ *The status of this data source.
* @public */ - enableSetting?: EnableSetting | undefined; + status?: DataSourceStatus | undefined; /** - *The details of the schedule of the data source runs.
+ *The type of this data source.
* @public */ - schedule?: ScheduleConfiguration | undefined; + type?: string | undefined; /** - *The status of the last data source run.
+ *The name of the data source that is deleted.
* @public */ - lastRunStatus?: DataSourceRunStatus | undefined; + name: string | undefined; /** - *The timestamp of when the data source run was last performed.
+ *The description of the data source that is deleted.
* @public */ - lastRunAt?: Date | undefined; + description?: string | undefined; /** - *The details of the error message that is returned if the operation cannot be - * successfully completed.
+ *The ID of the Amazon DataZone domain in which the data source is deleted.
* @public */ - lastRunErrorMessage?: DataSourceErrorMessage | undefined; + domainId: string | undefined; /** - *The count of the assets created during the last data source run.
+ *The ID of the project in which this data source exists and from which it's + * deleted.
* @public */ - lastRunAssetCount?: number | undefined; + projectId: string | undefined; /** - *The timestamp of when the data source was created.
+ *The ID of the environemnt associated with this data source.
* @public */ - createdAt?: Date | undefined; + environmentId: string | undefined; /** - *The timestamp of when the data source was updated.
+ *The configuration of the data source that is deleted.
* @public */ - updatedAt?: Date | undefined; -} + configuration?: DataSourceConfigurationOutput | undefined; -/** - * @public - */ -export interface ListDataSourcesOutput { /** - *The results of the ListDataSources action.
The enable setting of the data source that specifies whether the data source is enabled + * or disabled.
* @public */ - items: DataSourceSummary[] | undefined; + enableSetting?: EnableSetting | undefined; /** - *When the number of data sources is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of data sources, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListDataSources to
- * list the next set of data sources.
Specifies whether the assets that this data source creates in the inventory are to be + * also automatically published to the catalog.
* @public */ - nextToken?: string | undefined; -} + publishOnImport?: boolean | undefined; -/** - * @public - */ -export interface UpdateDataSourceInput { /** - *The identifier of the domain in which to update a data source.
+ *The asset data forms associated with this data source.
* @public */ - domainIdentifier: string | undefined; + assetFormsOutput?: FormOutput[] | undefined; /** - *The identifier of the data source to be updated.
+ *The schedule of runs for this data source.
* @public */ - identifier: string | undefined; + schedule?: ScheduleConfiguration | undefined; /** - *The name to be updated as part of the UpdateDataSource action.
The status of the last run of this data source.
* @public */ - name?: string | undefined; + lastRunStatus?: DataSourceRunStatus | undefined; /** - *The description to be updated as part of the UpdateDataSource
- * action.
The timestamp of when the data source was last run.
* @public */ - description?: string | undefined; + lastRunAt?: Date | undefined; /** - *The enable setting to be updated as part of the UpdateDataSource
- * action.
Specifies the error message that is returned if the operation cannot be successfully + * completed.
+ * @public + */ + lastRunErrorMessage?: DataSourceErrorMessage | undefined; + + /** + *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - enableSetting?: EnableSetting | undefined; + errorMessage?: DataSourceErrorMessage | undefined; /** - *The publish on import setting to be updated as part of the UpdateDataSource
- * action.
The timestamp of when this data source was created.
* @public */ - publishOnImport?: boolean | undefined; + createdAt?: Date | undefined; /** - *The asset forms to be updated as part of the UpdateDataSource
- * action.
The timestamp of when this data source was updated.
* @public */ - assetFormsInput?: FormInput[] | undefined; + updatedAt?: Date | undefined; /** - *The schedule to be updated as part of the UpdateDataSource action.
Specifies the status of the self-granting functionality.
* @public */ - schedule?: ScheduleConfiguration | undefined; + selfGrantStatus?: SelfGrantStatusOutput | undefined; /** - *The configuration to be updated as part of the UpdateDataSource
- * action.
Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.
* @public */ - configuration?: DataSourceConfigurationInput | undefined; + retainPermissionsOnRevokeFailure?: boolean | undefined; +} +/** + * @public + */ +export interface GetDataSourceInput { /** - *The recommendation to be updated as part of the UpdateDataSource
- * action.
The ID of the Amazon DataZone domain in which the data source exists.
* @public */ - recommendation?: RecommendationConfiguration | undefined; + domainIdentifier: string | undefined; /** - *Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.
+ *The ID of the Amazon DataZone data source.
* @public */ - retainPermissionsOnRevokeFailure?: boolean | undefined; + identifier: string | undefined; } /** * @public */ -export interface UpdateDataSourceOutput { +export interface GetDataSourceOutput { /** - *The identifier of the data source to be updated.
+ *The ID of the data source.
* @public */ id: string | undefined; /** - *The status to be updated as part of the UpdateDataSource action.
The status of the data source.
* @public */ status?: DataSourceStatus | undefined; /** - *The type to be updated as part of the UpdateDataSource action.
The type of the data source.
* @public */ type?: string | undefined; /** - *The name to be updated as part of the UpdateDataSource action.
The name of the data source.
* @public */ name: string | undefined; /** - *The description to be updated as part of the UpdateDataSource
- * action.
The description of the data source.
* @public */ description?: string | undefined; /** - *The identifier of the Amazon DataZone domain in which a data source is to be updated.
+ *The ID of the Amazon DataZone domain in which the data source exists.
* @public */ domainId: string | undefined; /** - *The identifier of the project where data source is to be updated.
+ *The ID of the project where the data source creates and publishes assets.
* @public */ projectId: string | undefined; /** - *The identifier of the environment in which a data source is to be updated.
+ *The ID of the environment where this data source creates and publishes assets,
* @public */ environmentId: string | undefined; /** - *The configuration to be updated as part of the UpdateDataSource
- * action.
The configuration of the data source.
* @public */ configuration?: DataSourceConfigurationOutput | undefined; /** - *The recommendation to be updated as part of the UpdateDataSource
- * action.
The recommendation configuration of the data source.
* @public */ recommendation?: RecommendationConfiguration | undefined; /** - *The enable setting to be updated as part of the UpdateDataSource
- * action.
Specifies whether this data source is enabled or not.
* @public */ enableSetting?: EnableSetting | undefined; /** - *The publish on import setting to be updated as part of the UpdateDataSource
- * action.
Specifies whether the assets that this data source creates in the inventory are to be + * also automatically published to the catalog.
* @public */ publishOnImport?: boolean | undefined; /** - *The asset forms to be updated as part of the UpdateDataSource
- * action.
The metadata forms attached to the assets created by this data source.
* @public */ assetFormsOutput?: FormOutput[] | undefined; /** - *The schedule to be updated as part of the UpdateDataSource action.
The schedule of the data source runs.
* @public */ schedule?: ScheduleConfiguration | undefined; /** - *The last run status of the data source.
+ *The status of the last run of the data source.
* @public */ lastRunStatus?: DataSourceRunStatus | undefined; /** - *The timestamp of when the data source was last run.
+ *The timestamp of the last run of the data source.
* @public */ lastRunAt?: Date | undefined; /** - *The last run error message of the data source.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ lastRunErrorMessage?: DataSourceErrorMessage | undefined; + /** + *The number of assets created by the data source during its last run.
+ * @public + */ + lastRunAssetCount?: number | undefined; + /** *Specifies the error message that is returned if the operation cannot be successfully * completed.
@@ -9181,7 +9183,7 @@ export interface UpdateDataSourceOutput { errorMessage?: DataSourceErrorMessage | undefined; /** - *The timestamp of when the data source was updated.
+ *The timestamp of when the data source was created.
* @public */ createdAt?: Date | undefined; @@ -9197,1180 +9199,1111 @@ export interface UpdateDataSourceOutput { * @public */ selfGrantStatus?: SelfGrantStatusOutput | undefined; - - /** - *Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.
- * @public - */ - retainPermissionsOnRevokeFailure?: boolean | undefined; } -/** - * @public - * @enum - */ -export const DataSourceRunType = { - PRIORITIZED: "PRIORITIZED", - SCHEDULED: "SCHEDULED", -} as const; - -/** - * @public - */ -export type DataSourceRunType = (typeof DataSourceRunType)[keyof typeof DataSourceRunType]; - /** * @public */ -export interface GetDataSourceRunInput { +export interface ListDataSourcesInput { /** - *The ID of the domain in which this data source run was performed.
+ *The identifier of the Amazon DataZone domain in which to list the data sources.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the data source run.
+ *The identifier of the project in which to list data sources.
* @public */ - identifier: string | undefined; -} + projectIdentifier: string | undefined; -/** - *The asset statistics from the data source run.
- * @public - */ -export interface RunStatisticsForAssets { /** - *The added statistic for the data source run.
The identifier of the environment in which to list the data sources.
* @public */ - added?: number | undefined; + environmentIdentifier?: string | undefined; /** - *The updated statistic for the data source run.
The type of the data source.
* @public */ - updated?: number | undefined; + type?: string | undefined; /** - *The unchanged statistic for the data source run.
The status of the data source.
* @public */ - unchanged?: number | undefined; + status?: DataSourceStatus | undefined; /** - *The skipped statistic for the data source run.
The name of the data source.
* @public */ - skipped?: number | undefined; + name?: string | undefined; /** - *The failed statistic for the data source run.
When the number of data sources is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of data sources, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListDataSources to
+ * list the next set of data sources.
The maximum number of data sources to return in a single call to
+ * ListDataSources. When the number of data sources to be listed is greater
+ * than the value of MaxResults, the response contains a NextToken
+ * value that you can use in a subsequent call to ListDataSources to list the
+ * next set of data sources.
The details of the data source.
* @public */ -export interface GetDataSourceRunOutput { +export interface DataSourceSummary { /** - *The ID of the domain in which this data source run was performed.
+ *The ID of the Amazon DataZone domain in which the data source exists.
* @public */ domainId: string | undefined; /** - *The ID of the data source for this data source run.
+ *The ID of the environment in which the data source exists.
+ * @public + */ + environmentId: string | undefined; + + /** + *The ID of the data source.
* @public */ dataSourceId: string | undefined; /** - *The ID of the data source run.
+ *The name of the data source.
* @public */ - id: string | undefined; + name: string | undefined; /** - *The ID of the project in which this data source run occured.
+ *The type of the data source.
* @public */ - projectId: string | undefined; + type: string | undefined; /** - *The status of this data source run.
+ *The status of the data source.
* @public */ - status: DataSourceRunStatus | undefined; + status: DataSourceStatus | undefined; /** - *The type of this data source run.
+ *Specifies whether the data source is enabled.
* @public */ - type: DataSourceRunType | undefined; + enableSetting?: EnableSetting | undefined; /** - *The configuration snapshot of the data source run.
+ *The details of the schedule of the data source runs.
* @public */ - dataSourceConfigurationSnapshot?: string | undefined; + schedule?: ScheduleConfiguration | undefined; /** - *The asset statistics from this data source run.
+ *The status of the last data source run.
* @public */ - runStatisticsForAssets?: RunStatisticsForAssets | undefined; + lastRunStatus?: DataSourceRunStatus | undefined; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The timestamp of when the data source run was last performed.
* @public */ - errorMessage?: DataSourceErrorMessage | undefined; + lastRunAt?: Date | undefined; /** - *The timestamp of when the data source run was created.
+ *The details of the error message that is returned if the operation cannot be + * successfully completed.
* @public */ - createdAt: Date | undefined; + lastRunErrorMessage?: DataSourceErrorMessage | undefined; /** - *The timestamp of when this data source run was updated.
+ *The count of the assets created during the last data source run.
* @public */ - updatedAt: Date | undefined; + lastRunAssetCount?: number | undefined; /** - *The timestamp of when this data source run started.
+ *The timestamp of when the data source was created.
* @public */ - startedAt?: Date | undefined; + createdAt?: Date | undefined; /** - *The timestamp of when this data source run stopped.
+ *The timestamp of when the data source was updated.
* @public */ - stoppedAt?: Date | undefined; + updatedAt?: Date | undefined; } /** * @public */ -export interface ListDataSourceRunsInput { - /** - *The identifier of the Amazon DataZone domain in which to invoke the
- * ListDataSourceRuns action.
The identifier of the data source.
- * @public - */ - dataSourceIdentifier: string | undefined; - - /** - *The status of the data source.
- * @public - */ - status?: DataSourceRunStatus | undefined; - +export interface ListDataSourcesOutput { /** - *When the number of runs is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of runs, the response includes a
- * pagination token named NextToken. You can specify this NextToken
- * value in a subsequent call to ListDataSourceRuns to list the next set of
- * runs.
The results of the ListDataSources action.
The maximum number of runs to return in a single call to
- * ListDataSourceRuns. When the number of runs to be listed is greater than the
- * value of MaxResults, the response contains a NextToken value that
- * you can use in a subsequent call to ListDataSourceRuns to list the next set of
- * runs.
When the number of data sources is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of data sources, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListDataSources to
+ * list the next set of data sources.
The details of a data source run.
* @public */ -export interface DataSourceRunSummary { +export interface UpdateDataSourceInput { /** - *The identifier of the data source run.
+ *The identifier of the domain in which to update a data source.
* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *The identifier of the data source of the data source run.
+ *The identifier of the data source to be updated.
* @public */ - dataSourceId: string | undefined; + identifier: string | undefined; /** - *The type of the data source run.
+ *The name to be updated as part of the UpdateDataSource action.
The status of the data source run.
+ *The description to be updated as part of the UpdateDataSource
+ * action.
The project ID of the data source run.
+ *The enable setting to be updated as part of the UpdateDataSource
+ * action.
The asset statistics from the data source run.
+ *The publish on import setting to be updated as part of the UpdateDataSource
+ * action.
The details of the error message that is returned if the operation cannot be - * successfully completed.
+ *The asset forms to be updated as part of the UpdateDataSource
+ * action.
The timestamp of when a data source run was created.
+ *The schedule to be updated as part of the UpdateDataSource action.
The timestamp of when a data source run was updated.
+ *The configuration to be updated as part of the UpdateDataSource
+ * action.
The timestamp of when a data source run was started.
+ *The recommendation to be updated as part of the UpdateDataSource
+ * action.
The timestamp of when a data source run was stopped.
+ *Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.
* @public */ - stoppedAt?: Date | undefined; + retainPermissionsOnRevokeFailure?: boolean | undefined; } /** * @public */ -export interface ListDataSourceRunsOutput { +export interface UpdateDataSourceOutput { /** - *The results of the ListDataSourceRuns action.
The identifier of the data source to be updated.
* @public */ - items: DataSourceRunSummary[] | undefined; + id: string | undefined; /** - *When the number of runs is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of runs, the response includes a
- * pagination token named NextToken. You can specify this NextToken
- * value in a subsequent call to ListDataSourceRuns to list the next set of
- * runs.
The status to be updated as part of the UpdateDataSource action.
The identifier of the Amazon DataZone domain in which to start a data source run.
+ *The type to be updated as part of the UpdateDataSource action.
The identifier of the data source.
+ *The name to be updated as part of the UpdateDataSource action.
A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The description to be updated as part of the UpdateDataSource
+ * action.
The identifier of the Amazon DataZone domain in which to start a data source run.
+ *The identifier of the Amazon DataZone domain in which a data source is to be updated.
* @public */ domainId: string | undefined; /** - *The identifier of the data source.
+ *The identifier of the project where data source is to be updated.
* @public */ - dataSourceId: string | undefined; + projectId: string | undefined; /** - *The identifier of the data source run.
+ *The identifier of the environment in which a data source is to be updated.
* @public */ - id: string | undefined; + environmentId: string | undefined; /** - *The identifier of the project.
+ *The configuration to be updated as part of the UpdateDataSource
+ * action.
The status of the data source run.
+ *The recommendation to be updated as part of the UpdateDataSource
+ * action.
The type of the data source run.
+ *The enable setting to be updated as part of the UpdateDataSource
+ * action.
The configuration snapshot of the data source that is being run.
+ *The publish on import setting to be updated as part of the UpdateDataSource
+ * action.
Specifies run statistics for assets.
+ *The asset forms to be updated as part of the UpdateDataSource
+ * action.
Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The schedule to be updated as part of the UpdateDataSource action.
The timestamp of when data source run was created.
+ *The last run status of the data source.
* @public */ - createdAt: Date | undefined; + lastRunStatus?: DataSourceRunStatus | undefined; /** - *The timestamp of when the data source run was updated.
+ *The timestamp of when the data source was last run.
* @public */ - updatedAt: Date | undefined; + lastRunAt?: Date | undefined; /** - *The timestamp of when the data source run was started.
+ *The last run error message of the data source.
* @public */ - startedAt?: Date | undefined; + lastRunErrorMessage?: DataSourceErrorMessage | undefined; /** - *The timestamp of when the data source run was stopped.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - stoppedAt?: Date | undefined; -} + errorMessage?: DataSourceErrorMessage | undefined; -/** - *The activity details of the data source run.
- * @public - */ -export interface DataSourceRunActivity { /** - *The database included in the data source run activity.
+ *The timestamp of when the data source was updated.
* @public */ - database: string | undefined; + createdAt?: Date | undefined; /** - *The identifier of the data source for the data source run activity.
+ *The timestamp of when the data source was updated.
* @public */ - dataSourceRunId: string | undefined; + updatedAt?: Date | undefined; /** - *The technical name included in the data source run activity.
+ *Specifies the status of the self-granting functionality.
* @public */ - technicalName: string | undefined; + selfGrantStatus?: SelfGrantStatusOutput | undefined; /** - *The status of the asset included in the data source run activity.
+ *Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.
* @public */ - dataAssetStatus: DataAssetActivityStatus | undefined; + retainPermissionsOnRevokeFailure?: boolean | undefined; +} + +/** + * @public + * @enum + */ +export const DataSourceRunType = { + PRIORITIZED: "PRIORITIZED", + SCHEDULED: "SCHEDULED", +} as const; + +/** + * @public + */ +export type DataSourceRunType = (typeof DataSourceRunType)[keyof typeof DataSourceRunType]; +/** + * @public + */ +export interface GetDataSourceRunInput { /** - *The project ID included in the data source run activity.
+ *The ID of the domain in which this data source run was performed.
* @public */ - projectId: string | undefined; + domainIdentifier: string | undefined; /** - *The identifier of the asset included in the data source run activity.
+ *The ID of the data source run.
* @public */ - dataAssetId?: string | undefined; + identifier: string | undefined; +} +/** + *The asset statistics from the data source run.
+ * @public + */ +export interface RunStatisticsForAssets { /** - *The technical description included in the data source run activity.
+ *The added statistic for the data source run.
The details of the error message that is returned if the operation cannot be - * successfully completed.
+ *The updated statistic for the data source run.
The timestamp of when data source run activity was created.
+ *The unchanged statistic for the data source run.
The timestamp of when data source run activity was updated.
+ *The skipped statistic for the data source run.
The failed statistic for the data source run.
The ID of the domain where you want to delete an asset filter.
+ *The ID of the domain in which this data source run was performed.
* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *The ID of the data asset.
+ *The ID of the data source for this data source run.
* @public */ - assetIdentifier: string | undefined; + dataSourceId: string | undefined; /** - *The ID of the asset filter that you want to delete.
+ *The ID of the data source run.
* @public */ - identifier: string | undefined; -} - -/** - * @public - */ -export interface DeleteEnvironmentInput { + id: string | undefined; + /** - *The ID of the Amazon DataZone domain in which the environment is deleted.
+ *The ID of the project in which this data source run occured.
* @public */ - domainIdentifier: string | undefined; + projectId: string | undefined; /** - *The identifier of the environment that is to be deleted.
+ *The status of this data source run.
* @public */ - identifier: string | undefined; -} + status: DataSourceRunStatus | undefined; -/** - * @public - */ -export interface DeleteEnvironmentActionInput { /** - *The ID of the Amazon DataZone domain in which an environment action is deleted.
+ *The type of this data source run.
* @public */ - domainIdentifier: string | undefined; + type: DataSourceRunType | undefined; /** - *The ID of the environment where an environment action is deleted.
+ *The configuration snapshot of the data source run.
* @public */ - environmentIdentifier: string | undefined; + dataSourceConfigurationSnapshot?: string | undefined; /** - *The ID of the environment action that is deleted.
+ *The asset statistics from this data source run.
* @public */ - identifier: string | undefined; -} + runStatisticsForAssets?: RunStatisticsForAssets | undefined; -/** - * @public - */ -export interface DeleteEnvironmentProfileInput { /** - *The ID of the Amazon DataZone domain in which the environment profile is deleted.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - domainIdentifier: string | undefined; + errorMessage?: DataSourceErrorMessage | undefined; /** - *The ID of the environment profile that is deleted.
+ *The timestamp of when the data source run was created.
* @public */ - identifier: string | undefined; -} + createdAt: Date | undefined; -/** - * @public - */ -export interface DeleteProjectInput { /** - *The ID of the Amazon DataZone domain in which the project is deleted.
+ *The timestamp of when this data source run was updated.
* @public */ - domainIdentifier: string | undefined; + updatedAt: Date | undefined; /** - *The identifier of the project that is to be deleted.
+ *The timestamp of when this data source run started.
* @public */ - identifier: string | undefined; + startedAt?: Date | undefined; /** - *Specifies the optional flag to delete all child entities within the project.
+ *The timestamp of when this data source run stopped.
* @public */ - skipDeletionCheck?: boolean | undefined; + stoppedAt?: Date | undefined; } /** * @public */ -export interface DeleteProjectOutput {} - -/** - * @public - */ -export interface DeleteProjectMembershipInput { +export interface ListDataSourceRunsInput { /** - *The ID of the Amazon DataZone domain where project membership is deleted.
+ *The identifier of the Amazon DataZone domain in which to invoke the
+ * ListDataSourceRuns action.
The ID of the Amazon DataZone project the membership to which is deleted.
+ *The identifier of the data source.
* @public */ - projectIdentifier: string | undefined; + dataSourceIdentifier: string | undefined; /** - *The project member whose project membership is deleted.
+ *The status of the data source.
* @public */ - member: Member | undefined; -} - -/** - * @public - */ -export interface DeleteProjectMembershipOutput {} + status?: DataSourceRunStatus | undefined; -/** - * @public - */ -export interface DeleteSubscriptionGrantInput { /** - *The ID of the Amazon DataZone domain where the subscription grant is deleted.
+ *When the number of runs is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of runs, the response includes a
+ * pagination token named NextToken. You can specify this NextToken
+ * value in a subsequent call to ListDataSourceRuns to list the next set of
+ * runs.
The ID of the subscription grant that is deleted.
+ *The maximum number of runs to return in a single call to
+ * ListDataSourceRuns. When the number of runs to be listed is greater than the
+ * value of MaxResults, the response contains a NextToken value that
+ * you can use in a subsequent call to ListDataSourceRuns to list the next set of
+ * runs.
The details of a data source run.
* @public */ -export interface DeleteSubscriptionGrantOutput { +export interface DataSourceRunSummary { /** - *The ID of the subscription grant that is deleted.
+ *The identifier of the data source run.
* @public */ id: string | undefined; /** - *The Amazon DataZone user who created the subscription grant that is deleted.
+ *The identifier of the data source of the data source run.
* @public */ - createdBy: string | undefined; + dataSourceId: string | undefined; /** - *The Amazon DataZone user who updated the subscription grant that is deleted.
+ *The type of the data source run.
* @public */ - updatedBy?: string | undefined; + type: DataSourceRunType | undefined; /** - *The ID of the Amazon DataZone domain in which the subscription grant is deleted.
+ *The status of the data source run.
* @public */ - domainId: string | undefined; + status: DataSourceRunStatus | undefined; /** - *The timestamp of when the subscription grant that is deleted was created.
+ *The project ID of the data source run.
* @public */ - createdAt: Date | undefined; + projectId: string | undefined; /** - *The timestamp of when the subscription grant that is deleted was updated.
+ *The asset statistics from the data source run.
* @public */ - updatedAt: Date | undefined; + runStatisticsForAssets?: RunStatisticsForAssets | undefined; /** - *The ID of the subscription target associated with the subscription grant that is - * deleted.
+ *The details of the error message that is returned if the operation cannot be + * successfully completed.
* @public */ - subscriptionTargetId: string | undefined; + errorMessage?: DataSourceErrorMessage | undefined; /** - *The entity to which the subscription is deleted.
+ *The timestamp of when a data source run was created.
* @public */ - grantedEntity: GrantedEntity | undefined; + createdAt: Date | undefined; /** - *The status of the subscription grant that is deleted.
+ *The timestamp of when a data source run was updated.
* @public */ - status: SubscriptionGrantOverallStatus | undefined; + updatedAt: Date | undefined; /** - *The assets for which the subsctiption grant that is deleted gave access.
+ *The timestamp of when a data source run was started.
* @public */ - assets?: SubscribedAsset[] | undefined; + startedAt?: Date | undefined; /** - * @deprecated - * - *The identifier of the subsctiption whose subscription grant is to be deleted.
+ *The timestamp of when a data source run was stopped.
* @public */ - subscriptionId?: string | undefined; + stoppedAt?: Date | undefined; } /** * @public */ -export interface DeleteSubscriptionRequestInput { +export interface ListDataSourceRunsOutput { /** - *The ID of the Amazon DataZone domain in which the subscription request is deleted.
+ *The results of the ListDataSourceRuns action.
The ID of the subscription request that is deleted.
+ *When the number of runs is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of runs, the response includes a
+ * pagination token named NextToken. You can specify this NextToken
+ * value in a subsequent call to ListDataSourceRuns to list the next set of
+ * runs.
The ID of the Amazon DataZone domain in which the subscription target is deleted.
+ *The identifier of the Amazon DataZone domain in which to start a data source run.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the Amazon DataZone environment in which the subscription target is deleted.
+ *The identifier of the data source.
* @public */ - environmentIdentifier: string | undefined; + dataSourceIdentifier: string | undefined; /** - *The ID of the subscription target that is deleted.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - identifier: string | undefined; + clientToken?: string | undefined; } -/** - * @public - * @enum - */ -export const TimeSeriesEntityType = { - ASSET: "ASSET", - LISTING: "LISTING", -} as const; - -/** - * @public - */ -export type TimeSeriesEntityType = (typeof TimeSeriesEntityType)[keyof typeof TimeSeriesEntityType]; - /** * @public */ -export interface DeleteTimeSeriesDataPointsInput { - /** - *The ID of the Amazon DataZone domain that houses the asset for which you want to delete - * a time series form.
- * @public - */ - domainIdentifier: string | undefined; - - /** - *The ID of the asset for which you want to delete a time series form.
- * @public - */ - entityIdentifier: string | undefined; - - /** - *The type of the asset for which you want to delete a time series form.
- * @public - */ - entityType: TimeSeriesEntityType | undefined; - +export interface StartDataSourceRunOutput { /** - *The name of the time series form that you want to delete.
+ *The identifier of the Amazon DataZone domain in which to start a data source run.
* @public */ - formName: string | undefined; + domainId: string | undefined; /** - *A unique, case-sensitive identifier to ensure idempotency of the request. This field is - * automatically populated if not provided.
+ *The identifier of the data source.
* @public */ - clientToken?: string | undefined; -} - -/** - * @public - */ -export interface DeleteTimeSeriesDataPointsOutput {} + dataSourceId: string | undefined; -/** - * @public - */ -export interface DisassociateEnvironmentRoleInput { /** - *The ID of the Amazon DataZone domain in which an environment role is disassociated.
+ *The identifier of the data source run.
* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *The ID of the environment.
+ *The identifier of the project.
* @public */ - environmentIdentifier: string | undefined; + projectId: string | undefined; /** - *The ARN of the environment role.
+ *The status of the data source run.
* @public */ - environmentRoleArn: string | undefined; -} - -/** - * @public - */ -export interface DisassociateEnvironmentRoleOutput {} + status: DataSourceRunStatus | undefined; -/** - * @public - */ -export interface DeleteDomainInput { /** - *The identifier of the Amazon Web Services domain that is to be deleted.
+ *The type of the data source run.
* @public */ - identifier: string | undefined; + type: DataSourceRunType | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The configuration snapshot of the data source that is being run.
* @public */ - clientToken?: string | undefined; + dataSourceConfigurationSnapshot?: string | undefined; /** - *Specifies the optional flag to delete all child entities within the domain.
+ *Specifies run statistics for assets.
* @public */ - skipDeletionCheck?: boolean | undefined; -} + runStatisticsForAssets?: RunStatisticsForAssets | undefined; -/** - * @public - */ -export interface DeleteDomainOutput { /** - *The status of the domain.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - status: DomainStatus | undefined; -} + errorMessage?: DataSourceErrorMessage | undefined; -/** - * @public - */ -export interface GetDomainInput { /** - *The identifier of the specified Amazon DataZone domain.
+ *The timestamp of when data source run was created.
* @public */ - identifier: string | undefined; -} + createdAt: Date | undefined; -/** - * @public - */ -export interface GetDomainOutput { /** - *The identifier of the specified Amazon DataZone domain.
+ *The timestamp of when the data source run was updated.
* @public */ - id: string | undefined; + updatedAt: Date | undefined; /** - *The ID of the root domain in Amazon Datazone.
+ *The timestamp of when the data source run was started.
* @public */ - rootDomainUnitId?: string | undefined; + startedAt?: Date | undefined; /** - *The name of the Amazon DataZone domain.
+ *The timestamp of when the data source run was stopped.
* @public */ - name?: string | undefined; + stoppedAt?: Date | undefined; +} +/** + *The activity details of the data source run.
+ * @public + */ +export interface DataSourceRunActivity { /** - *The description of the Amazon DataZone domain.
+ *The database included in the data source run activity.
* @public */ - description?: string | undefined; + database: string | undefined; /** - *The single sing-on option of the specified Amazon DataZone domain.
+ *The identifier of the data source for the data source run activity.
* @public */ - singleSignOn?: SingleSignOn | undefined; + dataSourceRunId: string | undefined; /** - *The domain execution role with which the Amazon DataZone domain is created.
+ *The technical name included in the data source run activity.
* @public */ - domainExecutionRole: string | undefined; + technicalName: string | undefined; /** - *The ARN of the specified Amazon DataZone domain.
+ *The status of the asset included in the data source run activity.
* @public */ - arn?: string | undefined; + dataAssetStatus: DataAssetActivityStatus | undefined; /** - *The identifier of the Amazon Web Services Key Management Service (KMS) key that is used - * to encrypt the Amazon DataZone domain, metadata, and reporting data.
+ *The project ID included in the data source run activity.
* @public */ - kmsKeyIdentifier?: string | undefined; + projectId: string | undefined; /** - *The status of the specified Amazon DataZone domain.
+ *The identifier of the asset included in the data source run activity.
* @public */ - status: DomainStatus | undefined; + dataAssetId?: string | undefined; /** - *The URL of the data portal for this Amazon DataZone domain.
+ *The technical description included in the data source run activity.
* @public */ - portalUrl?: string | undefined; + technicalDescription?: string | undefined; /** - *The timestamp of when the Amazon DataZone domain was created.
+ *The details of the error message that is returned if the operation cannot be + * successfully completed.
* @public */ - createdAt?: Date | undefined; + errorMessage?: DataSourceErrorMessage | undefined; /** - *The timestamp of when the Amazon DataZone domain was last updated.
+ *The timestamp of when data source run activity was created.
* @public */ - lastUpdatedAt?: Date | undefined; + createdAt: Date | undefined; /** - *The tags specified for the Amazon DataZone domain.
+ *The timestamp of when data source run activity was updated.
* @public */ - tags?: RecordThe status of the data source.
+ *The ID of the domain where you want to delete an asset filter.
* @public */ - status?: DomainStatus | undefined; + domainIdentifier: string | undefined; /** - *The maximum number of domains to return in a single call to ListDomains.
- * When the number of domains to be listed is greater than the value of
- * MaxResults, the response contains a NextToken value that you
- * can use in a subsequent call to ListDomains to list the next set of
- * domains.
The ID of the data asset.
* @public */ - maxResults?: number | undefined; + assetIdentifier: string | undefined; /** - *When the number of domains is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of domains, the response includes a
- * pagination token named NextToken. You can specify this NextToken
- * value in a subsequent call to ListDomains to list the next set of
- * domains.
The ID of the asset filter that you want to delete.
* @public */ - nextToken?: string | undefined; + identifier: string | undefined; } /** - *A summary of a Amazon DataZone domain.
* @public */ -export interface DomainSummary { +export interface DeleteEnvironmentInput { /** - *The ID of the Amazon DataZone domain.
+ *The ID of the Amazon DataZone domain in which the environment is deleted.
* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *A name of an Amazon DataZone domain.
+ *The identifier of the environment that is to be deleted.
* @public */ - name: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface DeleteEnvironmentActionInput { /** - *A description of an Amazon DataZone domain.
+ *The ID of the Amazon DataZone domain in which an environment action is deleted.
* @public */ - description?: string | undefined; + domainIdentifier: string | undefined; /** - *The ARN of the Amazon DataZone domain.
+ *The ID of the environment where an environment action is deleted.
* @public */ - arn: string | undefined; + environmentIdentifier: string | undefined; /** - *The identifier of the Amazon Web Services account that manages the domain.
+ *The ID of the environment action that is deleted.
* @public */ - managedAccountId: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface DeleteEnvironmentProfileInput { /** - *The status of the Amazon DataZone domain.
+ *The ID of the Amazon DataZone domain in which the environment profile is deleted.
* @public */ - status: DomainStatus | undefined; + domainIdentifier: string | undefined; /** - *The data portal URL for the Amazon DataZone domain.
+ *The ID of the environment profile that is deleted.
* @public */ - portalUrl?: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface DeleteProjectInput { /** - *A timestamp of when a Amazon DataZone domain was created.
+ *The ID of the Amazon DataZone domain in which the project is deleted.
* @public */ - createdAt: Date | undefined; + domainIdentifier: string | undefined; /** - *A timestamp of when a Amazon DataZone domain was last updated.
+ *The identifier of the project that is to be deleted.
* @public */ - lastUpdatedAt?: Date | undefined; + identifier: string | undefined; + + /** + *Specifies the optional flag to delete all child entities within the project.
+ * @public + */ + skipDeletionCheck?: boolean | undefined; } /** * @public */ -export interface ListDomainsOutput { +export interface DeleteProjectOutput {} + +/** + * @public + */ +export interface DeleteProjectMembershipInput { /** - *The results of the ListDomains action.
The ID of the Amazon DataZone domain where project membership is deleted.
* @public */ - items: DomainSummary[] | undefined; + domainIdentifier: string | undefined; /** - *When the number of domains is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of domains, the response includes a
- * pagination token named NextToken. You can specify this NextToken
- * value in a subsequent call to ListDomains to list the next set of
- * domains.
The ID of the Amazon DataZone project the membership to which is deleted.
* @public */ - nextToken?: string | undefined; + projectIdentifier: string | undefined; + + /** + *The project member whose project membership is deleted.
+ * @public + */ + member: Member | undefined; } /** * @public */ -export interface UpdateDomainInput { +export interface DeleteProjectMembershipOutput {} + +/** + * @public + */ +export interface DeleteSubscriptionGrantInput { /** - *The ID of the Amazon Web Services domain that is to be updated.
+ *The ID of the Amazon DataZone domain where the subscription grant is deleted.
* @public */ - identifier: string | undefined; + domainIdentifier: string | undefined; /** - *The description to be updated as part of the UpdateDomain action.
The ID of the subscription grant that is deleted.
* @public */ - description?: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface DeleteSubscriptionGrantOutput { /** - *The single sign-on option to be updated as part of the UpdateDomain
- * action.
The ID of the subscription grant that is deleted.
* @public */ - singleSignOn?: SingleSignOn | undefined; + id: string | undefined; /** - *The domain execution role to be updated as part of the UpdateDomain
- * action.
The Amazon DataZone user who created the subscription grant that is deleted.
* @public */ - domainExecutionRole?: string | undefined; + createdBy: string | undefined; /** - *The name to be updated as part of the UpdateDomain action.
The Amazon DataZone user who updated the subscription grant that is deleted.
* @public */ - name?: string | undefined; + updatedBy?: string | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The ID of the Amazon DataZone domain in which the subscription grant is deleted.
* @public */ - clientToken?: string | undefined; -} + domainId: string | undefined; -/** - * @public - */ -export interface UpdateDomainOutput { /** - *The identifier of the Amazon DataZone domain.
+ *The timestamp of when the subscription grant that is deleted was created.
* @public */ - id: string | undefined; + createdAt: Date | undefined; /** - *The ID of the root domain unit.
+ *The timestamp of when the subscription grant that is deleted was updated.
* @public */ - rootDomainUnitId?: string | undefined; + updatedAt: Date | undefined; /** - *The description to be updated as part of the UpdateDomain action.
The ID of the subscription target associated with the subscription grant that is + * deleted.
* @public */ - description?: string | undefined; + subscriptionTargetId: string | undefined; /** - *The single sign-on option of the Amazon DataZone domain.
+ *The entity to which the subscription is deleted.
* @public */ - singleSignOn?: SingleSignOn | undefined; + grantedEntity: GrantedEntity | undefined; /** - *The domain execution role to be updated as part of the UpdateDomain
- * action.
The status of the subscription grant that is deleted.
* @public */ - domainExecutionRole?: string | undefined; + status: SubscriptionGrantOverallStatus | undefined; /** - *The name to be updated as part of the UpdateDomain action.
The assets for which the subsctiption grant that is deleted gave access.
* @public */ - name?: string | undefined; + assets?: SubscribedAsset[] | undefined; /** - *Specifies the timestamp of when the domain was last updated.
+ * @deprecated + * + *The identifier of the subsctiption whose subscription grant is to be deleted.
* @public */ - lastUpdatedAt?: Date | undefined; + subscriptionId?: string | undefined; } /** * @public */ -export interface DeleteDomainUnitInput { +export interface DeleteSubscriptionRequestInput { /** - *The ID of the domain where you want to delete a domain unit.
+ *The ID of the Amazon DataZone domain in which the subscription request is deleted.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the domain unit that you want to delete.
+ *The ID of the subscription request that is deleted.
* @public */ identifier: string | undefined; @@ -10379,20 +10312,21 @@ export interface DeleteDomainUnitInput { /** * @public */ -export interface DeleteDomainUnitOutput {} - -/** - * @public - */ -export interface GetDomainUnitInput { +export interface DeleteSubscriptionTargetInput { /** - *The ID of the domain where you want to get a domain unit.
+ *The ID of the Amazon DataZone domain in which the subscription target is deleted.
* @public */ domainIdentifier: string | undefined; /** - *The identifier of the domain unit that you want to get.
+ *The ID of the Amazon DataZone environment in which the subscription target is deleted.
+ * @public + */ + environmentIdentifier: string | undefined; + + /** + *The ID of the subscription target that is deleted.
* @public */ identifier: string | undefined; @@ -10400,254 +10334,248 @@ export interface GetDomainUnitInput { /** * @public + * @enum */ -export interface GetDomainUnitOutput { - /** - *The ID of the domain unit.
- * @public - */ - id: string | undefined; +export const TimeSeriesEntityType = { + ASSET: "ASSET", + LISTING: "LISTING", +} as const; - /** - *The ID of the domain in which the domain unit lives.
- * @public - */ - domainId: string | undefined; +/** + * @public + */ +export type TimeSeriesEntityType = (typeof TimeSeriesEntityType)[keyof typeof TimeSeriesEntityType]; +/** + * @public + */ +export interface DeleteTimeSeriesDataPointsInput { /** - *The name of the domain unit.
+ *The ID of the Amazon DataZone domain that houses the asset for which you want to delete + * a time series form.
* @public */ - name: string | undefined; + domainIdentifier: string | undefined; /** - *The ID of the parent domain unit.
+ *The ID of the asset for which you want to delete a time series form.
* @public */ - parentDomainUnitId?: string | undefined; + entityIdentifier: string | undefined; /** - *The description of the domain unit.
+ *The type of the asset for which you want to delete a time series form.
* @public */ - description?: string | undefined; + entityType: TimeSeriesEntityType | undefined; /** - *The owners of the domain unit.
+ *The name of the time series form that you want to delete.
* @public */ - owners: DomainUnitOwnerProperties[] | undefined; + formName: string | undefined; /** - *The time stamp at which the domain unit was created.
+ *A unique, case-sensitive identifier to ensure idempotency of the request. This field is + * automatically populated if not provided.
* @public */ - createdAt?: Date | undefined; + clientToken?: string | undefined; +} + +/** + * @public + */ +export interface DeleteTimeSeriesDataPointsOutput {} +/** + * @public + */ +export interface DisassociateEnvironmentRoleInput { /** - *The timestamp at which the domain unit was last updated.
+ *The ID of the Amazon DataZone domain in which an environment role is disassociated.
* @public */ - lastUpdatedAt?: Date | undefined; + domainIdentifier: string | undefined; /** - *The user who created the domain unit.
+ *The ID of the environment.
* @public */ - createdBy?: string | undefined; + environmentIdentifier: string | undefined; /** - *The user who last updated the domain unit.
+ *The ARN of the environment role.
* @public */ - lastUpdatedBy?: string | undefined; + environmentRoleArn: string | undefined; } /** * @public */ -export interface ListDomainUnitsForParentInput { - /** - *The ID of the domain in which you want to list domain units for a parent domain - * unit.
- * @public - */ - domainIdentifier: string | undefined; +export interface DisassociateEnvironmentRoleOutput {} +/** + * @public + */ +export interface DeleteDomainInput { /** - *The ID of the parent domain unit.
+ *The identifier of the Amazon Web Services domain that is to be deleted.
* @public */ - parentDomainUnitIdentifier: string | undefined; + identifier: string | undefined; /** - *The maximum number of domain units to return in a single call to - * ListDomainUnitsForParent. When the number of domain units to be listed is greater than the - * value of MaxResults, the response contains a NextToken value that you can use in a - * subsequent call to ListDomainUnitsForParent to list the next set of domain units.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - maxResults?: number | undefined; + clientToken?: string | undefined; /** - *When the number of domain units is greater than the default value for the MaxResults - * parameter, or if you explicitly specify a value for MaxResults that is less than the number - * of domain units, the response includes a pagination token named NextToken. You can specify - * this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set - * of domain units.
+ *Specifies the optional flag to delete all child entities within the domain.
* @public */ - nextToken?: string | undefined; + skipDeletionCheck?: boolean | undefined; } /** - *The summary of the domain unit.
* @public */ -export interface DomainUnitSummary { - /** - *The name of the domain unit summary.
- * @public - */ - name: string | undefined; - +export interface DeleteDomainOutput { /** - *The ID of the domain unit summary.
+ *The status of the domain.
* @public */ - id: string | undefined; + status: DomainStatus | undefined; } /** * @public */ -export interface ListDomainUnitsForParentOutput { - /** - *The results returned by this action.
- * @public - */ - items: DomainUnitSummary[] | undefined; - +export interface GetDomainInput { /** - *When the number of domain units is greater than the default value for the MaxResults - * parameter, or if you explicitly specify a value for MaxResults that is less than the number - * of domain units, the response includes a pagination token named NextToken. You can specify - * this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set - * of domain units.
+ *The identifier of the specified Amazon DataZone domain.
* @public */ - nextToken?: string | undefined; + identifier: string | undefined; } /** * @public */ -export interface UpdateDomainUnitInput { +export interface GetDomainOutput { /** - *The ID of the domain where you want to update a domain unit.
+ *The identifier of the specified Amazon DataZone domain.
* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *The ID of the domain unit that you want to update.
+ *The ID of the root domain in Amazon Datazone.
* @public */ - identifier: string | undefined; + rootDomainUnitId?: string | undefined; /** - *The description of the domain unit that you want to update.
+ *The name of the Amazon DataZone domain.
* @public */ - description?: string | undefined; + name?: string | undefined; /** - *The name of the domain unit that you want to update.
+ *The description of the Amazon DataZone domain.
* @public */ - name?: string | undefined; -} + description?: string | undefined; -/** - * @public - */ -export interface UpdateDomainUnitOutput { /** - *The ID of the domain unit that you want to update.
+ *The single sing-on option of the specified Amazon DataZone domain.
* @public */ - id: string | undefined; + singleSignOn?: SingleSignOn | undefined; /** - *The ID of the domain where you want to update the domain unit.
+ *The domain execution role with which the Amazon DataZone domain is created.
* @public */ - domainId: string | undefined; + domainExecutionRole: string | undefined; /** - *The name of the domain unit that you want to update.
+ *The ARN of the specified Amazon DataZone domain.
* @public */ - name: string | undefined; + arn?: string | undefined; /** - *The owners of the domain unit that you want to update.
+ *The identifier of the Amazon Web Services Key Management Service (KMS) key that is used + * to encrypt the Amazon DataZone domain, metadata, and reporting data.
* @public */ - owners: DomainUnitOwnerProperties[] | undefined; + kmsKeyIdentifier?: string | undefined; /** - *The description of the domain unit that you want to update.
+ *The status of the specified Amazon DataZone domain.
* @public */ - description?: string | undefined; + status: DomainStatus | undefined; /** - *The ID of the parent domain unit.
+ *The URL of the data portal for this Amazon DataZone domain.
* @public */ - parentDomainUnitId?: string | undefined; + portalUrl?: string | undefined; /** - *The time stamp at which the domain unit that you want to update was created.
+ *The timestamp of when the Amazon DataZone domain was created.
* @public */ createdAt?: Date | undefined; /** - *The timestamp at which the domain unit was last updated.
+ *The timestamp of when the Amazon DataZone domain was last updated.
* @public */ lastUpdatedAt?: Date | undefined; /** - *The user who created the domain unit that you want to update.
- * @public - */ - createdBy?: string | undefined; - - /** - *The user who last updated the domain unit.
+ *The tags specified for the Amazon DataZone domain.
* @public */ - lastUpdatedBy?: string | undefined; + tags?: RecordThe ID of the Amazon DataZone domain in which the blueprint configuration is deleted.
+ *The status of the data source.
* @public */ - domainIdentifier: string | undefined; + status?: DomainStatus | undefined; /** - *The ID of the blueprint the configuration of which is deleted.
+ *The maximum number of domains to return in a single call to ListDomains.
+ * When the number of domains to be listed is greater than the value of
+ * MaxResults, the response contains a NextToken value that you
+ * can use in a subsequent call to ListDomains to list the next set of
+ * domains.
When the number of domains is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of domains, the response includes a
+ * pagination token named NextToken. You can specify this NextToken
+ * value in a subsequent call to ListDomains to list the next set of
+ * domains.
A summary of a Amazon DataZone domain.
* @public */ -export interface DeleteEnvironmentBlueprintConfigurationOutput {} - -/** - * @public - */ -export interface GetEnvironmentBlueprintConfigurationInput { - /** - *The ID of the Amazon DataZone domain where this blueprint exists.
- * @public - */ - domainIdentifier: string | undefined; - +export interface DomainSummary { /** - *He ID of the blueprint.
+ *The ID of the Amazon DataZone domain.
* @public */ - environmentBlueprintIdentifier: string | undefined; -} + id: string | undefined; -/** - *The Lake Formation configuration of the Data Lake blueprint.
- * @public - */ -export interface LakeFormationConfiguration { /** - *The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for - * Data Lake using AWS Lake Formation hybrid access mode.
+ *A name of an Amazon DataZone domain.
* @public */ - locationRegistrationRole?: string | undefined; + name: string | undefined; /** - *Specifies certain Amazon S3 locations if you do not want Amazon DataZone to - * automatically register them in hybrid mode.
+ *A description of an Amazon DataZone domain.
* @public */ - locationRegistrationExcludeS3Locations?: string[] | undefined; -} - -/** - *The provisioning configuration of the blueprint.
- * @public - */ -export type ProvisioningConfiguration = - | ProvisioningConfiguration.LakeFormationConfigurationMember - | ProvisioningConfiguration.$UnknownMember; + description?: string | undefined; -/** - * @public - */ -export namespace ProvisioningConfiguration { /** - *The Lake Formation configuration of the Data Lake blueprint.
+ *The ARN of the Amazon DataZone domain.
* @public */ - export interface LakeFormationConfigurationMember { - lakeFormationConfiguration: LakeFormationConfiguration; - $unknown?: never; - } + arn: string | undefined; /** + *The identifier of the Amazon Web Services account that manages the domain.
* @public */ - export interface $UnknownMember { - lakeFormationConfiguration?: never; - $unknown: [string, any]; - } - - export interface VisitorThe ID of the Amazon DataZone domain where this blueprint exists.
+ *The status of the Amazon DataZone domain.
* @public */ - domainId: string | undefined; + status: DomainStatus | undefined; /** - *The ID of the blueprint.
+ *The data portal URL for the Amazon DataZone domain.
* @public */ - environmentBlueprintId: string | undefined; + portalUrl?: string | undefined; /** - *The ARN of the provisioning role with which this blueprint is created.
+ *A timestamp of when a Amazon DataZone domain was created.
* @public */ - provisioningRoleArn?: string | undefined; + createdAt: Date | undefined; /** - *The ARN of the manage access role with which this blueprint is created.
+ *A timestamp of when a Amazon DataZone domain was last updated.
* @public */ - manageAccessRoleArn?: string | undefined; + lastUpdatedAt?: Date | undefined; +} +/** + * @public + */ +export interface ListDomainsOutput { /** - *The Amazon Web Services regions in which this blueprint is enabled.
+ *The results of the ListDomains action.
The regional parameters of the blueprint.
+ *When the number of domains is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of domains, the response includes a
+ * pagination token named NextToken. You can specify this NextToken
+ * value in a subsequent call to ListDomains to list the next set of
+ * domains.
The timestamp of when this blueprint was created.
+ *The ID of the Amazon Web Services domain that is to be updated.
* @public */ - createdAt?: Date | undefined; + identifier: string | undefined; /** - *The timestamp of when this blueprint was upated.
+ *The description to be updated as part of the UpdateDomain action.
The provisioning configuration of a blueprint.
+ *The single sign-on option to be updated as part of the UpdateDomain
+ * action.
The identifier of the Amazon DataZone domain.
+ *The domain execution role to be updated as part of the UpdateDomain
+ * action.
The maximum number of blueprint configurations to return in a single call to
- * ListEnvironmentBlueprintConfigurations. When the number of configurations
- * to be listed is greater than the value of MaxResults, the response contains a
- * NextToken value that you can use in a subsequent call to
- * ListEnvironmentBlueprintConfigurations to list the next set of
- * configurations.
The name to be updated as part of the UpdateDomain action.
When the number of blueprint configurations is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of configurations, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListEnvironmentBlueprintConfigurations to list the next set of
- * configurations.
A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - nextToken?: string | undefined; + clientToken?: string | undefined; } /** - *The configuration details of an environment blueprint.
* @public */ -export interface EnvironmentBlueprintConfigurationItem { +export interface UpdateDomainOutput { /** - *The identifier of the Amazon DataZone domain in which an environment blueprint exists.
+ *The identifier of the Amazon DataZone domain.
* @public */ - domainId: string | undefined; + id: string | undefined; /** - *The identifier of the environment blueprint.
+ *The ID of the root domain unit.
* @public */ - environmentBlueprintId: string | undefined; + rootDomainUnitId?: string | undefined; /** - *The ARN of the provisioning role specified in the environment blueprint - * configuration.
+ *The description to be updated as part of the UpdateDomain action.
The ARN of the manage access role specified in the environment blueprint - * configuration.
+ *The single sign-on option of the Amazon DataZone domain.
* @public */ - manageAccessRoleArn?: string | undefined; + singleSignOn?: SingleSignOn | undefined; /** - *The enabled Amazon Web Services Regions specified in a blueprint configuration.
+ *The domain execution role to be updated as part of the UpdateDomain
+ * action.
The regional parameters of the environment blueprint.
+ *The name to be updated as part of the UpdateDomain action.
The timestamp of when an environment blueprint was created.
+ *Specifies the timestamp of when the domain was last updated.
* @public */ - createdAt?: Date | undefined; + lastUpdatedAt?: Date | undefined; +} +/** + * @public + */ +export interface DeleteDomainUnitInput { /** - *The timestamp of when the environment blueprint was updated.
+ *The ID of the domain where you want to delete a domain unit.
* @public */ - updatedAt?: Date | undefined; + domainIdentifier: string | undefined; /** - *The provisioning configuration of a blueprint.
+ *The ID of the domain unit that you want to delete.
* @public */ - provisioningConfigurations?: ProvisioningConfiguration[] | undefined; + identifier: string | undefined; } /** * @public */ -export interface ListEnvironmentBlueprintConfigurationsOutput { +export interface DeleteDomainUnitOutput {} + +/** + * @public + */ +export interface GetDomainUnitInput { /** - *The results of the ListEnvironmentBlueprintConfigurations action.
The ID of the domain where you want to get a domain unit.
* @public */ - items?: EnvironmentBlueprintConfigurationItem[] | undefined; + domainIdentifier: string | undefined; /** - *When the number of blueprint configurations is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of configurations, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListEnvironmentBlueprintConfigurations to list the next set of
- * configurations.
The identifier of the domain unit that you want to get.
* @public */ - nextToken?: string | undefined; + identifier: string | undefined; } /** * @public */ -export interface PutEnvironmentBlueprintConfigurationInput { +export interface GetDomainUnitOutput { /** - *The identifier of the Amazon DataZone domain.
+ *The ID of the domain unit.
* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *The identifier of the environment blueprint.
+ *The ID of the domain in which the domain unit lives.
* @public */ - environmentBlueprintIdentifier: string | undefined; + domainId: string | undefined; /** - *The ARN of the provisioning role.
+ *The name of the domain unit.
* @public */ - provisioningRoleArn?: string | undefined; + name: string | undefined; /** - *The ARN of the manage access role.
+ *The ID of the parent domain unit.
* @public */ - manageAccessRoleArn?: string | undefined; + parentDomainUnitId?: string | undefined; /** - *Specifies the enabled Amazon Web Services Regions.
+ *The description of the domain unit.
* @public */ - enabledRegions: string[] | undefined; + description?: string | undefined; /** - *The regional parameters in the environment blueprint.
+ *The owners of the domain unit.
* @public */ - regionalParameters?: RecordThe provisioning configuration of a blueprint.
+ *The time stamp at which the domain unit was created.
* @public */ - provisioningConfigurations?: ProvisioningConfiguration[] | undefined; -} + createdAt?: Date | undefined; -/** - * @public - */ -export interface PutEnvironmentBlueprintConfigurationOutput { /** - *The identifier of the Amazon DataZone domain.
+ *The timestamp at which the domain unit was last updated.
* @public */ - domainId: string | undefined; + lastUpdatedAt?: Date | undefined; /** - *The identifier of the environment blueprint.
+ *The user who created the domain unit.
* @public */ - environmentBlueprintId: string | undefined; + createdBy?: string | undefined; /** - *The ARN of the provisioning role.
+ *The user who last updated the domain unit.
* @public */ - provisioningRoleArn?: string | undefined; + lastUpdatedBy?: string | undefined; +} +/** + * @public + */ +export interface ListDomainUnitsForParentInput { /** - *The ARN of the manage access role.
+ *The ID of the domain in which you want to list domain units for a parent domain + * unit.
* @public */ - manageAccessRoleArn?: string | undefined; + domainIdentifier: string | undefined; /** - *Specifies the enabled Amazon Web Services Regions.
+ *The ID of the parent domain unit.
* @public */ - enabledRegions?: string[] | undefined; + parentDomainUnitIdentifier: string | undefined; /** - *The regional parameters in the environment blueprint.
+ *The maximum number of domain units to return in a single call to + * ListDomainUnitsForParent. When the number of domain units to be listed is greater than the + * value of MaxResults, the response contains a NextToken value that you can use in a + * subsequent call to ListDomainUnitsForParent to list the next set of domain units.
* @public */ - regionalParameters?: RecordThe timestamp of when the environment blueprint was created.
+ *When the number of domain units is greater than the default value for the MaxResults + * parameter, or if you explicitly specify a value for MaxResults that is less than the number + * of domain units, the response includes a pagination token named NextToken. You can specify + * this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set + * of domain units.
* @public */ - createdAt?: Date | undefined; + nextToken?: string | undefined; +} +/** + *The summary of the domain unit.
+ * @public + */ +export interface DomainUnitSummary { /** - *The timestamp of when the environment blueprint was updated.
+ *The name of the domain unit summary.
* @public */ - updatedAt?: Date | undefined; + name: string | undefined; /** - *The provisioning configuration of a blueprint.
+ *The ID of the domain unit summary.
* @public */ - provisioningConfigurations?: ProvisioningConfiguration[] | undefined; + id: string | undefined; } /** * @public */ -export interface DeleteFormTypeInput { +export interface ListDomainUnitsForParentOutput { /** - *The ID of the Amazon DataZone domain in which the metadata form type is deleted.
+ *The results returned by this action.
* @public */ - domainIdentifier: string | undefined; + items: DomainUnitSummary[] | undefined; /** - *The ID of the metadata form type that is deleted.
+ *When the number of domain units is greater than the default value for the MaxResults + * parameter, or if you explicitly specify a value for MaxResults that is less than the number + * of domain units, the response includes a pagination token named NextToken. You can specify + * this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set + * of domain units.
* @public */ - formTypeIdentifier: string | undefined; + nextToken?: string | undefined; } /** * @public */ -export interface DeleteFormTypeOutput {} - -/** - * @public - */ -export interface GetFormTypeInput { +export interface UpdateDomainUnitInput { /** - *The ID of the Amazon DataZone domain in which this metadata form type exists.
+ *The ID of the domain where you want to update a domain unit.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the metadata form type.
+ *The ID of the domain unit that you want to update.
* @public */ - formTypeIdentifier: string | undefined; - - /** - *The revision of this metadata form type.
- * @public - */ - revision?: string | undefined; -} + identifier: string | undefined; -/** - *The details of the import of the metadata form type.
- * @public - */ -export interface Import { /** - *The name of the import.
+ *The description of the domain unit that you want to update.
* @public */ - name: string | undefined; + description?: string | undefined; /** - *The revision of the import.
+ *The name of the domain unit that you want to update.
* @public */ - revision: string | undefined; + name?: string | undefined; } /** * @public */ -export interface GetFormTypeOutput { +export interface UpdateDomainUnitOutput { /** - *The ID of the Amazon DataZone domain in which this metadata form type exists.
+ *The ID of the domain unit that you want to update.
* @public */ - domainId: string | undefined; + id: string | undefined; /** - *The name of the metadata form type.
+ *The ID of the domain where you want to update the domain unit.
* @public */ - name: string | undefined; + domainId: string | undefined; /** - *The revision of the metadata form type.
+ *The name of the domain unit that you want to update.
* @public */ - revision: string | undefined; + name: string | undefined; /** - *The model of the metadata form type.
+ *The owners of the domain unit that you want to update.
* @public */ - model: Model | undefined; + owners: DomainUnitOwnerProperties[] | undefined; /** - *The ID of the project that owns this metadata form type.
+ *The description of the domain unit that you want to update.
* @public */ - owningProjectId?: string | undefined; + description?: string | undefined; /** - *The ID of the Amazon DataZone domain in which the metadata form type was originally - * created.
+ *The ID of the parent domain unit.
* @public */ - originDomainId?: string | undefined; + parentDomainUnitId?: string | undefined; /** - *The ID of the project in which this metadata form type was originally created.
+ *The time stamp at which the domain unit that you want to update was created.
* @public */ - originProjectId?: string | undefined; + createdAt?: Date | undefined; /** - *The status of the metadata form type.
+ *The timestamp at which the domain unit was last updated.
* @public */ - status?: FormTypeStatus | undefined; + lastUpdatedAt?: Date | undefined; /** - *The timestamp of when this metadata form type was created.
+ *The user who created the domain unit that you want to update.
* @public */ - createdAt?: Date | undefined; + createdBy?: string | undefined; /** - *The Amazon DataZone user who created this metadata form type.
+ *The user who last updated the domain unit.
* @public */ - createdBy?: string | undefined; + lastUpdatedBy?: string | undefined; +} +/** + * @public + */ +export interface DeleteEnvironmentBlueprintConfigurationInput { /** - *The description of the metadata form type.
+ *The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.
* @public */ - description?: string | undefined; + domainIdentifier: string | undefined; /** - *The imports of the metadata form type.
+ *The ID of the blueprint the configuration of which is deleted.
* @public */ - imports?: Import[] | undefined; + environmentBlueprintIdentifier: string | undefined; } /** * @public */ -export interface GetAssetFilterInput { - /** - *The ID of the domain where you want to get an asset filter.
- * @public - */ - domainIdentifier: string | undefined; +export interface DeleteEnvironmentBlueprintConfigurationOutput {} +/** + * @public + */ +export interface GetEnvironmentBlueprintConfigurationInput { /** - *The ID of the data asset.
+ *The ID of the Amazon DataZone domain where this blueprint exists.
* @public */ - assetIdentifier: string | undefined; + domainIdentifier: string | undefined; /** - *The ID of the asset filter.
+ *He ID of the blueprint.
* @public */ - identifier: string | undefined; + environmentBlueprintIdentifier: string | undefined; } /** + *The Lake Formation configuration of the Data Lake blueprint.
* @public */ -export interface GetEnvironmentInput { +export interface LakeFormationConfiguration { /** - *The ID of the Amazon DataZone domain where the environment exists.
+ *The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for + * Data Lake using AWS Lake Formation hybrid access mode.
* @public */ - domainIdentifier: string | undefined; + locationRegistrationRole?: string | undefined; /** - *The ID of the Amazon DataZone environment.
+ *Specifies certain Amazon S3 locations if you do not want Amazon DataZone to + * automatically register them in hybrid mode.
* @public */ - identifier: string | undefined; + locationRegistrationExcludeS3Locations?: string[] | undefined; } /** + *The provisioning configuration of the blueprint.
* @public */ -export interface GetEnvironmentOutput { - /** - *The ID of the Amazon DataZone project in which this environment is created.
- * @public - */ - projectId: string | undefined; +export type ProvisioningConfiguration = + | ProvisioningConfiguration.LakeFormationConfigurationMember + | ProvisioningConfiguration.$UnknownMember; +/** + * @public + */ +export namespace ProvisioningConfiguration { /** - *The ID of the environment.
+ *The Lake Formation configuration of the Data Lake blueprint.
* @public */ - id?: string | undefined; + export interface LakeFormationConfigurationMember { + lakeFormationConfiguration: LakeFormationConfiguration; + $unknown?: never; + } /** - *The ID of the Amazon DataZone domain where the environment exists.
* @public */ - domainId: string | undefined; + export interface $UnknownMember { + lakeFormationConfiguration?: never; + $unknown: [string, any]; + } + + export interface VisitorThe Amazon DataZone user who created the environment.
+ *The ID of the Amazon DataZone domain where this blueprint exists.
* @public */ - createdBy: string | undefined; + domainId: string | undefined; /** - *The timestamp of when the environment was created.
+ *The ID of the blueprint.
* @public */ - createdAt?: Date | undefined; + environmentBlueprintId: string | undefined; /** - *The timestamp of when this environment was updated.
+ *The ARN of the provisioning role with which this blueprint is created.
* @public */ - updatedAt?: Date | undefined; + provisioningRoleArn?: string | undefined; /** - *The name of the environment.
+ *The ARN of the manage access role with which this blueprint is created.
* @public */ - name: string | undefined; + manageAccessRoleArn?: string | undefined; /** - *The description of the environment.
+ *The Amazon Web Services regions in which this blueprint is enabled.
* @public */ - description?: string | undefined; + enabledRegions?: string[] | undefined; /** - *The ID of the environment profile with which the environment is created.
+ *The regional parameters of the blueprint.
* @public */ - environmentProfileId?: string | undefined; + regionalParameters?: RecordThe ID of the Amazon Web Services account where the environment exists.
+ *The timestamp of when this blueprint was created.
* @public */ - awsAccountId?: string | undefined; + createdAt?: Date | undefined; /** - *The Amazon Web Services region where the environment exists.
+ *The timestamp of when this blueprint was upated.
* @public */ - awsAccountRegion?: string | undefined; + updatedAt?: Date | undefined; /** - *The provider of this Amazon DataZone environment.
+ *The provisioning configuration of a blueprint.
* @public */ - provider: string | undefined; + provisioningConfigurations?: ProvisioningConfiguration[] | undefined; +} +/** + * @public + */ +export interface ListEnvironmentBlueprintConfigurationsInput { /** - *The provisioned resources of this Amazon DataZone environment.
+ *The identifier of the Amazon DataZone domain.
* @public */ - provisionedResources?: Resource[] | undefined; + domainIdentifier: string | undefined; /** - *The status of this Amazon DataZone environment.
+ *The maximum number of blueprint configurations to return in a single call to
+ * ListEnvironmentBlueprintConfigurations. When the number of configurations
+ * to be listed is greater than the value of MaxResults, the response contains a
+ * NextToken value that you can use in a subsequent call to
+ * ListEnvironmentBlueprintConfigurations to list the next set of
+ * configurations.
The actions of the environment.
+ *When the number of blueprint configurations is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of configurations, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListEnvironmentBlueprintConfigurations to list the next set of
+ * configurations.
The configuration details of an environment blueprint.
+ * @public + */ +export interface EnvironmentBlueprintConfigurationItem { /** - *The business glossary terms that can be used in this environment.
+ *The identifier of the Amazon DataZone domain in which an environment blueprint exists.
* @public */ - glossaryTerms?: string[] | undefined; + domainId: string | undefined; /** - *The user parameters of this Amazon DataZone environment.
+ *The identifier of the environment blueprint.
* @public */ - userParameters?: CustomParameter[] | undefined; + environmentBlueprintId: string | undefined; /** - *The details of the last deployment of the environment.
+ *The ARN of the provisioning role specified in the environment blueprint + * configuration.
* @public */ - lastDeployment?: Deployment | undefined; + provisioningRoleArn?: string | undefined; /** - *The provisioning properties of this Amazon DataZone environment.
+ *The ARN of the manage access role specified in the environment blueprint + * configuration.
* @public */ - provisioningProperties?: ProvisioningProperties | undefined; + manageAccessRoleArn?: string | undefined; /** - *The deployment properties of the environment.
+ *The enabled Amazon Web Services Regions specified in a blueprint configuration.
* @public */ - deploymentProperties?: DeploymentProperties | undefined; + enabledRegions?: string[] | undefined; /** - *The blueprint with which the environment is created.
+ *The regional parameters of the environment blueprint.
* @public */ - environmentBlueprintId?: string | undefined; -} + regionalParameters?: RecordThe ID of the Amazon DataZone domain in which the GetEnvironmentAction API is
- * invoked.
The timestamp of when an environment blueprint was created.
* @public */ - domainIdentifier: string | undefined; + createdAt?: Date | undefined; /** - *The environment ID of the environment action.
+ *The timestamp of when the environment blueprint was updated.
* @public */ - environmentIdentifier: string | undefined; + updatedAt?: Date | undefined; /** - *The ID of the environment action
+ *The provisioning configuration of a blueprint.
* @public */ - identifier: string | undefined; + provisioningConfigurations?: ProvisioningConfiguration[] | undefined; } /** * @public */ -export interface GetEnvironmentActionOutput { +export interface ListEnvironmentBlueprintConfigurationsOutput { /** - *The ID of the Amazon DataZone domain in which the environment action lives.
+ *The results of the ListEnvironmentBlueprintConfigurations action.
The environment ID of the environment action.
- * @public + *When the number of blueprint configurations is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of configurations, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListEnvironmentBlueprintConfigurations to list the next set of
+ * configurations.
The ID of the environment action.
+ *The identifier of the Amazon DataZone domain.
* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *The name of the environment action.
+ *The identifier of the environment blueprint.
* @public */ - name: string | undefined; + environmentBlueprintIdentifier: string | undefined; /** - *The parameters of the environment action.
+ *The ARN of the provisioning role.
* @public */ - parameters: ActionParameters | undefined; + provisioningRoleArn?: string | undefined; /** - *The description of the environment action.
+ *The ARN of the manage access role.
* @public */ - description?: string | undefined; -} + manageAccessRoleArn?: string | undefined; -/** - * @public - */ -export interface GetEnvironmentBlueprintInput { /** - *The identifier of the domain in which this blueprint exists.
+ *Specifies the enabled Amazon Web Services Regions.
* @public */ - domainIdentifier: string | undefined; + enabledRegions: string[] | undefined; /** - *The ID of this Amazon DataZone blueprint.
+ *The regional parameters in the environment blueprint.
* @public */ - identifier: string | undefined; -} + regionalParameters?: RecordThe ID of this Amazon DataZone blueprint.
+ *The provisioning configuration of a blueprint.
* @public */ - id: string | undefined; + provisioningConfigurations?: ProvisioningConfiguration[] | undefined; +} +/** + * @public + */ +export interface PutEnvironmentBlueprintConfigurationOutput { /** - *The name of this Amazon DataZone blueprint.
+ *The identifier of the Amazon DataZone domain.
* @public */ - name: string | undefined; + domainId: string | undefined; /** - *The description of this Amazon DataZone blueprint.
+ *The identifier of the environment blueprint.
* @public */ - description?: string | undefined; + environmentBlueprintId: string | undefined; /** - *The provider of this Amazon DataZone blueprint.
+ *The ARN of the provisioning role.
* @public */ - provider: string | undefined; + provisioningRoleArn?: string | undefined; /** - *The provisioning properties of this Amazon DataZone blueprint.
+ *The ARN of the manage access role.
* @public */ - provisioningProperties: ProvisioningProperties | undefined; + manageAccessRoleArn?: string | undefined; /** - *The deployment properties of this Amazon DataZone blueprint.
+ *Specifies the enabled Amazon Web Services Regions.
* @public */ - deploymentProperties?: DeploymentProperties | undefined; + enabledRegions?: string[] | undefined; /** - *The user parameters of this blueprint.
+ *The regional parameters in the environment blueprint.
* @public */ - userParameters?: CustomParameter[] | undefined; + regionalParameters?: RecordThe glossary terms attached to this Amazon DataZone blueprint.
+ *The timestamp of when the environment blueprint was created.
* @public */ - glossaryTerms?: string[] | undefined; + createdAt?: Date | undefined; /** - *A timestamp of when this blueprint was created.
+ *The timestamp of when the environment blueprint was updated.
* @public */ - createdAt?: Date | undefined; + updatedAt?: Date | undefined; /** - *The timestamp of when this blueprint was updated.
+ *The provisioning configuration of a blueprint.
* @public */ - updatedAt?: Date | undefined; + provisioningConfigurations?: ProvisioningConfiguration[] | undefined; } /** * @public */ -export interface GetEnvironmentCredentialsInput { +export interface DeleteFormTypeInput { /** - *The ID of the Amazon DataZone domain in which this environment and its credentials - * exist.
+ *The ID of the Amazon DataZone domain in which the metadata form type is deleted.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the environment whose credentials this operation gets.
+ *The ID of the metadata form type that is deleted.
* @public */ - environmentIdentifier: string | undefined; + formTypeIdentifier: string | undefined; } /** * @public */ -export interface GetEnvironmentCredentialsOutput { - /** - *The access key ID of the environment.
- * @public - */ - accessKeyId?: string | undefined; +export interface DeleteFormTypeOutput {} +/** + * @public + */ +export interface GetFormTypeInput { /** - *The secret access key of the environment credentials.
+ *The ID of the Amazon DataZone domain in which this metadata form type exists.
* @public */ - secretAccessKey?: string | undefined; + domainIdentifier: string | undefined; /** - *The session token of the environment credentials.
+ *The ID of the metadata form type.
* @public */ - sessionToken?: string | undefined; + formTypeIdentifier: string | undefined; /** - *The expiration timestamp of the environment credentials.
+ *The revision of this metadata form type.
* @public */ - expiration?: Date | undefined; + revision?: string | undefined; } /** + *The details of the import of the metadata form type.
* @public */ -export interface GetEnvironmentProfileInput { +export interface Import { /** - *The ID of the Amazon DataZone domain in which this environment profile exists.
+ *The name of the import.
* @public */ - domainIdentifier: string | undefined; + name: string | undefined; /** - *The ID of the environment profile.
+ *The revision of the import.
* @public */ - identifier: string | undefined; + revision: string | undefined; } /** * @public */ -export interface GetEnvironmentProfileOutput { +export interface GetFormTypeOutput { /** - *The ID of the environment profile.
+ *The ID of the Amazon DataZone domain in which this metadata form type exists.
* @public */ - id: string | undefined; + domainId: string | undefined; /** - *The ID of the Amazon DataZone domain in which this environment profile exists.
+ *The name of the metadata form type.
* @public */ - domainId: string | undefined; + name: string | undefined; /** - *The ID of the Amazon Web Services account where this environment profile exists.
+ *The revision of the metadata form type.
* @public */ - awsAccountId?: string | undefined; + revision: string | undefined; /** - *The Amazon Web Services region where this environment profile exists.
+ *The model of the metadata form type.
* @public */ - awsAccountRegion?: string | undefined; + model: Model | undefined; /** - *The Amazon DataZone user who created this environment profile.
+ *The ID of the project that owns this metadata form type.
* @public */ - createdBy: string | undefined; + owningProjectId?: string | undefined; /** - *The timestamp of when this environment profile was created.
+ *The ID of the Amazon DataZone domain in which the metadata form type was originally + * created.
* @public */ - createdAt?: Date | undefined; + originDomainId?: string | undefined; /** - *The timestamp of when this environment profile was upated.
+ *The ID of the project in which this metadata form type was originally created.
* @public */ - updatedAt?: Date | undefined; + originProjectId?: string | undefined; /** - *The name of the environment profile.
+ *The status of the metadata form type.
* @public */ - name: string | undefined; + status?: FormTypeStatus | undefined; /** - *The description of the environment profile.
+ *The timestamp of when this metadata form type was created.
* @public */ - description?: string | undefined; + createdAt?: Date | undefined; /** - *The ID of the blueprint with which this environment profile is created.
+ *The Amazon DataZone user who created this metadata form type.
* @public */ - environmentBlueprintId: string | undefined; + createdBy?: string | undefined; /** - *The ID of the Amazon DataZone project in which this environment profile is created.
+ *The description of the metadata form type.
* @public */ - projectId?: string | undefined; + description?: string | undefined; /** - *The user parameters of the environment profile.
+ *The imports of the metadata form type.
* @public */ - userParameters?: CustomParameter[] | undefined; + imports?: Import[] | undefined; } /** * @public */ -export interface GetGroupProfileInput { +export interface GetAssetFilterInput { /** - *The identifier of the Amazon DataZone domain in which the group profile exists.
+ *The ID of the domain where you want to get an asset filter.
* @public */ domainIdentifier: string | undefined; /** - *The identifier of the group profile.
+ *The ID of the data asset.
* @public */ - groupIdentifier: string | undefined; + assetIdentifier: string | undefined; + + /** + *The ID of the asset filter.
+ * @public + */ + identifier: string | undefined; } /** * @public */ -export interface GetGroupProfileOutput { +export interface GetEnvironmentInput { /** - *The identifier of the Amazon DataZone domain in which the group profile exists.
+ *The ID of the Amazon DataZone domain where the environment exists.
* @public */ - domainId?: string | undefined; + domainIdentifier: string | undefined; /** - *The identifier of the group profile.
+ *The ID of the Amazon DataZone environment.
* @public */ - id?: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetEnvironmentOutput { /** - *The identifier of the group profile.
+ *The ID of the Amazon DataZone project in which this environment is created.
* @public */ - status?: GroupProfileStatus | undefined; + projectId: string | undefined; /** - *The name of the group for which the specified group profile exists.
+ *The ID of the environment.
* @public */ - groupName?: string | undefined; -} + id?: string | undefined; -/** - * @public - */ -export interface GetIamPortalLoginUrlInput { /** - *the ID of the Amazon DataZone domain the data portal of which you want to get.
+ *The ID of the Amazon DataZone domain where the environment exists.
* @public */ - domainIdentifier: string | undefined; -} + domainId: string | undefined; -/** - * @public - */ -export interface GetIamPortalLoginUrlOutput { /** - *The data portal URL of the specified Amazon DataZone domain.
+ *The Amazon DataZone user who created the environment.
* @public */ - authCodeUrl?: string | undefined; + createdBy: string | undefined; /** - *The ID of the user profile.
+ *The timestamp of when the environment was created.
* @public */ - userProfileId: string | undefined; -} + createdAt?: Date | undefined; -/** - * @public - */ -export interface GetLineageNodeInput { /** - *The ID of the domain in which you want to get the data lineage node.
+ *The timestamp of when this environment was updated.
* @public */ - domainIdentifier: string | undefined; + updatedAt?: Date | undefined; /** - *The ID of the data lineage node that you want to get.
- *Both, a lineage node identifier generated by Amazon DataZone and a
- * sourceIdentifier of the lineage node are supported. If
- * sourceIdentifier is greater than 1800 characters, you can use lineage node
- * identifier generated by Amazon DataZone to get the node details.
The event time stamp for which you want to get the data lineage node.
- * @public - */ - eventTimestamp?: Date | undefined; -} - -/** - *The reference details for the data lineage node.
- * @public - */ -export interface LineageNodeReference { - /** - *The ID of the data lineage node.
- * @public - */ - id?: string | undefined; - - /** - *The event timestamp of the data lineage node.
- * @public - */ - eventTimestamp?: Date | undefined; -} - -/** - * @public - */ -export interface GetLineageNodeOutput { - /** - *The ID of the domain where you're getting the data lineage node.
+ *The name of the environment.
* @public */ - domainId: string | undefined; + name: string | undefined; /** - *The name of the data lineage node.
+ *The description of the environment.
* @public */ - name?: string | undefined; + description?: string | undefined; /** - *The description of the data lineage node.
+ *The ID of the environment profile with which the environment is created.
* @public */ - description?: string | undefined; + environmentProfileId?: string | undefined; /** - *The timestamp at which the data lineage node was created.
+ *The ID of the Amazon Web Services account where the environment exists.
* @public */ - createdAt?: Date | undefined; + awsAccountId?: string | undefined; /** - *The user who created the data lineage node.
+ *The Amazon Web Services region where the environment exists.
* @public */ - createdBy?: string | undefined; + awsAccountRegion?: string | undefined; /** - *The timestamp at which the data lineage node was updated.
+ *The provider of this Amazon DataZone environment.
* @public */ - updatedAt?: Date | undefined; + provider: string | undefined; /** - *The user who updated the data lineage node.
+ *The provisioned resources of this Amazon DataZone environment.
* @public */ - updatedBy?: string | undefined; + provisionedResources?: Resource[] | undefined; /** - *The ID of the data lineage node.
+ *The status of this Amazon DataZone environment.
* @public */ - id: string | undefined; + status?: EnvironmentStatus | undefined; /** - *The name of the type of the specified data lineage node.
+ *The actions of the environment.
* @public */ - typeName: string | undefined; + environmentActions?: ConfigurableEnvironmentAction[] | undefined; /** - *The revision type of the specified data lineage node.
+ *The business glossary terms that can be used in this environment.
* @public */ - typeRevision?: string | undefined; + glossaryTerms?: string[] | undefined; /** - *The source identifier of the data lineage node.
+ *The user parameters of this Amazon DataZone environment.
* @public */ - sourceIdentifier?: string | undefined; + userParameters?: CustomParameter[] | undefined; /** - *The timestamp of the event described in the data lineage node.
+ *The details of the last deployment of the environment.
* @public */ - eventTimestamp?: Date | undefined; + lastDeployment?: Deployment | undefined; /** - *The metadata of the specified data lineage node.
+ *The provisioning properties of this Amazon DataZone environment.
* @public */ - formsOutput?: FormOutput[] | undefined; + provisioningProperties?: ProvisioningProperties | undefined; /** - *The upstream nodes of the specified data lineage node.
+ *The deployment properties of the environment.
* @public */ - upstreamNodes?: LineageNodeReference[] | undefined; + deploymentProperties?: DeploymentProperties | undefined; /** - *The downsteam nodes of the specified data lineage node.
+ *The blueprint with which the environment is created.
* @public */ - downstreamNodes?: LineageNodeReference[] | undefined; + environmentBlueprintId?: string | undefined; } /** * @public */ -export interface GetProjectInput { +export interface GetEnvironmentActionInput { /** - *The ID of the Amazon DataZone domain in which the project exists.
+ *The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is
+ * invoked.
The ID of the project.
+ *The environment ID of the environment action.
+ * @public + */ + environmentIdentifier: string | undefined; + + /** + *The ID of the environment action
* @public */ identifier: string | undefined; @@ -1277,175 +1256,185 @@ export interface GetProjectInput { /** * @public */ -export interface GetProjectOutput { +export interface GetEnvironmentActionOutput { /** - *The ID of the Amazon DataZone domain in which the project exists.
+ *The ID of the Amazon DataZone domain in which the environment action lives.
* @public */ domainId: string | undefined; /** - *>The ID of the project.
+ *The environment ID of the environment action.
* @public */ - id: string | undefined; + environmentId: string | undefined; /** - *The name of the project.
+ *The ID of the environment action.
* @public */ - name: string | undefined; + id: string | undefined; /** - *The description of the project.
+ *The name of the environment action.
* @public */ - description?: string | undefined; + name: string | undefined; /** - *The status of the project.
+ *The parameters of the environment action.
* @public */ - projectStatus?: ProjectStatus | undefined; + parameters: ActionParameters | undefined; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The description of the environment action.
* @public */ - failureReasons?: ProjectDeletionError[] | undefined; + description?: string | undefined; +} +/** + * @public + */ +export interface GetEnvironmentBlueprintInput { /** - *The Amazon DataZone user who created the project.
+ *The identifier of the domain in which this blueprint exists.
* @public */ - createdBy: string | undefined; + domainIdentifier: string | undefined; /** - *The timestamp of when the project was created.
+ *The ID of this Amazon DataZone blueprint.
* @public */ - createdAt?: Date | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetEnvironmentBlueprintOutput { /** - *The timestamp of when the project was last updated.
+ *The ID of this Amazon DataZone blueprint.
* @public */ - lastUpdatedAt?: Date | undefined; + id: string | undefined; /** - *The business glossary terms that can be used in the project.
+ *The name of this Amazon DataZone blueprint.
* @public */ - glossaryTerms?: string[] | undefined; + name: string | undefined; /** - *The ID of the domain unit.
+ *The description of this Amazon DataZone blueprint.
* @public */ - domainUnitId?: string | undefined; -} + description?: string | undefined; -/** - * @public - */ -export interface GetSubscriptionInput { /** - *The ID of the Amazon DataZone domain in which the subscription exists.
+ *The provider of this Amazon DataZone blueprint.
* @public */ - domainIdentifier: string | undefined; + provider: string | undefined; /** - *The ID of the subscription.
+ *The provisioning properties of this Amazon DataZone blueprint.
* @public */ - identifier: string | undefined; -} + provisioningProperties: ProvisioningProperties | undefined; -/** - * @public - */ -export interface GetSubscriptionOutput { /** - *The ID of the subscription.
+ *The deployment properties of this Amazon DataZone blueprint.
* @public */ - id: string | undefined; + deploymentProperties?: DeploymentProperties | undefined; /** - *The Amazon DataZone user who created the subscription.
+ *The user parameters of this blueprint.
* @public */ - createdBy: string | undefined; + userParameters?: CustomParameter[] | undefined; /** - *The Amazon DataZone user who updated the subscription.
+ *The glossary terms attached to this Amazon DataZone blueprint.
* @public */ - updatedBy?: string | undefined; + glossaryTerms?: string[] | undefined; /** - *The ID of the Amazon DataZone domain in which the subscription exists.
+ *A timestamp of when this blueprint was created.
* @public */ - domainId: string | undefined; + createdAt?: Date | undefined; /** - *The status of the subscription.
+ *The timestamp of when this blueprint was updated.
* @public */ - status: SubscriptionStatus | undefined; + updatedAt?: Date | undefined; +} +/** + * @public + */ +export interface GetEnvironmentCredentialsInput { /** - *The timestamp of when the subscription was created.
+ *The ID of the Amazon DataZone domain in which this environment and its credentials + * exist.
* @public */ - createdAt: Date | undefined; + domainIdentifier: string | undefined; /** - *The timestamp of when the subscription was updated.
+ *The ID of the environment whose credentials this operation gets.
* @public */ - updatedAt: Date | undefined; + environmentIdentifier: string | undefined; +} +/** + * @public + */ +export interface GetEnvironmentCredentialsOutput { /** - *The principal that owns the subscription.
+ *The access key ID of the environment.
* @public */ - subscribedPrincipal: SubscribedPrincipal | undefined; + accessKeyId?: string | undefined; /** - *The details of the published asset for which the subscription grant is created.
+ *The secret access key of the environment credentials.
* @public */ - subscribedListing: SubscribedListing | undefined; + secretAccessKey?: string | undefined; /** - *The ID of the subscription request.
+ *The session token of the environment credentials.
* @public */ - subscriptionRequestId?: string | undefined; + sessionToken?: string | undefined; /** - *The retain permissions of the subscription.
+ *The expiration timestamp of the environment credentials.
* @public */ - retainPermissions?: boolean | undefined; + expiration?: Date | undefined; } /** * @public */ -export interface GetSubscriptionGrantInput { +export interface GetEnvironmentProfileInput { /** - *The ID of the Amazon DataZone domain in which the subscription grant exists.
+ *The ID of the Amazon DataZone domain in which this environment profile exists.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the subscription grant.
+ *The ID of the environment profile.
* @public */ identifier: string | undefined; @@ -1454,474 +1443,483 @@ export interface GetSubscriptionGrantInput { /** * @public */ -export interface GetSubscriptionGrantOutput { +export interface GetEnvironmentProfileOutput { /** - *The ID of the subscription grant.
+ *The ID of the environment profile.
* @public */ id: string | undefined; /** - *The Amazon DataZone user who created the subscription grant.
+ *The ID of the Amazon DataZone domain in which this environment profile exists.
* @public */ - createdBy: string | undefined; + domainId: string | undefined; /** - *The Amazon DataZone user who updated the subscription grant.
+ *The ID of the Amazon Web Services account where this environment profile exists.
* @public */ - updatedBy?: string | undefined; + awsAccountId?: string | undefined; /** - *The ID of the Amazon DataZone domain in which the subscription grant exists.
+ *The Amazon Web Services region where this environment profile exists.
* @public */ - domainId: string | undefined; + awsAccountRegion?: string | undefined; /** - *The timestamp of when the subscription grant is created.
+ *The Amazon DataZone user who created this environment profile.
* @public */ - createdAt: Date | undefined; + createdBy: string | undefined; /** - *The timestamp of when the subscription grant was upated.
+ *The timestamp of when this environment profile was created.
* @public */ - updatedAt: Date | undefined; + createdAt?: Date | undefined; /** - *The subscription target ID associated with the subscription grant.
+ *The timestamp of when this environment profile was upated.
* @public */ - subscriptionTargetId: string | undefined; + updatedAt?: Date | undefined; /** - *The entity to which the subscription is granted.
+ *The name of the environment profile.
* @public */ - grantedEntity: GrantedEntity | undefined; + name: string | undefined; /** - *The status of the subscription grant.
+ *The description of the environment profile.
* @public */ - status: SubscriptionGrantOverallStatus | undefined; + description?: string | undefined; /** - *The assets for which the subscription grant is created.
+ *The ID of the blueprint with which this environment profile is created.
* @public */ - assets?: SubscribedAsset[] | undefined; + environmentBlueprintId: string | undefined; /** - * @deprecated - * - *The identifier of the subscription.
+ *The ID of the Amazon DataZone project in which this environment profile is created.
* @public */ - subscriptionId?: string | undefined; + projectId?: string | undefined; + + /** + *The user parameters of the environment profile.
+ * @public + */ + userParameters?: CustomParameter[] | undefined; } /** * @public */ -export interface GetSubscriptionRequestDetailsInput { +export interface GetGroupProfileInput { /** - *The identifier of the Amazon DataZone domain in which to get the subscription request - * details.
+ *The identifier of the Amazon DataZone domain in which the group profile exists.
* @public */ domainIdentifier: string | undefined; /** - *The identifier of the subscription request the details of which to get.
+ *The identifier of the group profile.
* @public */ - identifier: string | undefined; + groupIdentifier: string | undefined; } /** * @public */ -export interface GetSubscriptionRequestDetailsOutput { - /** - *The identifier of the subscription request.
- * @public - */ - id: string | undefined; - - /** - *The Amazon DataZone user who created the subscription request.
- * @public - */ - createdBy: string | undefined; - +export interface GetGroupProfileOutput { /** - *The Amazon DataZone user who updated the subscription request.
+ *The identifier of the Amazon DataZone domain in which the group profile exists.
* @public */ - updatedBy?: string | undefined; + domainId?: string | undefined; /** - *The Amazon DataZone domain of the subscription request.
+ *The identifier of the group profile.
* @public */ - domainId: string | undefined; + id?: string | undefined; /** - *The status of the subscription request.
+ *The identifier of the group profile.
* @public */ - status: SubscriptionRequestStatus | undefined; + status?: GroupProfileStatus | undefined; /** - *The timestamp of when the specified subscription request was created.
+ *The name of the group for which the specified group profile exists.
* @public */ - createdAt: Date | undefined; + groupName?: string | undefined; +} +/** + * @public + */ +export interface GetIamPortalLoginUrlInput { /** - *The timestamp of when the subscription request was updated.
+ *the ID of the Amazon DataZone domain the data portal of which you want to get.
* @public */ - updatedAt: Date | undefined; + domainIdentifier: string | undefined; +} +/** + * @public + */ +export interface GetIamPortalLoginUrlOutput { /** - *The reason for the subscription request.
+ *The data portal URL of the specified Amazon DataZone domain.
* @public */ - requestReason: string | undefined; + authCodeUrl?: string | undefined; /** - *The subscribed principals in the subscription request.
+ *The ID of the user profile.
* @public */ - subscribedPrincipals: SubscribedPrincipal[] | undefined; + userProfileId: string | undefined; +} +/** + * @public + */ +export interface GetLineageNodeInput { /** - *The subscribed listings in the subscription request.
+ *The ID of the domain in which you want to get the data lineage node.
* @public */ - subscribedListings: SubscribedListing[] | undefined; + domainIdentifier: string | undefined; /** - *The identifier of the Amazon DataZone user who reviewed the subscription request.
+ *The ID of the data lineage node that you want to get.
+ *Both, a lineage node identifier generated by Amazon DataZone and a
+ * sourceIdentifier of the lineage node are supported. If
+ * sourceIdentifier is greater than 1800 characters, you can use lineage node
+ * identifier generated by Amazon DataZone to get the node details.
The decision comment of the subscription request.
+ *The event time stamp for which you want to get the data lineage node.
* @public */ - decisionComment?: string | undefined; + eventTimestamp?: Date | undefined; } /** + *The reference details for the data lineage node.
* @public */ -export interface GetSubscriptionTargetInput { - /** - *The ID of the Amazon DataZone domain in which the subscription target exists.
- * @public - */ - domainIdentifier: string | undefined; - +export interface LineageNodeReference { /** - *The ID of the environment associated with the subscription target.
+ *The ID of the data lineage node.
* @public */ - environmentIdentifier: string | undefined; + id?: string | undefined; /** - *The ID of the subscription target.
+ *The event timestamp of the data lineage node.
* @public */ - identifier: string | undefined; + eventTimestamp?: Date | undefined; } /** * @public */ -export interface GetSubscriptionTargetOutput { +export interface GetLineageNodeOutput { /** - *The ID of the subscription target.
+ *The ID of the domain where you're getting the data lineage node.
* @public */ - id: string | undefined; + domainId: string | undefined; /** - *The authorized principals of the subscription target.
+ *The name of the data lineage node.
* @public */ - authorizedPrincipals: string[] | undefined; + name?: string | undefined; /** - *The ID of the Amazon DataZone domain in which the subscription target exists.
+ *The description of the data lineage node.
* @public */ - domainId: string | undefined; + description?: string | undefined; /** - *The ID of the project associated with the subscription target.
+ *The timestamp at which the data lineage node was created.
* @public */ - projectId: string | undefined; + createdAt?: Date | undefined; /** - *The ID of the environment associated with the subscription target.
+ *The user who created the data lineage node.
* @public */ - environmentId: string | undefined; + createdBy?: string | undefined; /** - *The name of the subscription target.
+ *The timestamp at which the data lineage node was updated.
* @public */ - name: string | undefined; + updatedAt?: Date | undefined; /** - *The type of the subscription target.
+ *The user who updated the data lineage node.
* @public */ - type: string | undefined; + updatedBy?: string | undefined; /** - *The Amazon DataZone user who created the subscription target.
+ *The ID of the data lineage node.
* @public */ - createdBy: string | undefined; + id: string | undefined; /** - *The Amazon DataZone user who updated the subscription target.
+ *The name of the type of the specified data lineage node.
* @public */ - updatedBy?: string | undefined; + typeName: string | undefined; /** - *The timestamp of when the subscription target was created.
+ *The revision type of the specified data lineage node.
* @public */ - createdAt: Date | undefined; + typeRevision?: string | undefined; /** - *The timestamp of when the subscription target was updated.
+ *The source identifier of the data lineage node.
* @public */ - updatedAt?: Date | undefined; + sourceIdentifier?: string | undefined; /** - *The manage access role with which the subscription target was created.
+ *The timestamp of the event described in the data lineage node.
* @public */ - manageAccessRole: string | undefined; + eventTimestamp?: Date | undefined; /** - *The asset types associated with the subscription target.
+ *The metadata of the specified data lineage node.
* @public */ - applicableAssetTypes: string[] | undefined; + formsOutput?: FormOutput[] | undefined; /** - *The configuration of teh subscription target.
+ *The upstream nodes of the specified data lineage node.
* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + upstreamNodes?: LineageNodeReference[] | undefined; /** - *The provider of the subscription target.
+ *The downsteam nodes of the specified data lineage node.
* @public */ - provider: string | undefined; + downstreamNodes?: LineageNodeReference[] | undefined; } /** * @public */ -export interface GetTimeSeriesDataPointInput { +export interface GetProjectInput { /** - *The ID of the Amazon DataZone domain that houses the asset for which you want to get the - * data point.
+ *The ID of the Amazon DataZone domain in which the project exists.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the asset for which you want to get the data point.
+ *The ID of the project.
* @public */ - entityIdentifier: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetProjectOutput { /** - *The type of the asset for which you want to get the data point.
+ *The ID of the Amazon DataZone domain in which the project exists.
* @public */ - entityType: TimeSeriesEntityType | undefined; + domainId: string | undefined; /** - *The ID of the data point that you want to get.
+ *>The ID of the project.
* @public */ - identifier: string | undefined; + id: string | undefined; /** - *The name of the time series form that houses the data point that you want to get.
+ *The name of the project.
* @public */ - formName: string | undefined; -} + name: string | undefined; -/** - *The time series data points form.
- * @public - */ -export interface TimeSeriesDataPointFormOutput { /** - *The name of the time series data points form.
+ *The description of the project.
* @public */ - formName: string | undefined; + description?: string | undefined; /** - *The ID of the type of the time series data points form.
+ *The status of the project.
* @public */ - typeIdentifier: string | undefined; + projectStatus?: ProjectStatus | undefined; /** - *The revision type of the time series data points form.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - typeRevision?: string | undefined; + failureReasons?: ProjectDeletionError[] | undefined; /** - *The timestamp of the time series data points form.
+ *The Amazon DataZone user who created the project.
* @public */ - timestamp: Date | undefined; + createdBy: string | undefined; /** - *The content of the time series data points form.
+ *The timestamp of when the project was created.
* @public */ - content?: string | undefined; + createdAt?: Date | undefined; /** - *The ID of the time series data points form.
+ *The timestamp of when the project was last updated.
* @public */ - id?: string | undefined; + lastUpdatedAt?: Date | undefined; + + /** + *The business glossary terms that can be used in the project.
+ * @public + */ + glossaryTerms?: string[] | undefined; + + /** + *The ID of the domain unit.
+ * @public + */ + domainUnitId?: string | undefined; } /** * @public */ -export interface GetTimeSeriesDataPointOutput { +export interface GetSubscriptionInput { /** - *The ID of the Amazon DataZone domain that houses the asset data point that you want to - * get.
+ *The ID of the Amazon DataZone domain in which the subscription exists.
* @public */ - domainId?: string | undefined; + domainIdentifier: string | undefined; /** - *The ID of the asset for which you want to get the data point.
+ *The ID of the subscription.
* @public */ - entityId?: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetSubscriptionOutput { /** - *The type of the asset for which you want to get the data point.
+ *The ID of the subscription.
* @public */ - entityType?: TimeSeriesEntityType | undefined; + id: string | undefined; /** - *The name of the time series form that houses the data point that you want to get.
+ *The Amazon DataZone user who created the subscription.
* @public */ - formName?: string | undefined; + createdBy: string | undefined; /** - *The time series form that houses the data point that you want to get.
+ *The Amazon DataZone user who updated the subscription.
* @public */ - form?: TimeSeriesDataPointFormOutput | undefined; -} + updatedBy?: string | undefined; -/** - * @public - */ -export interface GetUserProfileInput { /** - *the ID of the Amazon DataZone domain the data portal of which you want to get.
+ *The ID of the Amazon DataZone domain in which the subscription exists.
* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *The identifier of the user for which you want to get the user profile.
+ *The status of the subscription.
* @public */ - userIdentifier: string | undefined; + status: SubscriptionStatus | undefined; /** - *The type of the user profile.
+ *The timestamp of when the subscription was created.
* @public */ - type?: UserProfileType | undefined; -} + createdAt: Date | undefined; -/** - * @public - */ -export interface GetUserProfileOutput { /** - *the identifier of the Amazon DataZone domain of which you want to get the user - * profile.
+ *The timestamp of when the subscription was updated.
* @public */ - domainId?: string | undefined; + updatedAt: Date | undefined; /** - *The identifier of the user profile.
+ *The principal that owns the subscription.
* @public */ - id?: string | undefined; + subscribedPrincipal: SubscribedPrincipal | undefined; /** - *The type of the user profile.
+ *The details of the published asset for which the subscription grant is created.
* @public */ - type?: UserProfileType | undefined; + subscribedListing: SubscribedListing | undefined; /** - *The status of the user profile.
+ *The ID of the subscription request.
* @public */ - status?: UserProfileStatus | undefined; + subscriptionRequestId?: string | undefined; /** - *The details of the user profile in Amazon DataZone.
+ *The retain permissions of the subscription.
* @public */ - details?: UserProfileDetails | undefined; + retainPermissions?: boolean | undefined; } /** * @public */ -export interface DeleteGlossaryInput { +export interface GetSubscriptionGrantInput { /** - *The ID of the Amazon DataZone domain in which the business glossary is deleted.
+ *The ID of the Amazon DataZone domain in which the subscription grant exists.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the business glossary that is deleted.
+ *The ID of the subscription grant.
* @public */ identifier: string | undefined; @@ -1930,209 +1928,201 @@ export interface DeleteGlossaryInput { /** * @public */ -export interface DeleteGlossaryOutput {} +export interface GetSubscriptionGrantOutput { + /** + *The ID of the subscription grant.
+ * @public + */ + id: string | undefined; -/** - * @public - */ -export interface GetGlossaryInput { /** - *The ID of the Amazon DataZone domain in which this business glossary exists.
+ *The Amazon DataZone user who created the subscription grant.
* @public */ - domainIdentifier: string | undefined; + createdBy: string | undefined; /** - *The ID of the business glossary.
+ *The Amazon DataZone user who updated the subscription grant.
* @public */ - identifier: string | undefined; -} + updatedBy?: string | undefined; -/** - * @public - */ -export interface GetGlossaryOutput { /** - *The ID of the Amazon DataZone domain in which this business glossary exists.
+ *The ID of the Amazon DataZone domain in which the subscription grant exists.
* @public */ domainId: string | undefined; /** - *The ID of the business glossary.
+ *The timestamp of when the subscription grant is created.
* @public */ - id: string | undefined; + createdAt: Date | undefined; /** - *The ID of the project that owns this business glossary.
+ *The timestamp of when the subscription grant was upated.
* @public */ - owningProjectId: string | undefined; + updatedAt: Date | undefined; /** - *The name of the business glossary.
+ *The subscription target ID associated with the subscription grant.
* @public */ - name: string | undefined; + subscriptionTargetId: string | undefined; /** - *The description of the business glossary.
+ *The entity to which the subscription is granted.
* @public */ - description?: string | undefined; + grantedEntity: GrantedEntity | undefined; /** - *The status of the business glossary.
+ *The status of the subscription grant.
* @public */ - status: GlossaryStatus | undefined; + status: SubscriptionGrantOverallStatus | undefined; /** - *The timestamp of when this business glossary was created.
+ *The assets for which the subscription grant is created.
* @public */ - createdAt?: Date | undefined; + assets?: SubscribedAsset[] | undefined; /** - *The Amazon DataZone user who created this business glossary.
+ * @deprecated + * + *The identifier of the subscription.
* @public */ - createdBy?: string | undefined; + subscriptionId?: string | undefined; +} +/** + * @public + */ +export interface GetSubscriptionRequestDetailsInput { /** - *The timestamp of when the business glossary was updated.
+ *The identifier of the Amazon DataZone domain in which to get the subscription request + * details.
* @public */ - updatedAt?: Date | undefined; + domainIdentifier: string | undefined; /** - *The Amazon DataZone user who updated the business glossary.
+ *The identifier of the subscription request the details of which to get.
* @public */ - updatedBy?: string | undefined; + identifier: string | undefined; } /** * @public */ -export interface UpdateGlossaryInput { +export interface GetSubscriptionRequestDetailsOutput { /** - *The identifier of the Amazon DataZone domain in which a business glossary is to be - * updated.
+ *The identifier of the subscription request.
* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *The identifier of the business glossary to be updated.
+ *The Amazon DataZone user who created the subscription request.
* @public */ - identifier: string | undefined; + createdBy: string | undefined; /** - *The name to be updated as part of the UpdateGlossary action.
The Amazon DataZone user who updated the subscription request.
* @public */ - name?: string | undefined; + updatedBy?: string | undefined; /** - *The description to be updated as part of the UpdateGlossary action.
The Amazon DataZone domain of the subscription request.
* @public */ - description?: string | undefined; + domainId: string | undefined; /** - *The status to be updated as part of the UpdateGlossary action.
The status of the subscription request.
* @public */ - status?: GlossaryStatus | undefined; + status: SubscriptionRequestStatus | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The timestamp of when the specified subscription request was created.
* @public */ - clientToken?: string | undefined; -} + createdAt: Date | undefined; -/** - * @public - */ -export interface UpdateGlossaryOutput { /** - *The identifier of the Amazon DataZone domain in which a business glossary is to be - * updated.
+ *The timestamp of when the subscription request was updated.
* @public */ - domainId: string | undefined; + updatedAt: Date | undefined; /** - *The identifier of the business glossary that is to be updated.
+ *The reason for the subscription request.
* @public */ - id: string | undefined; + requestReason: string | undefined; /** - *The name to be updated as part of the UpdateGlossary action.
The subscribed principals in the subscription request.
* @public */ - name: string | undefined; + subscribedPrincipals: SubscribedPrincipal[] | undefined; /** - *The identifier of the project in which to update a business glossary.
+ *The subscribed listings in the subscription request.
* @public */ - owningProjectId: string | undefined; + subscribedListings: SubscribedListing[] | undefined; /** - *The description to be updated as part of the UpdateGlossary action.
The identifier of the Amazon DataZone user who reviewed the subscription request.
* @public */ - description?: string | undefined; + reviewerId?: string | undefined; /** - *The status to be updated as part of the UpdateGlossary action.
The decision comment of the subscription request.
* @public */ - status?: GlossaryStatus | undefined; -} + decisionComment?: string | undefined; -/** - * @public - */ -export interface DeleteGlossaryTermInput { /** - *The ID of the Amazon DataZone domain in which the business glossary term is deleted.
+ *The ID of the existing subscription.
* @public */ - domainIdentifier: string | undefined; + existingSubscriptionId?: string | undefined; /** - *The ID of the business glossary term that is deleted.
+ *The metadata forms included in the subscription request.
* @public */ - identifier: string | undefined; + metadataForms?: FormOutput[] | undefined; } /** * @public */ -export interface DeleteGlossaryTermOutput {} - -/** - * @public - */ -export interface GetGlossaryTermInput { +export interface GetSubscriptionTargetInput { /** - *The ID of the Amazon DataZone domain in which this business glossary term exists.
+ *The ID of the Amazon DataZone domain in which the subscription target exists.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the business glossary term.
+ *The ID of the environment associated with the subscription target.
+ * @public + */ + environmentIdentifier: string | undefined; + + /** + *The ID of the subscription target.
* @public */ identifier: string | undefined; @@ -2141,970 +2131,812 @@ export interface GetGlossaryTermInput { /** * @public */ -export interface GetGlossaryTermOutput { +export interface GetSubscriptionTargetOutput { /** - *The ID of the Amazon DataZone domain in which this business glossary term exists.
+ *The ID of the subscription target.
* @public */ - domainId: string | undefined; + id: string | undefined; /** - *The ID of the business glossary to which this term belongs.
+ *The authorized principals of the subscription target.
* @public */ - glossaryId: string | undefined; + authorizedPrincipals: string[] | undefined; /** - *The ID of the business glossary term.
+ *The ID of the Amazon DataZone domain in which the subscription target exists.
* @public */ - id: string | undefined; + domainId: string | undefined; /** - *The name of the business glossary term.
+ *The ID of the project associated with the subscription target.
* @public */ - name: string | undefined; + projectId: string | undefined; /** - *The short decription of the business glossary term.
+ *The ID of the environment associated with the subscription target.
* @public */ - shortDescription?: string | undefined; + environmentId: string | undefined; /** - *The long description of the business glossary term.
+ *The name of the subscription target.
* @public */ - longDescription?: string | undefined; + name: string | undefined; /** - *The relations of the business glossary term.
+ *The type of the subscription target.
* @public */ - termRelations?: TermRelations | undefined; + type: string | undefined; /** - *The status of the business glossary term.
+ *The Amazon DataZone user who created the subscription target.
* @public */ - status: GlossaryTermStatus | undefined; + createdBy: string | undefined; /** - *The timestamp of when the business glossary term was created.
+ *The Amazon DataZone user who updated the subscription target.
* @public */ - createdAt?: Date | undefined; + updatedBy?: string | undefined; /** - *The Amazon DataZone user who created the business glossary.
+ *The timestamp of when the subscription target was created.
* @public */ - createdBy?: string | undefined; + createdAt: Date | undefined; /** - *The timestamp of when the business glossary term was updated.
+ *The timestamp of when the subscription target was updated.
* @public */ updatedAt?: Date | undefined; /** - *The Amazon DataZone user who updated the business glossary term.
+ *The manage access role with which the subscription target was created.
* @public */ - updatedBy?: string | undefined; -} + manageAccessRole: string | undefined; -/** - * @public - */ -export interface UpdateGlossaryTermInput { /** - *The identifier of the Amazon DataZone domain in which a business glossary term is to be - * updated.
+ *The asset types associated with the subscription target.
* @public */ - domainIdentifier: string | undefined; + applicableAssetTypes: string[] | undefined; /** - *The identifier of the business glossary in which a term is to be updated.
+ *The configuration of teh subscription target.
* @public */ - glossaryIdentifier?: string | undefined; + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; /** - *The identifier of the business glossary term that is to be updated.
+ *The provider of the subscription target.
* @public */ - identifier: string | undefined; + provider: string | undefined; +} +/** + * @public + */ +export interface GetTimeSeriesDataPointInput { /** - *The name to be updated as part of the UpdateGlossaryTerm action.
The ID of the Amazon DataZone domain that houses the asset for which you want to get the + * data point.
* @public */ - name?: string | undefined; + domainIdentifier: string | undefined; /** - *The short description to be updated as part of the UpdateGlossaryTerm
- * action.
The ID of the asset for which you want to get the data point.
* @public */ - shortDescription?: string | undefined; + entityIdentifier: string | undefined; /** - *The long description to be updated as part of the UpdateGlossaryTerm
- * action.
The type of the asset for which you want to get the data point.
* @public */ - longDescription?: string | undefined; + entityType: TimeSeriesEntityType | undefined; /** - *The term relations to be updated as part of the UpdateGlossaryTerm
- * action.
The ID of the data point that you want to get.
* @public */ - termRelations?: TermRelations | undefined; + identifier: string | undefined; /** - *The status to be updated as part of the UpdateGlossaryTerm action.
The name of the time series form that houses the data point that you want to get.
* @public */ - status?: GlossaryTermStatus | undefined; + formName: string | undefined; } /** + *The time series data points form.
* @public */ -export interface UpdateGlossaryTermOutput { - /** - *The identifier of the business glossary term that is to be updated.
- * @public - */ - id: string | undefined; - - /** - *The identifier of the Amazon DataZone domain in which a business glossary term is to be - * updated.
- * @public - */ - domainId: string | undefined; - +export interface TimeSeriesDataPointFormOutput { /** - *The identifier of the business glossary in which a term is to be updated.
+ *The name of the time series data points form.
* @public */ - glossaryId: string | undefined; + formName: string | undefined; /** - *The name to be updated as part of the UpdateGlossaryTerm action.
The ID of the type of the time series data points form.
* @public */ - name: string | undefined; + typeIdentifier: string | undefined; /** - *The status to be updated as part of the UpdateGlossaryTerm action.
The revision type of the time series data points form.
* @public */ - status: GlossaryTermStatus | undefined; + typeRevision?: string | undefined; /** - *The short description to be updated as part of the UpdateGlossaryTerm
- * action.
The timestamp of the time series data points form.
* @public */ - shortDescription?: string | undefined; + timestamp: Date | undefined; /** - *The long description to be updated as part of the UpdateGlossaryTerm
- * action.
The content of the time series data points form.
* @public */ - longDescription?: string | undefined; + content?: string | undefined; /** - *The term relations to be updated as part of the UpdateGlossaryTerm
- * action.
The ID of the time series data points form.
* @public */ - termRelations?: TermRelations | undefined; + id?: string | undefined; } /** * @public */ -export interface ListAssetFiltersInput { +export interface GetTimeSeriesDataPointOutput { /** - *The ID of the domain where you want to list asset filters.
+ *The ID of the Amazon DataZone domain that houses the asset data point that you want to + * get.
* @public */ - domainIdentifier: string | undefined; + domainId?: string | undefined; /** - *The ID of the data asset.
+ *The ID of the asset for which you want to get the data point.
* @public */ - assetIdentifier: string | undefined; + entityId?: string | undefined; /** - *The status of the asset filter.
+ *The type of the asset for which you want to get the data point.
* @public */ - status?: FilterStatus | undefined; + entityType?: TimeSeriesEntityType | undefined; /** - *When the number of asset filters is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of asset filters, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListAssetFilters to
- * list the next set of asset filters.
The name of the time series form that houses the data point that you want to get.
* @public */ - nextToken?: string | undefined; + formName?: string | undefined; /** - *The maximum number of asset filters to return in a single call to
- * ListAssetFilters. When the number of asset filters to be listed is greater
- * than the value of MaxResults, the response contains a NextToken
- * value that you can use in a subsequent call to ListAssetFilters to list the
- * next set of asset filters.
The time series form that houses the data point that you want to get.
* @public */ - maxResults?: number | undefined; + form?: TimeSeriesDataPointFormOutput | undefined; } /** * @public */ -export interface ListAssetFiltersOutput { +export interface GetUserProfileInput { /** - *The results of the ListAssetFilters action.
the ID of the Amazon DataZone domain the data portal of which you want to get.
* @public */ - items: AssetFilterSummary[] | undefined; + domainIdentifier: string | undefined; /** - *When the number of asset filters is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of asset filters, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListAssetFilters to
- * list the next set of asset filters.
The identifier of the user for which you want to get the user profile.
* @public */ - nextToken?: string | undefined; + userIdentifier: string | undefined; + + /** + *The type of the user profile.
+ * @public + */ + type?: UserProfileType | undefined; } /** * @public */ -export interface ListAssetRevisionsInput { +export interface GetUserProfileOutput { /** - *The identifier of the domain.
+ *the identifier of the Amazon DataZone domain of which you want to get the user + * profile.
* @public */ - domainIdentifier: string | undefined; + domainId?: string | undefined; /** - *The identifier of the asset.
+ *The identifier of the user profile.
* @public */ - identifier: string | undefined; + id?: string | undefined; /** - *When the number of revisions is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of revisions, the response includes
- * a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListAssetRevisions to
- * list the next set of revisions.
The type of the user profile.
* @public */ - nextToken?: string | undefined; + type?: UserProfileType | undefined; /** - *The maximum number of revisions to return in a single call to
- * ListAssetRevisions. When the number of revisions to be listed is greater
- * than the value of MaxResults, the response contains a NextToken
- * value that you can use in a subsequent call to ListAssetRevisions to list the
- * next set of revisions.
The status of the user profile.
* @public */ - maxResults?: number | undefined; + status?: UserProfileStatus | undefined; + + /** + *The details of the user profile in Amazon DataZone.
+ * @public + */ + details?: UserProfileDetails | undefined; } /** * @public */ -export interface ListAssetRevisionsOutput { +export interface DeleteGlossaryInput { /** - *The results of the ListAssetRevisions action.
The ID of the Amazon DataZone domain in which the business glossary is deleted.
* @public */ - items?: AssetRevision[] | undefined; + domainIdentifier: string | undefined; /** - *When the number of revisions is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of revisions, the response includes
- * a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListAssetRevisions to
- * list the next set of revisions.
The ID of the business glossary that is deleted.
* @public */ - nextToken?: string | undefined; + identifier: string | undefined; } /** * @public */ -export interface ListDataProductRevisionsInput { +export interface DeleteGlossaryOutput {} + +/** + * @public + */ +export interface GetGlossaryInput { /** - *The ID of the domain of the data product revisions that you want to list.
+ *The ID of the Amazon DataZone domain in which this business glossary exists.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the data product revision.
+ *The ID of the business glossary.
* @public */ identifier: string | undefined; +} +/** + * @public + */ +export interface GetGlossaryOutput { /** - *The maximum number of asset filters to return in a single call to
- * ListDataProductRevisions. When the number of data product revisions to be
- * listed is greater than the value of MaxResults, the response contains a
- * NextToken value that you can use in a subsequent call to
- * ListDataProductRevisions to list the next set of data product
- * revisions.
The ID of the Amazon DataZone domain in which this business glossary exists.
* @public */ - maxResults?: number | undefined; + domainId: string | undefined; /** - *When the number of data product revisions is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of data product revisions, the
- * response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListDataProductRevisions to list the next set of data product
- * revisions.
The results of the ListDataProductRevisions action.
The ID of the business glossary.
* @public */ - items: DataProductRevision[] | undefined; + id: string | undefined; /** - *When the number of data product revisions is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of data product revisions, the
- * response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListDataProductRevisions to list the next set of data product
- * revisions.
The ID of the project that owns this business glossary.
* @public */ - nextToken?: string | undefined; -} + owningProjectId: string | undefined; -/** - * @public - */ -export interface ListDataSourceRunActivitiesInput { /** - *The identifier of the Amazon DataZone domain in which to list data source run - * activities.
+ *The name of the business glossary.
* @public */ - domainIdentifier: string | undefined; + name: string | undefined; /** - *The identifier of the data source run.
+ *The description of the business glossary.
* @public */ - identifier: string | undefined; + description?: string | undefined; /** - *The status of the data source run.
+ *The status of the business glossary.
* @public */ - status?: DataAssetActivityStatus | undefined; + status: GlossaryStatus | undefined; /** - *When the number of activities is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of activities, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListDataSourceRunActivities to list the next set of activities.
The timestamp of when this business glossary was created.
* @public */ - nextToken?: string | undefined; + createdAt?: Date | undefined; /** - *The maximum number of activities to return in a single call to
- * ListDataSourceRunActivities. When the number of activities to be listed is
- * greater than the value of MaxResults, the response contains a
- * NextToken value that you can use in a subsequent call to
- * ListDataSourceRunActivities to list the next set of activities.
The Amazon DataZone user who created this business glossary.
* @public */ - maxResults?: number | undefined; -} + createdBy?: string | undefined; -/** - * @public - */ -export interface ListDataSourceRunActivitiesOutput { /** - *The results of the ListDataSourceRunActivities action.
The timestamp of when the business glossary was updated.
* @public */ - items: DataSourceRunActivity[] | undefined; + updatedAt?: Date | undefined; /** - *When the number of activities is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of activities, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListDataSourceRunActivities to list the next set of activities.
The Amazon DataZone user who updated the business glossary.
* @public */ - nextToken?: string | undefined; + updatedBy?: string | undefined; } /** * @public */ -export interface ListEntityOwnersInput { +export interface UpdateGlossaryInput { /** - *The ID of the domain where you want to list entity owners.
+ *The identifier of the Amazon DataZone domain in which a business glossary is to be + * updated.
* @public */ domainIdentifier: string | undefined; /** - *The type of the entity that you want to list.
+ *The identifier of the business glossary to be updated.
* @public */ - entityType: DataZoneEntityType | undefined; + identifier: string | undefined; /** - *The ID of the entity that you want to list.
+ *The name to be updated as part of the UpdateGlossary action.
The maximum number of entities to return in a single call to
- * ListEntityOwners. When the number of entities to be listed is greater than
- * the value of MaxResults, the response contains a NextToken value
- * that you can use in a subsequent call to ListEntityOwners to list the next set
- * of entities.
The description to be updated as part of the UpdateGlossary action.
When the number of entities is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of entities, the response includes
- * a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListEntityOwners to
- * list the next set of entities.
The status to be updated as part of the UpdateGlossary action.
The properties of the domain unit owners group.
- * @public - */ -export interface OwnerGroupPropertiesOutput { /** - *The ID of the domain unit owners group.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - groupId?: string | undefined; + clientToken?: string | undefined; } /** - *The properties of the owner user.
* @public */ -export interface OwnerUserPropertiesOutput { +export interface UpdateGlossaryOutput { /** - *The ID of the owner user.
+ *The identifier of the Amazon DataZone domain in which a business glossary is to be + * updated.
* @public */ - userId?: string | undefined; -} - -/** - *The ID of the domain unit owners group.
- * @public - */ -export type OwnerPropertiesOutput = - | OwnerPropertiesOutput.GroupMember - | OwnerPropertiesOutput.UserMember - | OwnerPropertiesOutput.$UnknownMember; + domainId: string | undefined; -/** - * @public - */ -export namespace OwnerPropertiesOutput { /** - *Specifies that the domain unit owner is a user.
+ *The identifier of the business glossary that is to be updated.
* @public */ - export interface UserMember { - user: OwnerUserPropertiesOutput; - group?: never; - $unknown?: never; - } + id: string | undefined; /** - *Specifies that the domain unit owner is a group.
+ *The name to be updated as part of the UpdateGlossary action.
The identifier of the project in which to update a business glossary.
* @public */ - export interface $UnknownMember { - user?: never; - group?: never; - $unknown: [string, any]; - } - - export interface VisitorThe owners of the entity.
+ *The description to be updated as part of the UpdateGlossary action.
When the number of entities is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of entities, the response includes
- * a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListEntityOwners to
- * list the next set of entities.
The status to be updated as part of the UpdateGlossary action.
The ID of the Amazon DataZone domain in which the environment actions are listed.
+ *The ID of the Amazon DataZone domain in which the business glossary term is deleted.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the envrironment whose environment actions are listed.
+ *The ID of the business glossary term that is deleted.
* @public */ - environmentIdentifier: string | undefined; + identifier: string | undefined; +} + +/** + * @public + */ +export interface DeleteGlossaryTermOutput {} +/** + * @public + */ +export interface GetGlossaryTermInput { /** - *When the number of environment actions is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of environment actions, the
- * response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListEnvironmentActions
- * to list the next set of environment actions.
The ID of the Amazon DataZone domain in which this business glossary term exists.
* @public */ - nextToken?: string | undefined; + domainIdentifier: string | undefined; /** - *The maximum number of environment actions to return in a single call to
- * ListEnvironmentActions. When the number of environment actions to be listed
- * is greater than the value of MaxResults, the response contains a
- * NextToken value that you can use in a subsequent call to
- * ListEnvironmentActions to list the next set of environment actions.
The ID of the business glossary term.
* @public */ - maxResults?: number | undefined; + identifier: string | undefined; } /** - *The details about the specified action configured for an environment. For example, the - * details of the specified console links for an analytics tool that is available in this - * environment.
* @public */ -export interface EnvironmentActionSummary { +export interface GetGlossaryTermOutput { /** - *The Amazon DataZone domain ID of the environment action.
+ *The ID of the Amazon DataZone domain in which this business glossary term exists.
* @public */ domainId: string | undefined; /** - *The environment ID of the environment action.
+ *The ID of the business glossary to which this term belongs.
* @public */ - environmentId: string | undefined; + glossaryId: string | undefined; /** - *The ID of the environment action.
+ *The ID of the business glossary term.
* @public */ id: string | undefined; /** - *The name of the environment action.
+ *The name of the business glossary term.
* @public */ name: string | undefined; /** - *The parameters of the environment action.
+ *The short decription of the business glossary term.
* @public */ - parameters: ActionParameters | undefined; + shortDescription?: string | undefined; /** - *The environment action description.
+ *The long description of the business glossary term.
* @public */ - description?: string | undefined; -} - -/** - * @public - */ -export interface ListEnvironmentActionsOutput { - /** - *The results of ListEnvironmentActions.
When the number of environment actions is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of environment actions, the
- * response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListEnvironmentActions
- * to list the next set of environment actions.
The relations of the business glossary term.
* @public */ - nextToken?: string | undefined; -} + termRelations?: TermRelations | undefined; -/** - * @public - */ -export interface ListEnvironmentBlueprintsInput { /** - *The identifier of the Amazon DataZone domain.
+ *The status of the business glossary term.
* @public */ - domainIdentifier: string | undefined; + status: GlossaryTermStatus | undefined; /** - *The maximum number of blueprints to return in a single call to
- * ListEnvironmentBlueprints. When the number of blueprints to be listed is
- * greater than the value of MaxResults, the response contains a
- * NextToken value that you can use in a subsequent call to
- * ListEnvironmentBlueprints to list the next set of blueprints.
The timestamp of when the business glossary term was created.
* @public */ - maxResults?: number | undefined; + createdAt?: Date | undefined; /** - *When the number of blueprints in the environment is greater than the default value for
- * the MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of blueprints in the environment,
- * the response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListEnvironmentBlueprintsto list the next set of blueprints.
The Amazon DataZone user who created the business glossary.
* @public */ - nextToken?: string | undefined; + createdBy?: string | undefined; /** - *The name of the Amazon DataZone environment.
+ *The timestamp of when the business glossary term was updated.
* @public */ - name?: string | undefined; + updatedAt?: Date | undefined; /** - *Specifies whether the environment blueprint is managed by Amazon DataZone.
+ *The Amazon DataZone user who updated the business glossary term.
* @public */ - managed?: boolean | undefined; + updatedBy?: string | undefined; } /** - *The details of an environment blueprint summary.
* @public */ -export interface EnvironmentBlueprintSummary { - /** - *The identifier of the blueprint.
- * @public - */ - id: string | undefined; - +export interface UpdateGlossaryTermInput { /** - *The name of the blueprint.
+ *The identifier of the Amazon DataZone domain in which a business glossary term is to be + * updated.
* @public */ - name: string | undefined; + domainIdentifier: string | undefined; /** - *The description of a blueprint.
+ *The identifier of the business glossary in which a term is to be updated.
* @public */ - description?: string | undefined; + glossaryIdentifier?: string | undefined; /** - *The provider of the blueprint.
+ *The identifier of the business glossary term that is to be updated.
* @public */ - provider: string | undefined; + identifier: string | undefined; /** - *The provisioning properties of the blueprint.
+ *The name to be updated as part of the UpdateGlossaryTerm action.
The timestamp of when an environment blueprint was created.
+ *The short description to be updated as part of the UpdateGlossaryTerm
+ * action.
The timestamp of when the blueprint was enabled.
+ *The long description to be updated as part of the UpdateGlossaryTerm
+ * action.
The results of the ListEnvironmentBlueprints action.
The term relations to be updated as part of the UpdateGlossaryTerm
+ * action.
When the number of blueprints in the environment is greater than the default value for
- * the MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of blueprints in the environment,
- * the response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListEnvironmentBlueprintsto list the next set of blueprints.
The status to be updated as part of the UpdateGlossaryTerm action.
The identifier of the Amazon DataZone domain.
+ *The identifier of the business glossary term that is to be updated.
* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *The identifier of the Amazon Web Services account where you want to list environment - * profiles.
+ *The identifier of the Amazon DataZone domain in which a business glossary term is to be + * updated.
* @public */ - awsAccountId?: string | undefined; + domainId: string | undefined; /** - *The Amazon Web Services region where you want to list environment profiles.
+ *The identifier of the business glossary in which a term is to be updated.
* @public */ - awsAccountRegion?: string | undefined; + glossaryId: string | undefined; /** - *The identifier of the blueprint that was used to create the environment profiles that - * you want to list.
+ *The name to be updated as part of the UpdateGlossaryTerm action.
The identifier of the Amazon DataZone project.
+ *The status to be updated as part of the UpdateGlossaryTerm action.
The short description to be updated as part of the UpdateGlossaryTerm
+ * action.
When the number of environment profiles is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of environment profiles, the
- * response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListEnvironmentProfiles to list the next set of environment
- * profiles.
The long description to be updated as part of the UpdateGlossaryTerm
+ * action.
The maximum number of environment profiles to return in a single call to
- * ListEnvironmentProfiles. When the number of environment profiles to be
- * listed is greater than the value of MaxResults, the response contains a
- * NextToken value that you can use in a subsequent call to
- * ListEnvironmentProfiles to list the next set of environment
- * profiles.
The term relations to be updated as part of the UpdateGlossaryTerm
+ * action.
The details of an environment profile.
* @public */ -export interface EnvironmentProfileSummary { +export interface ListAssetFiltersInput { /** - *The identifier of the environment profile.
+ *The ID of the domain where you want to list asset filters.
* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *The identifier of the Amazon DataZone domain in which the environment profile exists.
+ *The ID of the data asset.
* @public */ - domainId: string | undefined; + assetIdentifier: string | undefined; /** - *The identifier of an Amazon Web Services account in which an environment profile exists.
+ *The status of the asset filter.
* @public */ - awsAccountId?: string | undefined; + status?: FilterStatus | undefined; /** - *The Amazon Web Services Region in which an environment profile exists.
+ *When the number of asset filters is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of asset filters, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListAssetFilters to
+ * list the next set of asset filters.
The Amazon DataZone user who created the environment profile.
+ *The maximum number of asset filters to return in a single call to
+ * ListAssetFilters. When the number of asset filters to be listed is greater
+ * than the value of MaxResults, the response contains a NextToken
+ * value that you can use in a subsequent call to ListAssetFilters to list the
+ * next set of asset filters.
The timestamp of when an environment profile was created.
+ *The results of the ListAssetFilters action.
The timestamp of when the environment profile was updated.
+ *When the number of asset filters is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of asset filters, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListAssetFilters to
+ * list the next set of asset filters.
The name of the environment profile.
+ *The identifier of the domain.
* @public */ - name: string | undefined; + domainIdentifier: string | undefined; /** - *The description of the environment profile.
+ *The identifier of the asset.
* @public */ - description?: string | undefined; + identifier: string | undefined; /** - *The identifier of a blueprint with which an environment profile is created.
+ *When the number of revisions is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of revisions, the response includes
+ * a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListAssetRevisions to
+ * list the next set of revisions.
The identifier of a project in which an environment profile exists.
+ *The maximum number of revisions to return in a single call to
+ * ListAssetRevisions. When the number of revisions to be listed is greater
+ * than the value of MaxResults, the response contains a NextToken
+ * value that you can use in a subsequent call to ListAssetRevisions to list the
+ * next set of revisions.
The results of the ListEnvironmentProfiles action.
The results of the ListAssetRevisions action.
When the number of environment profiles is greater than the default value for the + *
When the number of revisions is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of environment profiles, the
- * response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListEnvironmentProfiles to list the next set of environment
- * profiles.
MaxResults that is less than the number of revisions, the response includes
+ * a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListAssetRevisions to
+ * list the next set of revisions.
+ * @public
*/
nextToken?: string | undefined;
}
@@ -3112,185 +2944,273 @@ export interface ListEnvironmentProfilesOutput {
/**
* @public
*/
-export interface ListEnvironmentsInput {
+export interface ListDataProductRevisionsInput {
/**
- * The identifier of the Amazon DataZone domain.
+ *The ID of the domain of the data product revisions that you want to list.
* @public */ domainIdentifier: string | undefined; /** - *The identifier of the Amazon Web Services account where you want to list - * environments.
+ *The ID of the data product revision.
* @public */ - awsAccountId?: string | undefined; + identifier: string | undefined; /** - *The status of the environments that you want to list.
+ *The maximum number of asset filters to return in a single call to
+ * ListDataProductRevisions. When the number of data product revisions to be
+ * listed is greater than the value of MaxResults, the response contains a
+ * NextToken value that you can use in a subsequent call to
+ * ListDataProductRevisions to list the next set of data product
+ * revisions.
The Amazon Web Services region where you want to list environments.
+ *When the number of data product revisions is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of data product revisions, the
+ * response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListDataProductRevisions to list the next set of data product
+ * revisions.
The identifier of the Amazon DataZone project.
+ *The results of the ListDataProductRevisions action.
The identifier of the environment profile.
+ *When the number of data product revisions is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of data product revisions, the
+ * response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListDataProductRevisions to list the next set of data product
+ * revisions.
The identifier of the Amazon DataZone blueprint.
+ *The identifier of the Amazon DataZone domain in which to list data source run + * activities.
* @public */ - environmentBlueprintIdentifier?: string | undefined; + domainIdentifier: string | undefined; /** - *The provider of the environment.
+ *The identifier of the data source run.
* @public */ - provider?: string | undefined; + identifier: string | undefined; /** - *The name of the environment.
+ *The status of the data source run.
* @public */ - name?: string | undefined; + status?: DataAssetActivityStatus | undefined; /** - *The maximum number of environments to return in a single call to
- * ListEnvironments. When the number of environments to be listed is greater
- * than the value of MaxResults, the response contains a NextToken
- * value that you can use in a subsequent call to ListEnvironments to list the
- * next set of environments.
When the number of activities is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of activities, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListDataSourceRunActivities to list the next set of activities.
When the number of environments is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of environments, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListEnvironments to
- * list the next set of environments.
The maximum number of activities to return in a single call to
+ * ListDataSourceRunActivities. When the number of activities to be listed is
+ * greater than the value of MaxResults, the response contains a
+ * NextToken value that you can use in a subsequent call to
+ * ListDataSourceRunActivities to list the next set of activities.
The details of an environment.
* @public */ -export interface EnvironmentSummary { +export interface ListDataSourceRunActivitiesOutput { /** - *The identifier of the project in which the environment exists.
+ *The results of the ListDataSourceRunActivities action.
The identifier of the environment.
+ *When the number of activities is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of activities, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListDataSourceRunActivities to list the next set of activities.
The identifier of the Amazon DataZone domain in which the environment exists.
+ *The ID of the domain where you want to list entity owners.
* @public */ - domainId: string | undefined; + domainIdentifier: string | undefined; /** - *The Amazon DataZone user who created the environment.
+ *The type of the entity that you want to list.
* @public */ - createdBy: string | undefined; + entityType: DataZoneEntityType | undefined; /** - *The timestamp of when the environment was created.
+ *The ID of the entity that you want to list.
* @public */ - createdAt?: Date | undefined; + entityIdentifier: string | undefined; /** - *The timestamp of when the environment was updated.
+ *The maximum number of entities to return in a single call to
+ * ListEntityOwners. When the number of entities to be listed is greater than
+ * the value of MaxResults, the response contains a NextToken value
+ * that you can use in a subsequent call to ListEntityOwners to list the next set
+ * of entities.
The name of the environment.
+ *When the number of entities is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of entities, the response includes
+ * a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListEntityOwners to
+ * list the next set of entities.
The properties of the domain unit owners group.
+ * @public + */ +export interface OwnerGroupPropertiesOutput { /** - *The description of the environment.
+ *The ID of the domain unit owners group.
* @public */ - description?: string | undefined; + groupId?: string | undefined; +} +/** + *The properties of the owner user.
+ * @public + */ +export interface OwnerUserPropertiesOutput { /** - *The identifier of the environment profile with which the environment was created.
+ *The ID of the owner user.
* @public */ - environmentProfileId?: string | undefined; + userId?: string | undefined; +} - /** - *The identifier of the Amazon Web Services account in which an environment exists.
- * @public - */ - awsAccountId?: string | undefined; +/** + *The ID of the domain unit owners group.
+ * @public + */ +export type OwnerPropertiesOutput = + | OwnerPropertiesOutput.GroupMember + | OwnerPropertiesOutput.UserMember + | OwnerPropertiesOutput.$UnknownMember; +/** + * @public + */ +export namespace OwnerPropertiesOutput { /** - *The Amazon Web Services Region in which an environment exists.
+ *Specifies that the domain unit owner is a user.
* @public */ - awsAccountRegion?: string | undefined; + export interface UserMember { + user: OwnerUserPropertiesOutput; + group?: never; + $unknown?: never; + } /** - *The provider of the environment.
+ *Specifies that the domain unit owner is a group.
* @public */ - provider: string | undefined; + export interface GroupMember { + user?: never; + group: OwnerGroupPropertiesOutput; + $unknown?: never; + } /** - *The status of the environment.
* @public */ - status?: EnvironmentStatus | undefined; + export interface $UnknownMember { + user?: never; + group?: never; + $unknown: [string, any]; + } + + export interface VisitorThe results of the ListEnvironments action.
The owners of the entity.
* @public */ - items: EnvironmentSummary[] | undefined; + owners: OwnerPropertiesOutput[] | undefined; /** - *When the number of environments is greater than the default value for the + *
When the number of entities is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of environments, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListEnvironments to
- * list the next set of environments.
MaxResults that is less than the number of entities, the response includes
+ * a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListEntityOwners to
+ * list the next set of entities.
* @public
*/
nextToken?: string | undefined;
@@ -3299,362 +3219,1292 @@ export interface ListEnvironmentsOutput {
/**
* @public
*/
-export interface DeleteListingInput {
+export interface ListEnvironmentActionsInput {
/**
- * The ID of the Amazon DataZone domain.
+ *The ID of the Amazon DataZone domain in which the environment actions are listed.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the listing to be deleted.
+ *The ID of the envrironment whose environment actions are listed.
* @public */ - identifier: string | undefined; -} - -/** - * @public - */ -export interface DeleteListingOutput {} + environmentIdentifier: string | undefined; -/** - * @public - */ -export interface GetListingInput { /** - *The ID of the Amazon DataZone domain.
- * @public - */ + *When the number of environment actions is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of environment actions, the
+ * response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListEnvironmentActions
+ * to list the next set of environment actions.
The maximum number of environment actions to return in a single call to
+ * ListEnvironmentActions. When the number of environment actions to be listed
+ * is greater than the value of MaxResults, the response contains a
+ * NextToken value that you can use in a subsequent call to
+ * ListEnvironmentActions to list the next set of environment actions.
The details about the specified action configured for an environment. For example, the + * details of the specified console links for an analytics tool that is available in this + * environment.
+ * @public + */ +export interface EnvironmentActionSummary { + /** + *The Amazon DataZone domain ID of the environment action.
+ * @public + */ + domainId: string | undefined; + + /** + *The environment ID of the environment action.
+ * @public + */ + environmentId: string | undefined; + + /** + *The ID of the environment action.
+ * @public + */ + id: string | undefined; + + /** + *The name of the environment action.
+ * @public + */ + name: string | undefined; + + /** + *The parameters of the environment action.
+ * @public + */ + parameters: ActionParameters | undefined; + + /** + *The environment action description.
+ * @public + */ + description?: string | undefined; +} + +/** + * @public + */ +export interface ListEnvironmentActionsOutput { + /** + *The results of ListEnvironmentActions.
When the number of environment actions is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of environment actions, the
+ * response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListEnvironmentActions
+ * to list the next set of environment actions.
The identifier of the Amazon DataZone domain.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The maximum number of blueprints to return in a single call to
+ * ListEnvironmentBlueprints. When the number of blueprints to be listed is
+ * greater than the value of MaxResults, the response contains a
+ * NextToken value that you can use in a subsequent call to
+ * ListEnvironmentBlueprints to list the next set of blueprints.
When the number of blueprints in the environment is greater than the default value for
+ * the MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of blueprints in the environment,
+ * the response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListEnvironmentBlueprintsto list the next set of blueprints.
The name of the Amazon DataZone environment.
+ * @public + */ + name?: string | undefined; + + /** + *Specifies whether the environment blueprint is managed by Amazon DataZone.
+ * @public + */ + managed?: boolean | undefined; +} + +/** + *The details of an environment blueprint summary.
+ * @public + */ +export interface EnvironmentBlueprintSummary { + /** + *The identifier of the blueprint.
+ * @public + */ + id: string | undefined; + + /** + *The name of the blueprint.
+ * @public + */ + name: string | undefined; + + /** + *The description of a blueprint.
+ * @public + */ + description?: string | undefined; + + /** + *The provider of the blueprint.
+ * @public + */ + provider: string | undefined; + + /** + *The provisioning properties of the blueprint.
+ * @public + */ + provisioningProperties: ProvisioningProperties | undefined; + + /** + *The timestamp of when an environment blueprint was created.
+ * @public + */ + createdAt?: Date | undefined; + + /** + *The timestamp of when the blueprint was enabled.
+ * @public + */ + updatedAt?: Date | undefined; +} + +/** + * @public + */ +export interface ListEnvironmentBlueprintsOutput { + /** + *The results of the ListEnvironmentBlueprints action.
When the number of blueprints in the environment is greater than the default value for
+ * the MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of blueprints in the environment,
+ * the response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListEnvironmentBlueprintsto list the next set of blueprints.
The identifier of the Amazon DataZone domain.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The identifier of the Amazon Web Services account where you want to list environment + * profiles.
+ * @public + */ + awsAccountId?: string | undefined; + + /** + *The Amazon Web Services region where you want to list environment profiles.
+ * @public + */ + awsAccountRegion?: string | undefined; + + /** + *The identifier of the blueprint that was used to create the environment profiles that + * you want to list.
+ * @public + */ + environmentBlueprintIdentifier?: string | undefined; + + /** + *The identifier of the Amazon DataZone project.
+ * @public + */ + projectIdentifier?: string | undefined; + + /** + * + * @public + */ + name?: string | undefined; + + /** + *When the number of environment profiles is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of environment profiles, the
+ * response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListEnvironmentProfiles to list the next set of environment
+ * profiles.
The maximum number of environment profiles to return in a single call to
+ * ListEnvironmentProfiles. When the number of environment profiles to be
+ * listed is greater than the value of MaxResults, the response contains a
+ * NextToken value that you can use in a subsequent call to
+ * ListEnvironmentProfiles to list the next set of environment
+ * profiles.
The details of an environment profile.
+ * @public + */ +export interface EnvironmentProfileSummary { + /** + *The identifier of the environment profile.
+ * @public + */ + id: string | undefined; + + /** + *The identifier of the Amazon DataZone domain in which the environment profile exists.
+ * @public + */ + domainId: string | undefined; + + /** + *The identifier of an Amazon Web Services account in which an environment profile exists.
+ * @public + */ + awsAccountId?: string | undefined; + + /** + *The Amazon Web Services Region in which an environment profile exists.
+ * @public + */ + awsAccountRegion?: string | undefined; + + /** + *The Amazon DataZone user who created the environment profile.
+ * @public + */ + createdBy: string | undefined; + + /** + *The timestamp of when an environment profile was created.
+ * @public + */ + createdAt?: Date | undefined; + + /** + *The timestamp of when the environment profile was updated.
+ * @public + */ + updatedAt?: Date | undefined; + + /** + *The name of the environment profile.
+ * @public + */ + name: string | undefined; + + /** + *The description of the environment profile.
+ * @public + */ + description?: string | undefined; + + /** + *The identifier of a blueprint with which an environment profile is created.
+ * @public + */ + environmentBlueprintId: string | undefined; + + /** + *The identifier of a project in which an environment profile exists.
+ * @public + */ + projectId?: string | undefined; +} + +/** + * @public + */ +export interface ListEnvironmentProfilesOutput { + /** + *The results of the ListEnvironmentProfiles action.
When the number of environment profiles is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of environment profiles, the
+ * response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListEnvironmentProfiles to list the next set of environment
+ * profiles.
The identifier of the Amazon DataZone domain.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The identifier of the Amazon Web Services account where you want to list + * environments.
+ * @public + */ + awsAccountId?: string | undefined; + + /** + *The status of the environments that you want to list.
+ * @public + */ + status?: EnvironmentStatus | undefined; + + /** + *The Amazon Web Services region where you want to list environments.
+ * @public + */ + awsAccountRegion?: string | undefined; + + /** + *The identifier of the Amazon DataZone project.
+ * @public + */ + projectIdentifier: string | undefined; + + /** + *The identifier of the environment profile.
+ * @public + */ + environmentProfileIdentifier?: string | undefined; + + /** + *The identifier of the Amazon DataZone blueprint.
+ * @public + */ + environmentBlueprintIdentifier?: string | undefined; + + /** + *The provider of the environment.
+ * @public + */ + provider?: string | undefined; + + /** + *The name of the environment.
+ * @public + */ + name?: string | undefined; + + /** + *The maximum number of environments to return in a single call to
+ * ListEnvironments. When the number of environments to be listed is greater
+ * than the value of MaxResults, the response contains a NextToken
+ * value that you can use in a subsequent call to ListEnvironments to list the
+ * next set of environments.
When the number of environments is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of environments, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListEnvironments to
+ * list the next set of environments.
The details of an environment.
+ * @public + */ +export interface EnvironmentSummary { + /** + *The identifier of the project in which the environment exists.
+ * @public + */ + projectId: string | undefined; + + /** + *The identifier of the environment.
+ * @public + */ + id?: string | undefined; + + /** + *The identifier of the Amazon DataZone domain in which the environment exists.
+ * @public + */ + domainId: string | undefined; + + /** + *The Amazon DataZone user who created the environment.
+ * @public + */ + createdBy: string | undefined; + + /** + *The timestamp of when the environment was created.
+ * @public + */ + createdAt?: Date | undefined; + + /** + *The timestamp of when the environment was updated.
+ * @public + */ + updatedAt?: Date | undefined; + + /** + *The name of the environment.
+ * @public + */ + name: string | undefined; + + /** + *The description of the environment.
+ * @public + */ + description?: string | undefined; + + /** + *The identifier of the environment profile with which the environment was created.
+ * @public + */ + environmentProfileId?: string | undefined; + + /** + *The identifier of the Amazon Web Services account in which an environment exists.
+ * @public + */ + awsAccountId?: string | undefined; + + /** + *The Amazon Web Services Region in which an environment exists.
+ * @public + */ + awsAccountRegion?: string | undefined; + + /** + *The provider of the environment.
+ * @public + */ + provider: string | undefined; + + /** + *The status of the environment.
+ * @public + */ + status?: EnvironmentStatus | undefined; +} + +/** + * @public + */ +export interface ListEnvironmentsOutput { + /** + *The results of the ListEnvironments action.
When the number of environments is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of environments, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListEnvironments to
+ * list the next set of environments.
The ID of the Amazon DataZone domain.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the listing to be deleted.
+ * @public + */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface DeleteListingOutput {} + +/** + * @public + */ +export interface GetListingInput { + /** + *The ID of the Amazon DataZone domain.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the listing.
+ * @public + */ + identifier: string | undefined; + + /** + *The revision of the listing.
+ * @public + */ + listingRevision?: string | undefined; +} + +/** + *The details of a listing (aka asset published in a Amazon DataZone catalog).
+ * @public + */ +export type ListingItem = + | ListingItem.AssetListingMember + | ListingItem.DataProductListingMember + | ListingItem.$UnknownMember; + +/** + * @public + */ +export namespace ListingItem { + /** + *An asset published in an Amazon DataZone catalog.
+ * @public + */ + export interface AssetListingMember { + assetListing: AssetListing; + dataProductListing?: never; + $unknown?: never; + } + + /** + *The data product listing.
+ * @public + */ + export interface DataProductListingMember { + assetListing?: never; + dataProductListing: DataProductListing; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + assetListing?: never; + dataProductListing?: never; + $unknown: [string, any]; + } + + export interface VisitorThe ID of the Amazon DataZone domain.
+ * @public + */ + domainId: string | undefined; + + /** + *The ID of the listing.
+ * @public + */ + id: string | undefined; + + /** + *The revision of a listing.
+ * @public + */ + listingRevision: string | undefined; + + /** + *The timestamp of when the listing was created.
+ * @public + */ + createdAt?: Date | undefined; + + /** + *The timestamp of when the listing was updated.
+ * @public + */ + updatedAt?: Date | undefined; + + /** + *The Amazon DataZone user who created the listing.
+ * @public + */ + createdBy?: string | undefined; + + /** + *The Amazon DataZone user who updated the listing.
+ * @public + */ + updatedBy?: string | undefined; + + /** + *The details of a listing.
+ * @public + */ + item?: ListingItem | undefined; + + /** + *The name of the listing.
+ * @public + */ + name?: string | undefined; + + /** + *The description of the listing.
+ * @public + */ + description?: string | undefined; + + /** + *The status of the listing.
+ * @public + */ + status?: ListingStatus | undefined; +} + +/** + * @public + * @enum + */ +export const EdgeDirection = { + DOWNSTREAM: "DOWNSTREAM", + UPSTREAM: "UPSTREAM", +} as const; + +/** + * @public + */ +export type EdgeDirection = (typeof EdgeDirection)[keyof typeof EdgeDirection]; + +/** + * @public + * @enum + */ +export const SortOrder = { + ASCENDING: "ASCENDING", + DESCENDING: "DESCENDING", +} as const; + +/** + * @public + */ +export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; + +/** + * @public + */ +export interface ListLineageNodeHistoryInput { + /** + *The ID of the domain where you want to list the history of the specified data lineage + * node.
+ * @public + */ domainIdentifier: string | undefined; /** - *The ID of the listing.
+ *The maximum number of history items to return in a single call to + * ListLineageNodeHistory. When the number of memberships to be listed is greater than the + * value of MaxResults, the response contains a NextToken value that you can use in a + * subsequent call to ListLineageNodeHistory to list the next set of items.
+ * @public + */ + maxResults?: number | undefined; + + /** + *When the number of history items is greater than the default value for the MaxResults + * parameter, or if you explicitly specify a value for MaxResults that is less than the number + * of items, the response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of + * items.
+ * @public + */ + nextToken?: string | undefined; + + /** + *The ID of the data lineage node whose history you want to list.
+ * @public + */ + identifier: string | undefined; + + /** + *The direction of the data lineage node refers to the lineage node having neighbors in
+ * that direction. For example, if direction is UPSTREAM, the
+ * ListLineageNodeHistory API responds with historical versions with upstream
+ * neighbors only.
Specifies whether the action is to return data lineage node history from the time after + * the event timestamp.
+ * @public + */ + eventTimestampGTE?: Date | undefined; + + /** + *Specifies whether the action is to return data lineage node history from the time prior + * of the event timestamp.
+ * @public + */ + eventTimestampLTE?: Date | undefined; + + /** + *The order by which you want data lineage node history to be sorted.
+ * @public + */ + sortOrder?: SortOrder | undefined; +} + +/** + *The summary of the data lineage node.
+ * @public + */ +export interface LineageNodeSummary { + /** + *The ID of the domain of the data lineage node.
+ * @public + */ + domainId: string | undefined; + + /** + *The name of the data lineage node.
+ * @public + */ + name?: string | undefined; + + /** + *The description of the data lineage node.
+ * @public + */ + description?: string | undefined; + + /** + *The timestamp at which the data lineage node was created.
+ * @public + */ + createdAt?: Date | undefined; + + /** + *The user who created the data lineage node.
+ * @public + */ + createdBy?: string | undefined; + + /** + *The timestamp at which the data lineage node was updated.
* @public */ - identifier: string | undefined; + updatedAt?: Date | undefined; /** - *The revision of the listing.
+ *The user who updated the data lineage node.
* @public */ - listingRevision?: string | undefined; -} - -/** - *The details of a listing (aka asset published in a Amazon DataZone catalog).
- * @public - */ -export type ListingItem = - | ListingItem.AssetListingMember - | ListingItem.DataProductListingMember - | ListingItem.$UnknownMember; + updatedBy?: string | undefined; -/** - * @public - */ -export namespace ListingItem { /** - *An asset published in an Amazon DataZone catalog.
+ *The ID of the data lineage node.
* @public */ - export interface AssetListingMember { - assetListing: AssetListing; - dataProductListing?: never; - $unknown?: never; - } + id: string | undefined; /** - *The data product listing.
+ *The name of the type of the data lineage node.
* @public */ - export interface DataProductListingMember { - assetListing?: never; - dataProductListing: DataProductListing; - $unknown?: never; - } + typeName: string | undefined; /** + *The type of the revision of the data lineage node.
* @public */ - export interface $UnknownMember { - assetListing?: never; - dataProductListing?: never; - $unknown: [string, any]; - } + typeRevision?: string | undefined; - export interface VisitorThe alternate ID of the data lineage node.
+ * @public + */ + sourceIdentifier?: string | undefined; - export const visit =The event timestamp of the data lineage node.
+ * @public + */ + eventTimestamp?: Date | undefined; } /** * @public */ -export interface GetListingOutput { +export interface ListLineageNodeHistoryOutput { /** - *The ID of the Amazon DataZone domain.
+ *The nodes returned by the ListLineageNodeHistory action.
* @public */ - domainId: string | undefined; + nodes?: LineageNodeSummary[] | undefined; /** - *The ID of the listing.
+ *When the number of history items is greater than the default value for the MaxResults + * parameter, or if you explicitly specify a value for MaxResults that is less than the number + * of items, the response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of + * items.
* @public */ - id: string | undefined; + nextToken?: string | undefined; +} - /** - *The revision of a listing.
- * @public - */ - listingRevision: string | undefined; +/** + * @public + * @enum + */ +export const TaskStatus = { + ACTIVE: "ACTIVE", + INACTIVE: "INACTIVE", +} as const; + +/** + * @public + */ +export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus]; + +/** + * @public + * @enum + */ +export const NotificationType = { + EVENT: "EVENT", + TASK: "TASK", +} as const; + +/** + * @public + */ +export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType]; +/** + * @public + */ +export interface ListNotificationsInput { /** - *The timestamp of when the listing was created.
+ *The identifier of the Amazon DataZone domain.
* @public */ - createdAt?: Date | undefined; + domainIdentifier: string | undefined; /** - *The timestamp of when the listing was updated.
+ *The type of notifications.
* @public */ - updatedAt?: Date | undefined; + type: NotificationType | undefined; /** - *The Amazon DataZone user who created the listing.
+ *The time after which you want to list notifications.
* @public */ - createdBy?: string | undefined; + afterTimestamp?: Date | undefined; /** - *The Amazon DataZone user who updated the listing.
+ *The time before which you want to list notifications.
* @public */ - updatedBy?: string | undefined; + beforeTimestamp?: Date | undefined; /** - *The details of a listing.
+ *The subjects of notifications.
* @public */ - item?: ListingItem | undefined; + subjects?: string[] | undefined; /** - *The name of the listing.
+ *The task status of notifications.
* @public */ - name?: string | undefined; + taskStatus?: TaskStatus | undefined; /** - *The description of the listing.
+ *The maximum number of notifications to return in a single call to
+ * ListNotifications. When the number of notifications to be listed is greater
+ * than the value of MaxResults, the response contains a NextToken
+ * value that you can use in a subsequent call to ListNotifications to list the
+ * next set of notifications.
The status of the listing.
+ *When the number of notifications is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of notifications, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListNotifications to
+ * list the next set of notifications.
The details of the resource mentioned in a notification.
+ * @public + */ +export interface NotificationResource { + /** + *The type of the resource mentioned in a notification.
+ * @public + */ + type: NotificationResourceType | undefined; + + /** + *The ID of the resource mentioned in a notification.
+ * @public + */ + id: string | undefined; + + /** + *The name of the resource mentioned in a notification.
+ * @public + */ + name?: string | undefined; +} /** * @public * @enum */ -export const SortOrder = { - ASCENDING: "ASCENDING", - DESCENDING: "DESCENDING", +export const NotificationRole = { + DOMAIN_OWNER: "DOMAIN_OWNER", + PROJECT_CONTRIBUTOR: "PROJECT_CONTRIBUTOR", + PROJECT_OWNER: "PROJECT_OWNER", + PROJECT_SUBSCRIBER: "PROJECT_SUBSCRIBER", + PROJECT_VIEWER: "PROJECT_VIEWER", } as const; /** * @public */ -export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; +export type NotificationRole = (typeof NotificationRole)[keyof typeof NotificationRole]; /** + *The topic of the notification.
* @public */ -export interface ListLineageNodeHistoryInput { +export interface Topic { /** - *The ID of the domain where you want to list the history of the specified data lineage - * node.
+ *The subject of the resource mentioned in a notification.
+ * @public + */ + subject: string | undefined; + + /** + *The details of the resource mentioned in a notification.
+ * @public + */ + resource: NotificationResource | undefined; + + /** + *The role of the resource mentioned in a notification.
+ * @public + */ + role: NotificationRole | undefined; +} + +/** + *The details of a notification generated in Amazon DataZone.
+ * @public + */ +export interface NotificationOutput { + /** + *The identifier of the notification.
+ * @public + */ + identifier: string | undefined; + + /** + *The identifier of a Amazon DataZone domain in which the notification exists.
* @public */ domainIdentifier: string | undefined; /** - *The maximum number of history items to return in a single call to - * ListLineageNodeHistory. When the number of memberships to be listed is greater than the - * value of MaxResults, the response contains a NextToken value that you can use in a - * subsequent call to ListLineageNodeHistory to list the next set of items.
+ *The type of the notification.
* @public */ - maxResults?: number | undefined; + type: NotificationType | undefined; /** - *When the number of history items is greater than the default value for the MaxResults - * parameter, or if you explicitly specify a value for MaxResults that is less than the number - * of items, the response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of - * items.
+ *The topic of the notification.
+ * @public + */ + topic: Topic | undefined; + + /** + *The title of the notification.
+ * @public + */ + title: string | undefined; + + /** + *The message included in the notification.
* @public */ - nextToken?: string | undefined; + message: string | undefined; /** - *The ID of the data lineage node whose history you want to list.
+ *The status included in the notification.
* @public */ - identifier: string | undefined; + status?: TaskStatus | undefined; /** - *The direction of the data lineage node refers to the lineage node having neighbors in
- * that direction. For example, if direction is UPSTREAM, the
- * ListLineageNodeHistory API responds with historical versions with upstream
- * neighbors only.
The action link included in the notification.
* @public */ - direction?: EdgeDirection | undefined; + actionLink: string | undefined; /** - *Specifies whether the action is to return data lineage node history from the time after - * the event timestamp.
+ *The timestamp of when a notification was created.
* @public */ - eventTimestampGTE?: Date | undefined; + creationTimestamp: Date | undefined; /** - *Specifies whether the action is to return data lineage node history from the time prior - * of the event timestamp.
+ *The timestamp of when the notification was last updated.
* @public */ - eventTimestampLTE?: Date | undefined; + lastUpdatedTimestamp: Date | undefined; /** - *The order by which you want data lineage node history to be sorted.
+ *The metadata included in the notification.
* @public */ - sortOrder?: SortOrder | undefined; + metadata?: RecordThe summary of the data lineage node.
* @public */ -export interface LineageNodeSummary { +export interface ListNotificationsOutput { /** - *The ID of the domain of the data lineage node.
+ *The results of the ListNotifications action.
The name of the data lineage node.
+ *When the number of notifications is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of notifications, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListNotifications to
+ * list the next set of notifications.
The description of the data lineage node.
+ *The ID of the domain where you want to list policy grants.
* @public */ - description?: string | undefined; + domainIdentifier: string | undefined; /** - *The timestamp at which the data lineage node was created.
+ *The type of entity for which you want to list policy grants.
* @public */ - createdAt?: Date | undefined; + entityType: TargetEntityType | undefined; /** - *The user who created the data lineage node.
+ *The ID of the entity for which you want to list policy grants.
* @public */ - createdBy?: string | undefined; + entityIdentifier: string | undefined; /** - *The timestamp at which the data lineage node was updated.
+ *The type of policy that you want to list.
* @public */ - updatedAt?: Date | undefined; + policyType: ManagedPolicyType | undefined; /** - *The user who updated the data lineage node.
+ *The maximum number of grants to return in a single call to
+ * ListPolicyGrants. When the number of grants to be listed is greater than the
+ * value of MaxResults, the response contains a NextToken value that
+ * you can use in a subsequent call to ListPolicyGrants to list the next set of
+ * grants.
The ID of the data lineage node.
+ *When the number of grants is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of grants, the response includes a
+ * pagination token named NextToken. You can specify this NextToken
+ * value in a subsequent call to ListPolicyGrants to list the next set of
+ * grants.
A member of the policy grant list.
+ * @public + */ +export interface PolicyGrantMember { /** - *The name of the type of the data lineage node.
+ *The principal of the policy grant member.
* @public */ - typeName: string | undefined; + principal?: PolicyGrantPrincipal | undefined; /** - *The type of the revision of the data lineage node.
+ *The details of the policy grant member.
* @public */ - typeRevision?: string | undefined; + detail?: PolicyGrantDetail | undefined; /** - *The alternate ID of the data lineage node.
+ *Specifies the timestamp at which policy grant member was created.
* @public */ - sourceIdentifier?: string | undefined; + createdAt?: Date | undefined; /** - *The event timestamp of the data lineage node.
+ *Specifies the user who created the policy grant member.
* @public */ - eventTimestamp?: Date | undefined; + createdBy?: string | undefined; } /** * @public */ -export interface ListLineageNodeHistoryOutput { +export interface ListPolicyGrantsOutput { /** - *The nodes returned by the ListLineageNodeHistory action.
+ *The results of this action - the listed grants.
* @public */ - nodes?: LineageNodeSummary[] | undefined; + grantList: PolicyGrantMember[] | undefined; /** - *When the number of history items is greater than the default value for the MaxResults - * parameter, or if you explicitly specify a value for MaxResults that is less than the number - * of items, the response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of - * items.
+ *When the number of grants is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of grants, the response includes a
+ * pagination token named NextToken. You can specify this NextToken
+ * value in a subsequent call to ListPolicyGrants to list the next set of
+ * grants.
The identifier of the Amazon DataZone domain in which you want to list project + * memberships.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The identifier of the project whose memberships you want to list.
+ * @public + */ + projectIdentifier: string | undefined; + + /** + *The method by which you want to sort the project memberships.
+ * @public + */ + sortBy?: SortFieldProject | undefined; + + /** + *The sort order of the project memberships.
+ * @public + */ + sortOrder?: SortOrder | undefined; + + /** + *When the number of memberships is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of memberships, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListProjectMemberships
+ * to list the next set of memberships.
The maximum number of memberships to return in a single call to
+ * ListProjectMemberships. When the number of memberships to be listed is
+ * greater than the value of MaxResults, the response contains a
+ * NextToken value that you can use in a subsequent call to
+ * ListProjectMemberships to list the next set of memberships.
The details of a group in Amazon DataZone.
* @public */ -export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType]; +export interface GroupDetails { + /** + *The identifier of the group in Amazon DataZone.
+ * @public + */ + groupId: string | undefined; +} /** + *The user details of a project member.
* @public */ -export interface ListNotificationsInput { +export interface UserDetails { /** - *The identifier of the Amazon DataZone domain.
+ *The identifier of the Amazon DataZone user.
* @public */ - domainIdentifier: string | undefined; + userId: string | undefined; +} +/** + *The details about a project member.
+ * @public + */ +export type MemberDetails = MemberDetails.GroupMember | MemberDetails.UserMember | MemberDetails.$UnknownMember; + +/** + * @public + */ +export namespace MemberDetails { /** - *The type of notifications.
+ *The user details of a project member.
* @public */ - type: NotificationType | undefined; + export interface UserMember { + user: UserDetails; + group?: never; + $unknown?: never; + } /** - *The time after which you want to list notifications.
+ *The group details of a project member.
* @public */ - afterTimestamp?: Date | undefined; + export interface GroupMember { + user?: never; + group: GroupDetails; + $unknown?: never; + } /** - *The time before which you want to list notifications.
* @public */ - beforeTimestamp?: Date | undefined; + export interface $UnknownMember { + user?: never; + group?: never; + $unknown: [string, any]; + } + + export interface VisitorThe details of a project member.
+ * @public + */ +export interface ProjectMember { /** - *The subjects of notifications.
+ *The membership details of a project member.
* @public */ - subjects?: string[] | undefined; + memberDetails: MemberDetails | undefined; /** - *The task status of notifications.
+ *The designated role of a project member.
* @public */ - taskStatus?: TaskStatus | undefined; + designation: UserDesignation | undefined; +} +/** + * @public + */ +export interface ListProjectMembershipsOutput { /** - *The maximum number of notifications to return in a single call to
- * ListNotifications. When the number of notifications to be listed is greater
- * than the value of MaxResults, the response contains a NextToken
- * value that you can use in a subsequent call to ListNotifications to list the
- * next set of notifications.
The members of the project.
* @public */ - maxResults?: number | undefined; + members: ProjectMember[] | undefined; /** - *When the number of notifications is greater than the default value for the + *
When the number of memberships is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of notifications, the response
+ * MaxResults that is less than the number of memberships, the response
* includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListNotifications to
- * list the next set of notifications.
NextToken value in a subsequent call to ListProjectMemberships
+ * to list the next set of memberships.
* @public
*/
nextToken?: string | undefined;
}
-/**
- * @public
- * @enum
- */
-export const NotificationResourceType = {
- PROJECT: "PROJECT",
-} as const;
-
/**
* @public
*/
-export type NotificationResourceType = (typeof NotificationResourceType)[keyof typeof NotificationResourceType];
-
-/**
- * The details of the resource mentioned in a notification.
- * @public - */ -export interface NotificationResource { +export interface ListProjectsInput { /** - *The type of the resource mentioned in a notification.
+ *The identifier of the Amazon DataZone domain.
* @public */ - type: NotificationResourceType | undefined; + domainIdentifier: string | undefined; /** - *The ID of the resource mentioned in a notification.
+ *The identifier of the Amazon DataZone user.
* @public */ - id: string | undefined; + userIdentifier?: string | undefined; /** - *The name of the resource mentioned in a notification.
+ *The identifier of a group.
* @public */ - name?: string | undefined; -} - -/** - * @public - * @enum - */ -export const NotificationRole = { - DOMAIN_OWNER: "DOMAIN_OWNER", - PROJECT_CONTRIBUTOR: "PROJECT_CONTRIBUTOR", - PROJECT_OWNER: "PROJECT_OWNER", - PROJECT_SUBSCRIBER: "PROJECT_SUBSCRIBER", - PROJECT_VIEWER: "PROJECT_VIEWER", -} as const; - -/** - * @public - */ -export type NotificationRole = (typeof NotificationRole)[keyof typeof NotificationRole]; + groupIdentifier?: string | undefined; -/** - *The topic of the notification.
- * @public - */ -export interface Topic { /** - *The subject of the resource mentioned in a notification.
+ *The name of the project.
* @public */ - subject: string | undefined; + name?: string | undefined; /** - *The details of the resource mentioned in a notification.
+ *When the number of projects is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of projects, the response includes
+ * a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListProjects to list
+ * the next set of projects.
The role of the resource mentioned in a notification.
+ *The maximum number of projects to return in a single call to ListProjects.
+ * When the number of projects to be listed is greater than the value of
+ * MaxResults, the response contains a NextToken value that you
+ * can use in a subsequent call to ListProjects to list the next set of
+ * projects.
The details of a notification generated in Amazon DataZone.
+ *The details of a Amazon DataZone project.
* @public */ -export interface NotificationOutput { - /** - *The identifier of the notification.
- * @public - */ - identifier: string | undefined; - +export interface ProjectSummary { /** - *The identifier of a Amazon DataZone domain in which the notification exists.
+ *The identifier of a Amazon DataZone domain where the project exists.
* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *The type of the notification.
+ *The identifier of a project.
* @public */ - type: NotificationType | undefined; + id: string | undefined; /** - *The topic of the notification.
+ *The name of a project.
* @public */ - topic: Topic | undefined; + name: string | undefined; /** - *The title of the notification.
+ *The description of a project.
* @public */ - title: string | undefined; + description?: string | undefined; /** - *The message included in the notification.
+ *The status of the project.
* @public */ - message: string | undefined; + projectStatus?: ProjectStatus | undefined; /** - *The status included in the notification.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - status?: TaskStatus | undefined; + failureReasons?: ProjectDeletionError[] | undefined; /** - *The action link included in the notification.
+ *The Amazon DataZone user who created the project.
* @public */ - actionLink: string | undefined; + createdBy: string | undefined; /** - *The timestamp of when a notification was created.
+ *The timestamp of when a project was created.
* @public */ - creationTimestamp: Date | undefined; + createdAt?: Date | undefined; /** - *The timestamp of when the notification was last updated.
+ *The timestamp of when the project was updated.
* @public */ - lastUpdatedTimestamp: Date | undefined; + updatedAt?: Date | undefined; /** - *The metadata included in the notification.
+ *The ID of the domain unit.
* @public */ - metadata?: RecordThe results of the ListNotifications action.
The results of the ListProjects action.
When the number of notifications is greater than the default value for the + *
When the number of projects is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of notifications, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListNotifications to
- * list the next set of notifications.
MaxResults that is less than the number of projects, the response includes
+ * a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListProjects to list
+ * the next set of projects.
* @public
*/
nextToken?: string | undefined;
@@ -3924,443 +4831,403 @@ export interface ListNotificationsOutput {
/**
* @public
+ * @enum
*/
-export interface ListPolicyGrantsInput {
+export const SortKey = {
+ CREATED_AT: "CREATED_AT",
+ UPDATED_AT: "UPDATED_AT",
+} as const;
+
+/**
+ * @public
+ */
+export type SortKey = (typeof SortKey)[keyof typeof SortKey];
+
+/**
+ * @public
+ */
+export interface ListSubscriptionGrantsInput {
/**
- * The ID of the domain where you want to list policy grants.
+ *The identifier of the Amazon DataZone domain.
* @public */ domainIdentifier: string | undefined; /** - *The type of entity for which you want to list policy grants.
+ *The identifier of the Amazon DataZone environment.
* @public */ - entityType: TargetEntityType | undefined; + environmentId?: string | undefined; /** - *The ID of the entity for which you want to list policy grants.
+ *The identifier of the subscription target.
* @public */ - entityIdentifier: string | undefined; + subscriptionTargetId?: string | undefined; /** - *The type of policy that you want to list.
+ *The identifier of the subscribed listing.
* @public */ - policyType: ManagedPolicyType | undefined; + subscribedListingId?: string | undefined; /** - *The maximum number of grants to return in a single call to
- * ListPolicyGrants. When the number of grants to be listed is greater than the
- * value of MaxResults, the response contains a NextToken value that
- * you can use in a subsequent call to ListPolicyGrants to list the next set of
- * grants.
The identifier of the subscription.
+ * @public + */ + subscriptionId?: string | undefined; + + /** + *The ID of the owning project of the subscription grants.
+ * @public + */ + owningProjectId?: string | undefined; + + /** + *Specifies the way of sorting the results of this action.
+ * @public + */ + sortBy?: SortKey | undefined; + + /** + *Specifies the sort order of this action.
+ * @public + */ + sortOrder?: SortOrder | undefined; + + /** + *The maximum number of subscription grants to return in a single call to
+ * ListSubscriptionGrants. When the number of subscription grants to be listed
+ * is greater than the value of MaxResults, the response contains a
+ * NextToken value that you can use in a subsequent call to
+ * ListSubscriptionGrants to list the next set of subscription grants.
When the number of grants is greater than the default value for the + *
When the number of subscription grants is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of grants, the response includes a
- * pagination token named NextToken. You can specify this NextToken
- * value in a subsequent call to ListPolicyGrants to list the next set of
- * grants.
MaxResults that is less than the number of subscription grants, the
+ * response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListSubscriptionGrants
+ * to list the next set of subscription grants.
* @public
*/
nextToken?: string | undefined;
}
/**
- * A member of the policy grant list.
+ *The details of the subscription grant.
* @public */ -export interface PolicyGrantMember { - /** - *The principal of the policy grant member.
- * @public - */ - principal?: PolicyGrantPrincipal | undefined; - +export interface SubscriptionGrantSummary { /** - *The details of the policy grant member.
+ *The identifier of the subscription grant.
* @public */ - detail?: PolicyGrantDetail | undefined; + id: string | undefined; /** - *Specifies the timestamp at which policy grant member was created.
+ *The datazone user who created the subscription grant.
* @public */ - createdAt?: Date | undefined; + createdBy: string | undefined; /** - *Specifies the user who created the policy grant member.
+ *The Amazon DataZone user who updated the subscription grant.
* @public */ - createdBy?: string | undefined; -} + updatedBy?: string | undefined; -/** - * @public - */ -export interface ListPolicyGrantsOutput { /** - *The results of this action - the listed grants.
+ *The identifier of the Amazon DataZone domain in which a subscription grant exists.
* @public */ - grantList: PolicyGrantMember[] | undefined; + domainId: string | undefined; /** - *When the number of grants is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of grants, the response includes a
- * pagination token named NextToken. You can specify this NextToken
- * value in a subsequent call to ListPolicyGrants to list the next set of
- * grants.
The timestamp of when a subscription grant was created.
* @public */ - nextToken?: string | undefined; -} - -/** - * @public - * @enum - */ -export const SortFieldProject = { - NAME: "NAME", -} as const; - -/** - * @public - */ -export type SortFieldProject = (typeof SortFieldProject)[keyof typeof SortFieldProject]; + createdAt: Date | undefined; -/** - * @public - */ -export interface ListProjectMembershipsInput { /** - *The identifier of the Amazon DataZone domain in which you want to list project - * memberships.
+ *The timestampf of when the subscription grant was updated.
* @public */ - domainIdentifier: string | undefined; + updatedAt: Date | undefined; /** - *The identifier of the project whose memberships you want to list.
+ *The identifier of the target of the subscription grant.
* @public */ - projectIdentifier: string | undefined; + subscriptionTargetId: string | undefined; /** - *The method by which you want to sort the project memberships.
+ *The entity to which the subscription is granted.
* @public */ - sortBy?: SortFieldProject | undefined; + grantedEntity: GrantedEntity | undefined; /** - *The sort order of the project memberships.
+ *The status of the subscription grant.
* @public */ - sortOrder?: SortOrder | undefined; + status: SubscriptionGrantOverallStatus | undefined; /** - *When the number of memberships is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of memberships, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListProjectMemberships
- * to list the next set of memberships.
The assets included in the subscription grant.
* @public */ - nextToken?: string | undefined; + assets?: SubscribedAsset[] | undefined; /** - *The maximum number of memberships to return in a single call to
- * ListProjectMemberships. When the number of memberships to be listed is
- * greater than the value of MaxResults, the response contains a
- * NextToken value that you can use in a subsequent call to
- * ListProjectMemberships to list the next set of memberships.
The ID of the subscription.
* @public */ - maxResults?: number | undefined; + subscriptionId?: string | undefined; } /** - *The details of a group in Amazon DataZone.
* @public */ -export interface GroupDetails { +export interface ListSubscriptionGrantsOutput { /** - *The identifier of the group in Amazon DataZone.
+ *The results of the ListSubscriptionGrants action.
The user details of a project member.
- * @public - */ -export interface UserDetails { /** - *The identifier of the Amazon DataZone user.
+ *When the number of subscription grants is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of subscription grants, the
+ * response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListSubscriptionGrants
+ * to list the next set of subscription grants.
The details about a project member.
- * @public - */ -export type MemberDetails = MemberDetails.GroupMember | MemberDetails.UserMember | MemberDetails.$UnknownMember; - /** * @public */ -export namespace MemberDetails { +export interface ListSubscriptionRequestsInput { /** - *The user details of a project member.
+ *The identifier of the Amazon DataZone domain.
* @public */ - export interface UserMember { - user: UserDetails; - group?: never; - $unknown?: never; - } + domainIdentifier: string | undefined; /** - *The group details of a project member.
+ *Specifies the status of the subscription requests.
+ *This is not a required parameter, but if not specified, by default, Amazon DataZone
+ * returns only PENDING subscription requests.
The identifier of the subscribed listing.
* @public */ - export interface $UnknownMember { - user?: never; - group?: never; - $unknown: [string, any]; - } + subscribedListingId?: string | undefined; - export interface VisitorThe identifier of the project for the subscription requests.
+ * @public + */ + owningProjectId?: string | undefined; - export const visit =The identifier of the subscription request approver's project.
+ * @public + */ + approverProjectId?: string | undefined; -/** - *The details of a project member.
- * @public - */ -export interface ProjectMember { /** - *The membership details of a project member.
+ *Specifies the way to sort the results of this action.
* @public */ - memberDetails: MemberDetails | undefined; + sortBy?: SortKey | undefined; /** - *The designated role of a project member.
+ *Specifies the sort order for the results of this action.
* @public */ - designation: UserDesignation | undefined; -} + sortOrder?: SortOrder | undefined; -/** - * @public - */ -export interface ListProjectMembershipsOutput { /** - *The members of the project.
+ *The maximum number of subscription requests to return in a single call to
+ * ListSubscriptionRequests. When the number of subscription requests to be
+ * listed is greater than the value of MaxResults, the response contains a
+ * NextToken value that you can use in a subsequent call to
+ * ListSubscriptionRequests to list the next set of subscription
+ * requests.
When the number of memberships is greater than the default value for the + *
When the number of subscription requests is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of memberships, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListProjectMemberships
- * to list the next set of memberships.
MaxResults that is less than the number of subscription requests, the
+ * response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListSubscriptionRequests to list the next set of subscription
+ * requests.
* @public
*/
nextToken?: string | undefined;
}
/**
+ * The summary of the metadata form.
* @public */ -export interface ListProjectsInput { +export interface MetadataFormSummary { /** - *The identifier of the Amazon DataZone domain.
+ *The form name of the metadata form.
* @public */ - domainIdentifier: string | undefined; + formName?: string | undefined; /** - *The identifier of the Amazon DataZone user.
+ *The type name of the metadata form.
* @public */ - userIdentifier?: string | undefined; + typeName: string | undefined; /** - *The identifier of a group.
+ *The type revision of the metadata form.
* @public */ - groupIdentifier?: string | undefined; + typeRevision: string | undefined; +} +/** + *The details of the subscription request.
+ * @public + */ +export interface SubscriptionRequestSummary { /** - *The name of the project.
+ *The identifier of the subscription request.
* @public */ - name?: string | undefined; + id: string | undefined; /** - *When the number of projects is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of projects, the response includes
- * a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListProjects to list
- * the next set of projects.
The Amazon DataZone user who created the subscription request.
* @public */ - nextToken?: string | undefined; + createdBy: string | undefined; /** - *The maximum number of projects to return in a single call to ListProjects.
- * When the number of projects to be listed is greater than the value of
- * MaxResults, the response contains a NextToken value that you
- * can use in a subsequent call to ListProjects to list the next set of
- * projects.
The identifier of the Amazon DataZone user who updated the subscription request.
* @public */ - maxResults?: number | undefined; -} + updatedBy?: string | undefined; -/** - *The details of a Amazon DataZone project.
- * @public - */ -export interface ProjectSummary { /** - *The identifier of a Amazon DataZone domain where the project exists.
+ *The identifier of the Amazon DataZone domain in which a subscription request exists.
* @public */ domainId: string | undefined; /** - *The identifier of a project.
+ *The status of the subscription request.
* @public */ - id: string | undefined; + status: SubscriptionRequestStatus | undefined; /** - *The name of a project.
+ *The timestamp of when a subscription request was created.
* @public */ - name: string | undefined; + createdAt: Date | undefined; /** - *The description of a project.
+ *The timestamp of when the subscription request was updated.
* @public */ - description?: string | undefined; + updatedAt: Date | undefined; /** - *The status of the project.
+ *The reason for the subscription request.
* @public */ - projectStatus?: ProjectStatus | undefined; + requestReason: string | undefined; + + /** + *The principals included in the subscription request.
+ * @public + */ + subscribedPrincipals: SubscribedPrincipal[] | undefined; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The listings included in the subscription request.
* @public */ - failureReasons?: ProjectDeletionError[] | undefined; + subscribedListings: SubscribedListing[] | undefined; /** - *The Amazon DataZone user who created the project.
+ *The identifier of the subscription request reviewer.
* @public */ - createdBy: string | undefined; + reviewerId?: string | undefined; /** - *The timestamp of when a project was created.
+ *The decision comment of the subscription request.
* @public */ - createdAt?: Date | undefined; + decisionComment?: string | undefined; /** - *The timestamp of when the project was updated.
+ *The ID of the existing subscription.
* @public */ - updatedAt?: Date | undefined; + existingSubscriptionId?: string | undefined; /** - *The ID of the domain unit.
+ *The summary of the metadata forms.
* @public */ - domainUnitId?: string | undefined; + metadataFormsSummary?: MetadataFormSummary[] | undefined; } /** * @public */ -export interface ListProjectsOutput { +export interface ListSubscriptionRequestsOutput { /** - *The results of the ListProjects action.
The results of the ListSubscriptionRequests action.
When the number of projects is greater than the default value for the + *
When the number of subscription requests is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of projects, the response includes
- * a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListProjects to list
- * the next set of projects.
MaxResults that is less than the number of subscription requests, the
+ * response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListSubscriptionRequests to list the next set of subscription
+ * requests.
* @public
*/
nextToken?: string | undefined;
}
-/**
- * @public
- * @enum
- */
-export const SortKey = {
- CREATED_AT: "CREATED_AT",
- UPDATED_AT: "UPDATED_AT",
-} as const;
-
-/**
- * @public
- */
-export type SortKey = (typeof SortKey)[keyof typeof SortKey];
-
/**
* @public
*/
-export interface ListSubscriptionGrantsInput {
+export interface ListSubscriptionsInput {
/**
* The identifier of the Amazon DataZone domain.
* @public @@ -4368,335 +5235,440 @@ export interface ListSubscriptionGrantsInput { domainIdentifier: string | undefined; /** - *The identifier of the Amazon DataZone environment.
+ *The identifier of the subscription request for the subscriptions that you want to + * list.
* @public */ - environmentId?: string | undefined; + subscriptionRequestIdentifier?: string | undefined; /** - *The identifier of the subscription target.
+ *The status of the subscriptions that you want to list.
+ *This is not a required parameter, but if not provided, by default, Amazon DataZone
+ * returns only APPROVED subscriptions.
The identifier of the subscribed listing.
+ *The identifier of the subscribed listing for the subscriptions that you want to + * list.
* @public */ subscribedListingId?: string | undefined; /** - *The identifier of the subscription.
+ *The identifier of the owning project.
* @public */ - subscriptionId?: string | undefined; + owningProjectId?: string | undefined; /** - *The ID of the owning project of the subscription grants.
+ *The identifier of the project for the subscription's approver.
* @public */ - owningProjectId?: string | undefined; + approverProjectId?: string | undefined; /** - *Specifies the way of sorting the results of this action.
+ *Specifies the way in which the results of this action are to be sorted.
* @public */ sortBy?: SortKey | undefined; /** - *Specifies the sort order of this action.
+ *Specifies the sort order for the results of this action.
* @public */ sortOrder?: SortOrder | undefined; /** - *The maximum number of subscription grants to return in a single call to
- * ListSubscriptionGrants. When the number of subscription grants to be listed
- * is greater than the value of MaxResults, the response contains a
- * NextToken value that you can use in a subsequent call to
- * ListSubscriptionGrants to list the next set of subscription grants.
The maximum number of subscriptions to return in a single call to
+ * ListSubscriptions. When the number of subscriptions to be listed is greater
+ * than the value of MaxResults, the response contains a NextToken
+ * value that you can use in a subsequent call to ListSubscriptions to list the
+ * next set of Subscriptions.
When the number of subscription grants is greater than the default value for the + *
When the number of subscriptions is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of subscription grants, the
- * response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListSubscriptionGrants
- * to list the next set of subscription grants.
MaxResults that is less than the number of subscriptions, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListSubscriptions to
+ * list the next set of subscriptions.
* @public
*/
nextToken?: string | undefined;
}
/**
- * The details of the subscription grant.
+ *The details of the subscription.
* @public */ -export interface SubscriptionGrantSummary { +export interface SubscriptionSummary { /** - *The identifier of the subscription grant.
+ *The identifier of the subscription.
* @public */ id: string | undefined; /** - *The datazone user who created the subscription grant.
+ *The Amazon DataZone user who created the subscription.
* @public */ createdBy: string | undefined; /** - *The Amazon DataZone user who updated the subscription grant.
+ *The Amazon DataZone user who updated the subscription.
* @public */ updatedBy?: string | undefined; /** - *The identifier of the Amazon DataZone domain in which a subscription grant exists.
+ *The identifier of the Amazon DataZone domain in which a subscription exists.
* @public */ domainId: string | undefined; /** - *The timestamp of when a subscription grant was created.
+ *The status of the subscription.
+ * @public + */ + status: SubscriptionStatus | undefined; + + /** + *The timestamp of when the subscription was created.
* @public */ createdAt: Date | undefined; /** - *The timestampf of when the subscription grant was updated.
+ *The timestamp of when the subscription was updated.
* @public */ updatedAt: Date | undefined; /** - *The identifier of the target of the subscription grant.
+ *The principal included in the subscription.
* @public */ - subscriptionTargetId: string | undefined; + subscribedPrincipal: SubscribedPrincipal | undefined; /** - *The entity to which the subscription is granted.
+ *The listing included in the subscription.
* @public */ - grantedEntity: GrantedEntity | undefined; + subscribedListing: SubscribedListing | undefined; /** - *The status of the subscription grant.
+ *The identifier of the subscription request for the subscription.
* @public */ - status: SubscriptionGrantOverallStatus | undefined; + subscriptionRequestId?: string | undefined; /** - *The assets included in the subscription grant.
+ *The retain permissions included in the subscription.
* @public */ - assets?: SubscribedAsset[] | undefined; + retainPermissions?: boolean | undefined; +} +/** + * @public + */ +export interface ListSubscriptionsOutput { /** - * @deprecated - * - *The ID of the subscription.
+ *The results of the ListSubscriptions action.
When the number of subscriptions is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of subscriptions, the response
+ * includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to ListSubscriptions to
+ * list the next set of subscriptions.
The results of the ListSubscriptionGrants action.
The identifier of the Amazon DataZone domain where you want to list subscription + * targets.
* @public */ - items: SubscriptionGrantSummary[] | undefined; + domainIdentifier: string | undefined; /** - *When the number of subscription grants is greater than the default value for the + *
The identifier of the environment where you want to list subscription targets.
+ * @public + */ + environmentIdentifier: string | undefined; + + /** + *Specifies the way in which the results of this action are to be sorted.
+ * @public + */ + sortBy?: SortKey | undefined; + + /** + *Specifies the sort order for the results of this action.
+ * @public + */ + sortOrder?: SortOrder | undefined; + + /** + *The maximum number of subscription targets to return in a single call to
+ * ListSubscriptionTargets. When the number of subscription targets to be
+ * listed is greater than the value of MaxResults, the response contains a
+ * NextToken value that you can use in a subsequent call to
+ * ListSubscriptionTargets to list the next set of subscription targets.
+ *
When the number of subscription targets is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of subscription grants, the
+ * MaxResults that is less than the number of subscription targets, the
* response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListSubscriptionGrants
- * to list the next set of subscription grants.
NextToken value in a subsequent call to
+ * ListSubscriptionTargets to list the next set of subscription
+ * targets.
* @public
*/
nextToken?: string | undefined;
}
/**
+ * The details of the subscription target.
* @public */ -export interface ListSubscriptionRequestsInput { +export interface SubscriptionTargetSummary { /** - *The identifier of the Amazon DataZone domain.
+ *The identifier of the subscription target.
* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *Specifies the status of the subscription requests.
- *This is not a required parameter, but if not specified, by default, Amazon DataZone
- * returns only PENDING subscription requests.
The authorized principals included in the subscription target.
* @public */ - status?: SubscriptionRequestStatus | undefined; + authorizedPrincipals: string[] | undefined; /** - *The identifier of the subscribed listing.
+ *The identifier of the Amazon DataZone domain in which the subscription target exists.
+ * @public + */ + domainId: string | undefined; + + /** + *The identifier of the project specified in the subscription target.
+ * @public + */ + projectId: string | undefined; + + /** + *The identifier of the environment of the subscription target.
+ * @public + */ + environmentId: string | undefined; + + /** + *The name of the subscription target.
+ * @public + */ + name: string | undefined; + + /** + *The type of the subscription target.
+ * @public + */ + type: string | undefined; + + /** + *The Amazon DataZone user who created the subscription target.
+ * @public + */ + createdBy: string | undefined; + + /** + *The Amazon DataZone user who updated the subscription target.
* @public */ - subscribedListingId?: string | undefined; + updatedBy?: string | undefined; /** - *The identifier of the project for the subscription requests.
+ *The timestamp of when the subscription target was created.
* @public */ - owningProjectId?: string | undefined; + createdAt: Date | undefined; /** - *The identifier of the subscription request approver's project.
+ *The timestamp of when the subscription target was updated.
* @public */ - approverProjectId?: string | undefined; + updatedAt?: Date | undefined; /** - *Specifies the way to sort the results of this action.
+ *The manage access role specified in the subscription target.
* @public */ - sortBy?: SortKey | undefined; + manageAccessRole: string | undefined; /** - *Specifies the sort order for the results of this action.
+ *The asset types included in the subscription target.
* @public */ - sortOrder?: SortOrder | undefined; + applicableAssetTypes: string[] | undefined; /** - *The maximum number of subscription requests to return in a single call to
- * ListSubscriptionRequests. When the number of subscription requests to be
- * listed is greater than the value of MaxResults, the response contains a
- * NextToken value that you can use in a subsequent call to
- * ListSubscriptionRequests to list the next set of subscription
- * requests.
The configuration of the subscription target.
* @public */ - maxResults?: number | undefined; + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; /** - *When the number of subscription requests is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of subscription requests, the
- * response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListSubscriptionRequests to list the next set of subscription
- * requests.
The provider of the subscription target.
* @public */ - nextToken?: string | undefined; + provider: string | undefined; } /** - *The details of the subscription request.
* @public */ -export interface SubscriptionRequestSummary { +export interface ListSubscriptionTargetsOutput { /** - *The identifier of the subscription request.
+ *The results of the ListSubscriptionTargets action.
The Amazon DataZone user who created the subscription request.
+ *When the number of subscription targets is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of subscription targets, the
+ * response includes a pagination token named NextToken. You can specify this
+ * NextToken value in a subsequent call to
+ * ListSubscriptionTargets to list the next set of subscription
+ * targets.
The identifier of the Amazon DataZone user who updated the subscription request.
+ *The ARN of the resource whose tags you want to list.
* @public */ - updatedBy?: string | undefined; + resourceArn: string | undefined; +} +/** + * @public + */ +export interface ListTagsForResourceResponse { /** - *The identifier of the Amazon DataZone domain in which a subscription request exists.
+ *The tags of the specified resource.
* @public */ - domainId: string | undefined; + tags?: RecordThe status of the subscription request.
+ *The ID of the Amazon DataZone domain that houses the assets for which you want to list + * time series data points.
* @public */ - status: SubscriptionRequestStatus | undefined; + domainIdentifier: string | undefined; /** - *The timestamp of when a subscription request was created.
+ *The ID of the asset for which you want to list data points.
* @public */ - createdAt: Date | undefined; + entityIdentifier: string | undefined; /** - *The timestamp of when the subscription request was updated.
+ *The type of the asset for which you want to list data points.
* @public */ - updatedAt: Date | undefined; + entityType: TimeSeriesEntityType | undefined; /** - *The reason for the subscription request.
+ *The name of the time series data points form.
* @public */ - requestReason: string | undefined; + formName: string | undefined; /** - *The principals included in the subscription request.
+ *The timestamp at which the data points that you want to list started.
* @public */ - subscribedPrincipals: SubscribedPrincipal[] | undefined; + startedAt?: Date | undefined; /** - *The listings included in the subscription request.
+ *The timestamp at which the data points that you wanted to list ended.
* @public */ - subscribedListings: SubscribedListing[] | undefined; + endedAt?: Date | undefined; /** - *The identifier of the subscription request reviewer.
+ *When the number of data points is greater than the default value for the MaxResults + * parameter, or if you explicitly specify a value for MaxResults that is less than the number + * of data points, the response includes a pagination token named NextToken. You can specify + * this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set + * of data points.
* @public */ - reviewerId?: string | undefined; + nextToken?: string | undefined; /** - *The decision comment of the subscription request.
+ *The maximum number of data points to return in a single call to + * ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the + * value of MaxResults, the response contains a NextToken value that you can use in a + * subsequent call to ListTimeSeriesDataPoints to list the next set of data points.
* @public */ - decisionComment?: string | undefined; + maxResults?: number | undefined; } /** * @public */ -export interface ListSubscriptionRequestsOutput { +export interface ListTimeSeriesDataPointsOutput { /** - *The results of the ListSubscriptionRequests action.
The results of the ListTimeSeriesDataPoints action.
* @public */ - items: SubscriptionRequestSummary[] | undefined; + items?: TimeSeriesDataPointSummaryFormOutput[] | undefined; /** - *When the number of subscription requests is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of subscription requests, the
- * response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListSubscriptionRequests to list the next set of subscription
- * requests.
When the number of data points is greater than the default value for the MaxResults + * parameter, or if you explicitly specify a value for MaxResults that is less than the number + * of data points, the response includes a pagination token named NextToken. You can specify + * this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set + * of data points.
* @public */ nextToken?: string | undefined; @@ -4705,1336 +5677,1327 @@ export interface ListSubscriptionRequestsOutput { /** * @public */ -export interface ListSubscriptionsInput { +export interface GetMetadataGenerationRunInput { /** - *The identifier of the Amazon DataZone domain.
+ *The ID of the Amazon DataZone domain the metadata generation run of which you want to + * get.
* @public */ domainIdentifier: string | undefined; /** - *The identifier of the subscription request for the subscriptions that you want to - * list.
+ *The identifier of the metadata generation run.
* @public */ - subscriptionRequestIdentifier?: string | undefined; + identifier: string | undefined; +} - /** - *The status of the subscriptions that you want to list.
- *This is not a required parameter, but if not provided, by default, Amazon DataZone
- * returns only APPROVED subscriptions.
The identifier of the subscribed listing for the subscriptions that you want to - * list.
- * @public - */ - subscribedListingId?: string | undefined; +/** + * @public + */ +export type MetadataGenerationRunStatus = + (typeof MetadataGenerationRunStatus)[keyof typeof MetadataGenerationRunStatus]; - /** - *The identifier of the owning project.
- * @public - */ - owningProjectId?: string | undefined; +/** + * @public + * @enum + */ +export const MetadataGenerationTargetType = { + ASSET: "ASSET", +} as const; + +/** + * @public + */ +export type MetadataGenerationTargetType = + (typeof MetadataGenerationTargetType)[keyof typeof MetadataGenerationTargetType]; +/** + *The asset for which metadata was generated.
+ * @public + */ +export interface MetadataGenerationRunTarget { /** - *The identifier of the project for the subscription's approver.
+ *The type of the asset for which metadata was generated.
* @public */ - approverProjectId?: string | undefined; + type: MetadataGenerationTargetType | undefined; /** - *Specifies the way in which the results of this action are to be sorted.
+ *The ID of the metadata generation run's target.
* @public */ - sortBy?: SortKey | undefined; + identifier: string | undefined; /** - *Specifies the sort order for the results of this action.
+ *The revision of the asset for which metadata was generated.
* @public */ - sortOrder?: SortOrder | undefined; + revision?: string | undefined; +} + +/** + * @public + * @enum + */ +export const MetadataGenerationRunType = { + BUSINESS_DESCRIPTIONS: "BUSINESS_DESCRIPTIONS", +} as const; + +/** + * @public + */ +export type MetadataGenerationRunType = (typeof MetadataGenerationRunType)[keyof typeof MetadataGenerationRunType]; +/** + * @public + */ +export interface GetMetadataGenerationRunOutput { /** - *The maximum number of subscriptions to return in a single call to
- * ListSubscriptions. When the number of subscriptions to be listed is greater
- * than the value of MaxResults, the response contains a NextToken
- * value that you can use in a subsequent call to ListSubscriptions to list the
- * next set of Subscriptions.
The ID of the Amazon DataZone domain the metadata generation run of which you want to + * get.
* @public */ - maxResults?: number | undefined; + domainId: string | undefined; /** - *When the number of subscriptions is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of subscriptions, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListSubscriptions to
- * list the next set of subscriptions.
The ID of the metadata generation run.
* @public */ - nextToken?: string | undefined; -} + id: string | undefined; -/** - *The details of the subscription.
- * @public - */ -export interface SubscriptionSummary { /** - *The identifier of the subscription.
+ *The asset for which you're generating metadata.
* @public */ - id: string | undefined; + target?: MetadataGenerationRunTarget | undefined; /** - *The Amazon DataZone user who created the subscription.
+ *The status of the metadata generation run.
* @public */ - createdBy: string | undefined; + status?: MetadataGenerationRunStatus | undefined; /** - *The Amazon DataZone user who updated the subscription.
+ *The type of metadata generation run.
* @public */ - updatedBy?: string | undefined; + type?: MetadataGenerationRunType | undefined; /** - *The identifier of the Amazon DataZone domain in which a subscription exists.
+ *The timestamp of when the metadata generation run was start.
* @public */ - domainId: string | undefined; + createdAt?: Date | undefined; /** - *The status of the subscription.
+ *The Amazon DataZone user who started the metadata generation run.
* @public */ - status: SubscriptionStatus | undefined; + createdBy?: string | undefined; /** - *The timestamp of when the subscription was created.
+ *The ID of the project that owns the assets for which you're running metadata + * generation.
* @public */ - createdAt: Date | undefined; + owningProjectId: string | undefined; +} +/** + * @public + */ +export interface ListMetadataGenerationRunsInput { /** - *The timestamp of when the subscription was updated.
+ *The ID of the Amazon DataZone domain where you want to list metadata generation + * runs.
* @public */ - updatedAt: Date | undefined; + domainIdentifier: string | undefined; /** - *The principal included in the subscription.
+ *The status of the metadata generation runs.
* @public */ - subscribedPrincipal: SubscribedPrincipal | undefined; + status?: MetadataGenerationRunStatus | undefined; /** - *The listing included in the subscription.
+ *The type of the metadata generation runs.
* @public */ - subscribedListing: SubscribedListing | undefined; + type?: MetadataGenerationRunType | undefined; /** - *The identifier of the subscription request for the subscription.
+ *When the number of metadata generation runs is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than + * the number of metadata generation runs, the response includes a pagination token named + * NextToken. You can specify this NextToken value in a subsequent call to + * ListMetadataGenerationRuns to list the next set of revisions.
* @public */ - subscriptionRequestId?: string | undefined; + nextToken?: string | undefined; /** - *The retain permissions included in the subscription.
+ *The maximum number of metadata generation runs to return in a single call to + * ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is + * greater than the value of MaxResults, the response contains a NextToken value that you can + * use in a subsequent call to ListMetadataGenerationRuns to list the next set of + * revisions.
* @public */ - retainPermissions?: boolean | undefined; + maxResults?: number | undefined; } /** + *The metadata generation run.
* @public */ -export interface ListSubscriptionsOutput { +export interface MetadataGenerationRunItem { /** - *The results of the ListSubscriptions action.
The ID of the Amazon DataZone domain in which the metadata generation run was + * created.
* @public */ - items: SubscriptionSummary[] | undefined; + domainId: string | undefined; /** - *When the number of subscriptions is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of subscriptions, the response
- * includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to ListSubscriptions to
- * list the next set of subscriptions.
The ID of the metadata generation run.
* @public */ - nextToken?: string | undefined; -} + id: string | undefined; -/** - * @public - */ -export interface ListSubscriptionTargetsInput { /** - *The identifier of the Amazon DataZone domain where you want to list subscription - * targets.
+ *The asset for which metadata was generated.
* @public */ - domainIdentifier: string | undefined; + target?: MetadataGenerationRunTarget | undefined; /** - *The identifier of the environment where you want to list subscription targets.
+ *The status of the metadata generation run.
* @public */ - environmentIdentifier: string | undefined; + status?: MetadataGenerationRunStatus | undefined; /** - *Specifies the way in which the results of this action are to be sorted.
+ *The type of the metadata generation run.
* @public */ - sortBy?: SortKey | undefined; + type?: MetadataGenerationRunType | undefined; /** - *Specifies the sort order for the results of this action.
+ *The timestamp at which the metadata generation run was created.
* @public */ - sortOrder?: SortOrder | undefined; + createdAt?: Date | undefined; /** - *The maximum number of subscription targets to return in a single call to
- * ListSubscriptionTargets. When the number of subscription targets to be
- * listed is greater than the value of MaxResults, the response contains a
- * NextToken value that you can use in a subsequent call to
- * ListSubscriptionTargets to list the next set of subscription targets.
- *
The user who created the metadata generation run.
* @public */ - maxResults?: number | undefined; + createdBy?: string | undefined; /** - *When the number of subscription targets is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of subscription targets, the
- * response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListSubscriptionTargets to list the next set of subscription
- * targets.
The ID of the project that owns the asset for which the metadata generation was + * ran.
+ * @public + */ + owningProjectId: string | undefined; +} + +/** + * @public + */ +export interface ListMetadataGenerationRunsOutput { + /** + *The results of the ListMetadataGenerationRuns action.
+ * @public + */ + items?: MetadataGenerationRunItem[] | undefined; + + /** + *When the number of metadata generation runs is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than + * the number of metadata generation runs, the response includes a pagination token named + * NextToken. You can specify this NextToken value in a subsequent call to + * ListMetadataGenerationRuns to list the next set of revisions.
* @public */ nextToken?: string | undefined; } /** - *The details of the subscription target.
* @public */ -export interface SubscriptionTargetSummary { +export interface StartMetadataGenerationRunInput { /** - *The identifier of the subscription target.
+ *The ID of the Amazon DataZone domain where you want to start a metadata generation + * run.
* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *The authorized principals included in the subscription target.
+ *The type of the metadata generation run.
* @public */ - authorizedPrincipals: string[] | undefined; + type: MetadataGenerationRunType | undefined; /** - *The identifier of the Amazon DataZone domain in which the subscription target exists.
+ *The asset for which you want to start a metadata generation run.
* @public */ - domainId: string | undefined; + target: MetadataGenerationRunTarget | undefined; /** - *The identifier of the project specified in the subscription target.
+ *A unique, case-sensitive identifier to ensure idempotency of the request. This field is + * automatically populated if not provided.
* @public */ - projectId: string | undefined; + clientToken?: string | undefined; /** - *The identifier of the environment of the subscription target.
+ *The ID of the project that owns the asset for which you want to start a metadata + * generation run.
* @public */ - environmentId: string | undefined; + owningProjectIdentifier: string | undefined; +} +/** + * @public + */ +export interface StartMetadataGenerationRunOutput { /** - *The name of the subscription target.
+ *The ID of the Amazon DataZone domain in which the metadata generation run was + * started.
* @public */ - name: string | undefined; + domainId: string | undefined; /** - *The type of the subscription target.
+ *The ID of the metadata generation run.
* @public */ - type: string | undefined; + id: string | undefined; /** - *The Amazon DataZone user who created the subscription target.
+ *The status of the metadata generation run.
* @public */ - createdBy: string | undefined; + status?: MetadataGenerationRunStatus | undefined; /** - *The Amazon DataZone user who updated the subscription target.
+ *The type of the metadata generation run.
* @public */ - updatedBy?: string | undefined; + type?: MetadataGenerationRunType | undefined; /** - *The timestamp of when the subscription target was created.
+ *The timestamp at which the metadata generation run was started.
* @public */ - createdAt: Date | undefined; + createdAt?: Date | undefined; /** - *The timestamp of when the subscription target was updated.
+ *The ID of the user who started the metadata generation run.
* @public */ - updatedAt?: Date | undefined; + createdBy?: string | undefined; /** - *The manage access role specified in the subscription target.
+ *The ID of the project that owns the asset for which the metadata generation run was + * started.
* @public */ - manageAccessRole: string | undefined; + owningProjectId?: string | undefined; +} +/** + * @public + */ +export interface PostLineageEventInput { /** - *The asset types included in the subscription target.
+ *The ID of the domain where you want to post a data lineage event.
* @public */ - applicableAssetTypes: string[] | undefined; + domainIdentifier: string | undefined; /** - *The configuration of the subscription target.
+ *The data lineage event that you want to post. Only open-lineage run event are supported + * as events.
* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + event: Uint8Array | undefined; /** - *The provider of the subscription target.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - provider: string | undefined; + clientToken?: string | undefined; } /** * @public */ -export interface ListSubscriptionTargetsOutput { +export interface PostLineageEventOutput {} + +/** + *The time series data points form.
+ * @public + */ +export interface TimeSeriesDataPointFormInput { /** - *The results of the ListSubscriptionTargets action.
The name of the time series data points form.
* @public */ - items: SubscriptionTargetSummary[] | undefined; + formName: string | undefined; /** - *When the number of subscription targets is greater than the default value for the
- * MaxResults parameter, or if you explicitly specify a value for
- * MaxResults that is less than the number of subscription targets, the
- * response includes a pagination token named NextToken. You can specify this
- * NextToken value in a subsequent call to
- * ListSubscriptionTargets to list the next set of subscription
- * targets.
The ID of the type of the time series data points form.
* @public */ - nextToken?: string | undefined; -} + typeIdentifier: string | undefined; -/** - * @public - */ -export interface ListTagsForResourceRequest { /** - *The ARN of the resource whose tags you want to list.
+ *The revision type of the time series data points form.
* @public */ - resourceArn: string | undefined; -} + typeRevision?: string | undefined; + + /** + *The timestamp of the time series data points form.
+ * @public + */ + timestamp: Date | undefined; -/** - * @public - */ -export interface ListTagsForResourceResponse { /** - *The tags of the specified resource.
+ *The content of the time series data points form.
* @public */ - tags?: RecordThe ID of the Amazon DataZone domain that houses the assets for which you want to list - * time series data points.
+ *The ID of the Amazon DataZone domain in which you want to post time series data + * points.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the asset for which you want to list data points.
+ *The ID of the asset for which you want to post time series data points.
* @public */ entityIdentifier: string | undefined; /** - *The type of the asset for which you want to list data points.
+ *The type of the asset for which you want to post data points.
* @public */ entityType: TimeSeriesEntityType | undefined; /** - *The name of the time series data points form.
- * @public - */ - formName: string | undefined; - - /** - *The timestamp at which the data points that you want to list started.
+ *The forms that contain the data points that you want to post.
* @public */ - startedAt?: Date | undefined; + forms: TimeSeriesDataPointFormInput[] | undefined; /** - *The timestamp at which the data points that you wanted to list ended.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - endedAt?: Date | undefined; + clientToken?: string | undefined; +} +/** + * @public + */ +export interface PostTimeSeriesDataPointsOutput { /** - *When the number of data points is greater than the default value for the MaxResults - * parameter, or if you explicitly specify a value for MaxResults that is less than the number - * of data points, the response includes a pagination token named NextToken. You can specify - * this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set - * of data points.
+ *The ID of the Amazon DataZone domain in which you want to post time series data + * points.
* @public */ - nextToken?: string | undefined; + domainId?: string | undefined; /** - *The maximum number of data points to return in a single call to - * ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the - * value of MaxResults, the response contains a NextToken value that you can use in a - * subsequent call to ListTimeSeriesDataPoints to list the next set of data points.
+ *The ID of the asset for which you want to post time series data points.
* @public */ - maxResults?: number | undefined; -} + entityId?: string | undefined; -/** - * @public - */ -export interface ListTimeSeriesDataPointsOutput { /** - *The results of the ListTimeSeriesDataPoints action.
+ *The type of the asset for which you want to post data points.
* @public */ - items?: TimeSeriesDataPointSummaryFormOutput[] | undefined; + entityType?: TimeSeriesEntityType | undefined; /** - *When the number of data points is greater than the default value for the MaxResults - * parameter, or if you explicitly specify a value for MaxResults that is less than the number - * of data points, the response includes a pagination token named NextToken. You can specify - * this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set - * of data points.
+ *The forms that contain the data points that you have posted.
* @public */ - nextToken?: string | undefined; + forms?: TimeSeriesDataPointFormOutput[] | undefined; } /** + *The details of the automatically generated business metadata that is rejected.
* @public */ -export interface GetMetadataGenerationRunInput { +export interface RejectChoice { /** - *The ID of the Amazon DataZone domain the metadata generation run of which you want to - * get.
+ *Specifies the target (for example, a column name) where a prediction can be + * rejected.
* @public */ - domainIdentifier: string | undefined; + predictionTarget: string | undefined; /** - *The identifier of the metadata generation run.
+ *Specifies the the automatically generated business metadata that can be rejected.
* @public */ - identifier: string | undefined; + predictionChoices?: number[] | undefined; } /** * @public * @enum */ -export const MetadataGenerationRunStatus = { - CANCELED: "CANCELED", - FAILED: "FAILED", - IN_PROGRESS: "IN_PROGRESS", - SUBMITTED: "SUBMITTED", - SUCCEEDED: "SUCCEEDED", +export const RejectRuleBehavior = { + ALL: "ALL", + NONE: "NONE", } as const; /** * @public */ -export type MetadataGenerationRunStatus = - (typeof MetadataGenerationRunStatus)[keyof typeof MetadataGenerationRunStatus]; +export type RejectRuleBehavior = (typeof RejectRuleBehavior)[keyof typeof RejectRuleBehavior]; /** + *Specifies the rule and the threshold under which a prediction can be rejected.
* @public - * @enum */ -export const MetadataGenerationTargetType = { - ASSET: "ASSET", -} as const; +export interface RejectRule { + /** + *Specifies whether you want to reject the top prediction for all targets or none.
+ * @public + */ + rule?: RejectRuleBehavior | undefined; -/** - * @public - */ -export type MetadataGenerationTargetType = - (typeof MetadataGenerationTargetType)[keyof typeof MetadataGenerationTargetType]; + /** + *The confidence score that specifies the condition at which a prediction can be + * rejected.
+ * @public + */ + threshold?: number | undefined; +} /** - *The asset for which metadata was generated.
* @public */ -export interface MetadataGenerationRunTarget { +export interface RejectPredictionsInput { /** - *The type of the asset for which metadata was generated.
+ *The identifier of the Amazon DataZone domain.
* @public */ - type: MetadataGenerationTargetType | undefined; + domainIdentifier: string | undefined; /** - *The ID of the metadata generation run's target.
+ *The identifier of the prediction.
* @public */ identifier: string | undefined; /** - *The revision of the asset for which metadata was generated.
+ *The revision that is to be made to the asset.
* @public */ revision?: string | undefined; -} - -/** - * @public - * @enum - */ -export const MetadataGenerationRunType = { - BUSINESS_DESCRIPTIONS: "BUSINESS_DESCRIPTIONS", -} as const; -/** - * @public - */ -export type MetadataGenerationRunType = (typeof MetadataGenerationRunType)[keyof typeof MetadataGenerationRunType]; + /** + *Specifies the rule (or the conditions) under which a prediction can be rejected.
+ * @public + */ + rejectRule?: RejectRule | undefined; -/** - * @public - */ -export interface GetMetadataGenerationRunOutput { /** - *The ID of the Amazon DataZone domain the metadata generation run of which you want to - * get.
+ *Specifies the prediction (aka, the automatically generated piece of metadata) and the + * target (for example, a column name) that can be rejected.
* @public */ - domainId: string | undefined; + rejectChoices?: RejectChoice[] | undefined; /** - *The ID of the metadata generation run.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - id: string | undefined; + clientToken?: string | undefined; +} +/** + * @public + */ +export interface RejectPredictionsOutput { /** - *The asset for which you're generating metadata.
+ *The ID of the Amazon DataZone domain.
* @public */ - target?: MetadataGenerationRunTarget | undefined; + domainId: string | undefined; /** - *The status of the metadata generation run.
+ *The ID of the asset.
* @public */ - status?: MetadataGenerationRunStatus | undefined; + assetId: string | undefined; /** - *The type of metadata generation run.
+ *The revision that is to be made to the asset.
* @public */ - type?: MetadataGenerationRunType | undefined; + assetRevision: string | undefined; +} +/** + * @public + */ +export interface RejectSubscriptionRequestInput { /** - *The timestamp of when the metadata generation run was start.
+ *The identifier of the Amazon DataZone domain in which the subscription request was + * rejected.
* @public */ - createdAt?: Date | undefined; + domainIdentifier: string | undefined; /** - *The Amazon DataZone user who started the metadata generation run.
+ *The identifier of the subscription request that was rejected.
* @public */ - createdBy?: string | undefined; + identifier: string | undefined; /** - *The ID of the project that owns the assets for which you're running metadata - * generation.
+ *The decision comment of the rejected subscription request.
* @public */ - owningProjectId: string | undefined; + decisionComment?: string | undefined; } /** * @public */ -export interface ListMetadataGenerationRunsInput { - /** - *The ID of the Amazon DataZone domain where you want to list metadata generation - * runs.
- * @public - */ - domainIdentifier: string | undefined; - +export interface RejectSubscriptionRequestOutput { /** - *The status of the metadata generation runs.
+ *The identifier of the subscription request that was rejected.
* @public */ - status?: MetadataGenerationRunStatus | undefined; + id: string | undefined; /** - *The type of the metadata generation runs.
+ *The timestamp of when the subscription request was rejected.
* @public */ - type?: MetadataGenerationRunType | undefined; + createdBy: string | undefined; /** - *When the number of metadata generation runs is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than - * the number of metadata generation runs, the response includes a pagination token named - * NextToken. You can specify this NextToken value in a subsequent call to - * ListMetadataGenerationRuns to list the next set of revisions.
+ *The Amazon DataZone user who updated the subscription request.
* @public */ - nextToken?: string | undefined; + updatedBy?: string | undefined; /** - *The maximum number of metadata generation runs to return in a single call to - * ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is - * greater than the value of MaxResults, the response contains a NextToken value that you can - * use in a subsequent call to ListMetadataGenerationRuns to list the next set of - * revisions.
+ *The identifier of the Amazon DataZone domain in which the subscription request was + * rejected.
* @public */ - maxResults?: number | undefined; -} + domainId: string | undefined; -/** - *The metadata generation run.
- * @public - */ -export interface MetadataGenerationRunItem { /** - *The ID of the Amazon DataZone domain in which the metadata generation run was - * created.
+ *The status of the subscription request.
* @public */ - domainId: string | undefined; + status: SubscriptionRequestStatus | undefined; /** - *The ID of the metadata generation run.
+ *The timestamp of when the subscription request was rejected.
* @public */ - id: string | undefined; + createdAt: Date | undefined; /** - *The asset for which metadata was generated.
+ *The timestamp of when the subscription request was updated.
* @public */ - target?: MetadataGenerationRunTarget | undefined; + updatedAt: Date | undefined; /** - *The status of the metadata generation run.
+ *The reason for the subscription request.
* @public */ - status?: MetadataGenerationRunStatus | undefined; + requestReason: string | undefined; /** - *The type of the metadata generation run.
+ *The subscribed principals of the subscription request.
* @public */ - type?: MetadataGenerationRunType | undefined; + subscribedPrincipals: SubscribedPrincipal[] | undefined; /** - *The timestamp at which the metadata generation run was created.
+ *The subscribed listings of the subscription request.
* @public */ - createdAt?: Date | undefined; + subscribedListings: SubscribedListing[] | undefined; /** - *The user who created the metadata generation run.
+ *The identifier of the subscription request reviewer.
* @public */ - createdBy?: string | undefined; + reviewerId?: string | undefined; /** - *The ID of the project that owns the asset for which the metadata generation was - * ran.
+ *The decision comment of the rejected subscription request.
* @public */ - owningProjectId: string | undefined; -} + decisionComment?: string | undefined; -/** - * @public - */ -export interface ListMetadataGenerationRunsOutput { /** - *The results of the ListMetadataGenerationRuns action.
+ *The ID of the existing subscription.
* @public */ - items?: MetadataGenerationRunItem[] | undefined; + existingSubscriptionId?: string | undefined; /** - *When the number of metadata generation runs is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than - * the number of metadata generation runs, the response includes a pagination token named - * NextToken. You can specify this NextToken value in a subsequent call to - * ListMetadataGenerationRuns to list the next set of revisions.
+ *Metadata forms included in the subscription request.
* @public */ - nextToken?: string | undefined; + metadataForms?: FormOutput[] | undefined; } /** * @public */ -export interface StartMetadataGenerationRunInput { +export interface RemoveEntityOwnerInput { /** - *The ID of the Amazon DataZone domain where you want to start a metadata generation - * run.
+ *The ID of the domain where you want to remove an owner from an entity.
* @public */ domainIdentifier: string | undefined; /** - *The type of the metadata generation run.
+ *The type of the entity from which you want to remove an owner.
* @public */ - type: MetadataGenerationRunType | undefined; + entityType: DataZoneEntityType | undefined; /** - *The asset for which you want to start a metadata generation run.
+ *The ID of the entity from which you want to remove an owner.
* @public */ - target: MetadataGenerationRunTarget | undefined; + entityIdentifier: string | undefined; /** - *A unique, case-sensitive identifier to ensure idempotency of the request. This field is - * automatically populated if not provided.
+ *The owner that you want to remove from an entity.
* @public */ - clientToken?: string | undefined; + owner: OwnerProperties | undefined; /** - *The ID of the project that owns the asset for which you want to start a metadata - * generation run.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - owningProjectIdentifier: string | undefined; + clientToken?: string | undefined; } /** * @public */ -export interface StartMetadataGenerationRunOutput { - /** - *The ID of the Amazon DataZone domain in which the metadata generation run was - * started.
- * @public - */ - domainId: string | undefined; +export interface RemoveEntityOwnerOutput {} +/** + * @public + */ +export interface RemovePolicyGrantInput { /** - *The ID of the metadata generation run.
+ *The ID of the domain where you want to remove a policy grant.
* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *The status of the metadata generation run.
+ *The type of the entity from which you want to remove a policy grant.
* @public */ - status?: MetadataGenerationRunStatus | undefined; + entityType: TargetEntityType | undefined; /** - *The type of the metadata generation run.
+ *The ID of the entity from which you want to remove a policy grant.
* @public */ - type?: MetadataGenerationRunType | undefined; + entityIdentifier: string | undefined; /** - *The timestamp at which the metadata generation run was started.
+ *The type of the policy that you want to remove.
* @public */ - createdAt?: Date | undefined; + policyType: ManagedPolicyType | undefined; /** - *The ID of the user who started the metadata generation run.
+ *The principal from which you want to remove a policy grant.
* @public */ - createdBy?: string | undefined; + principal: PolicyGrantPrincipal | undefined; /** - *The ID of the project that owns the asset for which the metadata generation run was - * started.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - owningProjectId?: string | undefined; + clientToken?: string | undefined; } /** * @public */ -export interface PostLineageEventInput { +export interface RemovePolicyGrantOutput {} + +/** + * @public + */ +export interface RevokeSubscriptionInput { /** - *The ID of the domain where you want to post a data lineage event.
+ *The identifier of the Amazon DataZone domain where you want to revoke a subscription.
* @public */ domainIdentifier: string | undefined; /** - *The data lineage event that you want to post. Only open-lineage run event are supported - * as events.
+ *The identifier of the revoked subscription.
* @public */ - event: Uint8Array | undefined; + identifier: string | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *Specifies whether permissions are retained when the subscription is revoked.
* @public */ - clientToken?: string | undefined; + retainPermissions?: boolean | undefined; } /** * @public */ -export interface PostLineageEventOutput {} +export interface RevokeSubscriptionOutput { + /** + *The identifier of the revoked subscription.
+ * @public + */ + id: string | undefined; -/** - *The time series data points form.
- * @public - */ -export interface TimeSeriesDataPointFormInput { /** - *The name of the time series data points form.
+ *The identifier of the user who revoked the subscription.
* @public */ - formName: string | undefined; + createdBy: string | undefined; /** - *The ID of the type of the time series data points form.
+ *The Amazon DataZone user who revoked the subscription.
* @public */ - typeIdentifier: string | undefined; + updatedBy?: string | undefined; /** - *The revision type of the time series data points form.
+ *The identifier of the Amazon DataZone domain where you want to revoke a subscription.
* @public */ - typeRevision?: string | undefined; + domainId: string | undefined; /** - *The timestamp of the time series data points form.
+ *The status of the revoked subscription.
* @public */ - timestamp: Date | undefined; + status: SubscriptionStatus | undefined; /** - *The content of the time series data points form.
+ *The timestamp of when the subscription was revoked.
* @public */ - content?: string | undefined; -} + createdAt: Date | undefined; -/** - * @public - */ -export interface PostTimeSeriesDataPointsInput { /** - *The ID of the Amazon DataZone domain in which you want to post time series data - * points.
+ *The timestamp of when the subscription was revoked.
* @public */ - domainIdentifier: string | undefined; + updatedAt: Date | undefined; /** - *The ID of the asset for which you want to post time series data points.
+ *The subscribed principal of the revoked subscription.
* @public */ - entityIdentifier: string | undefined; + subscribedPrincipal: SubscribedPrincipal | undefined; /** - *The type of the asset for which you want to post data points.
+ *The subscribed listing of the revoked subscription.
* @public */ - entityType: TimeSeriesEntityType | undefined; + subscribedListing: SubscribedListing | undefined; /** - *The forms that contain the data points that you want to post.
+ *The identifier of the subscription request for the revoked subscription.
* @public */ - forms: TimeSeriesDataPointFormInput[] | undefined; + subscriptionRequestId?: string | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *Specifies whether permissions are retained when the subscription is revoked.
* @public */ - clientToken?: string | undefined; + retainPermissions?: boolean | undefined; } /** * @public */ -export interface PostTimeSeriesDataPointsOutput { +export interface DeleteRuleInput { /** - *The ID of the Amazon DataZone domain in which you want to post time series data - * points.
+ *The ID of the domain that where the rule is to be deleted.
* @public */ - domainId?: string | undefined; + domainIdentifier: string | undefined; /** - *The ID of the asset for which you want to post time series data points.
+ *The ID of the rule that is to be deleted.
* @public */ - entityId?: string | undefined; + identifier: string | undefined; +} + +/** + * @public + */ +export interface DeleteRuleOutput {} +/** + * @public + */ +export interface GetRuleInput { /** - *The type of the asset for which you want to post data points.
+ *The ID of the domain where the GetRule action is to be invoked.
The forms that contain the data points that you have posted.
+ *The ID of the rule.
* @public */ - forms?: TimeSeriesDataPointFormOutput[] | undefined; + identifier: string | undefined; + + /** + *The revision of the rule.
+ * @public + */ + revision?: string | undefined; } /** - *The details of the automatically generated business metadata that is rejected.
* @public */ -export interface RejectChoice { +export interface GetRuleOutput { /** - *Specifies the target (for example, a column name) where a prediction can be - * rejected.
+ *The ID of the rule.
* @public */ - predictionTarget: string | undefined; + identifier: string | undefined; /** - *Specifies the the automatically generated business metadata that can be rejected.
+ *The revision of the rule.
* @public */ - predictionChoices?: number[] | undefined; -} + revision: string | undefined; -/** - * @public - * @enum - */ -export const RejectRuleBehavior = { - ALL: "ALL", - NONE: "NONE", -} as const; + /** + *The name of the rule.
+ * @public + */ + name: string | undefined; -/** - * @public - */ -export type RejectRuleBehavior = (typeof RejectRuleBehavior)[keyof typeof RejectRuleBehavior]; + /** + *The type of the rule.
+ * @public + */ + ruleType: RuleType | undefined; -/** - *Specifies the rule and the threshold under which a prediction can be rejected.
- * @public - */ -export interface RejectRule { /** - *Specifies whether you want to reject the top prediction for all targets or none.
+ *The target of the rule.
* @public */ - rule?: RejectRuleBehavior | undefined; + target: RuleTarget | undefined; /** - *The confidence score that specifies the condition at which a prediction can be - * rejected.
+ *The action of the rule.
* @public */ - threshold?: number | undefined; -} + action: RuleAction | undefined; -/** - * @public - */ -export interface RejectPredictionsInput { /** - *The identifier of the Amazon DataZone domain.
+ *The scope of the rule.
* @public */ - domainIdentifier: string | undefined; + scope: RuleScope | undefined; /** - *The identifier of the prediction.
+ *The detail of the rule.
* @public */ - identifier: string | undefined; + detail: RuleDetail | undefined; /** - *The revision that is to be made to the asset.
+ *The target type of the rule.
* @public */ - revision?: string | undefined; + targetType?: RuleTargetType | undefined; /** - *Specifies the rule (or the conditions) under which a prediction can be rejected.
+ *The description of the rule.
+ * @public + */ + description?: string | undefined; + + /** + *The timestamp at which the rule was created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The timestamp at which the rule was last updated.
* @public */ - rejectRule?: RejectRule | undefined; + updatedAt: Date | undefined; /** - *Specifies the prediction (aka, the automatically generated piece of metadata) and the - * target (for example, a column name) that can be rejected.
+ *The user who created the rule.
* @public */ - rejectChoices?: RejectChoice[] | undefined; + createdBy: string | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The timestamp at which the rule was last updated.
* @public */ - clientToken?: string | undefined; + lastUpdatedBy: string | undefined; } /** * @public */ -export interface RejectPredictionsOutput { +export interface ListRulesInput { /** - *The ID of the Amazon DataZone domain.
+ *The ID of the domain in which the rules are to be listed.
* @public */ - domainId: string | undefined; + domainIdentifier: string | undefined; /** - *The ID of the asset.
+ *The target type of the rule.
* @public */ - assetId: string | undefined; + targetType: RuleTargetType | undefined; /** - *The revision that is to be made to the asset.
+ *The target ID of the rule.
* @public */ - assetRevision: string | undefined; -} + targetIdentifier: string | undefined; -/** - * @public - */ -export interface RejectSubscriptionRequestInput { /** - *The identifier of the Amazon DataZone domain in which the subscription request was - * rejected.
+ *The type of the rule.
* @public */ - domainIdentifier: string | undefined; + ruleType?: RuleType | undefined; /** - *The identifier of the subscription request that was rejected.
+ *The action of the rule.
* @public */ - identifier: string | undefined; + action?: RuleAction | undefined; /** - *The decision comment of the rejected subscription request.
+ *The IDs of projects in which rules are to be listed.
* @public */ - decisionComment?: string | undefined; -} + projectIds?: string[] | undefined; -/** - * @public - */ -export interface RejectSubscriptionRequestOutput { /** - *The identifier of the subscription request that was rejected.
+ *The asset types of the rule.
* @public */ - id: string | undefined; + assetTypes?: string[] | undefined; /** - *The timestamp of when the subscription request was rejected.
+ *The data product of the rule.
* @public */ - createdBy: string | undefined; + dataProduct?: boolean | undefined; /** - *The Amazon DataZone user who updated the subscription request.
+ *Specifies whether to include cascading rules in the results.
* @public */ - updatedBy?: string | undefined; + includeCascaded?: boolean | undefined; /** - *The identifier of the Amazon DataZone domain in which the subscription request was - * rejected.
+ *The maximum number of rules to return in a single call to ListRules. When
+ * the number of rules to be listed is greater than the value of MaxResults, the
+ * response contains a NextToken value that you can use in a subsequent call to
+ * ListRules to list the next set of rules.
The status of the subscription request.
+ *When the number of rules is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of rules, the response includes a
+ * pagination token named NextToken. You can specify this NextToken
+ * value in a subsequent call to ListRules to list the next set of rules.
The summary of the rule.
+ * @public + */ +export interface RuleSummary { /** - *The timestamp of when the subscription request was rejected.
+ *The ID of the rule.
* @public */ - createdAt: Date | undefined; + identifier?: string | undefined; /** - *The timestamp of when the subscription request was updated.
+ *The revision of the rule.
* @public */ - updatedAt: Date | undefined; + revision?: string | undefined; /** - *The reason for the subscription request.
+ *The type of the rule.
* @public */ - requestReason: string | undefined; + ruleType?: RuleType | undefined; /** - *The subscribed principals of the subscription request.
+ *The name of the rule.
* @public */ - subscribedPrincipals: SubscribedPrincipal[] | undefined; + name?: string | undefined; /** - *The subscribed listings of the subscription request.
+ *The target type of the rule.
* @public */ - subscribedListings: SubscribedListing[] | undefined; + targetType?: RuleTargetType | undefined; /** - *The identifier of the subscription request reviewer.
+ *The target of the rule.
* @public */ - reviewerId?: string | undefined; + target?: RuleTarget | undefined; /** - *The decision comment of the rejected subscription request.
+ *The action of the rule.
* @public */ - decisionComment?: string | undefined; -} + action?: RuleAction | undefined; -/** - * @public - */ -export interface RemoveEntityOwnerInput { /** - *The ID of the domain where you want to remove an owner from an entity.
+ *The scope of the rule.
* @public */ - domainIdentifier: string | undefined; + scope?: RuleScope | undefined; /** - *The type of the entity from which you want to remove an owner.
+ *The timestamp at which the rule was last updated.
* @public */ - entityType: DataZoneEntityType | undefined; + updatedAt?: Date | undefined; /** - *The ID of the entity from which you want to remove an owner.
+ *The timestamp at which the rule was last updated.
* @public */ - entityIdentifier: string | undefined; + lastUpdatedBy?: string | undefined; +} +/** + * @public + */ +export interface ListRulesOutput { /** - *The owner that you want to remove from an entity.
+ *The results of the ListRules action.
A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *When the number of rules is greater than the default value for the
+ * MaxResults parameter, or if you explicitly specify a value for
+ * MaxResults that is less than the number of rules, the response includes a
+ * pagination token named NextToken. You can specify this NextToken
+ * value in a subsequent call to ListRules to list the next set of rules.
The ID of the domain where you want to remove a policy grant.
+ *The ID of the domain in which a rule is to be updated.
* @public */ domainIdentifier: string | undefined; /** - *The type of the entity from which you want to remove a policy grant.
+ *The ID of the rule that is to be updated
* @public */ - entityType: TargetEntityType | undefined; + identifier: string | undefined; /** - *The ID of the entity from which you want to remove a policy grant.
+ *The name of the rule.
* @public */ - entityIdentifier: string | undefined; + name?: string | undefined; /** - *The type of the policy that you want to remove.
+ *The description of the rule.
* @public */ - policyType: ManagedPolicyType | undefined; + description?: string | undefined; /** - *The principal from which you want to remove a policy grant.
+ *The scrope of the rule.
* @public */ - principal: PolicyGrantPrincipal | undefined; + scope?: RuleScope | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The detail of the rule.
* @public */ - clientToken?: string | undefined; -} - -/** - * @public - */ -export interface RemovePolicyGrantOutput {} + detail?: RuleDetail | undefined; -/** - * @public - */ -export interface RevokeSubscriptionInput { /** - *The identifier of the Amazon DataZone domain where you want to revoke a subscription.
+ *Specifies whether to update this rule in the child domain units.
* @public */ - domainIdentifier: string | undefined; + includeChildDomainUnits?: boolean | undefined; +} +/** + * @public + */ +export interface UpdateRuleOutput { /** - *The identifier of the revoked subscription.
+ *The ID of the rule.
* @public */ identifier: string | undefined; /** - *Specifies whether permissions are retained when the subscription is revoked.
+ *The revision of the rule.
* @public */ - retainPermissions?: boolean | undefined; -} + revision: string | undefined; -/** - * @public - */ -export interface RevokeSubscriptionOutput { /** - *The identifier of the revoked subscription.
+ *The name of the rule.
* @public */ - id: string | undefined; + name: string | undefined; /** - *The identifier of the user who revoked the subscription.
+ *The type of the rule.
* @public */ - createdBy: string | undefined; + ruleType: RuleType | undefined; /** - *The Amazon DataZone user who revoked the subscription.
+ *The target of the rule.
* @public */ - updatedBy?: string | undefined; + target: RuleTarget | undefined; /** - *The identifier of the Amazon DataZone domain where you want to revoke a subscription.
+ *The action of the rule.
* @public */ - domainId: string | undefined; + action: RuleAction | undefined; /** - *The status of the revoked subscription.
+ *The scope of the rule.
* @public */ - status: SubscriptionStatus | undefined; + scope: RuleScope | undefined; /** - *The timestamp of when the subscription was revoked.
+ *The detail of the rule.
* @public */ - createdAt: Date | undefined; + detail: RuleDetail | undefined; /** - *The timestamp of when the subscription was revoked.
+ *The description of the rule.
* @public */ - updatedAt: Date | undefined; + description?: string | undefined; /** - *The subscribed principal of the revoked subscription.
+ *The timestamp at which the rule was created.
* @public */ - subscribedPrincipal: SubscribedPrincipal | undefined; + createdAt: Date | undefined; /** - *The subscribed listing of the revoked subscription.
+ *The timestamp at which the rule was last updated.
* @public */ - subscribedListing: SubscribedListing | undefined; + updatedAt: Date | undefined; /** - *The identifier of the subscription request for the revoked subscription.
+ *The user who created the rule.
* @public */ - subscriptionRequestId?: string | undefined; + createdBy: string | undefined; /** - *Specifies whether permissions are retained when the subscription is revoked.
+ *The timestamp at which the rule was last updated.
* @public */ - retainPermissions?: boolean | undefined; + lastUpdatedBy: string | undefined; } /** @@ -7767,6 +8730,18 @@ export interface UpdateSubscriptionRequestOutput { * @public */ decisionComment?: string | undefined; + + /** + *The ID of the existing subscription.
+ * @public + */ + existingSubscriptionId?: string | undefined; + + /** + *Metadata forms included in the subscription request.
+ * @public + */ + metadataForms?: FormOutput[] | undefined; } /** @@ -8721,6 +9696,52 @@ export interface UpdateAssetFilterOutput { effectiveRowFilter?: string | undefined; } +/** + * @internal + */ +export const DomainSummaryFilterSensitiveLog = (obj: DomainSummary): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const ListDomainsOutputFilterSensitiveLog = (obj: ListDomainsOutput): any => ({ + ...obj, + ...(obj.items && { items: obj.items.map((item) => DomainSummaryFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const GetDomainUnitOutputFilterSensitiveLog = (obj: GetDomainUnitOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.owners && { owners: obj.owners.map((item) => item) }), +}); + +/** + * @internal + */ +export const UpdateDomainUnitInputFilterSensitiveLog = (obj: UpdateDomainUnitInput): any => ({ + ...obj, + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.name && { name: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const UpdateDomainUnitOutputFilterSensitiveLog = (obj: UpdateDomainUnitOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.owners && { owners: obj.owners.map((item) => item) }), + ...(obj.description && { description: SENSITIVE_STRING }), +}); + /** * @internal */ @@ -8835,6 +9856,7 @@ export const GetSubscriptionRequestDetailsOutputFilterSensitiveLog = ( subscribedListings: obj.subscribedListings.map((item) => SubscribedListingFilterSensitiveLog(item)), }), ...(obj.decisionComment && { decisionComment: SENSITIVE_STRING }), + ...(obj.metadataForms && { metadataForms: obj.metadataForms.map((item) => FormOutputFilterSensitiveLog(item)) }), }); /** @@ -9049,6 +10071,14 @@ export const ListProjectsOutputFilterSensitiveLog = (obj: ListProjectsOutput): a ...(obj.items && { items: obj.items.map((item) => ProjectSummaryFilterSensitiveLog(item)) }), }); +/** + * @internal + */ +export const MetadataFormSummaryFilterSensitiveLog = (obj: MetadataFormSummary): any => ({ + ...obj, + ...(obj.typeName && { typeName: SENSITIVE_STRING }), +}); + /** * @internal */ @@ -9062,6 +10092,9 @@ export const SubscriptionRequestSummaryFilterSensitiveLog = (obj: SubscriptionRe subscribedListings: obj.subscribedListings.map((item) => SubscribedListingFilterSensitiveLog(item)), }), ...(obj.decisionComment && { decisionComment: SENSITIVE_STRING }), + ...(obj.metadataFormsSummary && { + metadataFormsSummary: obj.metadataFormsSummary.map((item) => MetadataFormSummaryFilterSensitiveLog(item)), + }), }); /** @@ -9136,6 +10169,7 @@ export const RejectSubscriptionRequestOutputFilterSensitiveLog = (obj: RejectSub subscribedListings: obj.subscribedListings.map((item) => SubscribedListingFilterSensitiveLog(item)), }), ...(obj.decisionComment && { decisionComment: SENSITIVE_STRING }), + ...(obj.metadataForms && { metadataForms: obj.metadataForms.map((item) => FormOutputFilterSensitiveLog(item)) }), }); /** @@ -9149,6 +10183,55 @@ export const RevokeSubscriptionOutputFilterSensitiveLog = (obj: RevokeSubscripti ...(obj.subscribedListing && { subscribedListing: SubscribedListingFilterSensitiveLog(obj.subscribedListing) }), }); +/** + * @internal + */ +export const GetRuleOutputFilterSensitiveLog = (obj: GetRuleOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.target && { target: obj.target }), + ...(obj.detail && { detail: obj.detail }), + ...(obj.description && { description: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const RuleSummaryFilterSensitiveLog = (obj: RuleSummary): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.target && { target: obj.target }), +}); + +/** + * @internal + */ +export const ListRulesOutputFilterSensitiveLog = (obj: ListRulesOutput): any => ({ + ...obj, + ...(obj.items && { items: obj.items.map((item) => RuleSummaryFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const UpdateRuleInputFilterSensitiveLog = (obj: UpdateRuleInput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.detail && { detail: obj.detail }), +}); + +/** + * @internal + */ +export const UpdateRuleOutputFilterSensitiveLog = (obj: UpdateRuleOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.target && { target: obj.target }), + ...(obj.detail && { detail: obj.detail }), + ...(obj.description && { description: SENSITIVE_STRING }), +}); + /** * @internal */ @@ -9380,6 +10463,7 @@ export const UpdateSubscriptionRequestOutputFilterSensitiveLog = (obj: UpdateSub subscribedListings: obj.subscribedListings.map((item) => SubscribedListingFilterSensitiveLog(item)), }), ...(obj.decisionComment && { decisionComment: SENSITIVE_STRING }), + ...(obj.metadataForms && { metadataForms: obj.metadataForms.map((item) => FormOutputFilterSensitiveLog(item)) }), }); /** diff --git a/clients/client-datazone/src/pagination/ListRulesPaginator.ts b/clients/client-datazone/src/pagination/ListRulesPaginator.ts new file mode 100644 index 000000000000..d3b0d75d3d20 --- /dev/null +++ b/clients/client-datazone/src/pagination/ListRulesPaginator.ts @@ -0,0 +1,20 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { ListRulesCommand, ListRulesCommandInput, ListRulesCommandOutput } from "../commands/ListRulesCommand"; +import { DataZoneClient } from "../DataZoneClient"; +import { DataZonePaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListRules: ( + config: DataZonePaginationConfiguration, + input: ListRulesCommandInput, + ...rest: any[] +) => PaginatorSpecifies the reason for accepting the subscription request.
" } + }, + "existingSubscriptionId": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The ID of the existing subscription.
" + } + }, + "metadataForms": { + "target": "com.amazonaws.datazone#MetadataForms", + "traits": { + "smithy.api#documentation": "The metadata form in the subscription request.
" + } } }, "traits": { @@ -1391,6 +1403,12 @@ "smithy.api#pattern": "^(?!\\.)[\\w\\.]*\\w$" } }, + "com.amazonaws.datazone#AssetTypeIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier" + } + }, "com.amazonaws.datazone#AssetTypeItem": { "type": "structure", "members": { @@ -1476,6 +1494,27 @@ "smithy.api#documentation": "The details of the asset type.
" } }, + "com.amazonaws.datazone#AssetTypesForRule": { + "type": "structure", + "members": { + "selectionMode": { + "target": "com.amazonaws.datazone#RuleScopeSelectionMode", + "traits": { + "smithy.api#documentation": "The selection mode for the rule.
", + "smithy.api#required": {} + } + }, + "specificAssetTypes": { + "target": "com.amazonaws.datazone#RuleAssetTypeList", + "traits": { + "smithy.api#documentation": "The specific asset types that are included in the rule.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The asset type for the rule details.
" + } + }, "com.amazonaws.datazone#AssociateEnvironmentRole": { "type": "operation", "input": { @@ -5357,6 +5396,194 @@ "smithy.api#documentation": "The details of the policy grant.
" } }, + "com.amazonaws.datazone#CreateRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateRuleInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a rule in Amazon DataZone. A rule is a formal agreement that enforces specific\n requirements across user workflows (e.g., publishing assets to the catalog, requesting\n subscriptions, creating projects) within the Amazon DataZone data portal. These rules help\n maintain consistency, ensure compliance, and uphold governance standards in data management\n processes. For instance, a metadata enforcement rule can specify the required information\n for creating a subscription request or publishing a data asset to the catalog, ensuring\n alignment with organizational standards.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/rules" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#CreateRuleInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where the rule is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#RuleName", + "traits": { + "smithy.api#documentation": "The name of the rule.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.datazone#RuleTarget", + "traits": { + "smithy.api#documentation": "The target of the rule.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.datazone#RuleAction", + "traits": { + "smithy.api#documentation": "The action of the rule.
", + "smithy.api#required": {} + } + }, + "scope": { + "target": "com.amazonaws.datazone#RuleScope", + "traits": { + "smithy.api#documentation": "The scope of the rule.
", + "smithy.api#required": {} + } + }, + "detail": { + "target": "com.amazonaws.datazone#RuleDetail", + "traits": { + "smithy.api#documentation": "The detail of the rule.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the rule.
" + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateRuleOutput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.datazone#RuleId", + "traits": { + "smithy.api#documentation": "The ID of the rule.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#RuleName", + "traits": { + "smithy.api#documentation": "The name of the rule.
", + "smithy.api#required": {} + } + }, + "ruleType": { + "target": "com.amazonaws.datazone#RuleType", + "traits": { + "smithy.api#documentation": "The type of the rule.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.datazone#RuleTarget", + "traits": { + "smithy.api#documentation": "The target of the rule.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.datazone#RuleAction", + "traits": { + "smithy.api#documentation": "The action of the rule.
", + "smithy.api#required": {} + } + }, + "scope": { + "target": "com.amazonaws.datazone#RuleScope", + "traits": { + "smithy.api#documentation": "The scope of the rule.
", + "smithy.api#required": {} + } + }, + "detail": { + "target": "com.amazonaws.datazone#RuleDetail", + "traits": { + "smithy.api#documentation": "The detail of the rule.
", + "smithy.api#required": {} + } + }, + "targetType": { + "target": "com.amazonaws.datazone#RuleTargetType", + "traits": { + "smithy.api#documentation": "The target type of the rule.
" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the rule.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the rule is created.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The user who creates the rule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#CreateSubscriptionGrant": { "type": "operation", "input": { @@ -5604,6 +5831,12 @@ "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", "smithy.api#idempotencyToken": {} } + }, + "metadataForms": { + "target": "com.amazonaws.datazone#MetadataFormInputs", + "traits": { + "smithy.api#documentation": "The metadata form included in the subscription request.
" + } } }, "traits": { @@ -5701,6 +5934,18 @@ "traits": { "smithy.api#documentation": "The decision comment of the subscription request.
" } + }, + "existingSubscriptionId": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The ID of the existing subscription.
" + } + }, + "metadataForms": { + "target": "com.amazonaws.datazone#MetadataForms", + "traits": { + "smithy.api#documentation": "The metadata form included in the subscription request.
" + } } }, "traits": { @@ -7578,6 +7823,9 @@ }, { "target": "com.amazonaws.datazone#MetadataGenerationRun" + }, + { + "target": "com.amazonaws.datazone#Rule" } ], "errors": [ @@ -9358,6 +9606,75 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#DeleteRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteRuleInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a rule in Amazon DataZone. A rule is a formal agreement that enforces specific\n requirements across user workflows (e.g., publishing assets to the catalog, requesting\n subscriptions, creating projects) within the Amazon DataZone data portal. These rules help\n maintain consistency, ensure compliance, and uphold governance standards in data management\n processes. For instance, a metadata enforcement rule can specify the required information\n for creating a subscription request or publishing a data asset to the catalog, ensuring\n alignment with organizational standards.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/rules/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteRuleInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain that where the rule is to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#RuleId", + "traits": { + "smithy.api#documentation": "The ID of the rule that is to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteRuleOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#DeleteSubscriptionGrant": { "type": "operation", "input": { @@ -10416,21 +10733,42 @@ "smithy.api#documentation": "The summary of the domain unit.
" } }, - "com.amazonaws.datazone#DomainUnitUserProperties": { + "com.amazonaws.datazone#DomainUnitTarget": { "type": "structure", "members": { - "userId": { - "target": "smithy.api#String", + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "The ID of teh domain unit user.
" + "smithy.api#documentation": "The ID of the domain unit.
", + "smithy.api#required": {} + } + }, + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to apply a rule to the child domain units.
" } } }, "traits": { - "smithy.api#documentation": "The properties of the domain unit user.
" + "smithy.api#documentation": "The target for the domain unit.
" } }, - "com.amazonaws.datazone#EdgeDirection": { + "com.amazonaws.datazone#DomainUnitUserProperties": { + "type": "structure", + "members": { + "userId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of teh domain unit user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties of the domain unit user.
" + } + }, + "com.amazonaws.datazone#EdgeDirection": { "type": "enum", "members": { "UPSTREAM": { @@ -11419,7 +11757,7 @@ } }, "typeRevision": { - "target": "com.amazonaws.datazone#Revision", + "target": "com.amazonaws.datazone#RevisionInput", "traits": { "smithy.api#documentation": "The revision of the metadata form type.
" } @@ -14985,6 +15323,176 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#GetRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetRuleInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the details of a rule in Amazon DataZone. A rule is a formal agreement that\n enforces specific requirements across user workflows (e.g., publishing assets to the\n catalog, requesting subscriptions, creating projects) within the Amazon DataZone data\n portal. These rules help maintain consistency, ensure compliance, and uphold governance\n standards in data management processes. For instance, a metadata enforcement rule can\n specify the required information for creating a subscription request or publishing a data\n asset to the catalog, ensuring alignment with organizational standards.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/rules/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetRuleInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where the GetRule action is to be invoked.
The ID of the rule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the rule.
", + "smithy.api#httpQuery": "revision" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetRuleOutput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.datazone#RuleId", + "traits": { + "smithy.api#documentation": "The ID of the rule.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the rule.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#RuleName", + "traits": { + "smithy.api#documentation": "The name of the rule.
", + "smithy.api#required": {} + } + }, + "ruleType": { + "target": "com.amazonaws.datazone#RuleType", + "traits": { + "smithy.api#documentation": "The type of the rule.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.datazone#RuleTarget", + "traits": { + "smithy.api#documentation": "The target of the rule.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.datazone#RuleAction", + "traits": { + "smithy.api#documentation": "The action of the rule.
", + "smithy.api#required": {} + } + }, + "scope": { + "target": "com.amazonaws.datazone#RuleScope", + "traits": { + "smithy.api#documentation": "The scope of the rule.
", + "smithy.api#required": {} + } + }, + "detail": { + "target": "com.amazonaws.datazone#RuleDetail", + "traits": { + "smithy.api#documentation": "The detail of the rule.
", + "smithy.api#required": {} + } + }, + "targetType": { + "target": "com.amazonaws.datazone#RuleTargetType", + "traits": { + "smithy.api#documentation": "The target type of the rule.
" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the rule.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the rule was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the rule was last updated.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The user who created the rule.
", + "smithy.api#required": {} + } + }, + "lastUpdatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The timestamp at which the rule was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#GetSubscription": { "type": "operation", "input": { @@ -15420,6 +15928,18 @@ "traits": { "smithy.api#documentation": "The decision comment of the subscription request.
" } + }, + "existingSubscriptionId": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The ID of the existing subscription.
" + } + }, + "metadataForms": { + "target": "com.amazonaws.datazone#MetadataForms", + "traits": { + "smithy.api#documentation": "The metadata forms included in the subscription request.
" + } } }, "traits": { @@ -19181,13 +19701,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#ListSubscriptionGrants": { + "com.amazonaws.datazone#ListRules": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#ListSubscriptionGrantsInput" + "target": "com.amazonaws.datazone#ListRulesInput" }, "output": { - "target": "com.amazonaws.datazone#ListSubscriptionGrantsOutput" + "target": "com.amazonaws.datazone#ListRulesOutput" }, "errors": [ { @@ -19207,11 +19727,11 @@ } ], "traits": { - "smithy.api#documentation": "Lists subscription grants.
", + "smithy.api#documentation": "Lists existing rules. In Amazon DataZone, a rule is a formal agreement that enforces\n specific requirements across user workflows (e.g., publishing assets to the catalog,\n requesting subscriptions, creating projects) within the Amazon DataZone data portal. These\n rules help maintain consistency, ensure compliance, and uphold governance standards in data\n management processes. For instance, a metadata enforcement rule can specify the required\n information for creating a subscription request or publishing a data asset to the catalog,\n ensuring alignment with organizational standards.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/subscription-grants" + "uri": "/v2/domains/{domainIdentifier}/list-rules/{targetType}/{targetIdentifier}" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -19222,77 +19742,90 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#ListSubscriptionGrantsInput": { + "com.amazonaws.datazone#ListRulesInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#documentation": "The ID of the domain in which the rules are to be listed.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "environmentId": { - "target": "com.amazonaws.datazone#EnvironmentId", + "targetType": { + "target": "com.amazonaws.datazone#RuleTargetType", "traits": { - "smithy.api#documentation": "The identifier of the Amazon DataZone environment.
", - "smithy.api#httpQuery": "environmentId" + "smithy.api#documentation": "The target type of the rule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "subscriptionTargetId": { - "target": "com.amazonaws.datazone#SubscriptionTargetId", + "targetIdentifier": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The identifier of the subscription target.
", - "smithy.api#httpQuery": "subscriptionTargetId" + "smithy.api#documentation": "The target ID of the rule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "subscribedListingId": { - "target": "com.amazonaws.datazone#ListingId", + "ruleType": { + "target": "com.amazonaws.datazone#RuleType", "traits": { - "smithy.api#documentation": "The identifier of the subscribed listing.
", - "smithy.api#httpQuery": "subscribedListingId" + "smithy.api#documentation": "The type of the rule.
", + "smithy.api#httpQuery": "ruleType" } }, - "subscriptionId": { - "target": "com.amazonaws.datazone#SubscriptionId", + "action": { + "target": "com.amazonaws.datazone#RuleAction", "traits": { - "smithy.api#documentation": "The identifier of the subscription.
", - "smithy.api#httpQuery": "subscriptionId" + "smithy.api#documentation": "The action of the rule.
", + "smithy.api#httpQuery": "ruleAction" } }, - "owningProjectId": { - "target": "com.amazonaws.datazone#ProjectId", + "projectIds": { + "target": "com.amazonaws.datazone#ProjectIds", "traits": { - "smithy.api#documentation": "The ID of the owning project of the subscription grants.
", - "smithy.api#httpQuery": "owningProjectId" + "smithy.api#documentation": "The IDs of projects in which rules are to be listed.
", + "smithy.api#httpQuery": "projectIds" } }, - "sortBy": { - "target": "com.amazonaws.datazone#SortKey", + "assetTypes": { + "target": "com.amazonaws.datazone#AssetTypeIdentifiers", "traits": { - "smithy.api#documentation": "Specifies the way of sorting the results of this action.
", - "smithy.api#httpQuery": "sortBy" + "smithy.api#documentation": "The asset types of the rule.
", + "smithy.api#httpQuery": "assetTypes" } }, - "sortOrder": { - "target": "com.amazonaws.datazone#SortOrder", + "dataProduct": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Specifies the sort order of this action.
", - "smithy.api#httpQuery": "sortOrder" + "smithy.api#documentation": "The data product of the rule.
", + "smithy.api#httpQuery": "dataProduct" + } + }, + "includeCascaded": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to include cascading rules in the results.
", + "smithy.api#httpQuery": "includeCascaded" } }, "maxResults": { - "target": "com.amazonaws.datazone#MaxResults", + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The maximum number of subscription grants to return in a single call to\n ListSubscriptionGrants. When the number of subscription grants to be listed\n is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListSubscriptionGrants to list the next set of subscription grants.
The maximum number of rules to return in a single call to ListRules. When\n the number of rules to be listed is greater than the value of MaxResults, the\n response contains a NextToken value that you can use in a subsequent call to\n ListRules to list the next set of rules.
When the number of subscription grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription grants, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptionGrants\n to list the next set of subscription grants.
When the number of rules is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of rules, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListRules to list the next set of rules.
The results of the ListSubscriptionGrants action.
The results of the ListRules action.
When the number of subscription grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription grants, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptionGrants\n to list the next set of subscription grants.
When the number of rules is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of rules, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListRules to list the next set of rules.
Lists Amazon DataZone subscription requests.
", + "smithy.api#documentation": "Lists subscription grants.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/subscription-requests" + "uri": "/v2/domains/{domainIdentifier}/subscription-grants" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -19363,7 +19896,7 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#ListSubscriptionRequestsInput": { + "com.amazonaws.datazone#ListSubscriptionGrantsInput": { "type": "structure", "members": { "domainIdentifier": { @@ -19374,11 +19907,18 @@ "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.datazone#SubscriptionRequestStatus", + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "Specifies the status of the subscription requests.
\nThis is not a required parameter, but if not specified, by default, Amazon DataZone\n returns only PENDING subscription requests.
The identifier of the Amazon DataZone environment.
", + "smithy.api#httpQuery": "environmentId" + } + }, + "subscriptionTargetId": { + "target": "com.amazonaws.datazone#SubscriptionTargetId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription target.
", + "smithy.api#httpQuery": "subscriptionTargetId" } }, "subscribedListingId": { @@ -19388,24 +19928,158 @@ "smithy.api#httpQuery": "subscribedListingId" } }, - "owningProjectId": { - "target": "com.amazonaws.datazone#ProjectId", + "subscriptionId": { + "target": "com.amazonaws.datazone#SubscriptionId", "traits": { - "smithy.api#documentation": "The identifier of the project for the subscription requests.
", - "smithy.api#httpQuery": "owningProjectId" + "smithy.api#documentation": "The identifier of the subscription.
", + "smithy.api#httpQuery": "subscriptionId" } }, - "approverProjectId": { + "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "The identifier of the subscription request approver's project.
", - "smithy.api#httpQuery": "approverProjectId" + "smithy.api#documentation": "The ID of the owning project of the subscription grants.
", + "smithy.api#httpQuery": "owningProjectId" } }, "sortBy": { "target": "com.amazonaws.datazone#SortKey", "traits": { - "smithy.api#documentation": "Specifies the way to sort the results of this action.
", + "smithy.api#documentation": "Specifies the way of sorting the results of this action.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "Specifies the sort order of this action.
", + "smithy.api#httpQuery": "sortOrder" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of subscription grants to return in a single call to\n ListSubscriptionGrants. When the number of subscription grants to be listed\n is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListSubscriptionGrants to list the next set of subscription grants.
When the number of subscription grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription grants, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptionGrants\n to list the next set of subscription grants.
The results of the ListSubscriptionGrants action.
When the number of subscription grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription grants, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptionGrants\n to list the next set of subscription grants.
Lists Amazon DataZone subscription requests.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/subscription-requests" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListSubscriptionRequestsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#SubscriptionRequestStatus", + "traits": { + "smithy.api#documentation": "Specifies the status of the subscription requests.
\nThis is not a required parameter, but if not specified, by default, Amazon DataZone\n returns only PENDING subscription requests.
The identifier of the subscribed listing.
", + "smithy.api#httpQuery": "subscribedListingId" + } + }, + "owningProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project for the subscription requests.
", + "smithy.api#httpQuery": "owningProjectId" + } + }, + "approverProjectId": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request approver's project.
", + "smithy.api#httpQuery": "approverProjectId" + } + }, + "sortBy": { + "target": "com.amazonaws.datazone#SortKey", + "traits": { + "smithy.api#documentation": "Specifies the way to sort the results of this action.
", "smithy.api#httpQuery": "sortBy" } }, @@ -20263,6 +20937,88 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#MetadataFormEnforcementDetail": { + "type": "structure", + "members": { + "requiredMetadataForms": { + "target": "com.amazonaws.datazone#RequiredMetadataFormList", + "traits": { + "smithy.api#documentation": "The required metadata forms.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The enforcement details of a metadata form.
" + } + }, + "com.amazonaws.datazone#MetadataFormInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#FormInput" + } + }, + "com.amazonaws.datazone#MetadataFormReference": { + "type": "structure", + "members": { + "typeIdentifier": { + "target": "com.amazonaws.datazone#FormTypeIdentifier", + "traits": { + "smithy.api#documentation": "The type ID of the metadata form reference.
", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The type revision of the metadata form reference.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The reference of a metadata form.
" + } + }, + "com.amazonaws.datazone#MetadataFormSummary": { + "type": "structure", + "members": { + "formName": { + "target": "com.amazonaws.datazone#FormName", + "traits": { + "smithy.api#documentation": "The form name of the metadata form.
" + } + }, + "typeName": { + "target": "com.amazonaws.datazone#FormTypeName", + "traits": { + "smithy.api#documentation": "The type name of the metadata form.
", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The type revision of the metadata form.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the metadata form.
" + } + }, + "com.amazonaws.datazone#MetadataForms": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#FormOutput" + } + }, + "com.amazonaws.datazone#MetadataFormsSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#MetadataFormSummary" + } + }, "com.amazonaws.datazone#MetadataGenerationRun": { "type": "resource", "identifiers": { @@ -21318,6 +22074,12 @@ "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" } }, + "com.amazonaws.datazone#ProjectIds": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ProjectId" + } + }, "com.amazonaws.datazone#ProjectMember": { "type": "structure", "members": { @@ -21487,6 +22249,27 @@ "smithy.api#documentation": "The details of a Amazon DataZone project.
" } }, + "com.amazonaws.datazone#ProjectsForRule": { + "type": "structure", + "members": { + "selectionMode": { + "target": "com.amazonaws.datazone#RuleScopeSelectionMode", + "traits": { + "smithy.api#documentation": "The selection mode of the rule.
", + "smithy.api#required": {} + } + }, + "specificProjects": { + "target": "com.amazonaws.datazone#RuleProjectIdentifierList", + "traits": { + "smithy.api#documentation": "The specific projects in which the rule is created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies projects in which the rule is created.
" + } + }, "com.amazonaws.datazone#ProvisioningConfiguration": { "type": "union", "members": { @@ -22247,6 +23030,18 @@ "traits": { "smithy.api#documentation": "The decision comment of the rejected subscription request.
" } + }, + "existingSubscriptionId": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The ID of the existing subscription.
" + } + }, + "metadataForms": { + "target": "com.amazonaws.datazone#MetadataForms", + "traits": { + "smithy.api#documentation": "Metadata forms included in the subscription request.
" + } } }, "traits": { @@ -22486,6 +23281,18 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#RequiredMetadataFormList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#MetadataFormReference" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.datazone#Resource": { "type": "structure", "members": { @@ -22551,6 +23358,16 @@ } } }, + "com.amazonaws.datazone#RevisionInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, "com.amazonaws.datazone#RevokeSubscription": { "type": "operation", "input": { @@ -22750,95 +23567,379 @@ "smithy.api#documentation": "Specifies whether the row filter is sensitive.
" } } - }, - "traits": { - "smithy.api#documentation": "The row filter configuration details.
" + }, + "traits": { + "smithy.api#documentation": "The row filter configuration details.
" + } + }, + "com.amazonaws.datazone#RowFilterExpression": { + "type": "union", + "members": { + "equalTo": { + "target": "com.amazonaws.datazone#EqualToExpression", + "traits": { + "smithy.api#documentation": "The 'equal to' clause of the row filter expression.
" + } + }, + "notEqualTo": { + "target": "com.amazonaws.datazone#NotEqualToExpression", + "traits": { + "smithy.api#documentation": "The 'no equal to' clause of the row filter expression.
" + } + }, + "greaterThan": { + "target": "com.amazonaws.datazone#GreaterThanExpression", + "traits": { + "smithy.api#documentation": "The 'greater than' clause of the row filter expression.
" + } + }, + "lessThan": { + "target": "com.amazonaws.datazone#LessThanExpression", + "traits": { + "smithy.api#documentation": "The 'less than' clause of the row filter expression.
" + } + }, + "greaterThanOrEqualTo": { + "target": "com.amazonaws.datazone#GreaterThanOrEqualToExpression", + "traits": { + "smithy.api#documentation": "The 'greater than or equal to' clause of the filter expression.
" + } + }, + "lessThanOrEqualTo": { + "target": "com.amazonaws.datazone#LessThanOrEqualToExpression", + "traits": { + "smithy.api#documentation": "The 'less than or equal to' clause of the row filter expression.
" + } + }, + "isNull": { + "target": "com.amazonaws.datazone#IsNullExpression", + "traits": { + "smithy.api#documentation": "The 'is null' clause of the row filter expression.
" + } + }, + "isNotNull": { + "target": "com.amazonaws.datazone#IsNotNullExpression", + "traits": { + "smithy.api#documentation": "The 'is not null' clause of the row filter expression.
" + } + }, + "in": { + "target": "com.amazonaws.datazone#InExpression", + "traits": { + "smithy.api#documentation": "The 'in' clause of the row filter expression.
" + } + }, + "notIn": { + "target": "com.amazonaws.datazone#NotInExpression", + "traits": { + "smithy.api#documentation": "The 'not in' clause of the row filter expression.
" + } + }, + "like": { + "target": "com.amazonaws.datazone#LikeExpression", + "traits": { + "smithy.api#documentation": "The 'like' clause of the row filter expression.
" + } + }, + "notLike": { + "target": "com.amazonaws.datazone#NotLikeExpression", + "traits": { + "smithy.api#documentation": "The 'not like' clause of the row filter expression.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The row filter expression.
" + } + }, + "com.amazonaws.datazone#RowFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#RowFilter" + } + }, + "com.amazonaws.datazone#Rule": { + "type": "resource", + "identifiers": { + "identifier": { + "target": "com.amazonaws.datazone#RuleId" + } + }, + "properties": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" + }, + "name": { + "target": "com.amazonaws.datazone#RuleName" + }, + "description": { + "target": "com.amazonaws.datazone#Description" + }, + "ruleType": { + "target": "com.amazonaws.datazone#RuleType" + }, + "targetType": { + "target": "com.amazonaws.datazone#RuleTargetType" + }, + "target": { + "target": "com.amazonaws.datazone#RuleTarget" + }, + "action": { + "target": "com.amazonaws.datazone#RuleAction" + }, + "scope": { + "target": "com.amazonaws.datazone#RuleScope" + }, + "detail": { + "target": "com.amazonaws.datazone#RuleDetail" + }, + "revision": { + "target": "com.amazonaws.datazone#Revision" + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy" + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt" + }, + "lastUpdatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy" + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt" + } + }, + "create": { + "target": "com.amazonaws.datazone#CreateRule" + }, + "read": { + "target": "com.amazonaws.datazone#GetRule" + }, + "update": { + "target": "com.amazonaws.datazone#UpdateRule" + }, + "delete": { + "target": "com.amazonaws.datazone#DeleteRule" + }, + "list": { + "target": "com.amazonaws.datazone#ListRules" + } + }, + "com.amazonaws.datazone#RuleAction": { + "type": "enum", + "members": { + "CREATE_SUBSCRIPTION_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_SUBSCRIPTION_REQUEST" + } + } + } + }, + "com.amazonaws.datazone#RuleAssetTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AssetTypeIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.datazone#RuleDetail": { + "type": "union", + "members": { + "metadataFormEnforcementDetail": { + "target": "com.amazonaws.datazone#MetadataFormEnforcementDetail", + "traits": { + "smithy.api#documentation": "The enforcement detail of the metadata form.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a rule.
" + } + }, + "com.amazonaws.datazone#RuleId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#RuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\w -]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#RuleProjectIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ProjectId" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.datazone#RuleScope": { + "type": "structure", + "members": { + "assetType": { + "target": "com.amazonaws.datazone#AssetTypesForRule", + "traits": { + "smithy.api#documentation": "The asset type included in the rule scope.
" + } + }, + "dataProduct": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "The data product included in the rule scope.
" + } + }, + "project": { + "target": "com.amazonaws.datazone#ProjectsForRule", + "traits": { + "smithy.api#documentation": "The project included in the rule scope.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The scope of a rule.
" + } + }, + "com.amazonaws.datazone#RuleScopeSelectionMode": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "SPECIFIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPECIFIC" + } + } } }, - "com.amazonaws.datazone#RowFilterExpression": { - "type": "union", + "com.amazonaws.datazone#RuleSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#RuleSummary" + } + }, + "com.amazonaws.datazone#RuleSummary": { + "type": "structure", "members": { - "equalTo": { - "target": "com.amazonaws.datazone#EqualToExpression", - "traits": { - "smithy.api#documentation": "The 'equal to' clause of the row filter expression.
" - } - }, - "notEqualTo": { - "target": "com.amazonaws.datazone#NotEqualToExpression", + "identifier": { + "target": "com.amazonaws.datazone#RuleId", "traits": { - "smithy.api#documentation": "The 'no equal to' clause of the row filter expression.
" + "smithy.api#documentation": "The ID of the rule.
" } }, - "greaterThan": { - "target": "com.amazonaws.datazone#GreaterThanExpression", + "revision": { + "target": "com.amazonaws.datazone#Revision", "traits": { - "smithy.api#documentation": "The 'greater than' clause of the row filter expression.
" + "smithy.api#documentation": "The revision of the rule.
" } }, - "lessThan": { - "target": "com.amazonaws.datazone#LessThanExpression", + "ruleType": { + "target": "com.amazonaws.datazone#RuleType", "traits": { - "smithy.api#documentation": "The 'less than' clause of the row filter expression.
" + "smithy.api#documentation": "The type of the rule.
" } }, - "greaterThanOrEqualTo": { - "target": "com.amazonaws.datazone#GreaterThanOrEqualToExpression", + "name": { + "target": "com.amazonaws.datazone#RuleName", "traits": { - "smithy.api#documentation": "The 'greater than or equal to' clause of the filter expression.
" + "smithy.api#documentation": "The name of the rule.
" } }, - "lessThanOrEqualTo": { - "target": "com.amazonaws.datazone#LessThanOrEqualToExpression", + "targetType": { + "target": "com.amazonaws.datazone#RuleTargetType", "traits": { - "smithy.api#documentation": "The 'less than or equal to' clause of the row filter expression.
" + "smithy.api#documentation": "The target type of the rule.
" } }, - "isNull": { - "target": "com.amazonaws.datazone#IsNullExpression", + "target": { + "target": "com.amazonaws.datazone#RuleTarget", "traits": { - "smithy.api#documentation": "The 'is null' clause of the row filter expression.
" + "smithy.api#documentation": "The target of the rule.
" } }, - "isNotNull": { - "target": "com.amazonaws.datazone#IsNotNullExpression", + "action": { + "target": "com.amazonaws.datazone#RuleAction", "traits": { - "smithy.api#documentation": "The 'is not null' clause of the row filter expression.
" + "smithy.api#documentation": "The action of the rule.
" } }, - "in": { - "target": "com.amazonaws.datazone#InExpression", + "scope": { + "target": "com.amazonaws.datazone#RuleScope", "traits": { - "smithy.api#documentation": "The 'in' clause of the row filter expression.
" + "smithy.api#documentation": "The scope of the rule.
" } }, - "notIn": { - "target": "com.amazonaws.datazone#NotInExpression", + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", "traits": { - "smithy.api#documentation": "The 'not in' clause of the row filter expression.
" + "smithy.api#documentation": "The timestamp at which the rule was last updated.
" } }, - "like": { - "target": "com.amazonaws.datazone#LikeExpression", + "lastUpdatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", "traits": { - "smithy.api#documentation": "The 'like' clause of the row filter expression.
" + "smithy.api#documentation": "The timestamp at which the rule was last updated.
" } - }, - "notLike": { - "target": "com.amazonaws.datazone#NotLikeExpression", + } + }, + "traits": { + "smithy.api#documentation": "The summary of the rule.
" + } + }, + "com.amazonaws.datazone#RuleTarget": { + "type": "union", + "members": { + "domainUnitTarget": { + "target": "com.amazonaws.datazone#DomainUnitTarget", "traits": { - "smithy.api#documentation": "The 'not like' clause of the row filter expression.
" + "smithy.api#documentation": "The ID of the domain unit.
" } } }, "traits": { - "smithy.api#documentation": "The row filter expression.
" + "smithy.api#documentation": "The target of the rule.
" } }, - "com.amazonaws.datazone#RowFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.datazone#RowFilter" + "com.amazonaws.datazone#RuleTargetType": { + "type": "enum", + "members": { + "DOMAIN_UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_UNIT" + } + } + } + }, + "com.amazonaws.datazone#RuleType": { + "type": "enum", + "members": { + "METADATA_FORM_ENFORCEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METADATA_FORM_ENFORCEMENT" + } + } } }, "com.amazonaws.datazone#RunStatisticsForAssets": { @@ -24896,6 +25997,18 @@ "traits": { "smithy.api#documentation": "The decision comment of the subscription request.
" } + }, + "existingSubscriptionId": { + "target": "com.amazonaws.datazone#SubscriptionId", + "traits": { + "smithy.api#documentation": "The ID of the existing subscription.
" + } + }, + "metadataFormsSummary": { + "target": "com.amazonaws.datazone#MetadataFormsSummary", + "traits": { + "smithy.api#documentation": "The summary of the metadata forms.
" + } } }, "traits": { @@ -27907,6 +29020,200 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#UpdateRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateRuleInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific\n requirements across user workflows (e.g., publishing assets to the catalog, requesting\n subscriptions, creating projects) within the Amazon DataZone data portal. These rules help\n maintain consistency, ensure compliance, and uphold governance standards in data management\n processes. For instance, a metadata enforcement rule can specify the required information\n for creating a subscription request or publishing a data asset to the catalog, ensuring\n alignment with organizational standards.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/rules/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateRuleInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain in which a rule is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#RuleId", + "traits": { + "smithy.api#documentation": "The ID of the rule that is to be updated
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#RuleName", + "traits": { + "smithy.api#documentation": "The name of the rule.
" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the rule.
" + } + }, + "scope": { + "target": "com.amazonaws.datazone#RuleScope", + "traits": { + "smithy.api#documentation": "The scrope of the rule.
" + } + }, + "detail": { + "target": "com.amazonaws.datazone#RuleDetail", + "traits": { + "smithy.api#documentation": "The detail of the rule.
" + } + }, + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to update this rule in the child domain units.
", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateRuleOutput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.datazone#RuleId", + "traits": { + "smithy.api#documentation": "The ID of the rule.
", + "smithy.api#required": {} + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the rule.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#RuleName", + "traits": { + "smithy.api#documentation": "The name of the rule.
", + "smithy.api#required": {} + } + }, + "ruleType": { + "target": "com.amazonaws.datazone#RuleType", + "traits": { + "smithy.api#documentation": "The type of the rule.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.datazone#RuleTarget", + "traits": { + "smithy.api#documentation": "The target of the rule.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.datazone#RuleAction", + "traits": { + "smithy.api#documentation": "The action of the rule.
", + "smithy.api#required": {} + } + }, + "scope": { + "target": "com.amazonaws.datazone#RuleScope", + "traits": { + "smithy.api#documentation": "The scope of the rule.
", + "smithy.api#required": {} + } + }, + "detail": { + "target": "com.amazonaws.datazone#RuleDetail", + "traits": { + "smithy.api#documentation": "The detail of the rule.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the rule.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the rule was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the rule was last updated.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The user who created the rule.
", + "smithy.api#required": {} + } + }, + "lastUpdatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The timestamp at which the rule was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#UpdateSubscriptionGrantStatus": { "type": "operation", "input": { @@ -28241,6 +29548,18 @@ "traits": { "smithy.api#documentation": "The decision comment of the UpdateSubscriptionRequest action.
The ID of the existing subscription.
" + } + }, + "metadataForms": { + "target": "com.amazonaws.datazone#MetadataForms", + "traits": { + "smithy.api#documentation": "Metadata forms included in the subscription request.
" + } } }, "traits": {